php-doc-en/reference/ssh2/functions/ssh2-publickey-init.xml
Sara Golemon 538929de02 Document ssh2 publickey subsystem
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@191169 c90b9560-bf6c-de11-be94-00142212c4b1
2005-07-21 21:37:49 +00:00

65 lines
1.8 KiB
XML

<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<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>
&note.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>
<simpara>
See Also:
<function>ssh2_publickey_add</function>,
<function>ssh2_publickey_remove</function>, and
<function>ssh2_publickey_list</function>
</simpara>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->