cvs: php-gtk-doc /manual/en/tutorials installation.xml

[email protected] ("Christian Weiske") Fri, 08 Dec 2006 14:06:15 -0000
Newsgroups php.gtk.doc
Message-ID <cvscweiske1165586775@cvsserver>
cweiske		Fri Dec  8 14:06:15 2006 UTC

  Modified files:              
    /php-gtk-doc/manual/en/tutorials	installation.xml 
  Log:
  Give that file a proper indention
cweiske-20061208140615.txt (text/plain, 20.9 KB)
http://cvs.php.net/viewvc.cgi/php-gtk-doc/manual/en/tutorials/installation.xml?r1=1.10&r2=1.11&diff_format=u
Index: php-gtk-doc/manual/en/tutorials/installation.xml
diff -u php-gtk-doc/manual/en/tutorials/installation.xml:1.10 php-gtk-doc/manual/en/tutorials/installation.xml:1.11
--- php-gtk-doc/manual/en/tutorials/installation.xml:1.10	Mon Nov 13 15:58:33 2006
+++ php-gtk-doc/manual/en/tutorials/installation.xml	Fri Dec  8 14:06:14 2006
@@ -1,114 +1,114 @@
 <?xml version="1.0" encoding="utf-8" ?>
-<!-- $Revision: 1.10 $ -->
+<!-- $Revision: 1.11 $ -->
 <chapter id="tutorials.installation">
  <title>Installing PHP-GTK 2</title>
 
-  <sect1 id="tutorials.installation.introduction">
-   <title>Introduction</title>
+ <sect1 id="tutorials.installation.introduction">
+  <title>Introduction</title>
+  <para>
+   PHP-GTK 2 is an extension to PHP and can be used only with versions 5.1
+   upwards. Although the most common way of installing PHP-GTK 2 is compiling,
+   this process can prove to be quite tedious on Windows systems; in which
+   case most people will be using the official PHP-GTK 2 Alpha binary release
+   or the Gnope installer.
+  </para>
+  <para>
+   We'll be covering the installation process for the three most popular
+   operating systems: Windows, Linux and Mac OS X. The instructions for Linux
+   are applicable to most distributions in addition to other POSIX compliant
+   systems.
+  </para>
+ </sect1>
+
+ <sect1 id="tutorials.installation.windows">
+  <title>Installation on Windows</title>
+
+  <sect2 id="tutorials.installation.windows.gnope">
+   <title>Using Gnope</title>
    <para>
-    PHP-GTK 2 is an extension to PHP and can be used only with versions 5.1
-    upwards. Although the most common way of installing PHP-GTK 2 is compiling,
-    this process can prove to be quite tedious on Windows systems; in which
-    case most people will be using the official PHP-GTK 2 Alpha binary release
-    or the Gnope installer.
+    Gnope has proven to be the most easiest way of installing and maintaining
+    PHP-GTK 2 on Windows. Gnope is a fully featured PHP-GTK 2 installer,
+    complete with PHP 5.1, GTK 2.6 and PEAR.
+    A few simple mouse clicks and you're done!
    </para>
    <para>
-    We'll be covering the installation process for the three most popular
-    operating systems: Windows, Linux and Mac OS X. The instructions for Linux
-    are applicable to most distributions in addition to other POSIX compliant
-    systems.
+    Just download the installer from <ulink url="&url.gnope;">gnope.org</ulink>
+    and follow the on-screen instructions. Gnope also has a PEARified channel
+    of its own, where you can download PHP-GTK 2 applications, in addition to
+    official PEAR packages, e.g. from the
+    <ulink url="&url.pear.gtk2;">Gtk2 category</ulink>.
    </para>
-  </sect1>
-
-  <sect1 id="tutorials.installation.windows">
-   <title>Installation on Windows</title>
-
-   <sect2 id="tutorials.installation.windows.gnope">
-    <title>Using Gnope</title>
-    <para>
-     Gnope has proven to be the most easiest way of installing and maintaining
-     PHP-GTK 2 on Windows. Gnope is a fully featured PHP-GTK 2 installer,
-     complete with PHP 5.1, GTK 2.6 and PEAR.
-     A few simple mouse clicks and you're done!
-    </para>
-    <para>
-     Just download the installer from <ulink url="&url.gnope;">gnope.org</ulink>
-     and follow the on-screen instructions. Gnope also has a PEARified channel
-     of its own, where you can download PHP-GTK 2 applications, in addition to
-     official PEAR packages, e.g. from the
-     <ulink url="&url.pear.gtk2;">Gtk2 category</ulink>.
-    </para>
-   </sect2>
-
-   <sect2 id="tutorials.installation.windows.manual">
-    <title>Manual Installation</title>
-    <para>
-     Download the Alpha binary release of PHP-GTK 2 for Windows from the
-     PHP-GTK 2 <ulink url="&url.phpgtk.download;">download</ulink> page. Unzip
-     the file into a directory of your choice. A directory named
-     <literal>php-gtk</literal> will be created containing everything included
-     in the release.
-    </para>
-    <para>
-     You will need a copy of <filename>php.exe</filename> (CLI Version) and
-     <filename>php5ts.dll</filename>, both of which are available in the binary
-     release of PHP 5 for windows, and put them in the
-     <filename>php-gtk</filename> directory. If you wish to use any other
-     extensions with this copy of <filename>php.exe</filename>, make sure you
-     put their binaries here too.
-    </para>
-    <para>
-     <!-- FIXME: Do we need to do this? I doubt that this is necessary
-        -cweiske -->
-     After this, you must set your <literal>PATH</literal> variable to include
-     the <filename>gtk+2.6.9</filename> directory present in the release.
-     You can also let the <literal>gtkpath.bat</literal> batch file set the
-     appropriate <literal>PATH</literal> for the current command line
-     session by executing it.
-    </para>
-   </sect2>
-
-   <sect2 id="tutorials.installation.windows.cvs">
-    <title>Compiling from CVS</title>
-    <para>
-     This is the least recommended method of installing PHP-GTK 2 on Windows.
-     If you still want to go ahead with this, please read
-     <filename>win32/README.win32.txt</filename> in the CVS checkout.
-    </para>
-   </sect2>
-  </sect1>
-
-  <sect1 id="tutorials.installation.linux">
-   <title>Installation on Linux</title>
+  </sect2>
 
+  <sect2 id="tutorials.installation.windows.manual">
+   <title>Manual Installation</title>
    <para>
-    The best way to install PHP-GTK 2 on Linux is to compile it. No binary or
-    source packages are available as yet for any distribution, so you can't use
-    your favorite package manager to install PHP-GTK 2! These instructions
-    should be valid for most distributions of Linux, as well as other POSIX
-    compliant systems.
+    Download the Alpha binary release of PHP-GTK 2 for Windows from the
+    PHP-GTK 2 <ulink url="&url.phpgtk.download;">download</ulink> page. Unzip
+    the file into a directory of your choice. A directory named
+    <literal>php-gtk</literal> will be created containing everything included
+    in the release.
    </para>
+   <para>
+    You will need a copy of <filename>php.exe</filename> (CLI Version) and
+    <filename>php5ts.dll</filename>, both of which are available in the binary
+    release of PHP 5 for windows, and put them in the
+    <filename>php-gtk</filename> directory. If you wish to use any other
+    extensions with this copy of <filename>php.exe</filename>, make sure you
+    put their binaries here too.
+   </para>
+   <para>
+    <!-- FIXME: Do we need to do this? I doubt that this is necessary
+       -cweiske -->
+    After this, you must set your <literal>PATH</literal> variable to include
+    the <filename>gtk+2.6.9</filename> directory present in the release.
+    You can also let the <literal>gtkpath.bat</literal> batch file set the
+    appropriate <literal>PATH</literal> for the current command line
+    session by executing it.
+   </para>
+  </sect2>
 
-   <note>The methods listed here reportedly don't work on FreeBSD</note>
-
+  <sect2 id="tutorials.installation.windows.cvs">
+   <title>Compiling from CVS</title>
    <para>
-    There are two ways to go about installing PHP-GTK 2 on your Linux system.
-    You can either choose to use your existing PHP installation, or decide to
-    install a separate one and dedicate it to PHP-GTK 2. The latter is a simpler
-    method and is recommended for users with little or no Linux experience.
-    In any case, you need Gtk+ version 2.6 upwards installed.
+    This is the least recommended method of installing PHP-GTK 2 on Windows.
+    If you still want to go ahead with this, please read
+    <filename>win32/README.win32.txt</filename> in the CVS checkout.
    </para>
+  </sect2>
+ </sect1>
 
-   <sect2 id="tutorials.installation.linux.newphp">
-    <title>Installing PHP-GTK 2 along with a new PHP installation</title>
+ <sect1 id="tutorials.installation.linux">
+  <title>Installation on Linux</title>
 
-    <para>
-     Just follow these steps, and you should be okay! First thing you need 
-     is a fresh checkout of PHP. You can choose either the
-     <literal>5_1</literal> or <literal>5_2</literal> branches,
-     both work fine:
+  <para>
+   The best way to install PHP-GTK 2 on Linux is to compile it. No binary or
+   source packages are available as yet for any distribution, so you can't use
+   your favorite package manager to install PHP-GTK 2! These instructions
+   should be valid for most distributions of Linux, as well as other POSIX
+   compliant systems.
+  </para>
+
+  <note>The methods listed here reportedly don't work on FreeBSD</note>
+
+  <para>
+   There are two ways to go about installing PHP-GTK 2 on your Linux system.
+   You can either choose to use your existing PHP installation, or decide to
+   install a separate one and dedicate it to PHP-GTK 2. The latter is a simpler
+   method and is recommended for users with little or no Linux experience.
+   In any case, you need Gtk+ version 2.6 upwards installed.
+  </para>
 
-     <programlisting role="bash"><![CDATA[
+  <sect2 id="tutorials.installation.linux.newphp">
+   <title>Installing PHP-GTK 2 along with a new PHP installation</title>
+
+   <para>
+    Just follow these steps, and you should be okay! First thing you need 
+    is a fresh checkout of PHP. You can choose either the
+    <literal>5_1</literal> or <literal>5_2</literal> branches,
+    both work fine:
+
+    <programlisting role="bash"><![CDATA[
 $ cvs -d :pserver:[email protected]:/repository login
 $ cvs -d :pserver:[email protected]:/repository co -r PHP_5_2 php-src]]></programlisting>
 
@@ -123,21 +123,20 @@
 $ make install
 $ echo extension=php_gtk2.so >> /opt/php5_2/lib/php.ini
 $ /opt/php5_2/bin/php-config --extension-dir | xargs echo 'extension_dir=' >> /opt/php5_2/lib/php.ini]]></programlisting>
-    </para>
-
-    <note>
-     <para>
-      If the current CVS of PHP does not compile, try an
-      official release from the
-      <ulink url="&url.php.download;">php downloads page</ulink>,
-      or a <ulink url="&url.php.snapshots;">snapshot</ulink>.
-     </para>
-    </note>
+   </para>
 
+   <note>
     <para>
-     Now, let's checkout and install PHP-GTK 2:
+     If the current CVS of PHP does not compile, try an
+     official release from the
+     <ulink url="&url.php.download;">php downloads page</ulink>,
+     or a <ulink url="&url.php.snapshots;">snapshot</ulink>.
+    </para>
+   </note>
 
-      <programlisting role="bash"><![CDATA[
+   <para>
+    Now, let's checkout and install PHP-GTK 2:
+    <programlisting role="bash"><![CDATA[
 $ cd ..
 $ cvs -d :pserver:[email protected]:/repository co php-gtk
 $ cd php-gtk
@@ -145,121 +144,121 @@
 $ ./configure --with-php-config=/opt/php5_2/bin/php-config
 $ make
 $ make install]]></programlisting>
-    </para>
+   </para>
 
-    <para>
-     You might want to create a link to the new php executable:
+   <para>
+    You might want to create a link to the new php executable:
 
-      <programlisting role="bash"><![CDATA[
+    <programlisting role="bash"><![CDATA[
 $ ln -s /opt/php5_2/bin/php /usr/bin/php-gtk]]></programlisting>
 
-     That's it, you're done!
-    </para>
-   </sect2>
+    That's it, you're done!
+   </para>
+  </sect2>
 
-   <sect2 id="tutorials.installation.linux.existingphp">
-    <title>Using an existing PHP installation</title>
+  <sect2 id="tutorials.installation.linux.existingphp">
+   <title>Using an existing PHP installation</title>
 
-    <para>
-     If you decide to 'add-on' PHP-GTK 2 to your existing PHP installation,
-     ensure that your version of PHP is at least 5.1 with CLI enabled.
-     PHP-GTK 2 will NOT work with any other versions of PHP.
-     You can check your PHP version by typing <command>php -v</command>
-     on the command line. Don't forget to check if the word
-     <literal>cli</literal> appears in the output!
-    </para>
+   <para>
+    If you decide to 'add-on' PHP-GTK 2 to your existing PHP installation,
+    ensure that your version of PHP is at least 5.1 with CLI enabled.
+    PHP-GTK 2 will NOT work with any other versions of PHP.
+    You can check your PHP version by typing <command>php -v</command>
+    on the command line. Don't forget to check if the word
+    <literal>cli</literal> appears in the output!
+   </para>
 
-    <para>
-     Now, checkout the latest CVS source of PHP-GTK 2, or download the Alpha
-     source tarball, as per instructions on the PHP-GTK 2
-     <ulink url="&url.phpgtk.download;">download</ulink> page.
-     <literal>cd</literal> into the checked out / extracted directory, and
-     execute the following:
-     <programlisting role="bash"><![CDATA[
+   <para>
+    Now, checkout the latest CVS source of PHP-GTK 2, or download the Alpha
+    source tarball, as per instructions on the PHP-GTK 2
+    <ulink url="&url.phpgtk.download;">download</ulink> page.
+    <literal>cd</literal> into the checked out / extracted directory, and
+    execute the following:
+    <programlisting role="bash"><![CDATA[
 $ ./buildconf
 $ ./configure
 $ make
 $ make install]]></programlisting>
-    </para>
+   </para>
 
-    <para>
-     This should just work for most people. However, if there are multiple
-     installations of PHP in your machine or you have installed PHP in some
-     exotic location, you might face trouble. Most of these cases can be solved
-     by specifying the exact locations of the <literal>phpize</literal> and
-     <literal>php-config</literal> files:
-     <programlisting role="bash"><![CDATA[
+   <para>
+    This should just work for most people. However, if there are multiple
+    installations of PHP in your machine or you have installed PHP in some
+    exotic location, you might face trouble. Most of these cases can be solved
+    by specifying the exact locations of the <literal>phpize</literal> and
+    <literal>php-config</literal> files:
+    <programlisting role="bash"><![CDATA[
 $ ./buildconf --with-phpize=/path/to/phpize
 $ ./configure --with-php-config=/path/to/php-config]]></programlisting>
-    </para>
-   </sect2>
+   </para>
+  </sect2>
 
-   <sect2 id="tutorials.installation.linux.testing">
-    <title>Testing your installation</title>
+  <sect2 id="tutorials.installation.linux.testing">
+   <title>Testing your installation</title>
 
-    <para>
-     Before you can use PHP-GTK 2, you need to enable the extension in
-     your php.ini. Just add a
-     <programlisting role="ini"><![CDATA[
+   <para>
+    Before you can use PHP-GTK 2, you need to enable the extension in
+    your <filename>php.ini</filename>. Just add a
+    <programlisting role="ini"><![CDATA[
 extension=php_gtk2.so]]></programlisting>
      below all the other <literal>extension=</literal> settings.
-    </para>
+   </para>
 
-    <para>
-     You can test whether your installation was successful by executing:
+   <para>
+    You can test whether your installation was successful by executing:
 
-     <programlisting role="bash"><![CDATA[
+    <programlisting role="bash"><![CDATA[
 $ php -m | grep php-gtk]]></programlisting>
 
-     You should get a single line that reads <literal>php-gtk</literal>.
-    </para>
-
-    <para>
-     Next, you can try out the demo applications in the
-     <filename>demos</filename> directory of the php-gtk sources,
-     e.g. <filename>demos/phpgtk2-demo.php</filename>.
-    </para>
-   </sect2>
-  </sect1>
+    You should get a single line that reads <literal>php-gtk</literal>.
+   </para>
 
-  <sect1 id="tutorials.installation.macosx">
-   <title>Installation on Mac OS X</title>
+   <para>
+    Next, you can try out the demo applications in the
+    <filename>demos</filename> directory of the php-gtk sources,
+    e.g. <filename>demos/phpgtk2-demo.php</filename>.
+   </para>
+  </sect2>
+ </sect1>
 
-    <para>
-     You need to make sure you have the Apple Developer Tools, BSD Subsystem,
-     and an installation of X before you try installing PHP-GTK 2. Although
-     the BSD subsystem is installed by default on Mac OS X, you need select
-     the Developer Tools and X Server manually. Although you can use any X
-     server, the easiest would be to use the one Apple provides by default on
-     it's Mac OS X installer.
-    </para>
+ <sect1 id="tutorials.installation.macosx">
+  <title>Installation on Mac OS X</title>
 
-    <para>
-     Get <ulink url="&url.macports;">MacPorts</ulink> (previously knows as
-     DarwinPorts) or <ulink url="&url.fink;">Fink</ulink> and install it. You
-     can use either to install a version of X (if you decided not to use
-     Apple's default distribution), and Gtk+ itself. Both Fink and MacPorts
-     provide versions 2.6 and above of Gtk+. Also make sure you have a version
-     of PHP that is atleast 5.2, MacPorts provides a package. Type
-     <literal>php -v</literal> on your Terminal to find out your version.
-     If you want to manually compile PHP you can do so:
+  <para>
+   You need to make sure you have the Apple Developer Tools, BSD Subsystem,
+   and an installation of X before you try installing PHP-GTK 2. Although
+   the BSD subsystem is installed by default on Mac OS X, you need select
+   the Developer Tools and X Server manually. Although you can use any X
+   server, the easiest would be to use the one Apple provides by default on
+   it's Mac OS X installer.
+  </para>
+
+  <para>
+   Get <ulink url="&url.macports;">MacPorts</ulink> (previously knows as
+   DarwinPorts) or <ulink url="&url.fink;">Fink</ulink> and install it. You
+   can use either to install a version of X (if you decided not to use
+   Apple's default distribution), and Gtk+ itself. Both Fink and MacPorts
+   provide versions 2.6 and above of Gtk+. Also make sure you have a version
+   of PHP that is atleast 5.2, MacPorts provides a package. Type
+   <literal>php -v</literal> on your Terminal to find out your version.
+   If you want to manually compile PHP you can do so:
 
-     <programlisting role="bash"><![CDATA[
+   <programlisting role="bash"><![CDATA[
 $ cvs -d :pserver:[email protected]:/repository co -r PHP_5_2 php-src
 $ cd php-src
 $ ./buildconf
 $ ./configure --disable-cgi
 $ make
 $ sudo make install]]></programlisting>
-    Although you may install it anywhere, <literal>/usr/local</literal> is
-    usually considered a good place. MacPorts installs PHP into
-    <literal>/opt/local</literal>.
-    </para>
+   Although you may install it anywhere, <filename>/usr/local/</filename> is
+   usually considered a good place. MacPorts installs PHP into
+   <filename>/opt/local/</filename>.
+  </para>
 
-    <para>
-     Now get the latest checkout of PHP-GTK and compile it:
+  <para>
+   Now get the latest checkout of PHP-GTK and compile it:
 
-     <programlisting role="bash"><![CDATA[
+   <programlisting role="bash"><![CDATA[
 $ cd..
 $ cvs -d :pserver:[email protected]:/repository co php-gtk
 $ cd php-gtk
@@ -268,29 +267,29 @@
             --disable-libglade
 $ make
 $ sudo make install]]></programlisting>
-    Remember to replace <literal>/usr/local</literal> with the actual directory
-    in which you installed PHP. For example, if you installed PHP 5.2 using
-    MacPorts, you would enter <literal>/opt/local</literal> instead.
-    </para>
-
-    <para>
-     Finally, copy over the <literal>php.ini-recommended</literal> file
-     to <literal>/usr/local/lib/php.ini</literal> and change the value of
-     <literal>extension_dir</literal> to the directory where
-     <literal>php_gtk2.so</literal> resides. This is usually something like:
-     <literal>/usr/local/lib/php/extensions/no-debug-non-zts-some-date</literal>.
-     You may want to create a new symbolic link in <literal>/usr/bin</literal>
-     that points to <literal>/usr/local/bin/php</literal>. Again, the directory
-     may be <literal>/opt/local</literal> instead of 
-     <literal>/usr/local</literal> depending on where your installation of PHP
-     resides.
-    </para>
-
-    <para>
-     Now continue with
-     <link linkend="tutorials.installation.linux.testing">Testing
-     your installation</link>.
-    </para>
-   </sect1>
+   Remember to replace <filename>/usr/local/</filename> with the actual directory
+   in which you installed PHP. For example, if you installed PHP 5.2 using
+   MacPorts, you would enter <filename>/opt/local/</filename> instead.
+  </para>
+
+  <para>
+   Finally, copy over the <filename>php.ini-recommended</filename> file
+   to <filename>/usr/local/lib/php.ini</filename> and change the value of
+   <literal>extension_dir</literal> to the directory where
+   <literal>php_gtk2.so</literal> resides. This is usually something like:
+   <literal>/usr/local/lib/php/extensions/no-debug-non-zts-some-date</literal>.
+   You may want to create a new symbolic link in <filename>/usr/bin/</filename>
+   that points to <filename>/usr/local/bin/php</filename>. Again, the directory
+   may be <filename>/opt/local/</filename> instead of
+   <filename>/usr/local/</filename> depending on where your installation of PHP
+   resides.
+  </para>
+
+  <para>
+   Now continue with
+   <link linkend="tutorials.installation.linux.testing">Testing
+   your installation</link>.
+  </para>
+ </sect1>
 
 </chapter>