php-doc-en/reference/ssh2/functions/ssh2-publickey-init.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml: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>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>session</parameter></term>
     <listitem>
      <para>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns an <literal>SSH2 Publickey Subsystem</literal> resource for use
   with all other ssh2_publickey_*() methods&return.falseforfailure;.
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  &note.ssh2.subsystem.publickey;
 </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:
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:"~/.phpdoc/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
-->