
SUPPORTED PLATFORMS 
===================
(eg: I've heard someone has compiled it on...)

- intel/Linux (primary platform)
- PowerPC/MkLinux
- FreeBSD
- Solaris 2.5.1
- SCO Unix
- Irix
- OSF/1
- HP-UX
Patches to make it work on other platforms are welcome.


REQUIREMENTS:
=============
- X11R6		
	WindowMaker can be compiled in older versions of X, like X11R5
	(Solaris) or X11R4 (OpenWindows) but it will not work correctly.

- libXPM 4.7 	
	Older versions may not work!!! 


RECOMMENDED:
============
- libpng 0.96 and zlib     
	For PNG image support

CONFIGURE OPTIONS:
==================
--disable-xpm   disables use of the XPM library even if it is available on
	your system. 

--disable-png	disables use of PNG library

--disable-shape  disables shaped windows (for oclock, xeyes etc.)

--enable-debug	adds extra debugging information. Do not use it
	unless you're debugging WindowMaker.
	
--enable-newstyle    uses a different style of buttons in titlebars.

--enable-kanji	support to display Kanji characters, Korean, Chinese 
		and other languagues

--enable-superfluous  adds some extra superfluous animations

OPTIONS FOR WRLIB:
==================
--disable-png	disables support for PNG using libpng



PLATFORM SPECIFIC NOTES:
========================
- SCO Unix - run configure like
	CFLAGS="-belf -DANSICPP" ./configure 

- SunOS, Solaris 
	If you have gcc installed, after running configure, edit
	src/config.h and change the #define CPP_PATH line to
	#define CPP_PATH "gcc -E -"
	Sun's cpp lacks some features needed by WindowMaker and it can
	cause problems when parsing the config files.


INSTALLATION:
=============

Quick Installation:
-------------------

The following will build and install WindowMaker in the default
installation directory (/usr/local/bin, /usr/local/lib)

% build
% su root
% make install
% rehash
% wmaker.inst
% add  
	sh ~/gnustep/Library/WindowMaker/winitrc 
	exec wmaker
in ~/.xinitrc or equivalent

Normal Installation:
--------------------
Edit src/wconfig.h for button style and other options. Also, check the 
paths section.
Look at the LOCALE section if you want national language support.

% ./configure 
% make 
% mkdir ~/gnustep
% cp -r Library ~/gnustep/Library
% su root
% make install
% add  
	sh ~/gnustep/Library/WindowMaker/winitrc
	exec wmaker
in ~/.xinitrc or equivalent

The wmaker.inst script can be used by users to install the necessary 
configuration files to their own directories.


Sample .xinitrc file:
---------------------

sh ~/gnustep/Library/WindowMaker/winitrc&
wmaker


After installing, each user that wishes to use WindowMaker must run the 
wmaker.inst script.


LOCALES
=======
WindowMaker has national language support. 
To enable national language support, you must compile
WindowMaker with some additional parameters. 

0 - You must have the GNU gettext package installed. It can be
obtained at ftp://prep.ai.mit.edu/pub/gnu/gettext-nnn.tar.gz

(Usually, you can skip the rest if you use the build script)

1 - You have to select the languages you want to support. Set the
LINGUAS to the list of locales you want. English is always
suported. Example:

setenv LINGUAS "pt ja de"
in csh

or

export LINGUAS;LINGUAS="pt ja de"
in sh

The list supported locales is:

pt	Portuguese
jp	Japanese
de	German
es	Spanish
se	Swedish
ko	Korean
cz	Czech
nl	Dutch
fr	French
gl	Galician

Besides English, which is the default language.

Contact me if you'd wish to translate and maintain locale files 
for other languages.


2 - Additionally, if your language uses multi-byte characters, such
as japanese or chinese, you must edit src/wconfig.h and define I18N_MB.


3 - Configure, build and install WindowMaker normally.


To select a particular locale at runtime you must set the LANG environment
variable to the locale you want. For example, if you want to
set the portuguese locale, you must run

setenv LANG pt

in csh or

export LANG; LANG=pt

in Bourne sh and similars

Note: If you have the LC_CTYPE environment variable set, you must
unset it before running wmaker.

For menu definition files, WindowMaker searches for them in the
following order (for brazilian portuguese, in this case):

menu.pt_BR
menu.pt
menu


TROUBLESHOOTING
===============

== Segmentation fault on startup

* Check if the version of libXPM you have is at least 4.7

* Verify if your cpp removes // comments appropriately. Test with
/your_cpp_path/cpp ~/gnustep/Library/WindowMaker/preferences. If all
// comments are not removed, edit CPP_ARGS in src/wconfig.h to include the
argument needed by your cpp to recognize // comments.



== "...: invalid colormap size in line ..."

* You may have specified a colormap size larger than it is
possible in the preferences file. Lower DitherColormap values.

* You're using a monochrome server. WindowMaker doesn't support
monochrome dithering yet.


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

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


== Multibyte I18N doesn't work

* Try to rebuild wmaker with the #define X_LOCALE in src/wconfig.h uncommented
or commented if it already was.

* Try other things noted in the FAQ

== Strange problems with pixmaps, gradients, icons etc.
	Try replacing your preference files with the files included in this
	distribution.

