cvs: peardoc /en/chapters installation.xml

mj Sun Sep 21 05:41:41 2003 EDT Modified files: /peardoc/en/chapters installation.xml Log: * Adding new section about installing packages manually. Index: peardoc/en/chapters/installation.xml diff -u peardoc/en/chapters/installation.xml:1.10 peardoc/en/chapters/installation.xml:1.11 --- peardoc/en/chapters/installation.xml:1.10 Sat Sep 20 14:02:36 2003 +++ peardoc/en/chapters/installation.xml Sun Sep 21 05:41:41 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1" ?> -<!-- $Revision: 1.10 $ --> +<!-- $Revision: 1.11 $ --> <!-- WORK IN PROGRESS, THERE IS PROBABLY LITTLE POINT IN TRANSLATING THIS DOCUMENT YET. @@ -136,7 +136,7 @@ The command line installer is the easiest way to install PEAR packages on your system: It connects to the PEAR package server via a simple HTTP connection, loads the package on your system - and installs it in the desired location. + and installs it to the desired location. </para> <sect2> <title>Fully-automatic installation</title> @@ -154,9 +154,9 @@ <para> &lt;package&gt; has to be replaced with the name of the package you want to install (e.g. HTTP_Upload). To get a list of the - available packages, you can point your browser to the <ulink url=" - http://pear.php.net/packages.php">PEAR package browser</ulink> or - you can run: + available packages, you can point your browser to the <ulink + url="&url.pear.package.browse;">PEAR package browser</ulink> or you + can run: </para> <para> <screen> @@ -193,6 +193,97 @@ file. </para> </sect2> + </sect1> + + <sect1 id="installation.manually"> + <title>Manual installation</title> + + <para> + Installing packages manually is no recommended way, but a lot of + people run into problems using the automated ways, when their + sites are located in web hosting environments with no shell access. + </para> + <para> + In the following paragraphs, we will demonstrate how to install + packages manually on a site with the following path scheme: + The document root of the site is + <filename>/var/www/www.example.com/htdocs/</filename>. On the same + level than <filename>htdocs</filename> there is another directory + called <filename>includes</filename>. This directory can not be + accessed via <acronym>HTTP</acronym> but via <acronym>FTP</acronym> + or WebDAV. + </para> + <para> + The installation consists of some easy to follow steps: + <orderedlist> + <listitem> + <simpara> + Download the package: + </simpara> + <para> + You can download the package from the + <ulink url="&url.pear;">PEAR homepage</ulink> with your web + browser. If you do not know the <acronym>URL</acronym> of the + package information page for the package, you can use the <ulink + url="&url.pear.package.browse;">package browser</ulink> + to view the currently available packages. + </para> + </listitem> + <listitem> + <simpara> + Upload the package source code + </simpara> + <para> + After having downloaded the .tgz file of the package, you have + to extract the contents of the archive file to a temporary + directory on your local machine. After that you must upload the + source code via <acronym>FTP</acronym>, WebDAV or another method + to the directory + <filename>/var/www/www.example.com/includes/</filename>, so that + the source code for Mail_Mime now e.g. resides in + <filename>/var/www/www.example.com/includes/Mail/</filename>. + </para> + </listitem> + <listitem> + <simpara> + Adjust your include_path directive. + </simpara> + <para> + Now you have to adjust PHP's include_path directive so that it + contains the location where you just uploaded the source code. If + you have access to the <filename>php.ini</filename> configuration + file for your site, you have to add + <filename>/var/www/www.example.com/includes/</filename> to the + directive there. If you do not have access to the configuration, + you have to set the include_path in each script where you want + to use the package: + </para> + <para> + <programlisting role="php"> +ini_set("include_path", ini_get("include_path") . ":/var/www/www.example.com/includes/"); + </programlisting> + </para> + </listitem> + <listitem> + <simpara> + After having finished the installation, you can now make use of + the package: + </simpara> + <para> + <programlisting role="php"> +require_once "Mail/Mime.php"; + +$mime = ... + </programlisting> + </para> + </listitem> + </orderedlist> + </para> + <para> + If you more questions concerning manual installation, you can ask + on the + <ulink url="&email.pear.general;">user mailing list</ulink>. + </para> </sect1>