php-doc-en/reference/ssh2/setup.xml
2021-07-17 13:32:31 +01:00

86 lines
2.3 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<chapter xml:id="ssh2.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
&reftitle.setup;
<!-- {{{ Requirements -->
<section xml:id="ssh2.requirements">
&reftitle.required;
<para>
The
<link xlink:href="&url.openssl;">OpenSSL</link> and
<link xlink:href="&url.libssh2;">libssh2</link> libraries
are required. Ensure that the development libraries are installed,
where a typical package name might be <literal>openssl-dev</literal>.
</para>
<para>
Version 1.2 or newer of the libssh2 library is required, although
it's possible newer releases of pecl/ssh2 may require newer
versions (see the release notes).
</para>
<para>
The <function>ssh2_auth_agent</function> function will only be available
with libssh >= 1.2.3.
</para>
<para>
support for <function>stream_set_timeout</function> to channel streams
will only be available with libssh >= 1.2.9.
</para>
<para>
Libssh2 comes in two flavours: gcrypt or openssl. Some Linux
distributions build libssh2 with the gcrypt library, some use openssl.
Libssh2 has some issues when compiled with gcrypt, please use openssl.
</para>
</section>
<!-- }}} -->
<!-- {{{ Installation -->
&reference.ssh2.installation;
<!-- }}} -->
<!-- {{{ Configuration -->
<section xml:id="ssh2.configuration">
&reftitle.runtime;
&no.config;
</section>
<!-- }}} -->
<!-- {{{ Resources -->
<section xml:id="ssh2.resources">
&reftitle.resources;
<para>
This extension defines the following resource types:
<simplelist>
<member>SSH2 Session</member>
<member>SSH2 Listener</member>
<member>SSH2 SFTP</member>
<member>SSH2 Publickey Subsystem (as of ssh2 0.10)</member>
</simplelist>
</para>
</section>
<!-- }}} -->
</chapter>
<!-- 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
-->