[DOC-CVS] [doc-en] master: ssh2: fix XML to remove useless wrapping para 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/b4bb5b358e77229d362b1afb1dbf13f07f385572
Raw diff: https://github.com/php/doc-en/commit/b4bb5b358e77229d362b1afb1dbf13f07f385572.diff
ssh2: fix XML to remove useless wrapping para tags via script
Changed paths:
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-exec.xml
M reference/ssh2/functions/ssh2-fetch-stream.xml
M reference/ssh2/functions/ssh2-fingerprint.xml
M reference/ssh2/functions/ssh2-methods-negotiated.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-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
Diff:
diff --git a/reference/ssh2/functions/ssh2-auth-agent.xml b/reference/ssh2/functions/ssh2-auth-agent.xml
index 52f672cf41c2..0bdd9b5d3fb5 100644
--- a/reference/ssh2/functions/ssh2-auth-agent.xml
+++ b/reference/ssh2/functions/ssh2-auth-agent.xml
@@ -18,35 +18,33 @@
</para>
<note>
<simpara>
- The <function>ssh2_auth_agent</function> function will only be available
- when the ssh2 extension is compiled with libssh >= 1.2.3.
+ The <function>ssh2_auth_agent</function> function will only be available
+ when the ssh2 extension is compiled with libssh >= 1.2.3.
</simpara>
</note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>session</parameter></term>
- <listitem>
- <para>
- An SSH connection link identifier, obtained from a call to
- <function>ssh2_connect</function>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>username</parameter></term>
- <listitem>
- <para>
- Remote user name.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>session</parameter></term>
+ <listitem>
+ <para>
+ An SSH connection link identifier, obtained from a call to
+ <function>ssh2_connect</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>username</parameter></term>
+ <listitem>
+ <para>
+ Remote user name.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -58,10 +56,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Authenticating with a ssh agent</title>
- <programlisting role="php">
+ <example>
+ <title>Authenticating with a ssh agent</title>
+ <programlisting role="php">
<![CDATA[
<?php
$connection = ssh2_connect('shell.example.com', 22);
@@ -73,13 +70,11 @@ if (ssh2_auth_agent($connection, 'username')) {
}
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/ssh2/functions/ssh2-auth-hostbased-file.xml b/reference/ssh2/functions/ssh2-auth-hostbased-file.xml
index a54c0bbeba7d..a8278f219ac1 100644
--- a/reference/ssh2/functions/ssh2-auth-hostbased-file.xml
+++ b/reference/ssh2/functions/ssh2-auth-hostbased-file.xml
@@ -5,7 +5,7 @@
<refname>ssh2_auth_hostbased_file</refname>
<refpurpose>Authenticate using a public hostkey</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -19,71 +19,69 @@
<methodparam choice="opt"><type>string</type><parameter>local_username</parameter></methodparam>
</methodsynopsis>
<para>
- Authenticate using a public hostkey read from a file.
+ Authenticate using a public hostkey read from a file.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>session</parameter></term>
- <listitem>
- <para>
- An SSH connection link identifier, obtained from a call to
- <function>ssh2_connect</function>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>username</parameter></term>
- <listitem>
- <para>
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>hostname</parameter></term>
- <listitem>
- <para>
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>pubkeyfile</parameter></term>
- <listitem>
- <para>
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>privkeyfile</parameter></term>
- <listitem>
- <para>
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>passphrase</parameter></term>
- <listitem>
- <para>
- If <parameter>privkeyfile</parameter> is encrypted (which it should
- be), the passphrase must be provided.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>local_username</parameter></term>
- <listitem>
- <para>
- If <parameter>local_username</parameter> is omitted, then the value
- for <parameter>username</parameter> will be used for it.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>session</parameter></term>
+ <listitem>
+ <para>
+ An SSH connection link identifier, obtained from a call to
+ <function>ssh2_connect</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>username</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>hostname</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>pubkeyfile</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>privkeyfile</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>passphrase</parameter></term>
+ <listitem>
+ <para>
+ If <parameter>privkeyfile</parameter> is encrypted (which it should
+ be), the passphrase must be provided.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>local_username</parameter></term>
+ <listitem>
+ <para>
+ If <parameter>local_username</parameter> is omitted, then the value
+ for <parameter>username</parameter> will be used for it.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -95,10 +93,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Authentication using a public hostkey</title>
- <programlisting role="php">
+ <example>
+ <title>Authentication using a public hostkey</title>
+ <programlisting role="php">
<![CDATA[
<?php
$connection = ssh2_connect('shell.example.com', 22, array('hostkey'=>'ssh-rsa'));
@@ -113,23 +110,21 @@ if (ssh2_auth_hostbased_file($connection, 'remoteusername', 'myhost.example.com'
}
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
- <function>ssh2_auth_hostbased_file</function> requires libssh2 >= 0.7 and
- PHP/SSH2 >= 0.7
+ <function>ssh2_auth_hostbased_file</function> requires libssh2 >= 0.7 and
+ PHP/SSH2 >= 0.7
</para>
</note>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/ssh2/functions/ssh2-auth-none.xml b/reference/ssh2/functions/ssh2-auth-none.xml
index a15ca81b0083..8f2779b6ba2a 100644
--- a/reference/ssh2/functions/ssh2-auth-none.xml
+++ b/reference/ssh2/functions/ssh2-auth-none.xml
@@ -5,7 +5,7 @@
<refname>ssh2_auth_none</refname>
<refpurpose>Authenticate as "none"</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -16,33 +16,31 @@
<para>
Attempt "none" authentication which usually will (and should) fail.
As part of the failure, this function will return an array of accepted
- authentication methods.
+ authentication methods.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>session</parameter></term>
- <listitem>
- <para>
- An SSH connection link identifier, obtained from a call to
- <function>ssh2_connect</function>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>username</parameter></term>
- <listitem>
- <para>
- Remote user name.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>session</parameter></term>
+ <listitem>
+ <para>
+ An SSH connection link identifier, obtained from a call to
+ <function>ssh2_connect</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>username</parameter></term>
+ <listitem>
+ <para>
+ Remote user name.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -55,10 +53,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Retrieving a list of authentication methods</title>
- <programlisting role="php">
+ <example>
+ <title>Retrieving a list of authentication methods</title>
+ <programlisting role="php">
<![CDATA[
<?php
$connection = ssh2_connect('shell.example.com', 22);
@@ -70,13 +67,11 @@ if (in_array('password', $auth_methods)) {
}
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/ssh2/functions/ssh2-auth-password.xml b/reference/ssh2/functions/ssh2-auth-password.xml
index c9bfffad21dc..f6795361b011 100644
--- a/reference/ssh2/functions/ssh2-auth-password.xml
+++ b/reference/ssh2/functions/ssh2-auth-password.xml
@@ -5,7 +5,7 @@
<refname>ssh2_auth_password</refname>
<refpurpose>Authenticate over SSH using a plain password</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -22,35 +22,33 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>session</parameter></term>
- <listitem>
- <para>
- An SSH connection link identifier, obtained from a call to
- <function>ssh2_connect</function>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>username</parameter></term>
- <listitem>
- <para>
- Remote user name.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>password</parameter></term>
- <listitem>
- <para>
- Password for <parameter>username</parameter>
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>session</parameter></term>
+ <listitem>
+ <para>
+ An SSH connection link identifier, obtained from a call to
+ <function>ssh2_connect</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>username</parameter></term>
+ <listitem>
+ <para>
+ Remote user name.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>password</parameter></term>
+ <listitem>
+ <para>
+ Password for <parameter>username</parameter>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -62,10 +60,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Authenticating with a password</title>
- <programlisting role="php">
+ <example>
+ <title>Authenticating with a password</title>
+ <programlisting role="php">
<![CDATA[
<?php
$connection = ssh2_connect('shell.example.com', 22);
@@ -77,13 +74,11 @@ if (ssh2_auth_password($connection, 'username', 'secret')) {
}
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/ssh2/functions/ssh2-auth-pubkey-file.xml b/reference/ssh2/functions/ssh2-auth-pubkey-file.xml
index 91f010377cdc..e78d2756b0d1 100644
--- a/reference/ssh2/functions/ssh2-auth-pubkey-file.xml
+++ b/reference/ssh2/functions/ssh2-auth-pubkey-file.xml
@@ -5,7 +5,7 @@
<refname>ssh2_auth_pubkey_file</refname>
<refpurpose>Authenticate using a public key</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -17,59 +17,57 @@
<methodparam choice="opt"><type>string</type><parameter>passphrase</parameter></methodparam>
</methodsynopsis>
<para>
- Authenticate using a public key read from a file.
+ Authenticate using a public key read from a file.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>session</parameter></term>
- <listitem>
- <para>
- An SSH connection link identifier, obtained from a call to
- <function>ssh2_connect</function>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>username</parameter></term>
- <listitem>
- <para>
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>pubkeyfile</parameter></term>
- <listitem>
- <para>
- The public key file needs to be in OpenSSH's format. It should look something like:
- </para>
- <para>
- ssh-rsa AAAAB3NzaC1yc2EAAA....NX6sqSnHA8= rsa-key-20121110
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>privkeyfile</parameter></term>
- <listitem>
- <para>
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>passphrase</parameter></term>
- <listitem>
- <para>
- If <parameter>privkeyfile</parameter> is encrypted (which it should
- be), the <parameter>passphrase</parameter> must be provided.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>session</parameter></term>
+ <listitem>
+ <para>
+ An SSH connection link identifier, obtained from a call to
+ <function>ssh2_connect</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>username</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>pubkeyfile</parameter></term>
+ <listitem>
+ <para>
+ The public key file needs to be in OpenSSH's format. It should look something like:
+ </para>
+ <para>
+ ssh-rsa AAAAB3NzaC1yc2EAAA....NX6sqSnHA8= rsa-key-20121110
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>privkeyfile</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>passphrase</parameter></term>
+ <listitem>
+ <para>
+ If <parameter>privkeyfile</parameter> is encrypted (which it should
+ be), the <parameter>passphrase</parameter> must be provided.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -81,10 +79,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Authentication using a public key</title>
- <programlisting role="php">
+ <example>
+ <title>Authentication using a public key</title>
+ <programlisting role="php">
<![CDATA[
<?php
$connection = ssh2_connect('shell.example.com', 22, array('hostkey'=>'ssh-rsa'));
@@ -98,9 +95,8 @@ if (ssh2_auth_pubkey_file($connection, 'username',
}
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
<refsect1 role="notes">
@@ -119,7 +115,6 @@ if (ssh2_auth_pubkey_file($connection, 'username',
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/ssh2/functions/ssh2-connect.xml b/reference/ssh2/functions/ssh2-connect.xml
index e4604c158976..eac12e26a276 100644
--- a/reference/ssh2/functions/ssh2-connect.xml
+++ b/reference/ssh2/functions/ssh2-connect.xml
@@ -5,7 +5,7 @@
<refname>ssh2_connect</refname>
<refpurpose>Connect to an SSH server</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -27,223 +27,215 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>host</parameter></term>
- <listitem>
- <para>
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>port</parameter></term>
- <listitem>
- <para>
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>methods</parameter></term>
- <listitem>
- <para>
- <parameter>methods</parameter> may be an associative array with up to four parameters
- as described below.
- </para>
- <para>
- <table>
- <title><parameter>methods</parameter> may be an associative array
- with any or all of the following parameters.</title>
- <tgroup cols="3">
- <thead>
- <row>
- <entry>Index</entry>
- <entry>Meaning</entry>
- <entry>Supported Values*</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>kex</entry>
- <entry>
- List of key exchange methods to advertise, comma separated
- in order of preference.
- </entry>
- <entry>
- <literal>diffie-hellman-group1-sha1</literal>,
- <literal>diffie-hellman-group14-sha1</literal>, and
- <literal>diffie-hellman-group-exchange-sha1</literal>
- </entry>
- </row>
- <row>
- <entry>hostkey</entry>
- <entry>
- List of hostkey methods to advertise, comma separated
- in order of preference.
- </entry>
- <entry>
- <literal>ssh-rsa</literal> and
- <literal>ssh-dss</literal>
- </entry>
- </row>
- <row>
- <entry>client_to_server</entry>
- <entry>
- Associative array containing crypt, compression, and
- message authentication code (MAC) method preferences
- for messages sent from client to server.
- </entry>
- <entry/>
- </row>
- <row>
- <entry>server_to_client</entry>
- <entry>
- Associative array containing crypt, compression, and
- message authentication code (MAC) method preferences
- for messages sent from server to client.
- </entry>
- <entry/>
- </row>
- </tbody>
- </tgroup>
- </table>
- </para>
- <para>
- * - Supported Values are dependent on methods supported by underlying library.
- See <link xlink:href="&url.libssh2;">libssh2</link> documentation for additional
- information.
- </para>
- <para>
- <table>
- <title>
- <parameter>client_to_server</parameter> and
- <parameter>server_to_client</parameter> may be an associative array
- with any or all of the following parameters.
- </title>
- <tgroup cols="3">
- <thead>
- <row>
- <entry>Index</entry>
- <entry>Meaning</entry>
- <entry>Supported Values*</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>crypt</entry>
- <entry>List of crypto methods to advertise, comma separated
- in order of preference.</entry>
- <entry>
- <literal>[email protected]</literal>,
- <literal>aes256-cbc</literal>,
- <literal>aes192-cbc</literal>,
- <literal>aes128-cbc</literal>,
- <literal>3des-cbc</literal>,
- <literal>blowfish-cbc</literal>,
- <literal>cast128-cbc</literal>,
- <literal>arcfour</literal>, and
- <literal>none**</literal>
- </entry>
- </row>
- <row>
- <entry>comp</entry>
- <entry>List of compression methods to advertise, comma separated
- in order of preference.</entry>
- <entry>
- <literal>zlib</literal> and
- <literal>none</literal>
- </entry>
- </row>
- <row>
- <entry>mac</entry>
- <entry>List of MAC methods to advertise, comma separated
- in order of preference.</entry>
- <entry>
- <literal>hmac-sha1</literal>,
- <literal>hmac-sha1-96</literal>,
- <literal>hmac-ripemd160</literal>,
- <literal>[email protected]</literal>, and
- <literal>none**</literal>
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>host</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>port</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>methods</parameter></term>
+ <listitem>
+ <para>
+ <parameter>methods</parameter> may be an associative array with up to four parameters
+ as described below.
+ </para>
+ <table>
+ <title><parameter>methods</parameter> may be an associative array
+ with any or all of the following parameters.</title>
+ <tgroup cols="3">
+ <thead>
+ <row>
+ <entry>Index</entry>
+ <entry>Meaning</entry>
+ <entry>Supported Values*</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>kex</entry>
+ <entry>
+ List of key exchange methods to advertise, comma separated
+ in order of preference.
+ </entry>
+ <entry>
+ <literal>diffie-hellman-group1-sha1</literal>,
+ <literal>diffie-hellman-group14-sha1</literal>, and
+ <literal>diffie-hellman-group-exchange-sha1</literal>
+ </entry>
+ </row>
+ <row>
+ <entry>hostkey</entry>
+ <entry>
+ List of hostkey methods to advertise, comma separated
+ in order of preference.
+ </entry>
+ <entry>
+ <literal>ssh-rsa</literal> and
+ <literal>ssh-dss</literal>
+ </entry>
+ </row>
+ <row>
+ <entry>client_to_server</entry>
+ <entry>
+ Associative array containing crypt, compression, and
+ message authentication code (MAC) method preferences
+ for messages sent from client to server.
+ </entry>
+ <entry/>
+ </row>
+ <row>
+ <entry>server_to_client</entry>
+ <entry>
+ Associative array containing crypt, compression, and
+ message authentication code (MAC) method preferences
+ for messages sent from server to client.
+ </entry>
+ <entry/>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ <para>
+ * - Supported Values are dependent on methods supported by underlying library.
+ See <link xlink:href="&url.libssh2;">libssh2</link> documentation for additional
+ information.
+ </para>
+ <table>
+ <title>
+ <parameter>client_to_server</parameter> and
+ <parameter>server_to_client</parameter> may be an associative array
+ with any or all of the following parameters.
+ </title>
+ <tgroup cols="3">
+ <thead>
+ <row>
+ <entry>Index</entry>
+ <entry>Meaning</entry>
+ <entry>Supported Values*</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>crypt</entry>
+ <entry>List of crypto methods to advertise, comma separated
+ in order of preference.</entry>
+ <entry>
+ <literal>[email protected]</literal>,
+ <literal>aes256-cbc</literal>,
+ <literal>aes192-cbc</literal>,
+ <literal>aes128-cbc</literal>,
+ <literal>3des-cbc</literal>,
+ <literal>blowfish-cbc</literal>,
+ <literal>cast128-cbc</literal>,
+ <literal>arcfour</literal>, and
+ <literal>none**</literal>
+ </entry>
+ </row>
+ <row>
+ <entry>comp</entry>
+ <entry>List of compression methods to advertise, comma separated
+ in order of preference.</entry>
+ <entry>
+ <literal>zlib</literal> and
+ <literal>none</literal>
+ </entry>
+ </row>
+ <row>
+ <entry>mac</entry>
+ <entry>List of MAC methods to advertise, comma separated
+ in order of preference.</entry>
+ <entry>
+ <literal>hmac-sha1</literal>,
+ <literal>hmac-sha1-96</literal>,
+ <literal>hmac-ripemd160</literal>,
+ <literal>[email protected]</literal>, and
+ <literal>none**</literal>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ <note>
+ <title>Crypt and MAC method "<literal>none</literal>"</title>
<para>
- <note>
- <title>Crypt and MAC method "<literal>none</literal>"</title>
- <para>
- 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>
- </note>
+ 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>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>callbacks</parameter></term>
- <listitem>
- <para>
- <parameter>callbacks</parameter> may be an associative array with any
- or all of the following parameters.
- <table>
- <title>
- Callbacks parameters
- </title>
- <tgroup cols="3">
- <thead>
- <row>
- <entry>Index</entry>
- <entry>Meaning</entry>
- <entry>Prototype</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>ignore</entry>
- <entry>
- Name of function to call when an
- <constant>SSH2_MSG_IGNORE</constant> packet is received
- </entry>
- <entry>void ignore_cb($message)</entry>
- </row>
- <row>
- <entry>debug</entry>
- <entry>
- Name of function to call when an
- <constant>SSH2_MSG_DEBUG</constant> packet is received
- </entry>
- <entry>void debug_cb($message, $language, $always_display)</entry>
- </row>
- <row>
- <entry>macerror</entry>
- <entry>
- Name of function to call when a packet is received but the
- message authentication code failed. If the callback returns
- &true;, the mismatch will be ignored, otherwise the connection
- will be terminated.
- </entry>
- <entry>bool macerror_cb($packet)</entry>
- </row>
- <row>
- <entry>disconnect</entry>
- <entry>
- Name of function to call when an
- <constant>SSH2_MSG_DISCONNECT</constant> packet is received
- </entry>
- <entry>void disconnect_cb($reason, $message, $language)</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ </note>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>callbacks</parameter></term>
+ <listitem>
+ <para>
+ <parameter>callbacks</parameter> may be an associative array with any
+ or all of the following parameters.
+ <table>
+ <title>
+ Callbacks parameters
+ </title>
+ <tgroup cols="3">
+ <thead>
+ <row>
+ <entry>Index</entry>
+ <entry>Meaning</entry>
+ <entry>Prototype</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>ignore</entry>
+ <entry>
+ Name of function to call when an
+ <constant>SSH2_MSG_IGNORE</constant> packet is received
+ </entry>
+ <entry>void ignore_cb($message)</entry>
+ </row>
+ <row>
+ <entry>debug</entry>
+ <entry>
+ Name of function to call when an
+ <constant>SSH2_MSG_DEBUG</constant> packet is received
+ </entry>
+ <entry>void debug_cb($message, $language, $always_display)</entry>
+ </row>
+ <row>
+ <entry>macerror</entry>
+ <entry>
+ Name of function to call when a packet is received but the
+ message authentication code failed. If the callback returns
+ &true;, the mismatch will be ignored, otherwise the connection
+ will be terminated.
+ </entry>
+ <entry>bool macerror_cb($packet)</entry>
+ </row>
+ <row>
+ <entry>disconnect</entry>
+ <entry>
+ Name of function to call when an
+ <constant>SSH2_MSG_DISCONNECT</constant> packet is received
+ </entry>
+ <entry>void disconnect_cb($reason, $message, $language)</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -255,15 +247,14 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title><function>ssh2_connect</function> example</title>
- <para>
- 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>
- <programlisting role="php">
+ <example>
+ <title><function>ssh2_connect</function> example</title>
+ <para>
+ 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>
+ <programlisting role="php">
<![CDATA[
<?php
/* Notify the user if the server terminates the connection */
@@ -287,26 +278,22 @@ $connection = ssh2_connect('shell.example.com', 22, $methods, $callbacks);
if (!$connection) die('Connection failed');
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>ssh2_fingerprint</function></member>
- <member><function>ssh2_auth_none</function></member>
- <member><function>ssh2_auth_password</function></member>
- <member><function>ssh2_auth_pubkey_file</function></member>
- <member><function>ssh2_disconnect</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>ssh2_fingerprint</function></member>
+ <member><function>ssh2_auth_none</function></member>
+ <member><function>ssh2_auth_password</function></member>
+ <member><function>ssh2_auth_pubkey_file</function></member>
+ <member><function>ssh2_disconnect</function></member>
+ </simplelist>
</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 1e5d4f95e626..31ed48017747 100644
--- a/reference/ssh2/functions/ssh2-exec.xml
+++ b/reference/ssh2/functions/ssh2-exec.xml
@@ -5,7 +5,7 @@
<refname>ssh2_exec</refname>
<refpurpose>Execute a command on a remote server</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -25,68 +25,66 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>session</parameter></term>
- <listitem>
- <para>
- An SSH connection link identifier, obtained from a call to
- <function>ssh2_connect</function>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>command</parameter></term>
- <listitem>
- <para>
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>pty</parameter></term>
- <listitem>
- <para>
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>env</parameter></term>
- <listitem>
- <para>
- <parameter>env</parameter> may be passed as an associative array of
- name/value pairs to set in the target environment.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>width</parameter></term>
- <listitem>
- <para>
- Width of the virtual terminal.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>height</parameter></term>
- <listitem>
- <para>
- Height of the virtual terminal.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>width_height_type</parameter></term>
- <listitem>
- <para>
- <parameter>width_height_type</parameter> should be one of
- <constant>SSH2_TERM_UNIT_CHARS</constant> or
- <constant>SSH2_TERM_UNIT_PIXELS</constant>.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>session</parameter></term>
+ <listitem>
+ <para>
+ An SSH connection link identifier, obtained from a call to
+ <function>ssh2_connect</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>command</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>pty</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>env</parameter></term>
+ <listitem>
+ <para>
+ <parameter>env</parameter> may be passed as an associative array of
+ name/value pairs to set in the target environment.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>width</parameter></term>
+ <listitem>
+ <para>
+ Width of the virtual terminal.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>height</parameter></term>
+ <listitem>
+ <para>
+ Height of the virtual terminal.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>width_height_type</parameter></term>
+ <listitem>
+ <para>
+ <parameter>width_height_type</parameter> should be one of
+ <constant>SSH2_TERM_UNIT_CHARS</constant> or
+ <constant>SSH2_TERM_UNIT_PIXELS</constant>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -98,10 +96,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Executing a command</title>
- <programlisting role="php">
+ <example>
+ <title>Executing a command</title>
+ <programlisting role="php">
<![CDATA[
<?php
$connection = ssh2_connect('shell.example.com', 22);
@@ -110,24 +107,20 @@ ssh2_auth_password($connection, 'username', 'password');
$stream = ssh2_exec($connection, '/usr/local/bin/php -i');
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>ssh2_connect</function></member>
- <member><function>ssh2_shell</function></member>
- <member><function>ssh2_tunnel</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>ssh2_connect</function></member>
+ <member><function>ssh2_shell</function></member>
+ <member><function>ssh2_tunnel</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/ssh2/functions/ssh2-fetch-stream.xml b/reference/ssh2/functions/ssh2-fetch-stream.xml
index ebceb9a7836f..9681347502fe 100644
--- a/reference/ssh2/functions/ssh2-fetch-stream.xml
+++ b/reference/ssh2/functions/ssh2-fetch-stream.xml
@@ -5,7 +5,7 @@
<refname>ssh2_fetch_stream</refname>
<refpurpose>Fetch an extended data stream</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -22,25 +22,23 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>channel</parameter></term>
- <listitem>
- <para>
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>streamid</parameter></term>
- <listitem>
- <para>
- An SSH2 channel stream.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>channel</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>streamid</parameter></term>
+ <listitem>
+ <para>
+ An SSH2 channel stream.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -52,10 +50,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Opening a shell and retrieving the stderr stream associated with it</title>
- <programlisting role="php">
+ <example>
+ <title>Opening a shell and retrieving the stderr stream associated with it</title>
+ <programlisting role="php">
<![CDATA[
<?php
$connection = ssh2_connect('shell.example.com', 22);
@@ -65,24 +62,20 @@ $stdio_stream = ssh2_shell($connection);
$stderr_stream = ssh2_fetch_stream($stdio_stream, SSH2_STREAM_STDERR);
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>ssh2_shell</function></member>
- <member><function>ssh2_exec</function></member>
- <member><function>ssh2_connect</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>ssh2_shell</function></member>
+ <member><function>ssh2_exec</function></member>
+ <member><function>ssh2_connect</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/ssh2/functions/ssh2-fingerprint.xml b/reference/ssh2/functions/ssh2-fingerprint.xml
index d0ea24e2c714..1c4f0601728c 100644
--- a/reference/ssh2/functions/ssh2-fingerprint.xml
+++ b/reference/ssh2/functions/ssh2-fingerprint.xml
@@ -5,7 +5,7 @@
<refname>ssh2_fingerprint</refname>
<refpurpose>Retrieve fingerprint of remote server</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -20,31 +20,29 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>session</parameter></term>
- <listitem>
- <para>
- An SSH connection link identifier, obtained from a call to
- <function>ssh2_connect</function>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>flags</parameter></term>
- <listitem>
- <para>
- <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>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>session</parameter></term>
+ <listitem>
+ <para>
+ An SSH connection link identifier, obtained from a call to
+ <function>ssh2_connect</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>flags</parameter></term>
+ <listitem>
+ <para>
+ <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>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -56,10 +54,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Checking the fingerprint against a known value</title>
- <programlisting role="php">
+ <example>
+ <title>Checking the fingerprint against a known value</title>
+ <programlisting role="php">
<![CDATA[
<?php
$known_host = '6F89C2F0A719B30CC38ABDF90755F2E4';
@@ -75,13 +72,11 @@ if ($fingerprint != $known_host) {
}
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</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 a80b282fef81..22de97bc423a 100644
--- a/reference/ssh2/functions/ssh2-methods-negotiated.xml
+++ b/reference/ssh2/functions/ssh2-methods-negotiated.xml
@@ -5,7 +5,7 @@
<refname>ssh2_methods_negotiated</refname>
<refpurpose>Return list of negotiated methods</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -19,34 +19,31 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>session</parameter></term>
- <listitem>
- <para>
- An SSH connection link identifier, obtained from a call to
- <function>ssh2_connect</function>.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>session</parameter></term>
+ <listitem>
+ <para>
+ An SSH connection link identifier, obtained from a call to
+ <function>ssh2_connect</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
-
+
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Determining what methods were negotiated</title>
- <programlisting role="php">
+ <example>
+ <title>Determining what methods were negotiated</title>
+ <programlisting role="php">
<![CDATA[
<?php
$connection = ssh2_connect('shell.example.com', 22);
@@ -68,22 +65,18 @@ echo "\tMAC: {$methods['server_to_client']['mac']}\n";
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>ssh2_connect</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>ssh2_connect</function></member>
+ </simplelist>
</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 ed01cdcb8449..583f25a4b076 100644
--- a/reference/ssh2/functions/ssh2-publickey-add.xml
+++ b/reference/ssh2/functions/ssh2-publickey-add.xml
@@ -25,56 +25,54 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>pkey</parameter></term>
- <listitem>
- <para>
- Publickey Subsystem resource created by <function>ssh2_publickey_init</function>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>algoname</parameter></term>
- <listitem>
- <para>
- Publickey algorithm (e.g.): ssh-dss, ssh-rsa
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>blob</parameter></term>
- <listitem>
- <para>
- Publickey blob as raw binary data
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>overwrite</parameter></term>
- <listitem>
- <para>
- If the specified key already exists, should it be overwritten?
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>attributes</parameter></term>
- <listitem>
- <para>
- 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>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>pkey</parameter></term>
+ <listitem>
+ <para>
+ Publickey Subsystem resource created by <function>ssh2_publickey_init</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>algoname</parameter></term>
+ <listitem>
+ <para>
+ Publickey algorithm (e.g.): ssh-dss, ssh-rsa
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>blob</parameter></term>
+ <listitem>
+ <para>
+ Publickey blob as raw binary data
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>overwrite</parameter></term>
+ <listitem>
+ <para>
+ If the specified key already exists, should it be overwritten?
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>attributes</parameter></term>
+ <listitem>
+ <para>
+ 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>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
-
+
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
@@ -84,10 +82,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Adding a publickey with <function>ssh2_publickey_add</function></title>
- <programlisting role="php">
+ <example>
+ <title>Adding a publickey with <function>ssh2_publickey_add</function></title>
+ <programlisting role="php">
<![CDATA[
<?php
$ssh2 = ssh2_connect('shell.example.com', 22);
@@ -103,24 +100,20 @@ zaLpipu\BGRrw17mWVBhuCExo476ri5tQFzbTc54VEHYckxQ16CjSTibI5X
ssh2_publickey_add($pkey, 'ssh-rsa', $keyblob, false, array('comment'=>"John's Key"));
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>ssh2_publickey_init</function></member>
- <member><function>ssh2_publickey_remove</function></member>
- <member><function>ssh2_publickey_list</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>ssh2_publickey_init</function></member>
+ <member><function>ssh2_publickey_remove</function></member>
+ <member><function>ssh2_publickey_list</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/ssh2/functions/ssh2-publickey-init.xml b/reference/ssh2/functions/ssh2-publickey-init.xml
index ebcdf352c9c1..6a158c5afcb4 100644
--- a/reference/ssh2/functions/ssh2-publickey-init.xml
+++ b/reference/ssh2/functions/ssh2-publickey-init.xml
@@ -7,7 +7,7 @@
Initialize Publickey subsystem
</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -28,17 +28,15 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>session</parameter></term>
- <listitem>
- <para>
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>session</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -56,17 +54,14 @@
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>ssh2_publickey_add</function></member>
- <member><function>ssh2_publickey_remove</function></member>
- <member><function>ssh2_publickey_list</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>ssh2_publickey_add</function></member>
+ <member><function>ssh2_publickey_remove</function></member>
+ <member><function>ssh2_publickey_list</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/ssh2/functions/ssh2-publickey-list.xml b/reference/ssh2/functions/ssh2-publickey-list.xml
index f0f997f52ce6..6448e871a35e 100644
--- a/reference/ssh2/functions/ssh2-publickey-list.xml
+++ b/reference/ssh2/functions/ssh2-publickey-list.xml
@@ -21,18 +21,16 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>pkey</parameter></term>
- <listitem>
- <para>
- Publickey Subsystem resource
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>pkey</parameter></term>
+ <listitem>
+ <para>
+ Publickey Subsystem resource
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -42,45 +40,42 @@
each of which is an associative array containing:
name, blob, and attrs elements.
</para>
- <para>
- <table>
- <title>Publickey elements</title>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>Array Key</entry>
- <entry>Meaning</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>name</entry>
- <entry>Name of algorithm used by this publickey, for example:
- <literal>ssh-dss</literal> or <literal>ssh-rsa</literal>.</entry>
- </row>
- <row>
- <entry>blob</entry>
- <entry>Publickey blob as raw binary data.</entry>
- </row>
- <row>
- <entry>attrs</entry>
- <entry>Attributes assigned to this publickey. The most common
- attribute, and the only one supported by publickey version 1
- servers, is <literal>comment</literal>, which may be any freeform
- string.</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- </para>
+ <table>
+ <title>Publickey elements</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Array Key</entry>
+ <entry>Meaning</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>name</entry>
+ <entry>Name of algorithm used by this publickey, for example:
+ <literal>ssh-dss</literal> or <literal>ssh-rsa</literal>.</entry>
+ </row>
+ <row>
+ <entry>blob</entry>
+ <entry>Publickey blob as raw binary data.</entry>
+ </row>
+ <row>
+ <entry>attrs</entry>
+ <entry>Attributes assigned to this publickey. The most common
+ attribute, and the only one supported by publickey version 1
+ servers, is <literal>comment</literal>, which may be any freeform
+ string.</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Listing authorized keys with <function>ssh2_publickey_list</function></title>
- <programlisting role="php">
+ <example>
+ <title>Listing authorized keys with <function>ssh2_publickey_list</function></title>
+ <programlisting role="php">
<![CDATA[
<?php
$ssh2 = ssh2_connect('shell.example.com', 22);
@@ -96,9 +91,9 @@ foreach($list as $key) {
}
?>
]]>
- </programlisting>
- &example.outputs;
- <screen>
+ </programlisting>
+ &example.outputs;
+ <screen>
<![CDATA[
Key: ssh-rsa
Blob: AAAAB3NzaC1yc2EAAAABIwAAAIEA5HVt6VqSGd5P
@@ -117,9 +112,8 @@ SGd5sDHwfL351xjzaLpipu\BGB3NzaC1yc2EA/1T
Comment: Alice's Key
]]>
- </screen>
- </example>
- </para>
+ </screen>
+ </example>
</refsect1>
<refsect1 role="notes">
@@ -129,17 +123,14 @@ Comment: Alice's Key
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>ssh2_publickey_init</function></member>
- <member><function>ssh2_publickey_add</function></member>
- <member><function>ssh2_publickey_remove</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>ssh2_publickey_init</function></member>
+ <member><function>ssh2_publickey_add</function></member>
+ <member><function>ssh2_publickey_remove</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/ssh2/functions/ssh2-publickey-remove.xml b/reference/ssh2/functions/ssh2-publickey-remove.xml
index 10426d01a62b..f377b1567e5e 100644
--- a/reference/ssh2/functions/ssh2-publickey-remove.xml
+++ b/reference/ssh2/functions/ssh2-publickey-remove.xml
@@ -23,34 +23,32 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>pkey</parameter></term>
- <listitem>
- <para>
- Publickey Subsystem Resource
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>algoname</parameter></term>
- <listitem>
- <para>
- Publickey algorithm (e.g.): ssh-dss, ssh-rsa
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>blob</parameter></term>
- <listitem>
- <para>
- Publickey blob as raw binary data
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>pkey</parameter></term>
+ <listitem>
+ <para>
+ Publickey Subsystem Resource
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>algoname</parameter></term>
+ <listitem>
+ <para>
+ Publickey algorithm (e.g.): ssh-dss, ssh-rsa
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>blob</parameter></term>
+ <listitem>
+ <para>
+ Publickey blob as raw binary data
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -67,16 +65,13 @@
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>ssh2_publickey_init</function></member>
- <member><function>ssh2_publickey_add</function></member>
- <member><function>ssh2_publickey_list</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>ssh2_publickey_init</function></member>
+ <member><function>ssh2_publickey_add</function></member>
+ <member><function>ssh2_publickey_list</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/ssh2/functions/ssh2-scp-recv.xml b/reference/ssh2/functions/ssh2-scp-recv.xml
index 04611eed238d..5f5ab9751a3f 100644
--- a/reference/ssh2/functions/ssh2-scp-recv.xml
+++ b/reference/ssh2/functions/ssh2-scp-recv.xml
@@ -5,7 +5,7 @@
<refname>ssh2_scp_recv</refname>
<refpurpose>Request a file via SCP</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -21,35 +21,33 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>session</parameter></term>
- <listitem>
- <para>
- An SSH connection link identifier, obtained from a call to
- <function>ssh2_connect</function>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>remote_file</parameter></term>
- <listitem>
- <para>
- Path to the remote file.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>local_file</parameter></term>
- <listitem>
- <para>
- Path to the local file.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>session</parameter></term>
+ <listitem>
+ <para>
+ An SSH connection link identifier, obtained from a call to
+ <function>ssh2_connect</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>remote_file</parameter></term>
+ <listitem>
+ <para>
+ Path to the remote file.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>local_file</parameter></term>
+ <listitem>
+ <para>
+ Path to the local file.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -61,10 +59,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Downloading a file via SCP</title>
- <programlisting role="php">
+ <example>
+ <title>Downloading a file via SCP</title>
+ <programlisting role="php">
<![CDATA[
<?php
$connection = ssh2_connect('shell.example.com', 22);
@@ -73,23 +70,19 @@ ssh2_auth_password($connection, 'username', 'password');
ssh2_scp_recv($connection, '/remote/filename', '/local/filename');
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>ssh2_scp_send</function></member>
- <member><function>copy</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>ssh2_scp_send</function></member>
+ <member><function>copy</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/ssh2/functions/ssh2-scp-send.xml b/reference/ssh2/functions/ssh2-scp-send.xml
index 41860c21eaf6..28d522d9584b 100644
--- a/reference/ssh2/functions/ssh2-scp-send.xml
+++ b/reference/ssh2/functions/ssh2-scp-send.xml
@@ -5,7 +5,7 @@
<refname>ssh2_scp_send</refname>
<refpurpose>Send a file via SCP</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -22,44 +22,42 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>session</parameter></term>
- <listitem>
- <para>
- An SSH connection link identifier, obtained from a call to
- <function>ssh2_connect</function>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>local_file</parameter></term>
- <listitem>
- <para>
- Path to the local file.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>remote_file</parameter></term>
- <listitem>
- <para>
- Path to the remote file.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>create_mode</parameter></term>
- <listitem>
- <para>
- The file will be created with the mode specified by
- <parameter>create_mode</parameter>.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>session</parameter></term>
+ <listitem>
+ <para>
+ An SSH connection link identifier, obtained from a call to
+ <function>ssh2_connect</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>local_file</parameter></term>
+ <listitem>
+ <para>
+ Path to the local file.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>remote_file</parameter></term>
+ <listitem>
+ <para>
+ Path to the remote file.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>create_mode</parameter></term>
+ <listitem>
+ <para>
+ The file will be created with the mode specified by
+ <parameter>create_mode</parameter>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -71,10 +69,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Uploading a file via SCP</title>
- <programlisting role="php">
+ <example>
+ <title>Uploading a file via SCP</title>
+ <programlisting role="php">
<![CDATA[
<?php
$connection = ssh2_connect('shell.example.com', 22);
@@ -83,23 +80,19 @@ ssh2_auth_password($connection, 'username', 'password');
ssh2_scp_send($connection, '/local/filename', '/remote/filename', 0644);
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>ssh2_scp_recv</function></member>
- <member><function>copy</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>ssh2_scp_recv</function></member>
+ <member><function>copy</function></member>
+ </simplelist>
</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 44a5fcface5a..dbe7c38a4075 100644
--- a/reference/ssh2/functions/ssh2-sftp-chmod.xml
+++ b/reference/ssh2/functions/ssh2-sftp-chmod.xml
@@ -22,34 +22,32 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>sftp</parameter></term>
- <listitem>
- <para>
- An SSH2 SFTP resource opened by <function>ssh2_sftp</function>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>filename</parameter></term>
- <listitem>
- <para>
- Path to the file.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>mode</parameter></term>
- <listitem>
- <para>
- Permissions on the file. See the <function>chmod</function> for more details on this parameter.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>sftp</parameter></term>
+ <listitem>
+ <para>
+ An SSH2 SFTP resource opened by <function>ssh2_sftp</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>filename</parameter></term>
+ <listitem>
+ <para>
+ Path to the file.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>mode</parameter></term>
+ <listitem>
+ <para>
+ Permissions on the file. See the <function>chmod</function> for more details on this parameter.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -61,10 +59,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Changing the mode of a file on a remote server</title>
- <programlisting role="php">
+ <example>
+ <title>Changing the mode of a file on a remote server</title>
+ <programlisting role="php">
<![CDATA[
<?php
$connection = ssh2_connect('shell.example.com', 22);
@@ -74,24 +71,20 @@ $sftp = ssh2_sftp($connection);
ssh2_sftp_chmod($sftp, '/somedir/somefile', 0755);
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>chmod</function></member>
- <member><function>ssh2_sftp</function></member>
- <member><function>ssh2_connect</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>chmod</function></member>
+ <member><function>ssh2_sftp</function></member>
+ <member><function>ssh2_connect</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/ssh2/functions/ssh2-sftp-lstat.xml b/reference/ssh2/functions/ssh2-sftp-lstat.xml
index 6e45dd4ce4a0..09dd9634c587 100644
--- a/reference/ssh2/functions/ssh2-sftp-lstat.xml
+++ b/reference/ssh2/functions/ssh2-sftp-lstat.xml
@@ -5,7 +5,7 @@
<refname>ssh2_sftp_lstat</refname>
<refpurpose>Stat a symbolic link</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -20,32 +20,30 @@
<para>
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.
+ and returns the same values.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>sftp</parameter></term>
- <listitem>
- <para>
- An SSH2 SFTP resource opened by <function>ssh2_sftp</function>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>path</parameter></term>
- <listitem>
- <para>
- Path to the remote symbolic link.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>sftp</parameter></term>
+ <listitem>
+ <para>
+ An SSH2 SFTP resource opened by <function>ssh2_sftp</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>path</parameter></term>
+ <listitem>
+ <para>
+ Path to the remote symbolic link.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -58,10 +56,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Stating a symbolic link via SFTP</title>
- <programlisting role="php">
+ <example>
+ <title>Stating a symbolic link via SFTP</title>
+ <programlisting role="php">
<![CDATA[
<?php
$connection = ssh2_connect('shell.example.com', 22);
@@ -78,24 +75,20 @@ $mtime = $statinfo['mtime'];
$mode = $statinfo['mode'];
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>ssh2_sftp_stat</function></member>
- <member><function>lstat</function></member>
- <member><function>stat</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>ssh2_sftp_stat</function></member>
+ <member><function>lstat</function></member>
+ <member><function>stat</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/ssh2/functions/ssh2-sftp-mkdir.xml b/reference/ssh2/functions/ssh2-sftp-mkdir.xml
index eb220ce4d287..e0b76eeb9d83 100644
--- a/reference/ssh2/functions/ssh2-sftp-mkdir.xml
+++ b/reference/ssh2/functions/ssh2-sftp-mkdir.xml
@@ -5,7 +5,7 @@
<refname>ssh2_sftp_mkdir</refname>
<refpurpose>Create a directory</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -17,7 +17,7 @@
</methodsynopsis>
<para>
Creates a directory on the remote file server with permissions set to
- <parameter>mode</parameter>.
+ <parameter>mode</parameter>.
</para>
<para>
This function is similar to using <function>mkdir</function> with the
@@ -27,44 +27,42 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>sftp</parameter></term>
- <listitem>
- <para>
- An SSH2 SFTP resource opened by <function>ssh2_sftp</function>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>dirname</parameter></term>
- <listitem>
- <para>
- Path of the new directory.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>mode</parameter></term>
- <listitem>
- <para>
- Permissions on the new directory.
- The actual mode is affected by the current umask.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>recursive</parameter></term>
- <listitem>
- <para>
- If <parameter>recursive</parameter> is &true; any parent directories
- required for <parameter>dirname</parameter> will be automatically created as well.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>sftp</parameter></term>
+ <listitem>
+ <para>
+ An SSH2 SFTP resource opened by <function>ssh2_sftp</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>dirname</parameter></term>
+ <listitem>
+ <para>
+ Path of the new directory.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>mode</parameter></term>
+ <listitem>
+ <para>
+ Permissions on the new directory.
+ The actual mode is affected by the current umask.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>recursive</parameter></term>
+ <listitem>
+ <para>
+ If <parameter>recursive</parameter> is &true; any parent directories
+ required for <parameter>dirname</parameter> will be automatically created as well.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -76,10 +74,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Creating a directory on a remote server</title>
- <programlisting role="php">
+ <example>
+ <title>Creating a directory on a remote server</title>
+ <programlisting role="php">
<![CDATA[
<?php
$connection = ssh2_connect('shell.example.com', 22);
@@ -90,23 +87,19 @@ ssh2_sftp_mkdir($sftp, '/home/username/newdir');
/* Or: mkdir("ssh2.sftp://$sftp/home/username/newdir"); */
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>mkdir</function></member>
- <member><function>ssh2_sftp_rmdir</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>mkdir</function></member>
+ <member><function>ssh2_sftp_rmdir</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/ssh2/functions/ssh2-sftp-readlink.xml b/reference/ssh2/functions/ssh2-sftp-readlink.xml
index 3c0d46f229c3..a77e11e124b3 100644
--- a/reference/ssh2/functions/ssh2-sftp-readlink.xml
+++ b/reference/ssh2/functions/ssh2-sftp-readlink.xml
@@ -5,7 +5,7 @@
<refname>ssh2_sftp_readlink</refname>
<refpurpose>Return the target of a symbolic link</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -20,26 +20,24 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>sftp</parameter></term>
- <listitem>
- <para>
- An SSH2 SFTP resource opened by <function>ssh2_sftp</function>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>link</parameter></term>
- <listitem>
- <para>
- Path of the symbolic link.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>sftp</parameter></term>
+ <listitem>
+ <para>
+ An SSH2 SFTP resource opened by <function>ssh2_sftp</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>link</parameter></term>
+ <listitem>
+ <para>
+ Path of the symbolic link.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -51,10 +49,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Reading a symbolic link</title>
- <programlisting role="php">
+ <example>
+ <title>Reading a symbolic link</title>
+ <programlisting role="php">
<![CDATA[
<?php
$connection = ssh2_connect('shell.example.com', 22);
@@ -65,23 +62,19 @@ $target = ssh2_sftp_readlink($sftp, '/tmp/mysql.sock');
/* $target is now (e.g.): '/var/run/mysql.sock' */
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>readlink</function></member>
- <member><function>ssh2_sftp_symlink</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>readlink</function></member>
+ <member><function>ssh2_sftp_symlink</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/ssh2/functions/ssh2-sftp-realpath.xml b/reference/ssh2/functions/ssh2-sftp-realpath.xml
index 8620c706f35e..688b25a12b3b 100644
--- a/reference/ssh2/functions/ssh2-sftp-realpath.xml
+++ b/reference/ssh2/functions/ssh2-sftp-realpath.xml
@@ -5,7 +5,7 @@
<refname>ssh2_sftp_realpath</refname>
<refpurpose>Resolve the realpath of a provided path string</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -21,25 +21,23 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>sftp</parameter></term>
- <listitem>
- <para>
- An SSH2 SFTP resource opened by <function>ssh2_sftp</function>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>filename</parameter></term>
- <listitem>
- <para>
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>sftp</parameter></term>
+ <listitem>
+ <para>
+ An SSH2 SFTP resource opened by <function>ssh2_sftp</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>filename</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -51,10 +49,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Resolving a pathname</title>
- <programlisting role="php">
+ <example>
+ <title>Resolving a pathname</title>
+ <programlisting role="php">
<![CDATA[
<?php
$connection = ssh2_connect('shell.example.com', 22);
@@ -65,24 +62,20 @@ $realpath = ssh2_sftp_realpath($sftp, '/home/username/../../../..//./usr/../etc/
/* $realpath is now: '/etc/passwd' */
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>realpath</function></member>
- <member><function>ssh2_sftp_symlink</function></member>
- <member><function>ssh2_sftp_readlink</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>realpath</function></member>
+ <member><function>ssh2_sftp_symlink</function></member>
+ <member><function>ssh2_sftp_readlink</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/ssh2/functions/ssh2-sftp-rename.xml b/reference/ssh2/functions/ssh2-sftp-rename.xml
index 956d930b9b3e..8b4b7081cc15 100644
--- a/reference/ssh2/functions/ssh2-sftp-rename.xml
+++ b/reference/ssh2/functions/ssh2-sftp-rename.xml
@@ -5,7 +5,7 @@
<refname>ssh2_sftp_rename</refname>
<refpurpose>Rename a remote file</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -21,34 +21,32 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>sftp</parameter></term>
- <listitem>
- <para>
- An SSH2 SFTP resource opened by <function>ssh2_sftp</function>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>from</parameter></term>
- <listitem>
- <para>
- The current file that is being renamed.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>to</parameter></term>
- <listitem>
- <para>
- The new file name that replaces <parameter>from</parameter>.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>sftp</parameter></term>
+ <listitem>
+ <para>
+ An SSH2 SFTP resource opened by <function>ssh2_sftp</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>from</parameter></term>
+ <listitem>
+ <para>
+ The current file that is being renamed.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>to</parameter></term>
+ <listitem>
+ <para>
+ The new file name that replaces <parameter>from</parameter>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -60,10 +58,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Renaming a file via sftp</title>
- <programlisting role="php">
+ <example>
+ <title>Renaming a file via sftp</title>
+ <programlisting role="php">
<![CDATA[
<?php
$connection = ssh2_connect('shell.example.com', 22);
@@ -73,22 +70,18 @@ $sftp = ssh2_sftp($connection);
ssh2_sftp_rename($sftp, '/home/username/oldname', '/home/username/newname');
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>rename</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>rename</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/ssh2/functions/ssh2-sftp-rmdir.xml b/reference/ssh2/functions/ssh2-sftp-rmdir.xml
index 410a89b7f4f6..9b4e765285ce 100644
--- a/reference/ssh2/functions/ssh2-sftp-rmdir.xml
+++ b/reference/ssh2/functions/ssh2-sftp-rmdir.xml
@@ -5,7 +5,7 @@
<refname>ssh2_sftp_rmdir</refname>
<refpurpose>Remove a directory</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -24,25 +24,23 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>sftp</parameter></term>
- <listitem>
- <para>
- An SSH2 SFTP resource opened by <function>ssh2_sftp</function>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>dirname</parameter></term>
- <listitem>
- <para>
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>sftp</parameter></term>
+ <listitem>
+ <para>
+ An SSH2 SFTP resource opened by <function>ssh2_sftp</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>dirname</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -54,10 +52,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Removing a directory on a remote server</title>
- <programlisting role="php">
+ <example>
+ <title>Removing a directory on a remote server</title>
+ <programlisting role="php">
<![CDATA[
<?php
$connection = ssh2_connect('shell.example.com', 22);
@@ -68,23 +65,19 @@ ssh2_sftp_rmdir($sftp, '/home/username/deltodel');
/* Or: rmdir("ssh2.sftp://$sftp/home/username/dirtodel"); */
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>rmdir</function></member>
- <member><function>ssh2_sftp_mkdir</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>rmdir</function></member>
+ <member><function>ssh2_sftp_mkdir</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/ssh2/functions/ssh2-sftp-stat.xml b/reference/ssh2/functions/ssh2-sftp-stat.xml
index 71c0a4828145..f2339d3778fc 100644
--- a/reference/ssh2/functions/ssh2-sftp-stat.xml
+++ b/reference/ssh2/functions/ssh2-sftp-stat.xml
@@ -5,7 +5,7 @@
<refname>ssh2_sftp_stat</refname>
<refpurpose>Stat a file on a remote filesystem</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -25,25 +25,23 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>sftp</parameter></term>
- <listitem>
- <para>
- An SSH2 SFTP resource opened by <function>ssh2_sftp</function>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>path</parameter></term>
- <listitem>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>sftp</parameter></term>
+ <listitem>
<para>
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ An SSH2 SFTP resource opened by <function>ssh2_sftp</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>path</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -56,10 +54,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Stating a file via SFTP</title>
- <programlisting role="php">
+ <example>
+ <title>Stating a file via SFTP</title>
+ <programlisting role="php">
<![CDATA[
<?php
$connection = ssh2_connect('shell.example.com', 22);
@@ -76,24 +73,20 @@ $mtime = $statinfo['mtime'];
$mode = $statinfo['mode'];
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>ssh2_sftp_lstat</function></member>
- <member><function>lstat</function></member>
- <member><function>stat</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>ssh2_sftp_lstat</function></member>
+ <member><function>lstat</function></member>
+ <member><function>stat</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/ssh2/functions/ssh2-sftp-symlink.xml b/reference/ssh2/functions/ssh2-sftp-symlink.xml
index 42c9de87470e..2639efbb977f 100644
--- a/reference/ssh2/functions/ssh2-sftp-symlink.xml
+++ b/reference/ssh2/functions/ssh2-sftp-symlink.xml
@@ -5,7 +5,7 @@
<refname>ssh2_sftp_symlink</refname>
<refpurpose>Create a symlink</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -22,33 +22,31 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>sftp</parameter></term>
- <listitem>
- <para>
- An SSH2 SFTP resource opened by <function>ssh2_sftp</function>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>target</parameter></term>
- <listitem>
- <para>
- Target of the symbolic link.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>link</parameter></term>
- <listitem>
- <para>
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>sftp</parameter></term>
+ <listitem>
+ <para>
+ An SSH2 SFTP resource opened by <function>ssh2_sftp</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>target</parameter></term>
+ <listitem>
+ <para>
+ Target of the symbolic link.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>link</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -60,10 +58,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Creating a symbolic link</title>
- <programlisting role="php">
+ <example>
+ <title>Creating a symbolic link</title>
+ <programlisting role="php">
<![CDATA[
<?php
$connection = ssh2_connect('shell.example.com', 22);
@@ -73,23 +70,19 @@ $sftp = ssh2_sftp($connection);
ssh2_sftp_symlink($sftp, '/var/run/mysql.sock', '/tmp/mysql.sock');
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>ssh2_sftp_readlink</function></member>
- <member><function>symlink</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>ssh2_sftp_readlink</function></member>
+ <member><function>symlink</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/ssh2/functions/ssh2-sftp-unlink.xml b/reference/ssh2/functions/ssh2-sftp-unlink.xml
index 1ac8358ad4bd..075fbab6e0b2 100644
--- a/reference/ssh2/functions/ssh2-sftp-unlink.xml
+++ b/reference/ssh2/functions/ssh2-sftp-unlink.xml
@@ -5,7 +5,7 @@
<refname>ssh2_sftp_unlink</refname>
<refpurpose>Delete a file</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -20,25 +20,23 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>sftp</parameter></term>
- <listitem>
- <para>
- An SSH2 SFTP resource opened by <function>ssh2_sftp</function>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>filename</parameter></term>
- <listitem>
- <para>
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>sftp</parameter></term>
+ <listitem>
+ <para>
+ An SSH2 SFTP resource opened by <function>ssh2_sftp</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>filename</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -50,10 +48,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Deleting a file</title>
- <programlisting role="php">
+ <example>
+ <title>Deleting a file</title>
+ <programlisting role="php">
<![CDATA[
<?php
$connection = ssh2_connect('shell.example.com', 22);
@@ -63,22 +60,18 @@ $sftp = ssh2_sftp($connection);
ssh2_sftp_unlink($sftp, '/home/username/stale_file');
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>unlink</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>unlink</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/ssh2/functions/ssh2-sftp.xml b/reference/ssh2/functions/ssh2-sftp.xml
index 262d1cefe585..d54da4edb279 100644
--- a/reference/ssh2/functions/ssh2-sftp.xml
+++ b/reference/ssh2/functions/ssh2-sftp.xml
@@ -5,7 +5,7 @@
<refname>ssh2_sftp</refname>
<refpurpose>Initialize SFTP subsystem</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -19,19 +19,17 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>session</parameter></term>
- <listitem>
- <para>
- An SSH connection link identifier, obtained from a call to
- <function>ssh2_connect</function>.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>session</parameter></term>
+ <listitem>
+ <para>
+ An SSH connection link identifier, obtained from a call to
+ <function>ssh2_connect</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -46,10 +44,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Opening a file via SFTP</title>
- <programlisting role="php">
+ <example>
+ <title>Opening a file via SFTP</title>
+ <programlisting role="php">
<![CDATA[
<?php
$connection = ssh2_connect('shell.example.com', 22);
@@ -60,23 +57,19 @@ $sftp = ssh2_sftp($connection);
$stream = fopen('ssh2.sftp://' . intval($sftp) . '/path/to/file', 'r');
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>ssh2_scp_recv</function></member>
- <member><function>ssh2_scp_send</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>ssh2_scp_recv</function></member>
+ <member><function>ssh2_scp_send</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/ssh2/functions/ssh2-shell.xml b/reference/ssh2/functions/ssh2-shell.xml
index 0554e312aa25..1b1651ddc610 100644
--- a/reference/ssh2/functions/ssh2-shell.xml
+++ b/reference/ssh2/functions/ssh2-shell.xml
@@ -5,7 +5,7 @@
<refname>ssh2_shell</refname>
<refpurpose>Request an interactive shell</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -24,63 +24,61 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>session</parameter></term>
- <listitem>
- <para>
- An SSH connection link identifier, obtained from a call to
- <function>ssh2_connect</function>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>termtype</parameter></term>
- <listitem>
- <para>
- <parameter>termtype</parameter> should correspond to one of the
- entries in the target system's <literal>/etc/termcap</literal> file.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>env</parameter></term>
- <listitem>
- <para>
- <parameter>env</parameter> may be passed as an associative array of
- name/value pairs to set in the target environment.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>width</parameter></term>
- <listitem>
- <para>
- Width of the virtual terminal.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>height</parameter></term>
- <listitem>
- <para>
- Height of the virtual terminal.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>width_height_type</parameter></term>
- <listitem>
- <para>
- <parameter>width_height_type</parameter> should be one of
- <constant>SSH2_TERM_UNIT_CHARS</constant> or
- <constant>SSH2_TERM_UNIT_PIXELS</constant>.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>session</parameter></term>
+ <listitem>
+ <para>
+ An SSH connection link identifier, obtained from a call to
+ <function>ssh2_connect</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>termtype</parameter></term>
+ <listitem>
+ <para>
+ <parameter>termtype</parameter> should correspond to one of the
+ entries in the target system's <literal>/etc/termcap</literal> file.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>env</parameter></term>
+ <listitem>
+ <para>
+ <parameter>env</parameter> may be passed as an associative array of
+ name/value pairs to set in the target environment.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>width</parameter></term>
+ <listitem>
+ <para>
+ Width of the virtual terminal.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>height</parameter></term>
+ <listitem>
+ <para>
+ Height of the virtual terminal.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>width_height_type</parameter></term>
+ <listitem>
+ <para>
+ <parameter>width_height_type</parameter> should be one of
+ <constant>SSH2_TERM_UNIT_CHARS</constant> or
+ <constant>SSH2_TERM_UNIT_PIXELS</constant>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
@@ -92,10 +90,9 @@
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Requesting an interactive shell</title>
- <programlisting role="php">
+ <example>
+ <title>Requesting an interactive shell</title>
+ <programlisting role="php">
<![CDATA[
<?php
$connection = ssh2_connect('shell.example.com', 22);
@@ -104,24 +101,20 @@ ssh2_auth_password($connection, 'username', 'password');
$stream = ssh2_shell($connection, 'vt102', null, 80, 24, SSH2_TERM_UNIT_CHARS);
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>ssh2_exec</function></member>
- <member><function>ssh2_tunnel</function></member>
- <member><function>ssh2_fetch_stream</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>ssh2_exec</function></member>
+ <member><function>ssh2_tunnel</function></member>
+ <member><function>ssh2_fetch_stream</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/ssh2/functions/ssh2-tunnel.xml b/reference/ssh2/functions/ssh2-tunnel.xml
index 035a39a9e1e9..543129b61ecb 100644
--- a/reference/ssh2/functions/ssh2-tunnel.xml
+++ b/reference/ssh2/functions/ssh2-tunnel.xml
@@ -5,7 +5,7 @@
<refname>ssh2_tunnel</refname>
<refpurpose>Open a tunnel through a remote server</refpurpose>
</refnamediv>
-
+
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
@@ -22,48 +22,45 @@
<refsect1 role="parameters">
&reftitle.parameters;
- <para>
- <variablelist>
- <varlistentry>
- <term><parameter>session</parameter></term>
- <listitem>
- <para>
- An SSH connection link identifier, obtained from a call to
- <function>ssh2_connect</function>.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>host</parameter></term>
- <listitem>
- <para>
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>port</parameter></term>
- <listitem>
- <para>
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>session</parameter></term>
+ <listitem>
+ <para>
+ An SSH connection link identifier, obtained from a call to
+ <function>ssh2_connect</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>host</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>port</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
-
+
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
- <para>
- <example>
- <title>Opening a tunnel to an arbitrary host</title>
- <programlisting role="php">
+ <example>
+ <title>Opening a tunnel to an arbitrary host</title>
+ <programlisting role="php">
<![CDATA[
<?php
$connection = ssh2_connect('shell.example.com', 22);
@@ -72,23 +69,19 @@ ssh2_auth_pubkey_file($connection, 'username', 'id_dsa.pub', 'id_dsa');
$tunnel = ssh2_tunnel($connection, '10.0.0.101', 12345);
?>
]]>
- </programlisting>
- </example>
- </para>
+ </programlisting>
+ </example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
- <para>
- <simplelist>
- <member><function>ssh2_connect</function></member>
- <member><function>fsockopen</function></member>
- </simplelist>
- </para>
+ <simplelist>
+ <member><function>ssh2_connect</function></member>
+ <member><function>fsockopen</function></member>
+ </simplelist>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml