From 6554181d424b01f1c602d66fff6a0a26bca0b1f2 Mon Sep 17 00:00:00 2001 From: gryf Date: Sat, 4 May 2019 14:40:14 -0600 Subject: [PATCH] Converted installation.md to rst --- docs/{installation.md => installation.rst} | 89 ++++++++++++++-------- 1 file changed, 56 insertions(+), 33 deletions(-) rename docs/{installation.md => installation.rst} (60%) diff --git a/docs/installation.md b/docs/installation.rst similarity index 60% rename from docs/installation.md rename to docs/installation.rst index ae09ac3..9fe00f1 100644 --- a/docs/installation.md +++ b/docs/installation.rst @@ -9,16 +9,19 @@ Installation Basics Downloading and Extracting -------------------------- -The first necessary step is to -[download](http://windowmaker.org/pub/source/release/WindowMaker-0.95.5.tar.gz) -the Window Maker source distribution. From this point on, we'll assume it has -been retrieved and is residing on the local hard disk. The next step is to -extract it, and change into the source directory. +The first necessary step is to `download +`_ the +Window Maker source distribution. From this point on, we'll assume it has been +retrieved and is residing on the local hard disk. The next step is to extract +it, and change into the source directory. - # cd /path/to/your/download - # gunzip WindowMaker-0.xx.xx.tar.gz - # tar -xf WindowMaker-0.xx.xx.tar - # cd WindowMaker-0.xx.xx +.. code:: console + :class: highlight + + # cd /path/to/your/download + # gunzip WindowMaker-0.xx.xx.tar.gz + # tar -xf WindowMaker-0.xx.xx.tar + # cd WindowMaker-0.xx.xx Now that things are extracted, it's time to look at the relevant pieces of documentation. Most UNIX oriented free software packages come with a README @@ -28,8 +31,8 @@ other general information. Moving along, we have the NEWS file. For now, we just want to point out its existence. It will become more useful to novice users over time. Veteran Window -Maker users will find it handy for keeping their configuration files up to date, -and learning about various changes which affect Window Maker's behavior. +Maker users will find it handy for keeping their configuration files up to +date, and learning about various changes which affect Window Maker's behavior. The two remaining files we need to look at are INSTALL and BUGS. The INSTALL file provides additional information that is necessary to install Window Maker @@ -48,60 +51,80 @@ compilers and build tools are available on the local system. The configure script allows for various arguments to be passed to it which relate to Window Maker's installation. For a complete list of all configurable settings, enter: - $ ./configure --help +.. code:: console + :class: highlight + + $ ./configure --help Commonly used configuration options are: - --prefix=DIR --enable-modelock --enable-xinerama --enable-silent-rules +.. code:: console + :class: highlight -The first configuration option lets Window Maker be installed into a non-default -installation directory (e.g if Window Maker cannot be installed system wide for -some reason, a user can specify a path under his/her home directory). The -default installation directory is /usr/local/bin. Note that root access will be -needed later on during the installation process if the defaults were used. + --prefix=DIR --enable-modelock --enable-xinerama --enable-silent-rules + +The first configuration option lets Window Maker be installed into a +non-default installation directory (e.g if Window Maker cannot be installed +system wide for some reason, a user can specify a path under his/her home +directory). The default installation directory is /usr/local/bin. Note that +root access will be needed later on during the installation process if the +defaults were used. So if a user johndoe would like to install the wmaker binary into /home/johndoe/wmaker/bin instead of the default /usr/local/bin, the following argument would be passed to the configure script: - $ ./configure --prefix=/home/johndoe/wmaker +.. code:: console + :class: highlight + + $ ./configure --prefix=/home/johndoe/wmaker After the configure script has been successfully executed, Window Maker can now be compiled with the make command; simply enter: - $ make +.. code:: console + :class: highlight + + $ make The final step is to install the binaries and other support files. This is accomplished by entering: - # make install +.. code:: console + :class: highlight + + # make install Note that this is the step that needs to be performed by root if the default installation directory was used, or if a directory was specified that the running user cannot write to. If the installing user has root access, they -should first become root by issuing `su - root`. Otherwise, reconfigure and +should first become root by issuing ``su - root``. Otherwise, reconfigure and recompile Window Maker by specifying a different installation directory, or kindly ask the local system administator to install it system wide. Once Window Maker is installed system-wide, a default configuration can be installed on a per-user basis, through the bundled installation script, -wmaker.inst. Enter wmaker.inst in a terminal emulator -to configure Window Maker for your user. +``wmaker.inst``. Enter ``wmaker.inst`` in a terminal emulator to configure +Window Maker for your user. This script copies the default Window Maker configuration to your user's home -directory and sets Window Maker as the default window manager. It is recommended -to create `~/GNUstep` before executing the script. +directory and sets Window Maker as the default window manager. It is +recommended to create ``~/GNUstep`` before executing the script. Final tweaks ------------ -Edit your ~/.xinitrc to load your newly installed Window Maker using the line -`exec /usr/local/bin/wmaker`. +Edit your ~/.xinitrc to load your newly installed Window Maker using the line +``exec /usr/local/bin/wmaker``. -Generate a new root menu (accessible with F12) with `wmgenmenu`, for example +Generate a new root menu (accessible with F12) with ``wmgenmenu``, for example - $ wmgenmenu > $HOME/GNUstep/Defaults/WMRootMenu +.. code:: console + :class: highlight -Another recommended step is to install a few dockapps like wmvolman, wmmixer and -wmsystemtray which allow one to easily mount external media on /media among -other things. Visit [dockapps](http://www.dockapps.net) for many more choices. + $ wmgenmenu > $HOME/GNUstep/Defaults/WMRootMenu + +Another recommended step is to install a few dockapps like wmvolman, wmmixer +and wmsystemtray which allow one to easily mount external media on /media among +other things. Visit `dockapps `_ for many more +choices.