From 024838e1398acbdfc38e856d42388003ad1a3518 Mon Sep 17 00:00:00 2001
From: Sara Golemon <pollita@php.net>
Date: Tue, 22 Feb 2005 00:18:16 +0000
Subject: [PATCH] Provide installation instructions

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@180399 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/ssh2/installation.xml | 126 ++++++++++++++++++++++++++++++++
 reference/ssh2/reference.xml    |  15 +---
 2 files changed, 129 insertions(+), 12 deletions(-)
 create mode 100644 reference/ssh2/installation.xml

diff --git a/reference/ssh2/installation.xml b/reference/ssh2/installation.xml
new file mode 100644
index 0000000000..1c396a6240
--- /dev/null
+++ b/reference/ssh2/installation.xml
@@ -0,0 +1,126 @@
+<?xml version='1.0' encoding='iso-8859-1'?>
+<!-- $Revision: 1.1 $ -->
+<section id="ssh2.installation">
+ &reftitle.install;
+ <simpara>
+  <emphasis>Windows</emphasis> binaries may be found at
+  <ulink url="&url.php.snapshots;">&url.php.snapshots;</ulink>.
+  To install, download php_ssh2.dll to the folder specified
+  by your php.ini file's <literal>extension_dir</literal> directive.
+  Enable it by adding <literal>extension=php_ssh2.dll</literal>
+  to your php.ini and restarting your webserver.
+ </simpara>
+
+ <screen>
+<![CDATA[
+extension_dir=c:/php5/exts/
+extension=php_ssh2.dll
+]]>
+ </screen>
+
+ <simpara>
+  <emphasis>Linux, BSD, and other *nix variants</emphasis>
+  can be compiled using the following steps:
+ </simpara>
+
+ <itemizedlist>
+  <listitem>
+   <simpara>
+    Download and install <ulink url="&url.openssl;">OpenSSL</ulink>.
+    If you install OpenSSL via your distribution's packaging system
+    be sure to install the development libraries as well.
+    This will typically be a package named <literal>openssl-dev</literal>,
+    <literal>openssl_devel</literal>, or some variation thereof.
+   </simpara>
+  </listitem>
+
+  <listitem>
+   <simpara>
+    Download and install <ulink url="&url.libssh2;">libssh2</ulink>.
+    Typically this means executing the following command from
+    the libssh2 source tree. <literal>./configure && make all install</literal>.
+   </simpara>
+  </listitem>
+
+  <listitem>
+   <simpara>
+    Run the pear installer for PECL/ssh2: <literal>pear install ssh2</literal>
+   </simpara>
+  </listitem>
+
+  <listitem>
+   <simpara>
+    Copy <literal>ssh2.so</literal> from the directory indicated by the
+    build process to the location specified in your php.ini file under
+    <literal>extension_dir</literal>.
+   </simpara>
+  </listitem>
+
+  <listitem>
+   <simpara>
+    Add <literal>extension=ssh2.so</literal> to your php.ini
+   </simpara>
+  </listitem>
+
+  <listitem>
+   <simpara>
+    Restart your webserver to reload your php.ini settings.
+   </simpara>
+  </listitem>
+
+ </itemizedlist>
+
+ <note>
+  <title>Development Versions</title>
+  <simpara>
+   There are currently no <literal>stable</literal> versions of PECL/ssh2,
+   to force installation of the <literal>beta</literal> version of PECL/ssh2
+   execute: <literal>pear install ssh2-</literal><emphasis>beta</emphasis>
+  </simpara>
+ </note>
+
+ <tip>
+  <title>Compiling PECL/ssh2 without using the PEAR command</title>
+  <simpara>
+   Rather than using <literal>pear install ssh2</literal> to automatically
+   download and install PECL/ssh2, you may download the tarball from
+   <ulink url="&url.pecl.package;ssh2">PECL</ulink>.
+   From the root of the unpacked tarball, run:
+   <literal>phpize && ./configure && make</literal> to generate
+   <literal>ssh2.so</literal>.
+   Once built, continue the installation from step 4 above.
+  </simpara>
+ </tip>
+
+ <simpara>
+  &pecl.info;
+  <ulink url="&url.pecl.package;ssh2">&url.pecl.package;ssh2</ulink>.
+ </simpara>
+ <note>
+  <simpara>
+   You will need version 0.4 or greater of the libssh2 library
+   (possibly higher, see release notes).
+  </simpara>
+ </note>
+</section>
+
+<!-- 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
+-->
diff --git a/reference/ssh2/reference.xml b/reference/ssh2/reference.xml
index ad2d42e685..5b24194fde 100644
--- a/reference/ssh2/reference.xml
+++ b/reference/ssh2/reference.xml
@@ -1,5 +1,5 @@
 <?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
 <!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. -->
  <reference id="ref.ssh2">
   <title>Secure Shell2 Functions</title>
@@ -14,17 +14,8 @@
      on a remote machine using a secure cryptographic transport.
     </para>
    </section>
-   <section id="ssh2.installation">
-   &reftitle.install;
-    <para>
-     &pecl.info;
-     <ulink url="&url.pecl.package;ssh2">&url.pecl.package;ssh2</ulink>.
-    </para>
-    <para>
-     You will also need version 0.4 or greater of the libssh2 library
-     (possibly higher, see release notes).
-    </para>
-   </section>
+
+   &reference.ssh2.installation;
 
    &reference.ssh2.constants;