gryf/window-maker.github.io
1
0
Fork 0
mirror of https://github.com/gryf/window-maker.github.io.git synced 2025-12-17 11:10:18 +01:00
Code Issues Projects Releases Wiki Activity

Converted installation.md to rst

Browse Source
This commit is contained in:
gryf
2019-05-04 14:40:14 -06:00
parent 9a6f2ea562
commit 6554181d42
1 changed files with 56 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

89
docs/installation.md → docs/installation.rst
View File

@@ -9,16 +9,19 @@ Installation Basics
Downloading and Extracting Downloading and Extracting
-------------------------- --------------------------
The first necessary step is to The first necessary step is to `download
[download](http://windowmaker.org/pub/source/release/WindowMaker-0.95.5.tar.gz) <http://windowmaker.org/pub/source/release/WindowMaker-0.95.5.tar.gz>`_ the
the Window Maker source distribution. From this point on, we'll assume it has Window Maker source distribution. From this point on, we'll assume it has been
been retrieved and is residing on the local hard disk. The next step is to retrieved and is residing on the local hard disk. The next step is to extract
extract it, and change into the source directory. it, and change into the source directory.
# cd /path/to/your/download .. code:: console
# gunzip WindowMaker-0.xx.xx.tar.gz :class: highlight
# tar -xf WindowMaker-0.xx.xx.tar
# cd WindowMaker-0.xx.xx # 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 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 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 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 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, Maker users will find it handy for keeping their configuration files up to
and learning about various changes which affect Window Maker's behavior. 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 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 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 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: 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: 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 --prefix=DIR --enable-modelock --enable-xinerama --enable-silent-rules
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 The first configuration option lets Window Maker be installed into a
default installation directory is /usr/local/bin. Note that root access will be non-default installation directory (e.g if Window Maker cannot be installed
needed later on during the installation process if the defaults were used. 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 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 /home/johndoe/wmaker/bin instead of the default /usr/local/bin, the following
argument would be passed to the configure script: 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 After the configure script has been successfully executed, Window Maker can now
be compiled with the make command; simply enter: 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 The final step is to install the binaries and other support files. This is
accomplished by entering: 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 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 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 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 recompile Window Maker by specifying a different installation directory, or
kindly ask the local system administator to install it system wide. kindly ask the local system administator to install it system wide.
Once Window Maker is installed system-wide, a default configuration can be Once Window Maker is installed system-wide, a default configuration can be
installed on a per-user basis, through the bundled installation script, installed on a per-user basis, through the bundled installation script,
<code>wmaker.inst</code>. Enter <code>wmaker.inst</code> in a terminal emulator ``wmaker.inst``. Enter ``wmaker.inst`` in a terminal emulator to configure
to configure Window Maker for your user. Window Maker for your user.
This script copies the default Window Maker configuration to your user's home 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 directory and sets Window Maker as the default window manager. It is
to create `~/GNUstep` before executing the script. recommended to create ``~/GNUstep`` before executing the script.
Final tweaks Final tweaks
------------ ------------
Edit your ~/.xinitrc to load your newly installed Window Maker using the line Edit your ~/.xinitrc to load your newly installed Window Maker using the line
`exec /usr/local/bin/wmaker`. ``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 $ wmgenmenu > $HOME/GNUstep/Defaults/WMRootMenu
wmsystemtray which allow one to easily mount external media on /media among
other things. Visit [dockapps](http://www.dockapps.net) for many more choices. 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.