[DOC-CVS] [doc-en] master: ssh2 : fix XML by converting para to simpara tags via script
[email protected] (Gina Peter Banyard)
| Newsgroups | php.doc.cvs |
|---|---|
| Message-ID | <[email protected]> |
Author: Gina Peter Banyard (Girgias)
Date: 2026-01-25T16:09:56Z
Commit: https://github.com/php/doc-en/commit/12f0e72200ea9249d0fc2f118528bd24b24c44a6
Raw diff: https://github.com/php/doc-en/commit/12f0e72200ea9249d0fc2f118528bd24b24c44a6.diff
ssh2 : fix XML by converting para to simpara tags via script
Changed paths:
M reference/ssh2/book.xml
M reference/ssh2/functions/ssh2-auth-agent.xml
M reference/ssh2/functions/ssh2-auth-hostbased-file.xml
M reference/ssh2/functions/ssh2-auth-none.xml
M reference/ssh2/functions/ssh2-auth-password.xml
M reference/ssh2/functions/ssh2-auth-pubkey-file.xml
M reference/ssh2/functions/ssh2-connect.xml
M reference/ssh2/functions/ssh2-disconnect.xml
M reference/ssh2/functions/ssh2-exec.xml
M reference/ssh2/functions/ssh2-fetch-stream.xml
M reference/ssh2/functions/ssh2-fingerprint.xml
M reference/ssh2/functions/ssh2-forward-accept.xml
M reference/ssh2/functions/ssh2-forward-listen.xml
M reference/ssh2/functions/ssh2-methods-negotiated.xml
M reference/ssh2/functions/ssh2-poll.xml
M reference/ssh2/functions/ssh2-publickey-add.xml
M reference/ssh2/functions/ssh2-publickey-init.xml
M reference/ssh2/functions/ssh2-publickey-list.xml
M reference/ssh2/functions/ssh2-publickey-remove.xml
M reference/ssh2/functions/ssh2-scp-recv.xml
M reference/ssh2/functions/ssh2-scp-send.xml
M reference/ssh2/functions/ssh2-send-eof.xml
M reference/ssh2/functions/ssh2-sftp-chmod.xml
M reference/ssh2/functions/ssh2-sftp-lstat.xml
M reference/ssh2/functions/ssh2-sftp-mkdir.xml
M reference/ssh2/functions/ssh2-sftp-readlink.xml
M reference/ssh2/functions/ssh2-sftp-realpath.xml
M reference/ssh2/functions/ssh2-sftp-rename.xml
M reference/ssh2/functions/ssh2-sftp-rmdir.xml
M reference/ssh2/functions/ssh2-sftp-stat.xml
M reference/ssh2/functions/ssh2-sftp-symlink.xml
M reference/ssh2/functions/ssh2-sftp-unlink.xml
M reference/ssh2/functions/ssh2-sftp.xml
M reference/ssh2/functions/ssh2-shell.xml
M reference/ssh2/functions/ssh2-tunnel.xml
M reference/ssh2/installation.xml
M reference/ssh2/setup.xml
Diff:
diff --git a/reference/ssh2/book.xml b/reference/ssh2/book.xml
index 65ea086f51f5..dea838953a16 100644
--- a/reference/ssh2/book.xml
+++ b/reference/ssh2/book.xml
@@ -1,28 +1,26 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<book xml:id="book.ssh2" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<book xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="book.ssh2">
<?phpdoc extension-membership="pecl" ?>
<title>Secure Shell2</title>
<titleabbrev>SSH2</titleabbrev>
-
+
<!-- {{{ preface -->
<preface xml:id="intro.ssh2">
&reftitle.intro;
- <para>
+ <simpara>
Bindings to the <link xlink:href="&url.libssh2;">libssh2</link> library which
provide access to resources (shell, remote exec, tunneling, file transfer)
on a remote machine using a secure cryptographic transport.
- </para>
+ </simpara>
</preface>
<!-- }}} -->
-
+
&reference.ssh2.setup;
&reference.ssh2.constants;
&reference.ssh2.reference;
</book>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -43,4 +41,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-
diff --git a/reference/ssh2/functions/ssh2-auth-agent.xml b/reference/ssh2/functions/ssh2-auth-agent.xml
index 0bdd9b5d3fb5..597388a61c6e 100644
--- a/reference/ssh2/functions/ssh2-auth-agent.xml
+++ b/reference/ssh2/functions/ssh2-auth-agent.xml
@@ -13,9 +13,9 @@
<methodparam><type>resource</type><parameter>session</parameter></methodparam>
<methodparam><type>string</type><parameter>username</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Authenticate over SSH using the ssh agent
- </para>
+ </simpara>
<note>
<simpara>
The <function>ssh2_auth_agent</function> function will only be available
@@ -30,18 +30,18 @@
<varlistentry>
<term><parameter>session</parameter></term>
<listitem>
- <para>
+ <simpara>
An SSH connection link identifier, obtained from a call to
<function>ssh2_connect</function>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>username</parameter></term>
<listitem>
- <para>
+ <simpara>
Remote user name.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -49,9 +49,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&return.success;
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/ssh2/functions/ssh2-auth-hostbased-file.xml b/reference/ssh2/functions/ssh2-auth-hostbased-file.xml
index a8278f219ac1..c567433019a9 100644
--- a/reference/ssh2/functions/ssh2-auth-hostbased-file.xml
+++ b/reference/ssh2/functions/ssh2-auth-hostbased-file.xml
@@ -18,9 +18,9 @@
<methodparam choice="opt"><type>string</type><parameter>passphrase</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>local_username</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Authenticate using a public hostkey read from a file.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -29,56 +29,56 @@
<varlistentry>
<term><parameter>session</parameter></term>
<listitem>
- <para>
+ <simpara>
An SSH connection link identifier, obtained from a call to
<function>ssh2_connect</function>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>username</parameter></term>
<listitem>
- <para>
- </para>
+ <simpara>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>hostname</parameter></term>
<listitem>
- <para>
- </para>
+ <simpara>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>pubkeyfile</parameter></term>
<listitem>
- <para>
- </para>
+ <simpara>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>privkeyfile</parameter></term>
<listitem>
- <para>
- </para>
+ <simpara>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>passphrase</parameter></term>
<listitem>
- <para>
+ <simpara>
If <parameter>privkeyfile</parameter> is encrypted (which it should
be), the passphrase must be provided.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>local_username</parameter></term>
<listitem>
- <para>
+ <simpara>
If <parameter>local_username</parameter> is omitted, then the value
for <parameter>username</parameter> will be used for it.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -86,9 +86,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&return.success;
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
@@ -117,10 +117,10 @@ if (ssh2_auth_hostbased_file($connection, 'remoteusername', 'myhost.example.com'
<refsect1 role="notes">
&reftitle.notes;
<note>
- <para>
+ <simpara>
<function>ssh2_auth_hostbased_file</function> requires libssh2 >= 0.7 and
PHP/SSH2 >= 0.7
- </para>
+ </simpara>
</note>
</refsect1>
diff --git a/reference/ssh2/functions/ssh2-auth-none.xml b/reference/ssh2/functions/ssh2-auth-none.xml
index 8f2779b6ba2a..153f99c66221 100644
--- a/reference/ssh2/functions/ssh2-auth-none.xml
+++ b/reference/ssh2/functions/ssh2-auth-none.xml
@@ -13,11 +13,11 @@
<methodparam><type>resource</type><parameter>session</parameter></methodparam>
<methodparam><type>string</type><parameter>username</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Attempt "none" authentication which usually will (and should) fail.
As part of the failure, this function will return an array of accepted
authentication methods.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,18 +26,18 @@
<varlistentry>
<term><parameter>session</parameter></term>
<listitem>
- <para>
+ <simpara>
An SSH connection link identifier, obtained from a call to
<function>ssh2_connect</function>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>username</parameter></term>
<listitem>
- <para>
+ <simpara>
Remote user name.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -45,10 +45,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns &true; if the server does accept "none" as an authentication
method, or an array of accepted authentication methods on failure.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/ssh2/functions/ssh2-auth-password.xml b/reference/ssh2/functions/ssh2-auth-password.xml
index f6795361b011..8710f9c907bc 100644
--- a/reference/ssh2/functions/ssh2-auth-password.xml
+++ b/reference/ssh2/functions/ssh2-auth-password.xml
@@ -14,10 +14,10 @@
<methodparam><type>string</type><parameter>username</parameter></methodparam>
<methodparam><type>string</type><parameter>password</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Authenticate over SSH using a plain password. Since version 0.12 this function
also supports keyboard_interactive method.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,26 +26,26 @@
<varlistentry>
<term><parameter>session</parameter></term>
<listitem>
- <para>
+ <simpara>
An SSH connection link identifier, obtained from a call to
<function>ssh2_connect</function>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>username</parameter></term>
<listitem>
- <para>
+ <simpara>
Remote user name.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>password</parameter></term>
<listitem>
- <para>
+ <simpara>
Password for <parameter>username</parameter>
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -53,9 +53,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&return.success;
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/ssh2/functions/ssh2-auth-pubkey-file.xml b/reference/ssh2/functions/ssh2-auth-pubkey-file.xml
index e78d2756b0d1..bcbe76c1f271 100644
--- a/reference/ssh2/functions/ssh2-auth-pubkey-file.xml
+++ b/reference/ssh2/functions/ssh2-auth-pubkey-file.xml
@@ -16,9 +16,9 @@
<methodparam><type>string</type><parameter>privkeyfile</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>passphrase</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Authenticate using a public key read from a file.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -27,44 +27,44 @@
<varlistentry>
<term><parameter>session</parameter></term>
<listitem>
- <para>
+ <simpara>
An SSH connection link identifier, obtained from a call to
<function>ssh2_connect</function>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>username</parameter></term>
<listitem>
- <para>
- </para>
+ <simpara>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>pubkeyfile</parameter></term>
<listitem>
- <para>
+ <simpara>
The public key file needs to be in OpenSSH's format. It should look something like:
- </para>
- <para>
+ </simpara>
+ <simpara>
ssh-rsa AAAAB3NzaC1yc2EAAA....NX6sqSnHA8= rsa-key-20121110
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>privkeyfile</parameter></term>
<listitem>
- <para>
- </para>
+ <simpara>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>passphrase</parameter></term>
<listitem>
- <para>
+ <simpara>
If <parameter>privkeyfile</parameter> is encrypted (which it should
be), the <parameter>passphrase</parameter> must be provided.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -72,9 +72,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&return.success;
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
@@ -102,7 +102,7 @@ if (ssh2_auth_pubkey_file($connection, 'username',
<refsect1 role="notes">
&reftitle.notes;
<note>
- <para>
+ <simpara>
The underlying libssh library doesn't support partial auths very cleanly
That is, if you need to supply both a public key and a password it will
appear as if this function has failed. In this particular case a failure
@@ -110,7 +110,7 @@ if (ssh2_auth_pubkey_file($connection, 'username',
would need to ignore this failure and continue on and call
<function>ssh2_auth_password</function> in order to complete
authentication.
- </para>
+ </simpara>
</note>
</refsect1>
diff --git a/reference/ssh2/functions/ssh2-connect.xml b/reference/ssh2/functions/ssh2-connect.xml
index eac12e26a276..1a05d4d86606 100644
--- a/reference/ssh2/functions/ssh2-connect.xml
+++ b/reference/ssh2/functions/ssh2-connect.xml
@@ -15,14 +15,14 @@
<methodparam choice="opt"><type>array</type><parameter>methods</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>callbacks</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Establish a connection to a remote SSH server.
- </para>
- <para>
+ </simpara>
+ <simpara>
Once connected, the client should verify the server's hostkey using
<function>ssh2_fingerprint</function>, then authenticate using either
password or public key.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -31,24 +31,24 @@
<varlistentry>
<term><parameter>host</parameter></term>
<listitem>
- <para>
- </para>
+ <simpara>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>port</parameter></term>
<listitem>
- <para>
- </para>
+ <simpara>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>methods</parameter></term>
<listitem>
- <para>
+ <simpara>
<parameter>methods</parameter> may be an associative array with up to four parameters
as described below.
- </para>
+ </simpara>
<table>
<title><parameter>methods</parameter> may be an associative array
with any or all of the following parameters.</title>
@@ -105,11 +105,11 @@
</tbody>
</tgroup>
</table>
- <para>
+ <simpara>
* - Supported Values are dependent on methods supported by underlying library.
See <link xlink:href="&url.libssh2;">libssh2</link> documentation for additional
information.
- </para>
+ </simpara>
<table>
<title>
<parameter>client_to_server</parameter> and
@@ -167,12 +167,12 @@
</table>
<note>
<title>Crypt and MAC method "<literal>none</literal>"</title>
- <para>
+ <simpara>
For security reasons, <literal>none</literal> is disabled by the underlying
<link xlink:href="&url.libssh2;">libssh2</link> library unless explicitly enabled
during build time by using the appropriate ./configure options. See documentation
for the underlying library for more information.
- </para>
+ </simpara>
</note>
</listitem>
</varlistentry>
@@ -240,20 +240,20 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns a resource on success, or &false; on error.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>ssh2_connect</function> example</title>
- <para>
+ <simpara>
Open a connection forcing 3des-cbc when sending packets, any strength
aes cipher when receiving packets, no compression in either direction,
and Group1 key exchange.
- </para>
+ </simpara>
<programlisting role="php">
<![CDATA[
<?php
diff --git a/reference/ssh2/functions/ssh2-disconnect.xml b/reference/ssh2/functions/ssh2-disconnect.xml
index 9f84ebc5ddc1..3ba1575605ef 100644
--- a/reference/ssh2/functions/ssh2-disconnect.xml
+++ b/reference/ssh2/functions/ssh2-disconnect.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="function.ssh2-disconnect" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.ssh2-disconnect">
<refnamediv>
<refname>ssh2_disconnect</refname>
<refpurpose>Close a connection to a remote SSH server</refpurpose>
@@ -13,9 +12,9 @@
<type>bool</type><methodname>ssh2_disconnect</methodname>
<methodparam><type>resource</type><parameter>session</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Close a connection to a remote SSH server.
- </para>
+ </simpara>
</refsect1><!-- }}} -->
<refsect1 role="parameters"><!-- {{{ -->
@@ -24,10 +23,10 @@
<varlistentry>
<term><parameter>session</parameter></term>
<listitem>
- <para>
+ <simpara>
An SSH connection link identifier, obtained from a call to
<function>ssh2_connect</function>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -35,9 +34,9 @@
<refsect1 role="returnvalues"><!-- {{{ -->
&reftitle.returnvalues;
- <para>
+ <simpara>
&return.success;
- </para>
+ </simpara>
</refsect1><!-- }}} -->
<refsect1 role="seealso"><!-- {{{ -->
@@ -48,7 +47,6 @@
</refsect1><!-- }}} -->
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/ssh2/functions/ssh2-exec.xml b/reference/ssh2/functions/ssh2-exec.xml
index 31ed48017747..10068837fa8a 100644
--- a/reference/ssh2/functions/ssh2-exec.xml
+++ b/reference/ssh2/functions/ssh2-exec.xml
@@ -18,9 +18,9 @@
<methodparam choice="opt"><type>int</type><parameter>height</parameter><initializer>25</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>width_height_type</parameter><initializer>SSH2_TERM_UNIT_CHARS</initializer></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Execute a command at the remote end and allocate a channel for it.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -29,59 +29,59 @@
<varlistentry>
<term><parameter>session</parameter></term>
<listitem>
- <para>
+ <simpara>
An SSH connection link identifier, obtained from a call to
<function>ssh2_connect</function>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>command</parameter></term>
<listitem>
- <para>
- </para>
+ <simpara>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>pty</parameter></term>
<listitem>
- <para>
- </para>
+ <simpara>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>env</parameter></term>
<listitem>
- <para>
+ <simpara>
<parameter>env</parameter> may be passed as an associative array of
name/value pairs to set in the target environment.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>width</parameter></term>
<listitem>
- <para>
+ <simpara>
Width of the virtual terminal.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>height</parameter></term>
<listitem>
- <para>
+ <simpara>
Height of the virtual terminal.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>width_height_type</parameter></term>
<listitem>
- <para>
+ <simpara>
<parameter>width_height_type</parameter> should be one of
<constant>SSH2_TERM_UNIT_CHARS</constant> or
<constant>SSH2_TERM_UNIT_PIXELS</constant>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -89,9 +89,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns a stream on success&return.falseforfailure;.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/ssh2/functions/ssh2-fetch-stream.xml b/reference/ssh2/functions/ssh2-fetch-stream.xml
index 9681347502fe..0a7f07fb5b91 100644
--- a/reference/ssh2/functions/ssh2-fetch-stream.xml
+++ b/reference/ssh2/functions/ssh2-fetch-stream.xml
@@ -13,11 +13,11 @@
<methodparam><type>resource</type><parameter>channel</parameter></methodparam>
<methodparam><type>int</type><parameter>streamid</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Fetches an alternate substream associated with an SSH2 channel stream.
The SSH2 protocol currently defines only one substream, STDERR, which has
a substream ID of <constant>SSH2_STREAM_STDERR</constant> (defined as 1).
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,16 +26,16 @@
<varlistentry>
<term><parameter>channel</parameter></term>
<listitem>
- <para>
- </para>
+ <simpara>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>streamid</parameter></term>
<listitem>
- <para>
+ <simpara>
An SSH2 channel stream.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -43,9 +43,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns the requested stream resource.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/ssh2/functions/ssh2-fingerprint.xml b/reference/ssh2/functions/ssh2-fingerprint.xml
index 1c4f0601728c..09f0f3c9ed8d 100644
--- a/reference/ssh2/functions/ssh2-fingerprint.xml
+++ b/reference/ssh2/functions/ssh2-fingerprint.xml
@@ -13,9 +13,9 @@
<methodparam><type>resource</type><parameter>session</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>SSH2_FINGERPRINT_MD5 | SSH2_FINGERPRINT_HEX</initializer></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Returns a server hostkey hash from an active session.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,22 +24,22 @@
<varlistentry>
<term><parameter>session</parameter></term>
<listitem>
- <para>
+ <simpara>
An SSH connection link identifier, obtained from a call to
<function>ssh2_connect</function>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
- <para>
+ <simpara>
<parameter>flags</parameter> may be either of
<constant>SSH2_FINGERPRINT_MD5</constant> or
<constant>SSH2_FINGERPRINT_SHA1</constant> logically ORed with
<constant>SSH2_FINGERPRINT_HEX</constant> or
<constant>SSH2_FINGERPRINT_RAW</constant>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -47,9 +47,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns the hostkey hash as a string.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/ssh2/functions/ssh2-forward-accept.xml b/reference/ssh2/functions/ssh2-forward-accept.xml
index 253c5368455d..ad1fa84c802d 100644
--- a/reference/ssh2/functions/ssh2-forward-accept.xml
+++ b/reference/ssh2/functions/ssh2-forward-accept.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="function.ssh2-forward-accept" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.ssh2-forward-accept">
<refnamediv>
<refname>ssh2_forward_accept</refname>
<refpurpose>Accept a connection created by a listener</refpurpose>
@@ -13,9 +12,9 @@
<type class="union"><type>resource</type><type>false</type></type><methodname>ssh2_forward_accept</methodname>
<methodparam><type>resource</type><parameter>listener</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Accepts a connection created by a listener.
- </para>
+ </simpara>
&warn.undocumented.func;
@@ -27,9 +26,9 @@
<varlistentry>
<term><parameter>desc</parameter></term>
<listitem>
- <para>
+ <simpara>
An SSH2 Listener resource, obtained from a call to <function>ssh2_forward_listen</function>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -37,13 +36,12 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns a stream resource, &return.falseforfailure;.
- </para>
+ </simpara>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/ssh2/functions/ssh2-forward-listen.xml b/reference/ssh2/functions/ssh2-forward-listen.xml
index 4a100295f95e..17eca78e274d 100644
--- a/reference/ssh2/functions/ssh2-forward-listen.xml
+++ b/reference/ssh2/functions/ssh2-forward-listen.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="function.ssh2-forward-listen" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.ssh2-forward-listen">
<refnamediv>
<refname>ssh2_forward_listen</refname>
<refpurpose>Bind a port on the remote server and listen for connections</refpurpose>
@@ -16,9 +15,9 @@
<methodparam choice="opt"><type>string</type><parameter>host</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>max_connections</parameter><initializer>16</initializer></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Binds a port on the remote server and listen for connections.
- </para>
+ </simpara>
&warn.undocumented.func;
@@ -30,33 +29,33 @@
<varlistentry>
<term><parameter>session</parameter></term>
<listitem>
- <para>
+ <simpara>
An SSH Session resource, obtained from a call to <function>ssh2_connect</function>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>port</parameter></term>
<listitem>
- <para>
+ <simpara>
The port of the remote server.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>host</parameter></term>
<listitem>
- <para>
+ <simpara>
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>max_connections</parameter></term>
<listitem>
- <para>
+ <simpara>
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -64,9 +63,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns an SSH2 Listener, &return.falseforfailure;.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="seealso">
@@ -76,7 +75,6 @@
</simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/ssh2/functions/ssh2-methods-negotiated.xml b/reference/ssh2/functions/ssh2-methods-negotiated.xml
index 22de97bc423a..ffa7cb10dafc 100644
--- a/reference/ssh2/functions/ssh2-methods-negotiated.xml
+++ b/reference/ssh2/functions/ssh2-methods-negotiated.xml
@@ -12,9 +12,9 @@
<type>array</type><methodname>ssh2_methods_negotiated</methodname>
<methodparam><type>resource</type><parameter>session</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Returns list of negotiated methods.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -23,10 +23,10 @@
<varlistentry>
<term><parameter>session</parameter></term>
<listitem>
- <para>
+ <simpara>
An SSH connection link identifier, obtained from a call to
<function>ssh2_connect</function>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -34,9 +34,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/ssh2/functions/ssh2-poll.xml b/reference/ssh2/functions/ssh2-poll.xml
index fdea353c18db..16a3ee8b161c 100644
--- a/reference/ssh2/functions/ssh2-poll.xml
+++ b/reference/ssh2/functions/ssh2-poll.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="function.ssh2-poll" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.ssh2-poll">
<refnamediv>
<refname>ssh2_poll</refname>
<refpurpose>Poll the channels/listeners/streams for events</refpurpose>
@@ -14,10 +13,10 @@
<methodparam><type>array</type><parameter role="reference">desc</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>timeout</parameter><initializer>30</initializer></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Polls the channels/listeners/streams for events,
and returns the number of descriptors which returned non-zero revents.
- </para>
+ </simpara>
&warn.undocumented.func;
@@ -29,22 +28,22 @@
<varlistentry>
<term><parameter>desc</parameter></term>
<listitem>
- <para>
+ <simpara>
An indexed array of subarrays with the keys
<literal>'resource'</literal> and <literal>'events'</literal>.
The value of the resource is a (channel) stream or an SSH2 Listener resource.
The value of the event are SSH2_POLL* flags bitwise ORed together.
Each subarray will be populated with an <literal>'revents'</literal> element on return,
whose values are SSH2_POLL* flags bitwise ORed together of the events that occurred.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>timeout</parameter></term>
<listitem>
- <para>
+ <simpara>
The timeout in seconds.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -52,13 +51,12 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns the number of descriptors which returned non-zero revents.
- </para>
+ </simpara>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/ssh2/functions/ssh2-publickey-add.xml b/reference/ssh2/functions/ssh2-publickey-add.xml
index 583f25a4b076..0b279afcef70 100644
--- a/reference/ssh2/functions/ssh2-publickey-add.xml
+++ b/reference/ssh2/functions/ssh2-publickey-add.xml
@@ -29,45 +29,45 @@
<varlistentry>
<term><parameter>pkey</parameter></term>
<listitem>
- <para>
+ <simpara>
Publickey Subsystem resource created by <function>ssh2_publickey_init</function>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>algoname</parameter></term>
<listitem>
- <para>
+ <simpara>
Publickey algorithm (e.g.): ssh-dss, ssh-rsa
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>blob</parameter></term>
<listitem>
- <para>
+ <simpara>
Publickey blob as raw binary data
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>overwrite</parameter></term>
<listitem>
- <para>
+ <simpara>
If the specified key already exists, should it be overwritten?
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>attributes</parameter></term>
<listitem>
- <para>
+ <simpara>
Associative array of attributes to assign to this public key.
Refer to ietf-secsh-publickey-subsystem for a list of supported attributes.
To mark an attribute as mandatory, precede its name with an asterisk.
If the server is unable to support an attribute marked mandatory,
it will abort the add process.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -75,9 +75,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&return.success;
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/ssh2/functions/ssh2-publickey-init.xml b/reference/ssh2/functions/ssh2-publickey-init.xml
index 6a158c5afcb4..88add4ed5f1b 100644
--- a/reference/ssh2/functions/ssh2-publickey-init.xml
+++ b/reference/ssh2/functions/ssh2-publickey-init.xml
@@ -14,16 +14,16 @@
<type class="union"><type>resource</type><type>false</type></type><methodname>ssh2_publickey_init</methodname>
<methodparam><type>resource</type><parameter>session</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Request the Publickey subsystem from an already connected SSH2 server.
- </para>
- <para>
+ </simpara>
+ <simpara>
The publickey subsystem allows an already connected and authenticated
client to manage the list of authorized public keys stored on the
target server in an implementation agnostic manner.
If the remote server does not support the publickey subsystem,
the <function>ssh2_publickey_init</function> function will return &false;.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -32,8 +32,8 @@
<varlistentry>
<term><parameter>session</parameter></term>
<listitem>
- <para>
- </para>
+ <simpara>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -41,10 +41,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns an <literal>SSH2 Publickey Subsystem</literal> resource for use
with all other ssh2_publickey_*() methods&return.falseforfailure;.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="notes">
diff --git a/reference/ssh2/functions/ssh2-publickey-list.xml b/reference/ssh2/functions/ssh2-publickey-list.xml
index 6448e871a35e..d2bf0f985b55 100644
--- a/reference/ssh2/functions/ssh2-publickey-list.xml
+++ b/reference/ssh2/functions/ssh2-publickey-list.xml
@@ -14,9 +14,9 @@
<type>array</type><methodname>ssh2_publickey_list</methodname>
<methodparam><type>resource</type><parameter>pkey</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
List currently authorized publickeys.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,9 +25,9 @@
<varlistentry>
<term><parameter>pkey</parameter></term>
<listitem>
- <para>
+ <simpara>
Publickey Subsystem resource
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -35,11 +35,11 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns a numerically indexed array of keys,
each of which is an associative array containing:
name, blob, and attrs elements.
- </para>
+ </simpara>
<table>
<title>Publickey elements</title>
<tgroup cols="2">
diff --git a/reference/ssh2/functions/ssh2-publickey-remove.xml b/reference/ssh2/functions/ssh2-publickey-remove.xml
index f377b1567e5e..317083d28595 100644
--- a/reference/ssh2/functions/ssh2-publickey-remove.xml
+++ b/reference/ssh2/functions/ssh2-publickey-remove.xml
@@ -16,9 +16,9 @@
<methodparam><type>string</type><parameter>algoname</parameter></methodparam>
<methodparam><type>string</type><parameter>blob</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Removes an authorized publickey.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -27,25 +27,25 @@
<varlistentry>
<term><parameter>pkey</parameter></term>
<listitem>
- <para>
+ <simpara>
Publickey Subsystem Resource
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>algoname</parameter></term>
<listitem>
- <para>
+ <simpara>
Publickey algorithm (e.g.): ssh-dss, ssh-rsa
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>blob</parameter></term>
<listitem>
- <para>
+ <simpara>
Publickey blob as raw binary data
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -53,9 +53,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&return.success;
- </para>
+ </simpara>
</refsect1>
<refsect1 role="notes">
diff --git a/reference/ssh2/functions/ssh2-scp-recv.xml b/reference/ssh2/functions/ssh2-scp-recv.xml
index 5f5ab9751a3f..eb42d23f0127 100644
--- a/reference/ssh2/functions/ssh2-scp-recv.xml
+++ b/reference/ssh2/functions/ssh2-scp-recv.xml
@@ -14,9 +14,9 @@
<methodparam><type>string</type><parameter>remote_file</parameter></methodparam>
<methodparam><type>string</type><parameter>local_file</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Copy a file from the remote server to the local filesystem using the SCP protocol.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,26 +25,26 @@
<varlistentry>
<term><parameter>session</parameter></term>
<listitem>
- <para>
+ <simpara>
An SSH connection link identifier, obtained from a call to
<function>ssh2_connect</function>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>remote_file</parameter></term>
<listitem>
- <para>
+ <simpara>
Path to the remote file.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>local_file</parameter></term>
<listitem>
- <para>
+ <simpara>
Path to the local file.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -52,9 +52,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&return.success;
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/ssh2/functions/ssh2-scp-send.xml b/reference/ssh2/functions/ssh2-scp-send.xml
index 28d522d9584b..210294f1a1db 100644
--- a/reference/ssh2/functions/ssh2-scp-send.xml
+++ b/reference/ssh2/functions/ssh2-scp-send.xml
@@ -15,9 +15,9 @@
<methodparam><type>string</type><parameter>remote_file</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>create_mode</parameter><initializer>0644</initializer></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Copy a file from the local filesystem to the remote server using the SCP protocol.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,35 +26,35 @@
<varlistentry>
<term><parameter>session</parameter></term>
<listitem>
- <para>
+ <simpara>
An SSH connection link identifier, obtained from a call to
<function>ssh2_connect</function>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>local_file</parameter></term>
<listitem>
- <para>
+ <simpara>
Path to the local file.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>remote_file</parameter></term>
<listitem>
- <para>
+ <simpara>
Path to the remote file.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>create_mode</parameter></term>
<listitem>
- <para>
+ <simpara>
The file will be created with the mode specified by
<parameter>create_mode</parameter>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -62,9 +62,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&return.success;
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/ssh2/functions/ssh2-send-eof.xml b/reference/ssh2/functions/ssh2-send-eof.xml
index bb3bdc6804cd..657c26e73f89 100644
--- a/reference/ssh2/functions/ssh2-send-eof.xml
+++ b/reference/ssh2/functions/ssh2-send-eof.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="function.ssh2-send-eof" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="function.ssh2-send-eof">
<refnamediv>
<refname>ssh2_send_eof</refname>
<refpurpose>Send EOF to stream</refpurpose>
@@ -13,12 +12,12 @@
<type>bool</type><methodname>ssh2_send_eof</methodname>
<methodparam><type>resource</type><parameter>channel</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Sends an EOF to the stream; this is typically used to close standard input,
while keeping output and error alive. For example, one can send a remote
process some data over standard input, close it to start processing, and
still be able to read out the results without creating additional files.
- </para>
+ </simpara>
</refsect1><!-- }}} -->
<refsect1 role="parameters"><!-- {{{ -->
@@ -27,10 +26,10 @@
<varlistentry>
<term><parameter>channel</parameter></term>
<listitem>
- <para>
+ <simpara>
An SSH stream; can be acquired through functions like <function>ssh2_fetch_stream</function>
or <function>ssh2_connect</function>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -38,9 +37,9 @@
<refsect1 role="returnvalues"><!-- {{{ -->
&reftitle.returnvalues;
- <para>
+ <simpara>
&return.success;
- </para>
+ </simpara>
</refsect1><!-- }}} -->
<refsect1 role="seealso"><!-- {{{ -->
@@ -51,7 +50,6 @@
</refsect1><!-- }}} -->
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/ssh2/functions/ssh2-sftp-chmod.xml b/reference/ssh2/functions/ssh2-sftp-chmod.xml
index dbe7c38a4075..2c4c01644b4d 100644
--- a/reference/ssh2/functions/ssh2-sftp-chmod.xml
+++ b/reference/ssh2/functions/ssh2-sftp-chmod.xml
@@ -14,10 +14,10 @@
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam><type>int</type><parameter>mode</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Attempts to change the mode of the specified file to that given in
<parameter>mode</parameter>.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,25 +26,25 @@
<varlistentry>
<term><parameter>sftp</parameter></term>
<listitem>
- <para>
+ <simpara>
An SSH2 SFTP resource opened by <function>ssh2_sftp</function>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
- <para>
+ <simpara>
Path to the file.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mode</parameter></term>
<listitem>
- <para>
+ <simpara>
Permissions on the file. See the <function>chmod</function> for more details on this parameter.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -52,9 +52,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&return.success;
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/ssh2/functions/ssh2-sftp-lstat.xml b/reference/ssh2/functions/ssh2-sftp-lstat.xml
index 09dd9634c587..92b78e7cb372 100644
--- a/reference/ssh2/functions/ssh2-sftp-lstat.xml
+++ b/reference/ssh2/functions/ssh2-sftp-lstat.xml
@@ -13,15 +13,15 @@
<methodparam><type>resource</type><parameter>sftp</parameter></methodparam>
<methodparam><type>string</type><parameter>path</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Stats a symbolic link on the remote filesystem <emphasis>without</emphasis>
following the link.
- </para>
- <para>
+ </simpara>
+ <simpara>
This function is similar to using the <function>lstat</function> function
with the <link linkend="wrappers.ssh2">ssh2.sftp://</link> wrapper
and returns the same values.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -30,17 +30,17 @@
<varlistentry>
<term><parameter>sftp</parameter></term>
<listitem>
- <para>
+ <simpara>
An SSH2 SFTP resource opened by <function>ssh2_sftp</function>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>path</parameter></term>
<listitem>
- <para>
+ <simpara>
Path to the remote symbolic link.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -48,10 +48,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
See the documentation for <function>stat</function> for details on the
values which may be returned.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/ssh2/functions/ssh2-sftp-mkdir.xml b/reference/ssh2/functions/ssh2-sftp-mkdir.xml
index e0b76eeb9d83..403c19e0951d 100644
--- a/reference/ssh2/functions/ssh2-sftp-mkdir.xml
+++ b/reference/ssh2/functions/ssh2-sftp-mkdir.xml
@@ -15,14 +15,14 @@
<methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer>0777</initializer></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>recursive</parameter><initializer>&false;</initializer></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Creates a directory on the remote file server with permissions set to
<parameter>mode</parameter>.
- </para>
- <para>
+ </simpara>
+ <simpara>
This function is similar to using <function>mkdir</function> with the
<link linkend="wrappers.ssh2">ssh2.sftp://</link> wrapper.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -31,35 +31,35 @@
<varlistentry>
<term><parameter>sftp</parameter></term>
<listitem>
- <para>
+ <simpara>
An SSH2 SFTP resource opened by <function>ssh2_sftp</function>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>dirname</parameter></term>
<listitem>
- <para>
+ <simpara>
Path of the new directory.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mode</parameter></term>
<listitem>
- <para>
+ <simpara>
Permissions on the new directory.
The actual mode is affected by the current umask.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>recursive</parameter></term>
<listitem>
- <para>
+ <simpara>
If <parameter>recursive</parameter> is &true; any parent directories
required for <parameter>dirname</parameter> will be automatically created as well.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -67,9 +67,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&return.success;
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/ssh2/functions/ssh2-sftp-readlink.xml b/reference/ssh2/functions/ssh2-sftp-readlink.xml
index a77e11e124b3..1a34e5661ac7 100644
--- a/reference/ssh2/functions/ssh2-sftp-readlink.xml
+++ b/reference/ssh2/functions/ssh2-sftp-readlink.xml
@@ -13,9 +13,9 @@
<methodparam><type>resource</type><parameter>sftp</parameter></methodparam>
<methodparam><type>string</type><parameter>link</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Returns the target of a symbolic link.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,17 +24,17 @@
<varlistentry>
<term><parameter>sftp</parameter></term>
<listitem>
- <para>
+ <simpara>
An SSH2 SFTP resource opened by <function>ssh2_sftp</function>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>link</parameter></term>
<listitem>
- <para>
+ <simpara>
Path of the symbolic link.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -42,9 +42,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns the target of the symbolic <parameter>link</parameter>.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/ssh2/functions/ssh2-sftp-realpath.xml b/reference/ssh2/functions/ssh2-sftp-realpath.xml
index 688b25a12b3b..dd77a64d6346 100644
--- a/reference/ssh2/functions/ssh2-sftp-realpath.xml
+++ b/reference/ssh2/functions/ssh2-sftp-realpath.xml
@@ -13,10 +13,10 @@
<methodparam><type>resource</type><parameter>sftp</parameter></methodparam>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Translates <parameter>filename</parameter> into the effective real path
on the remote filesystem.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,16 +25,16 @@
<varlistentry>
<term><parameter>sftp</parameter></term>
<listitem>
- <para>
+ <simpara>
An SSH2 SFTP resource opened by <function>ssh2_sftp</function>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
- <para>
- </para>
+ <simpara>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -42,9 +42,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns the real path as a string.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/ssh2/functions/ssh2-sftp-rename.xml b/reference/ssh2/functions/ssh2-sftp-rename.xml
index 8b4b7081cc15..e0b4f4109777 100644
--- a/reference/ssh2/functions/ssh2-sftp-rename.xml
+++ b/reference/ssh2/functions/ssh2-sftp-rename.xml
@@ -14,9 +14,9 @@
<methodparam><type>string</type><parameter>from</parameter></methodparam>
<methodparam><type>string</type><parameter>to</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Renames a file on the remote filesystem.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -25,25 +25,25 @@
<varlistentry>
<term><parameter>sftp</parameter></term>
<listitem>
- <para>
+ <simpara>
An SSH2 SFTP resource opened by <function>ssh2_sftp</function>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>from</parameter></term>
<listitem>
- <para>
+ <simpara>
The current file that is being renamed.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>to</parameter></term>
<listitem>
- <para>
+ <simpara>
The new file name that replaces <parameter>from</parameter>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -51,9 +51,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&return.success;
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/ssh2/functions/ssh2-sftp-rmdir.xml b/reference/ssh2/functions/ssh2-sftp-rmdir.xml
index 9b4e765285ce..efb33884bbe6 100644
--- a/reference/ssh2/functions/ssh2-sftp-rmdir.xml
+++ b/reference/ssh2/functions/ssh2-sftp-rmdir.xml
@@ -13,13 +13,13 @@
<methodparam><type>resource</type><parameter>sftp</parameter></methodparam>
<methodparam><type>string</type><parameter>dirname</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Removes a directory from the remote file server.
- </para>
- <para>
+ </simpara>
+ <simpara>
This function is similar to using <function>rmdir</function> with the
<link linkend="wrappers.ssh2">ssh2.sftp://</link> wrapper.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -28,16 +28,16 @@
<varlistentry>
<term><parameter>sftp</parameter></term>
<listitem>
- <para>
+ <simpara>
An SSH2 SFTP resource opened by <function>ssh2_sftp</function>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>dirname</parameter></term>
<listitem>
- <para>
- </para>
+ <simpara>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -45,9 +45,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&return.success;
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/ssh2/functions/ssh2-sftp-stat.xml b/reference/ssh2/functions/ssh2-sftp-stat.xml
index f2339d3778fc..1c4756122fde 100644
--- a/reference/ssh2/functions/ssh2-sftp-stat.xml
+++ b/reference/ssh2/functions/ssh2-sftp-stat.xml
@@ -13,14 +13,14 @@
<methodparam><type>resource</type><parameter>sftp</parameter></methodparam>
<methodparam><type>string</type><parameter>path</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Stats a file on the remote filesystem following any symbolic links.
- </para>
- <para>
+ </simpara>
+ <simpara>
This function is similar to using the <function>stat</function> function
with the <link linkend="wrappers.ssh2">ssh2.sftp://</link> wrapper
and returns the same values.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -29,16 +29,16 @@
<varlistentry>
<term><parameter>sftp</parameter></term>
<listitem>
- <para>
+ <simpara>
An SSH2 SFTP resource opened by <function>ssh2_sftp</function>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>path</parameter></term>
<listitem>
- <para>
- </para>
+ <simpara>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -46,10 +46,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
See the documentation for <function>stat</function> for details on the
values which may be returned.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/ssh2/functions/ssh2-sftp-symlink.xml b/reference/ssh2/functions/ssh2-sftp-symlink.xml
index 2639efbb977f..347381b91925 100644
--- a/reference/ssh2/functions/ssh2-sftp-symlink.xml
+++ b/reference/ssh2/functions/ssh2-sftp-symlink.xml
@@ -14,10 +14,10 @@
<methodparam><type>string</type><parameter>target</parameter></methodparam>
<methodparam><type>string</type><parameter>link</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Creates a symbolic link named <parameter>link</parameter> on the remote
filesystem pointing to <parameter>target</parameter>.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,24 +26,24 @@
<varlistentry>
<term><parameter>sftp</parameter></term>
<listitem>
- <para>
+ <simpara>
An SSH2 SFTP resource opened by <function>ssh2_sftp</function>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>target</parameter></term>
<listitem>
- <para>
+ <simpara>
Target of the symbolic link.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>link</parameter></term>
<listitem>
- <para>
- </para>
+ <simpara>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -51,9 +51,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&return.success;
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/ssh2/functions/ssh2-sftp-unlink.xml b/reference/ssh2/functions/ssh2-sftp-unlink.xml
index 075fbab6e0b2..18db544888dd 100644
--- a/reference/ssh2/functions/ssh2-sftp-unlink.xml
+++ b/reference/ssh2/functions/ssh2-sftp-unlink.xml
@@ -13,9 +13,9 @@
<methodparam><type>resource</type><parameter>sftp</parameter></methodparam>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Deletes a file on the remote filesystem.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,16 +24,16 @@
<varlistentry>
<term><parameter>sftp</parameter></term>
<listitem>
- <para>
+ <simpara>
An SSH2 SFTP resource opened by <function>ssh2_sftp</function>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
- <para>
- </para>
+ <simpara>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -41,9 +41,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&return.success;
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/ssh2/functions/ssh2-sftp.xml b/reference/ssh2/functions/ssh2-sftp.xml
index d54da4edb279..c985b63754c0 100644
--- a/reference/ssh2/functions/ssh2-sftp.xml
+++ b/reference/ssh2/functions/ssh2-sftp.xml
@@ -12,9 +12,9 @@
<type class="union"><type>resource</type><type>false</type></type><methodname>ssh2_sftp</methodname>
<methodparam><type>resource</type><parameter>session</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Request the SFTP subsystem from an already connected SSH2 server.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -23,10 +23,10 @@
<varlistentry>
<term><parameter>session</parameter></term>
<listitem>
- <para>
+ <simpara>
An SSH connection link identifier, obtained from a call to
<function>ssh2_connect</function>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -34,12 +34,12 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
This method returns an <literal>SSH2 SFTP</literal> resource for use with
all other ssh2_sftp_*() methods and the
<link linkend="wrappers.ssh2">ssh2.sftp://</link> fopen wrapper,
&return.falseforfailure;.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/ssh2/functions/ssh2-shell.xml b/reference/ssh2/functions/ssh2-shell.xml
index 1b1651ddc610..69368509243f 100644
--- a/reference/ssh2/functions/ssh2-shell.xml
+++ b/reference/ssh2/functions/ssh2-shell.xml
@@ -17,9 +17,9 @@
<methodparam choice="opt"><type>int</type><parameter>height</parameter><initializer>25</initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>width_height_type</parameter><initializer>SSH2_TERM_UNIT_CHARS</initializer></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Open a shell at the remote end and allocate a stream for it.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -28,54 +28,54 @@
<varlistentry>
<term><parameter>session</parameter></term>
<listitem>
- <para>
+ <simpara>
An SSH connection link identifier, obtained from a call to
<function>ssh2_connect</function>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>termtype</parameter></term>
<listitem>
- <para>
+ <simpara>
<parameter>termtype</parameter> should correspond to one of the
entries in the target system's <literal>/etc/termcap</literal> file.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>env</parameter></term>
<listitem>
- <para>
+ <simpara>
<parameter>env</parameter> may be passed as an associative array of
name/value pairs to set in the target environment.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>width</parameter></term>
<listitem>
- <para>
+ <simpara>
Width of the virtual terminal.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>height</parameter></term>
<listitem>
- <para>
+ <simpara>
Height of the virtual terminal.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>width_height_type</parameter></term>
<listitem>
- <para>
+ <simpara>
<parameter>width_height_type</parameter> should be one of
<constant>SSH2_TERM_UNIT_CHARS</constant> or
<constant>SSH2_TERM_UNIT_PIXELS</constant>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -83,9 +83,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns a stream &resource; on success, &return.falseforfailure;.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/ssh2/functions/ssh2-tunnel.xml b/reference/ssh2/functions/ssh2-tunnel.xml
index 543129b61ecb..bf0b38ecaf6d 100644
--- a/reference/ssh2/functions/ssh2-tunnel.xml
+++ b/reference/ssh2/functions/ssh2-tunnel.xml
@@ -14,10 +14,10 @@
<methodparam><type>string</type><parameter>host</parameter></methodparam>
<methodparam><type>int</type><parameter>port</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Open a socket stream to an arbitrary host/port by way of the currently
connected SSH server.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -26,24 +26,24 @@
<varlistentry>
<term><parameter>session</parameter></term>
<listitem>
- <para>
+ <simpara>
An SSH connection link identifier, obtained from a call to
<function>ssh2_connect</function>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>host</parameter></term>
<listitem>
- <para>
- </para>
+ <simpara>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>port</parameter></term>
<listitem>
- <para>
- </para>
+ <simpara>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -51,9 +51,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/ssh2/installation.xml b/reference/ssh2/installation.xml
index 227af5fb7a2e..6378e43909f3 100644
--- a/reference/ssh2/installation.xml
+++ b/reference/ssh2/installation.xml
@@ -1,18 +1,17 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-<section xml:id="ssh2.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="ssh2.installation">
&reftitle.install;
- <para>
+ <simpara>
&pecl.info;
<link xlink:href="&url.pecl.package;ssh2">&url.pecl.package;ssh2</link>.
- </para>
- <para>
+ </simpara>
+ <simpara>
&pecl.windows.download.avail;
- </para>
+ </simpara>
</section>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/ssh2/setup.xml b/reference/ssh2/setup.xml
index 3aae04c720b4..4204084c9379 100644
--- a/reference/ssh2/setup.xml
+++ b/reference/ssh2/setup.xml
@@ -1,37 +1,36 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<chapter xml:id="ssh2.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="ssh2.setup">
&reftitle.setup;
<!-- {{{ Requirements -->
<section xml:id="ssh2.requirements">
&reftitle.required;
- <para>
+ <simpara>
The
<link xlink:href="&url.openssl;">OpenSSL</link> and
<link xlink:href="&url.libssh2;">libssh2</link> libraries
are required. Ensure that the development libraries are installed,
where a typical package name might be <literal>openssl-dev</literal>.
- </para>
- <para>
+ </simpara>
+ <simpara>
Version 1.2 or newer of the libssh2 library is required, although
it's possible newer releases of pecl/ssh2 may require newer
versions (see the release notes).
- </para>
- <para>
+ </simpara>
+ <simpara>
The <function>ssh2_auth_agent</function> function will only be available
- with libssh >= 1.2.3.
- </para>
- <para>
+ with libssh >= 1.2.3.
+ </simpara>
+ <simpara>
support for <function>stream_set_timeout</function> to channel streams
- will only be available with libssh >= 1.2.9.
- </para>
- <para>
+ will only be available with libssh >= 1.2.9.
+ </simpara>
+ <simpara>
Libssh2 comes in two flavours: gcrypt or openssl. Some Linux
distributions build libssh2 with the gcrypt library, some use openssl.
Libssh2 has some issues when compiled with gcrypt, please use openssl.
- </para>
+ </simpara>
</section>
<!-- }}} -->
@@ -55,7 +54,6 @@
<!-- }}} -->
</chapter>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
@@ -76,4 +74,3 @@ vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
-