From 2caaf4b12db5b03d2a72f2fc6db7ab2c9008d7b3 Mon Sep 17 00:00:00 2001 From: Doug Torrance Date: Fri, 10 Mar 2017 15:47:25 -0500 Subject: [PATCH] Add installation and internationalization docs to webpage. Generated from Compilation.texi and Translations.texi under the doc/build directory of the Window Maker source tree using makeinfo. --- docs.php | 3 +- wmaker_i18n.php | 525 +++++++++++++++++++++++++++++++++ wmaker_install.php | 840 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 1367 insertions(+), 1 deletion(-) create mode 100644 wmaker_i18n.php create mode 100644 wmaker_install.php diff --git a/docs.php b/docs.php index 9cc6255..e3b9df2 100644 --- a/docs.php +++ b/docs.php @@ -34,7 +34,8 @@

Installation Basics
Window Maker Compilation and Installation
Window Maker Internationalisation
Guided Tour
User Guide

Window Maker Internationalisation 1.0

Window Maker Internationalisation

A guide to enable support for language translations +in WINDOW MAKER and to the contributors +who want to help translating. +

+ +

1 Enabling Languages support +
2 Choosing the Language
3 Troubleshooting
4 Contribute to Translations +

This manual is for Window Maker, version git#next. +

1 Enabling Languages support

WINDOW MAKER has the possibility to be translated in many languages, but by default none of +them will be installed, and the support for translation will not be compiled. +

To enable the translation capabilities, you have to specify which language(s) you want to be +installed: this is done with the variable LINGUAS when running the configure script. +This variable should contain the space-separated list of languages you want to install. +

You could for instance enable both French (fr) and Dutch (nl) with this: +

./configure LINGUAS="fr nl"
+

You can of course add any other option that you want to the configure command. +From the moment you specify the variable, the configure script will check that you have +the appropriate dependencies for this (basically the gettext function and the libintl +library); when you run make to compile the project, it will also compile the translation +(mo files) for the language(s) you asked (if available, of course), and during +make install it will install them in the usual directory. +

The installation directory can be changed with the standard option --localedir to the +configure script, the default path being +<prefix>/share/locale/<lang>/LC_MESSAGES). +

1.1 Getting the list of supported languages

The naming convention for the languages follows the ISO 639-1 standard, +for which you can find a summary list in the +GNU gettext manual. +

But as WINDOW MAKER does not support all of them, the configure script will print a +warning for each language you specify that it does not know, and sum up at the end the list of +enabled languages that will be installed. +

There is a non-standard possibility to set LINGUAS to list, in which case the +configure script will provide you the list of languages it supports, and stop: +

./configure LINGUAS="list"
+

There is also another non-standard possibility to enable all the languages that WINDOW MAKER +supports by setting LINGUAS to *. +This is an internal trick implemented so the development team can have the command +make distcheck include some checks on translations: +

./configure LINGUAS='*'
+

1.2 Translations for Menus

In order to propose an Application Menu (also called Root Menu) that is also +translated in the language of the interface, WINDOW MAKER implements two complementary +mechanisms: +

The first, always enabled when i18n support is enabled, is to look for the menu file containing the +name of the locale. +For example, if the file is called menu and the language is set as LANG=fr_FR.utf-8, +then WINDOW MAKER will search for, and use the first match found: +

menu.fr_FR.utf-8 +
menu.fr_FR +
menu.fr +
menu +

The second possibility, which is not enabled by default, is to be able to use a custom po +file which contains the translations for the text of the menu. +This feature is enabled at compile time, using the option --with-menu-textdomain to the +configure script. For example, if you specify: +

./configure --with-menu-textdomain=WMMenu
+

then the translations for the menu will be searched in the file WMMenu.mo located +at the standard location, the default path being +<prefix>/share/locale/<lang>/LC_MESSAGES/WMMenu.mo. +

If you do not enable the feature (the default behaviour, or with an explicit +--without-menu-textdomain), then WINDOW MAKER will not try to translate the +strings, even using its own domain file (WindowMaker.mo). +

1.3 Setting `LINGUAS` at system level

As the variable LINGUAS is quite standard, you also have the possibility to set its value in +the config.site file for AUTOCONF. +This file can be placed in one of these paths: +

<prefix>/share/config.site +
<prefix>/etc/config.site +

This way, the same language list will be used for all the programs that use AUTOCONF that you +would compile. +Please note that if you also specify a value on the command line, it will have precedence over the +value in that file. +

2 Choosing the Language

If you have compiled and installed WINDOW MAKER with support for your language, +the effective translation is done is the very same way as any other application on an UNIX +system, you just have to set the shell variable LANG to your language before wmaker +is started. +In sh type of shell (SH, KSH, BASH, ...), this is done for example with +(fr is for French): +

export LANG=fr
+

There is also a command line option --locale for WINDOW MAKER which may be used to set +the language: +

wmaker --locale fr
+

When using this option, WINDOW MAKER will use the locale you specified, redefining the +LANG environment variable to this value so all program started from WINDOW MAKER will +inherit its value. +

If your system is using SYSTEMD, you can also configure the locale at system level using the +command: +

localectl set-locale LANG=fr
+

You can check if the current value is properly supported with the command: +

locale
+

If this does not work, you may need first to activate the support for your locale in the system; +you can get the list of currently enabled locales with the command: +

locale -a
+

You should be able to enable a new language support by editing the file /etc/locale.gen to +uncomment the locale(s) you need (by removing the # character and space(s) in front of it, +and by running the command locale-gen as root. +

For further information, you may wish to read dedicated documentation, for example from +the Linux Documentation Project +or through pages like +Shell Hacks’ note on Changing Locale. +

3 Troubleshooting

If I18N support does not work for you, check these: +

- the LANG environment variable is set to your locale, and +the locale is supported by your OS’s locale or X’s locale +emulation. you can display all supported locales by +executing "locale -a" command if it is available; you +can check if your locale is supported by X’s locale emulation, +see /usr/share/X11/locale/locale.alias + +
- check if you are using an appropriate fonts for the locale you +chose. If you’re using a font set that has a different +encoding than the one used by XLIB or LIBC, bad things can +happen. Try specifically putting the encoding in the LANG +variable, like ru_RU.KOI8-R. Again, see +/usr/share/X11/locale/locale.alias + +
- the fonts you’re using support your locale. if your font +setting on $HOME/GNUstep/Defaults/WindowMaker is like... + +
+
```
   WindowTitleFont = "Trebuchet MS:bold:pixelsize=12";
+   MenuTitleFont   = "Trebuchet MS:bold:pixelsize=12";
+
```
+ +
then you can’t display Asian languages (ja, ko, ch, ...) characters using +Trebuchet MS. A font that is guaranteed to work for any language is +sans (or sans-serif). sans is not a font itself, but an alias which +points to multiple fonts and will load the first in that list that +has the ability to show glyphs in your language. If you don’t know +a font that is suited for your language you can always set all your +fonts to something like: +
+
+
```
   "sans:pixelsize=12"
+
```
+ +
However, please note that if your font is something like: +
+
+
```
   "Trebuchet MS,sans serif:pixelsize=12"
+
```
+ +
this will not be able to display Asian languages if any of the +previous fonts before sans are installed. This is because unlike +the proper font pickup that sans guarantees for your language, +this construct only allows a font fallback mechanism, which tries +all the fonts in the list in order, until it finds one that is +available, even if it doesn’t support your language. +
+
Also you need to change font settings in style files in +the $HOME/Library/WindowMaker/Style directory. +
+
- the LC_CTYPE environment variable is unset or it has the correct +value. If you don’t know what is the correct value, unset it. + +

4 Contribute to Translations

You may have noticed that many translations are not up to date, because the code has evolved but the +persons who initially contributed may not have had the time to continue, so any help is welcome. +

Since WINDOW MAKER 0.95.7 there are some targets to make that can help you in that +task. +

4.1 Install the latest sources

If you want to contribute, the first step is get the development branch of the code; +this is done using git. +If you do not feel confident at all with using git, you may also try to ask for a +snapshot on the developer’s mailing list wmaker-dev@lists.windowmaker.org. +With git the procedure is: +

# Get your working copy of the sources
+git clone git://repo.or.cz/wmaker-crm.git
+
+# Go into that newly created directory
+cd wmaker-crm
+
+# Switch to the branch where everything happens
+git checkout next
+
+# Generate the configuration script
+./autogen.sh
+

Now you should have an up-to-date working copy ready to be compiled; +you will not need to go the full way but you should run the configure script, so it will +create the Makefiles, and you may want to compile the code once so it will not do it again +automatically later while you are doing something else: +

# Setup the build, enabling at least the language you want to work on
+./configure LINGUAS="<list of iso 639 country code>"
+
+# Compile the code once
+make
+

4.2 Updating the Translations

The typical process for translating one program is: +

generate a POT file (PO Template): +this is done with xgettext which searches for all the strings from the sources that can be +translated; + +
update the PO file for your language: +this is done with msgmerge which compares the PO file and aligns it to the latest +template; + +
edit the new PO file: +this is done by you with your favourite editor, to add the missing msgstr, review the +possible fuzzy matches, ... + +
check the PO file: +unfortunately there is no definitive method for this; + +
submit your contribution to the project: +this is done with git. +

In WINDOW MAKER, you have actually 4 po files to take care of: +

- po/<lang>.po: for WINDOW MAKER itself +
- WPrefs.app/po/<lang>.po: for the Preference Editor program +
- WINGs/po/<lang>.po: for the graphic toolkit library +
- util/po/<lang>.po: for the command-line tools of WINDOW MAKER +

As stated previously, there is a make target that can help you to automatically generate +the POT and update the PO for these 4 cases: +

make update-lang PO=<lang>
+

Once run, it will have updated as needed the 4 po files against the latest source code. +You may wish to use the command git gui to view the changes; +you can now edit the files to complete the translation, correct them, remove deprecated stuff, ... +Please note that the encoding should be set to UTF-8 as this is now the standard. +

If you think an error message is too obscure, just ask on the developer mailing list +wmaker-dev@lists.windowmaker.org: in addition to clarifications there’s even a chance for the original message +to be improved! +

You may find some information on working with po file in the +GNU gettext documentation. +

4.3 Translate the Man Pages

You may want to extend the translation to the documentation that is provided to users in the form +of Unix man pages. +The sources of the man pages are located in the doc/ directory; +the translation should be placed in the directory doc/lang/ with the same file name. +

The directory will also need a file Makefile.am which provides the list of man pages to be +included in the distribution package and to be installed. +You can probably get inspiration from an existing one from another language; +if you do not feel confident about it do not hesitate to ask on the project’s mailing list +(wmaker-dev@lists.windowmaker.org), either for help or to ask someone to make it for you. +

Please note that although most man pages sources are directly in man page format +(nroff, the file extension being a number), a few of them are processed by a script +(those with the .in extension, like wmaker.in). +This is done because in some case we want the man page to reflect the actual compilation options. +

You may not want to bother with this hassle, in which case you can simply name your translation +file with the .1 and remove the special @keyword@ marks. +If you are sure you want to keep that processing but do not feel confident about hacking the +Makefile.am do not hesitate to ask on the project’s mailing list (wmaker-dev@lists.windowmaker.org). +

4.4 Checking the Result

In the WINDOW MAKER build tree you also have another target that can help you, it is +make check. +

At current time, it does not check much, but if during the make update-lang new po +file have been created you may get some errors, because you have to add these new files to the +variable EXTRA_DIST in the corresponding Makefile. +

If you do not feel confident about doing it, do not worry, just tell about it when you submit your +work, and some developer on the mailing list will just be happy to do it for you when integrating +your valuable contribution (we always like when someone helps making WINDOW MAKER better). +

4.5 Submitting your Contribution

Preliminary Remark: if the update process made changes in a po file but you did not +change any msgstr content, it is probably a good idea to not submit the changes to that +po file because it would just add noise. +

When you feel ready to send your changes, the first step is to prepare them. +This is done with git: if you have not run the git gui previously then it is a +good time to do it now. +This window offers you the possibility to show your changes and to decide what you want to send. +

The window is divided in 4 panes: +

top-right show the current changes you have selected, for review +(and also for cherry-picking stuff if you want to select precisely) + +
top-left ("Unstaged Changes") the list of files with changes to be send, + you can click on the name of the file to see the changes, + you can click on the icon of the file if you want to send all the changes in this file; +an icon in blue shows a file that have been changed and an icon in black shows a file that is new + +
bottom-left ("Staged Changes") the list of files with changes that you have chosen to send so far, + you can click on the file name to view these changes, + you can click on the icon if you want to remove the changes from this file from the list to send + +
bottom-right ("Commit Message") the message you want to attach to your changes when you submit them +to the development team +

The idea here is to pick your changes to the po files; +for the commit message you may wish to stuck to a simple, single line: +

+
"Updated translations for <lang>" +

The penultimate step is to click on the button Sign Off (it will add a line in the commit +message), and then click on the button Commit. +From this time, the commit message will clear itself and the "Staged Changes" also, showing that +your action was done. +

You may now quit the git gui, the final step begins by running this command: +

git format-patch HEAD^
+

This will generate a file named like 0001-updated-translations-for-XX.patch +which contains your changes, ready for sending. +The goal will now be to email this file to wmaker-dev@lists.windowmaker.org. +If you feel confident in having git send it for you, you may want to read the file +The-perfect-Window-Maker-patch.txt to see how to configure git for mailing, so you +can run: +

git send-email 0001-updated-translations-for-XX.patch
+

Window Maker Compilation and Installation 1.0

Window Maker Compilation and Installation

A guide to configure, compile and install +WINDOW MAKER from sources. +

+ +

1 Prerequisites +
2 Building WINDOW MAKER +
3 Miscellaneous +
4 Troubleshooting +

This manual is for Window Maker, version git#next. +

1 Prerequisites

1.1 Supported Platforms

- Intel GNU/Linux Systems in general, ix86 and x86_64 but other architectures should work +
- BSD systems +
- Solaris, at least on release 10 and 11 +

Patches to make it work on other platforms are welcome. +

1.2 Software Dependencies

The following software is required to use WINDOW MAKER: +

- X11R6.x + +
Window Maker can be compiled in older versions of X, like X11R5 (Solaris) +or X11R4 (OpenWindows) but it will not work 100% correctly. +In such servers there will not be application icons and you’ll have trouble using the dock. +Upgrading the client libraries (Xlib, Xt, etc.) will help if you can’t upgrade +the server. +

The following is required to build WINDOW MAKER: +

- Basic obvious stuff + +
- gcc (or some other ANSI C compiler, supporting some C99 extensions) +
- glibc development files (usually glibc-devel in Linux distributions) +
- X development files (XFree86-devel or something similar) +
+ +
- Xft2 and its dependencies + +
Dependencies include freetype2 and fontconfig. +You will also need the development files for them (xft2-devel). +Sources are available at: http://www.freedesktop.org/wiki/Software/Xft/ +
+

Note: +WINDOW MAKER is known to compile with gcc and clang; +the code source is mostly ANSI C (also known as C89 and C90) but is uses very few of the C99 +novelties; +it also uses a few attributes introduced in the C11 standard but those are detected automatically, +so most compilers should work. +

1.3 Special Dependencies

If you want to compile using the sources from the git repository instead of the distribution +package, you will also need: +

git +
autoconf 2.69 +
automake 1.12 +
libtool 1.4.2 +

1.4 Optional Dependencies

These libraries are not required to make WINDOW MAKER work, but they are supported in case you +want to use them. Version numbers are indicative, but other versions might work too. +

- libXPM 4.7 or newer + +
Older versions may not work! +
+
Available from http://xlibs.freedesktop.org/release/ +
+
There is built-in support for XPM files, but it will not +load images in some uncommon encodings. +
+
- libpng 0.96 or newer and zlib + +
For PNG image support, +http://www.libpng.org/pub/png/libpng.html +
+
- libtiff 3.4 or newer + +
For TIFF image support, +http://www.libtiff.org/ +
+
- libjpeg 6.0.1 or newer + +
For JPEG image support, +http://www.ijg.org/ +
+
Note that if you don’t have it, configure will issue a big warning in the end, +this is because JPEG images are often used in themes and for background images +so you probably want this format supported. +
+
- libgif 2.2 or libungif + +
For GIF image support, +http://giflib.sourceforge.net/ +
+
- WebP 0.4.1 or newer + +
The reference library from Google for their image format, +https://developers.google.com/speed/webp/download +
+
- GNU xgettext + +
If you want to use translated messages, you will need GNU gettext. +Other versions of gettext are not compatible and will not work. +Get the GNU version from http://www.gnu.org/software/gettext/ +
+
- Pango 1.36.8 or newer + +
This library can be used by the WINGs toolkit to improve support for UTF-8 and for +languages written in right-to-left direction, in some widgets. +You have to explicitly ask for its support through (see Configure Options). +You can get it from http://www.pango.org/Download +
+
- libbsd + +
This library can be used by the WINGs utility library to make use of strlcat and +strlcpy instead of using built-in functions if your system does not provide them in its +core libc. +You should let WINDOW MAKER’s configure detect this for you. +You can get it from http://libbsd.freedesktop.org/wiki/ +
+
- Inotify + +
If you have Linux’s inotify support, WINDOW MAKER will use it to check for configuration +updates instead of polling regularly the file. +The needed header comes with the kernel, typical packages names include: +
- kernel-headers for Slackware and Fedora +
- linux-userspace-headers for Mageia +
- linux-libc-dev for Debian and Ubuntu +
- linux-glibc-devel for OpenSuSE +
+ +
- MagickWand 6.8.9-9 or newer + +
If found, then the library WRaster can use the ImageMagick library to let +WINDOW MAKER support more image formats, like SVG, BMP, TGA, ... +You can get it from http://www.imagemagick.org/ +
+
- Boehm GC + +
This library can be used by the WINGs utility toolkit to use a +Boehm-Demers-Weiser Garbage Collector instead of the traditional +malloc/free functions from the libc. +You have to explicitly ask for its support though (see Configure Options). +You can get it from http://www.hboehm.info/gc/ +
+

2 Building WINDOW MAKER

2.1 Getting the Sources

The latest version of WINDOW MAKER (-crm) can be downloaded from +http://www.windowmaker.org/ +

Alternatively, the development branch, called #next is in the git repository at +http://repo.or.cz/w/wmaker-crm.git +

If you want to use the git versions, you can get it with: +

git clone -b next git://repo.or.cz/wmaker-crm.git
+

then, assuming you have the dependencies listed in Special Dependencies, you have to +type: +

./autogen.sh
+

to generate the configuration script. +

2.2 Build and Install

For a quick start, type the following in your shell prompt: +

./configure
+make
+

then, login as root and type: +

make install
+ldconfig
+

or if you want to strip the debugging symbols from the binaries to make them smaller, +you can type instead: +

make install-strip
+ldconfig
+

This will build and install WINDOW MAKER with default parameters. +

If you want to customise some compile-time options, you can do the following: +

(optional) Look at the Configure Options, for the options available. +Also run: +
+
```
./configure --help
+
```
+ +
to get a complete list of options that are available. +
+
Run configure with the options you want. +For example, if you want to use the --enable-modelock option, type: +
+
```
./configure --enable-modelock
+
```
+ +
(optional) Edit src/wconfig.h with your favourite text editor and browse through it for some +options you might want to change. + +
Compile. Just type: +
+
```
make
+
```
+ +
Login as root (if you can’t do that, read the I don’t have the root password) +and install WINDOW MAKER in your system: +
+
```
su root
+make install
+
```
+ +

2.3 User specific configuration

These instructions do not need to be followed when upgrading WINDOW MAKER +from an older version, unless stated differently in the NEWS file. +

Every user on your system that wishes to run WINDOW MAKER must do the +following: +

Install Window Maker configuration files in your home directory. +Type: +
+
```
wmaker.inst
+
```
+ +
wmaker.inst will install WINDOW MAKER configuration files and will +setup X to automatically launch WINDOW MAKER at startup. +
+

That’s it! +

You can type man wmaker to get some general help for configuration +and other stuff. +

Read the User Guide for a more in-depth explanation of WINDOW MAKER. +

You might want to take a look at the FAQ too. +

2.4 Locales/Internationalisation

WINDOW MAKER has national language support. The procedure to enable national +language support is described in the dedicated +Enabling Languages support in README.i18n. +

2.5 Configure Options

These options can be passed to the configure script to enable/disable +some WINDOW MAKER features. Example: +

./configure --enable-modelock --disable-gif
+

will configure WINDOW MAKER with modelock supported and disable gif support. +Normally, you won’t need any of them. +

To get the list of all options, run ./configure --help +

2.5.1 Installation Directory

The default installation path will be in the /usr/local hierarchy; +a number of option can customise this: +

--prefix=PREFIX
--exec-prefix=EPREFIX
--bindir=DIR
--sysconfdir=DIR
--libdir=DIR
--includedir=DIR
--datarootdir=DIR
--datadir=DIR
--localedir=DIR
--mandir=DIR: Standard options from autoconf to define target paths, +you probably want to read Installation Names in INSTALL. +
+
--sbindir=DIR
--libexecdir=DIR
--sharedstatedir=DIR
--localstatedir=DIR
--oldincludedir=DIR
--infodir=DIR
--docdir=DIR
--htmldir=DIR
--dvidir=DIR
--pdfdir=DIR
--psdir=DIR: More standard options from autoconf, today these are not used by WINDOW MAKER; +they are provided automatically by autoconf for consistency. +
+
--with-gnustepdir=PATH: Specific to WINDOW MAKER, defines the directory where WPrefs.app will be installed, +if you want to install it like a GNUstep applications. +If not specified, it will be installed like usual programs. +
+
--with-pixmapdir=DIR: Specific to WINDOW MAKER, this option defines an additional path where pixmaps will be +searched. Nothing will be installed there; the default path taken is DATADIR/pixmaps, +where DATADIR is the path defined from --datadir. +
+
--with-defsdatadir=DIR: Specific to WINDOW MAKER, defines the directory where system configuration +files, e.g., WindowMaker, WMRootMenu, etc., are installed. The +default value is SYSCONFDIR/WindowMaker, where SYSCONFDIR is +the path defined from --sysconfdir. +
+

2.5.2 External Libraries

Unless specifically written, configure will try to detect automatically for the libraries; +if you explicitly provide --enable-FEATURE then it will break with an error message +if the library cannot be linked; +if you specify --disable-FEATURE then it will not try to search for the library. +You can find more information about the libraries in the +Optional Dependencies. +

--enable-boehm-gc: Never enabled by default, use Boehm GC instead of the default libc malloc() +
+
--disable-gif: Disable GIF support in WRaster library; when enabled use libgif or libungif. +
+
--disable-jpeg: Disable JPEG support in WRaster library; when enabled use libjpeg. +
+
--without-libbsd: Refuse use of the libbsd compatibility library in WINGs utility library, +even if your system provides it. +
+
--disable-magick: Disable ImageMagick’s MagickWand support in WRaster, used to support for image formats. +
+
--enable-pango: Disabled by default, enable Pango text layout support in WINGs. +
+
--disable-png: Disable PNG support in WRaster; when enabled use libpng. +
+
--disable-tiff: Disable TIFF support in WRaster. when enabled use libtiff. +
+
--disable-webp: Disable WEBP support in WRaster. when enabled use libwebp. +
+
--disable-xpm: Disable use of libXpm for XPM support in WRaster, use internal code instead. +
+

The following options can be used to tell configure about extra paths that needs to be +used when compiling against libraries: +

--with-libs-from

specify additional paths for libraries to be searched. +The -L flag must precede each path, like: +

--with-libs-from="-L/opt/libs -L/usr/local/lib"
+

+ +

--with-incs-from

specify additional paths for header files to be searched. +The -I flag must precede each paths, like: +

--with-incs-from="-I/opt/headers -I/usr/local/include"
+

+ +

2.5.3 X11 and Extensions

configure will try to detect automatically the compilation paths for X11 headers and +libraries, and which X Extensions support can be enabled. +if you explicitly provide --enable-FEATURE then it will break with an error message +if the extension cannot be used; +if you specify --disable-FEATURE then it will not check for the extension. +

--x-includes=DIR

--x-libraries=DIR

Autoconf’s option to specify search paths for X11, +for the case were it would not have been able to detect it automatically. +

--disable-xlocale

If you activated support for Native Languages, then X11 may use a hack to also configure its +locale support when the program configure the locale for itself. +The configure script detects if the Xlib supports this or not; +this options explicitly disable this initialisation mechanism. +

--enable-modelock

XKB language status lock support. If you don’t know what it is you probably don’t need it. +The default is to not enable it. +

--disable-shm

Disable use of the MIT shared memory extension. +This will slow down texture generation a little bit, but in some cases it seems to be necessary due +to a bug that manifests as messed icons and textures. +

--disable-shape

Disables support for shaped windows (for oclock, xeyes, etc.). +

--enable-xinerama

The Xinerama extension provides information about the different screens connected when +running a multi-head setting (if you plug more than one monitor). +

--enable-randr

The RandR extension provides feedback when changing the multiple-monitor configuration in X11 +and allows to re-configure how screens are organised. +

At current time, it is not enabled by default because it is NOT recommended (buggy); +WINDOW MAKER only restart itself when the configuration change, to take into account the new +screen size. +

2.5.4 Feature Selection

--disable-animations

Disable animations permanently, by not compiling the corresponding code into WINDOW MAKER. +When enabled (the default), you still have a run-time configuration option in WPrefs. +

--disable-mwm-hints

Disable support for Motif’s MWM Window Manager hints. +These attributes were introduced by the Motif toolkit to ask for special window appearance requests. +Nowadays this is covered by the NetWM/EWMH specification, but there are still applications that rely on MWM Hints. +

--enable-wmreplace

Add support for the ICCCM protocol for cooperative window manager replacement. +This feature is disabled by default because you probably don’t need to switch seamlessly the window manager; +if you are making a package for a distribution you’d probably want to enable this because it allows users to give +a try to different window managers without restarting everything for an extra cost that is not really big. +

--disable-xdnd

Disable support for dragging and dropping files on the dock, which launches a user-specified command +with that file. +Starting from version 0.65.6 this feature is enabled by default. +

--enable-ld-version-script

This feature is auto-detected, and you should not use this option. +When compiling a library (wrlib, ...), gcc has the possibility to filter the list of +functions that will be visible, to keep only the public API, because it helps running programs +faster. +

The configure script checks if this feature is available; +if you specify this option it will not check anymore and blindly trust you that it is supposed to +work, which is not a good idea as you may encounter problems later when compiling. +

--enable-usermenu

This feature, disabled by default, allows to add a user-defined custom menu to applications; +when choosing an entry of the menu it will send the key combination defined by the user to that +application. See Application User Menu in NEWS for more information. +

--with-menu-textdomain=DOMAIN

Selection of the domain used for translation of the menus; +see Translations for Menus in README.i18n. +

2.5.5 Developer Stuff

These options are disabled by default: +

--config-cache

If you intend to re-run the configure script often, you probably want to include this +option, so it will save and re-use the status of what have been detected in the file +config.cache. +

--enable-debug

Enable debugging features (debug symbol, some extra verbosity and checks) and add a number of +check flags (warnings) for the compiler (in gcc fashion). +

--enable-lcov=DIRECTORY

Enable generation of code coverage and profiling data; +if the DIRECTORY is not specified, use coverage-report. +

This option was meant to be use with gcc; +it was not used recently so it is probable that is does not work anymore; +the configure script will not even check that your compiling environment has the +appropriate requirements and works with this. +Despite all this, if you think there’s a use for it and feel in the mood to help, do not hesitate to +discuss on the mailing list wmaker-dev@lists.windowmaker.org to get it working. +

3 Miscellaneous

3.1 Platform Specific Notes

- GNU/Linux in general + +
Make sure you have /usr/local/lib in /etc/ld.so.conf and that you +run ldconfig after installing. +Uninstall any packaged version of WINDOW MAKER before installing a new version. +
+
- RedHat GNU/Linux + +
RedHat systems have several annoying problems. +If you use it, be sure to follow the steps below or WINDOW MAKER will not work: +
+
- if you installed the WINDOW MAKER that comes with RedHat, uninstall it before upgrading; + +
- make sure you have /usr/local/bin in your PATH environment variable; + +
- make sure you have /usr/local/lib in /etc/ld.so.conf before running ldconfig; +
+ +
- PowerPC MkLinux + +
You will need to have the latest version of Xpmac. +Older versions seem to have bugs that cause the system to hang. +
+
- Debian GNU/Linux + +
If you want JPEG and TIFF support, make sure you have libtiff-dev +and libjpeg-dev installed. +
+
- SuSE GNU/Linux + +
If you installed the WINDOW MAKER package from SuSE, uninstall it before trying to +compile Window Maker or you might have problems. +
+
- MetroX (unknown version) + +
MetroX has a bug that corrupts pixmaps that are set as window backgrounds. +If you use MetroX and have weird problems with textures, do not use textures in title bars. +Or use a different X server. +
+

3.2 I don’t have the root password :(

If you can’t get superuser privileges (can’t be root) you can install Window Maker in your own +home directory. +For that, supply the --prefix option when running configure in step 2 of building +WINDOW MAKER. +You will also need to supply the --with-gnustepdir option, to specify the path for +WPrefs.app. +Example: +

./configure --prefix=/home/jshmoe --with-gnustepdir=/home/jshmoe/GNUstep/Applications
+

Then make /home/jshmoe/bin be included in your search PATH, add /home/jshmoe/lib +to your LD_LIBRARY_PATH environment variable and run bin/wmaker.inst +

Of course, /home/jshmoe is supposed to be replaced by your actual home directory path. +

3.3 Upgrading

If you are upgrading from an older version of WINDOW MAKER: +

Configure and build WINDOW MAKER as always +
Install WINDOW MAKER (but do not run wmaker.inst) +
Read the NEWS file and update your configuration files if necessary. +

4 Troubleshooting

When you have some trouble during configuration (while running configure), like not being able to +use a graphic format library you think you have installed, look at the config.log file for +clues of the problem. +

4.1 Error with loading fonts, even if they exist

This is probably a problem with NLS (Native Language Support), you probably want to look at the +Troubleshooting in README.i18n +or try rebuilding without NLS support, which is done with: +

./configure LINGUAS=""
+

4.2 configure doesn’t detect libtiff, or other graphic libraries

Delete config.cache, then rerun configure adding the following options to configure +(among the other options you use): +

--with-libs-from="-L/usr/local/lib"
+--with-incs-from="-I/usr/local/include -I/usr/local/include/tiff"
+

Put the paths where your graphic libs and their corresponding header files are located. +You can put multiple paths in any of these options, as the example of --with-incs-from shows. +Just put a space between them. +

4.3 configure doesn’t detect libXpm

Check if you have a symbolic link from libXpm.so.4.9 to libXpm.so +

4.4 Segmentation fault on startup

Check if the version of libXPM you have is at least 4.7 + +
Check if you have an updated version of ~/GNUstep/Defaults/WindowMaker +

If you’re not sure, try renaming ~/GNUstep to ~/GNUtmp +and then run wmaker.inst +

4.5 "...: your machine is misconfigured. gethostname() returned (none)"

the host name of your machine is set to something invalid, that starts with a parenthesis. +Do a man hostname for info about how to set it. +

4.6 The root menu contains only 2 entries. ("XTerm" and "Exit...")

WINDOW MAKER could not read your menu definition file. +You should check the output of wmaker for an error, it may be visible in the console or in the +.xsession-errors file. +