<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.ssh2.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'function.ssh2-publickey-init.php',
    1 => 'ssh2_publickey_init',
    2 => 'Initialize Publickey subsystem',
  ),
  'up' => 
  array (
    0 => 'ref.ssh2.php',
    1 => 'SSH2 Functions',
  ),
  'prev' => 
  array (
    0 => 'function.ssh2-publickey-add.php',
    1 => 'ssh2_publickey_add',
  ),
  'next' => 
  array (
    0 => 'function.ssh2-publickey-list.php',
    1 => 'ssh2_publickey_list',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/ssh2/functions/ssh2-publickey-init.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.ssh2-publickey-init" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">ssh2_publickey_init</h1>
  <p class="verinfo">(PECL ssh2 &gt;= 0.10)</p><p class="refpurpose"><span class="refname">ssh2_publickey_init</span> &mdash; <span class="dc-title">
   Initialize Publickey subsystem
  </span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.ssh2-publickey-init-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>ssh2_publickey_init</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> <code class="parameter">$session</code></span>): <span class="type"><span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="simpara">
   Request the Publickey subsystem from an already connected SSH2 server.
  </p>
  <p class="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 <span class="function"><strong>ssh2_publickey_init()</strong></span> function will return <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.ssh2-publickey-init-parameters">
  <h3 class="title">Parameters</h3>
  <dl>
   
    <dt><code class="parameter">session</code></dt>
    <dd>
     <span class="simpara">
     </span>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.ssh2-publickey-init-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="simpara">
   Returns an <code class="literal">SSH2 Publickey Subsystem</code> resource for use
   with all other ssh2_publickey_*() methods or <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> on failure.
  </p>
 </div>


 <div class="refsect1 notes" id="refsect1-function.ssh2-publickey-init-notes">
  <h3 class="title">Notes</h3>
  <blockquote class="note"><p><strong class="note">Note</strong>: <span class="simpara">The public key subsystem
is used for managing public keys on a server to which the client is
<em>already</em> authenticated.  To authenticate to a remote system
using public key authentication, use the
<span class="function"><a href="function.ssh2-auth-pubkey-file.php" class="function">ssh2_auth_pubkey_file()</a></span> function instead.</span></p></blockquote>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.ssh2-publickey-init-seealso">
  <h3 class="title">See Also</h3>
  <ul class="simplelist">
   <li><span class="function"><a href="function.ssh2-publickey-add.php" class="function" rel="rdfs-seeAlso">ssh2_publickey_add()</a> - Add an authorized publickey</span></li>
   <li><span class="function"><a href="function.ssh2-publickey-remove.php" class="function" rel="rdfs-seeAlso">ssh2_publickey_remove()</a> - Remove an authorized publickey</span></li>
   <li><span class="function"><a href="function.ssh2-publickey-list.php" class="function" rel="rdfs-seeAlso">ssh2_publickey_list()</a> - List currently authorized publickeys</span></li>
  </ul>
 </div>


</div><?php manual_footer($setup); ?>