jsgoupil Sun Jul 24 01:44:28 2005 EDT
Modified files: /phpdoc/en/reference/ssh2/functions ssh2-publickey-add.xml ssh2-publickey-init.xml ssh2-publickey-list.xml ssh2-publickey-remove.xml Log: fix to new doc style
http://cvs.php.net/diff.php/phpdoc/en/reference/ssh2/functions/ssh2-publickey-add.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/ssh2/functions/ssh2-publickey-add.xml diff -u phpdoc/en/reference/ssh2/functions/ssh2-publickey-add.xml:1.2 phpdoc/en/reference/ssh2/functions/ssh2-publickey-add.xml:1.3 --- phpdoc/en/reference/ssh2/functions/ssh2-publickey-add.xml:1.2 Fri Jul 22 15:34:25 2005 +++ phpdoc/en/reference/ssh2/functions/ssh2-publickey-add.xml Sun Jul 24 01:44:27 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.ssh2-publickey-add"> <refnamediv> @@ -8,6 +8,7 @@ Add an authorized publickey </refpurpose> </refnamediv> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -22,6 +23,7 @@ ¬e.ssh2.subsystem.publickey; </refsect1> + <refsect1 role="parameters"> &reftitle.parameters; <para> @@ -38,7 +40,7 @@ <term><parameter>algoname</parameter></term> <listitem> <para> - Publickey algorithm (e.g): ssh-dss, ssh-rsa + Publickey algorithm (e.g.): ssh-dss, ssh-rsa </para> </listitem> </varlistentry> @@ -46,7 +48,7 @@ <term><parameter>blob</parameter></term> <listitem> <para> - Publickey blob as raw binary + Publickey blob as raw binary data </para> </listitem> </varlistentry> @@ -73,11 +75,12 @@ </variablelist> </para> </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; - <simpara> - &return.success; - </simpara> + <para> + &return.success; + </para> </refsect1> <refsect1 role="examples"> @@ -116,8 +119,6 @@ </simplelist> </para> </refsect1> - - </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/diff.php/phpdoc/en/reference/ssh2/functions/ssh2-publickey-init.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/ssh2/functions/ssh2-publickey-init.xml diff -u phpdoc/en/reference/ssh2/functions/ssh2-publickey-init.xml:1.2 phpdoc/en/reference/ssh2/functions/ssh2-publickey-init.xml:1.3 --- phpdoc/en/reference/ssh2/functions/ssh2-publickey-init.xml:1.2 Fri Jul 22 15:34:25 2005 +++ phpdoc/en/reference/ssh2/functions/ssh2-publickey-init.xml Sun Jul 24 01:44:27 2005 @@ -1,52 +1,53 @@ <?xml version='1.0' encoding='iso-8859-1'?> -<!-- $Revision: 1.2 $ --> - <refentry id="function.ssh2-publickey-init"> - <refnamediv> - <refname>ssh2_publickey_init</refname> - <refpurpose> - Initialize Publickey subsystem - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>resource</type><methodname>ssh2_publickey_init</methodname> - <methodparam><type>resource</type><parameter>session</parameter></methodparam> - </methodsynopsis> - - <simpara> - Request the Publickey subsystem from an already connected SSH2 server. - </simpara> - - ¬e.ssh2.subsystem.publickey; - - <simpara> - This method returns an <literal>SSH2 Publickey Subsystem</literal> - resource for use with all other ssh2_publickey_*() methods. - </simpara> - - <simpara> - The publickey subsystem allows an already connected and authenticated - client to manage the list of authorized public keys stored on the - target server in an implementation agnostic manner. - If the remote server does not support the publickey subsystem, - the <function>ssh2_publickey_init</function> function will return &false;. - </simpara> - - </refsect1> - - <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> - </refsect1> - - </refentry> +<!-- $Revision: 1.3 $ --> +<refentry id="function.ssh2-publickey-init"> + <refnamediv> + <refname>ssh2_publickey_init</refname> + <refpurpose> + Initialize Publickey subsystem + </refpurpose> + </refnamediv> + + <refsect1 role="description"> + &reftitle.description; + <methodsynopsis> + <type>resource</type><methodname>ssh2_publickey_init</methodname> + <methodparam><type>resource</type><parameter>session</parameter></methodparam> + </methodsynopsis> + <para> + Request the Publickey subsystem from an already connected SSH2 server. + </para> + <para> + The publickey subsystem allows an already connected and authenticated + client to manage the list of authorized public keys stored on the + target server in an implementation agnostic manner. + If the remote server does not support the publickey subsystem, + the <function>ssh2_publickey_init</function> function will return &false;. + </para> + + ¬e.ssh2.subsystem.publickey; + + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an <literal>SSH2 Publickey Subsystem</literal> + resource for use with all other ssh2_publickey_*() methods. + </para> + </refsect1> + + <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> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/diff.php/phpdoc/en/reference/ssh2/functions/ssh2-publickey-list.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/ssh2/functions/ssh2-publickey-list.xml diff -u phpdoc/en/reference/ssh2/functions/ssh2-publickey-list.xml:1.2 phpdoc/en/reference/ssh2/functions/ssh2-publickey-list.xml:1.3 --- phpdoc/en/reference/ssh2/functions/ssh2-publickey-list.xml:1.2 Fri Jul 22 15:34:25 2005 +++ phpdoc/en/reference/ssh2/functions/ssh2-publickey-list.xml Sun Jul 24 01:44:27 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.ssh2-publickey-list"> <refnamediv> @@ -8,6 +8,7 @@ List currently authorized publickeys </refpurpose> </refnamediv> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -18,6 +19,7 @@ ¬e.ssh2.subsystem.publickey; </refsect1> + <refsect1 role="parameters"> &reftitle.parameters; <para> @@ -33,6 +35,7 @@ </variablelist> </para> </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> @@ -43,7 +46,7 @@ <para> <table> <title>Publickey elements</title> - <tgroup cols="3"> + <tgroup cols="2"> <thead> <row> <entry>Array Key</entry> @@ -130,7 +133,6 @@ </simplelist> </para> </refsect1> - </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/diff.php/phpdoc/en/reference/ssh2/functions/ssh2-publickey-remove.xml?r1=1.2&r2=1.3&ty=u Index: phpdoc/en/reference/ssh2/functions/ssh2-publickey-remove.xml diff -u phpdoc/en/reference/ssh2/functions/ssh2-publickey-remove.xml:1.2 phpdoc/en/reference/ssh2/functions/ssh2-publickey-remove.xml:1.3 --- phpdoc/en/reference/ssh2/functions/ssh2-publickey-remove.xml:1.2 Fri Jul 22 15:34:25 2005 +++ phpdoc/en/reference/ssh2/functions/ssh2-publickey-remove.xml Sun Jul 24 01:44:27 2005 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. --> <refentry id="function.ssh2-publickey-remove"> <refnamediv> @@ -8,6 +8,7 @@ Remove an authorized publickey </refpurpose> </refnamediv> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -20,6 +21,7 @@ ¬e.ssh2.subsystem.publickey; </refsect1> + <refsect1 role="parameters"> &reftitle.parameters; <para> @@ -51,11 +53,12 @@ </variablelist> </para> </refsect1> + <refsect1 role="returnvalues"> &reftitle.returnvalues; - <simpara> - &return.success; - </simpara> + <para> + &return.success; + </para> </refsect1> <refsect1 role="seealso"> @@ -68,8 +71,6 @@ </simplelist> </para> </refsect1> - - </refentry> <!-- Keep this comment at the end of the file