installation.php

   1 <html xmlns="http://www.w3.org/1999/xhtml">
   2 <head>
   3   <meta name="generator" content="HTML Tidy for Linux (vers 25 March 2009), see www.w3.org" />
   4
   5   <title>Window Maker: Documentation</title>
   6   <meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
   7   <link href="title.css" rel="stylesheet" type="text/css" />
   8 </head>
   9
  10 <body>
  11   <?php include("dock.php");  ?>
  12   <?php include("header.php"); ?>
  13
  14   <div>
  15     <table class="inner" border="0" cellpadding="1" cellspacing="1">
  16       <tr>
  17         <td content="content" colspan="2" valign="top">
  18           <br />
  19           <br />
  20
  21           <h1>Installation Basics</h1>
  22
  23           <h2>Downloading and Extracting</h2>
  24
  25           <p>The first necessary step is to <span class="newWikiWord"><a title="Not found. Click to create this page." href=
  26           "/download.edit">download?</a></span> the Window Maker source distribution. From this point on, we'll assume it has
  27           been retrieved and is residing on the local hard disk. The next step is to extract it, and change into the source
  28           directory.</p>
  29           <pre>
  30 <code># cd /path/to/your/download
  31 # gunzip WindowMaker-0.xx.xx.tar.gz
  32 # tar -xf WindowMaker-0.xx.xx.tar
  33 # cd WindowMaker-0.xx.xx
  34 </code>
  35 </pre>
  36
  37           <p>Now that things are extracted, it's time to look at the relevant pieces of documentation. Most UNIX oriented free
  38           software packages come with a README file, and Window Maker is no exception. The README file contains a summary
  39           overview of what the distribution is, what the various directories contain, and other general information.</p>
  40
  41           <p>Next, we have the ChangeLog which describes a list of changes since the first version. Although it usually lists
  42           technical advancements about the distribution, it is also useful for finding out about bug fixes and recently added
  43           features.</p>
  44
  45           <p>Moving along, we have the NEWS file. For now, we just want to point out its existence. It will become more useful to
  46           novice users over time. Veteran Window Maker users will find it handy for keeping their configuration files up to date,
  47           and learning about various changes which affect Window Maker's behavior.</p>
  48
  49           <p>The two remaining files we need to look at are INSTALL and BUGS. The INSTALL file provides additional information
  50           that is necessary to install Window Maker successfully. The BUGS file contains a list of known Window Maker bugs. If a
  51           user feels they've found a bug in Window Maker, they should consult the BUGS file first. If the bug isn't listed,
  52           proceed to the Bug Tracker and see if its there.</p>
  53
  54           <h2>Compiling</h2>
  55
  56           <p>After extracting the latest version of Window Maker using the previous instructions, the next step is to compile it.
  57           First of all, the configure script should be run. It will test to make sure all the necessary libraries, compilers and
  58           build tools are available on the local system. The configure script allows for various arguments to be passed to it
  59           which relate to Window Maker's installation. For a complete list of all configurable settings, enter:</p>
  60           <pre>
  61 <code># ./configure -help
  62 </code>
  63 </pre>
  64
  65           <p>Three commonly used configuration options are:</p>
  66           <pre>
  67 <code>--prefix=DIR --enable-kde --enable-gnome
  68 </code>
  69 </pre>
  70
  71           <p>The first configuration option lets Window Maker be installed into a non-default installation directory (e.g if
  72           Window Maker cannot be installed system wide for some reason, a user can specify a path under his/her home directory).
  73           The default installation directory is /usr/local/bin for the wmaker binary and /usr/local/GNUstep/Apps for the WPrefs
  74           application (the WPrefs installation directory can be specified by using --with-appspath=DIR). Note that root access
  75           will be needed later on during the installation process if the defaults were used. The second and third configuration
  76           options will enable Window Maker to fully cooperate with <a href="http://kde.org">KDE</a> and <a href=
  77           "http://gnome.org">GNOME</a> respectively.</p>
  78
  79           <p>So if a user johndoe would like to install the wmaker binary into /home/johndoe/wmaker/bin instead of the default
  80           /usr/local/bin, and if he wishes to use Window Maker in cooperation with KDE, the following arguments would be passed
  81           to the configure script:</p>
  82           <pre>
  83 <code> # ./configure --prefix=/home/johndoe/wmaker --enable-kde
  84 </code>
  85 </pre>
  86
  87           <p>After the configure script has been successfully executed, Window Maker can now be compiled with the make command;
  88           simply enter:</p>
  89           <pre>
  90 <code># make
  91 </code>
  92 </pre>
  93
  94           <p>Now is a good time to get a drink while the compilation takes place. Providing the compilation goes well, the final
  95           step is to install the binaries and other support files. This is accomplished by entering: # make install</p>
  96
  97           <p>Note that this is the step that needs to be performed by root if the default installation directory was used, or if
  98           a directory was specified that the running user cannot write to. If the installing user has root access, they should
  99           first become root by issuing <code>su - root</code>. Otherwise, reconfigure and recompile Window Maker by specifying a
 100           different installation directory, or kindly ask the local system administator to install it system wide.</p>
 101
 102           <p>Once Window Maker is installed system-wide, a default configuration can be installed on a per-user basis, through
 103           the bundled installation script, <code>wmaker.inst</code>. Enter <code>wmaker.inst</code> in a terminal emulator to
 104           configure Window Maker for your user.</p>
 105
 106           <p>This script copies the default Window Maker configuration to your user's home directory and sets Window Maker as the
 107           default window manager. It is recommended to create ~/GNUstep before executing the script.</p>
 108         </td>
 109       </tr>
 110     </table>
 111
 112   <?php include("footer.php"); ?>
 113
 114 </body>
 115 </html>