*** empty log message ***
[wmaker-crm.git] / INSTALL
blobd1028802a51227bb59d415573f93f4efa915b275
2                 Installation Instructions for Window Maker
6 SUPPORTED PLATFORMS
7 ===================
8 (ie: I've heard someone has compiled it on...)
10 - Intel GNU/Linux Slackware 3.5 (primary platform)
11 - Intel GNU/Linux other distributions
12 - Sparc GNU/Linux RedHat 5.1
13 - PowerPC GNU/MkLinux
14 - Alpha GNU/Linux RedHat 5.1
15 - FreeBSD
16 - NetBSD
17 - OpenBSD
18 - BSDI 4.0
19 - Solaris 2.5.1, 2.5.2
20 - Solaris 2.6.0
21 - Solaris 2.7beta
22 - SCO Unix
23 - SGI Irix 5.x, 6.5
24 - OSF/1
25 - HP-UX
26 - AIX 3.2.5
27 - AIX 4.1.4 / IBM PowerPC
28 - AIX 4.3.1 / IBM CC compiler
29 - AIX 4.3.2 / IBM PowerPC
30 - AIX 5.3
31 - DEC Alpha/Digital UNIX 4.x
32 - XFree86 / OS/2
33 - Corel NetWinder
34 - SunOS 4.x
35 - PowerMac / Power MachTen 4.1.1 over MacOS
36 - Amiga 3000 running RedHat Linux 5.1 (Rawhide)
38 Patches to make it work on other platforms are welcome. 
40 If the latest version doesn't work for you, try 0.19.3, 
41 which is known to be pretty stable on many platforms.
44 REQUIREMENTS:
45 =============
47 The following software is required to use Window Maker:
49 - X11R6.x       
50         Window Maker can be compiled in older versions of X, like X11R5
51         (Solaris) or X11R4 (OpenWindows) but it will not work 100% correctly.
52         In such servers there will not be application icons and you'll have
53         trouble using the dock. Upgrading the client libraries (Xlib, Xt etc)
54         will help if you can't upgrade the server.
56 The following is required to build Window Maker:
58 - Basic obvious stuff
59         If you will build Window Maker, make sure you have gcc (or some
60         other ANSI C compiler) and the X header files installed. Specially
61         for newbie Linux users: you must install all X development packages
62         and the gcc suite. Otherwise you won't be able to build any X
63         program, including Window Maker.
65 - libPropList
66         This library can be found in ftp://ftp.windowmaker.org/pub/libs
67         or in ftp://ftp.gnome.org/pub/libPropList
68         Install it before building Window Maker.
70 - autoconf, automake and libtool
71         These tools are NOT needed, but IF you have one or
72         more of them installed, make sure you have ALL of the following 
73         with exactly these versions:
74                 autoconf 2.13
75                 automake 1.4
76                 libtool 1.3
77         If you have a different version, disable them by temporarily
78         renaming them to something else or uninstalling them from your
79         system. If you don't develop software you don't need them,
80         so you can safely uninstall. 
82 - lex (or flex) and yacc (or bison)
83         These are used by libPropList. lex is actually not needed since
84         it's output file is included, but either me or automake is stupid,
85         causing the configure script for libPropList to simply abort for no
86         convincent reason if lex is not found.
89 OPTIONAL:
90 =========
92 These libraries are not required to make Window Maker work, but they
93 are supported in case you want to use them. Version numbers are those
94 that I have (and therefore, guraranteed to work), but other versions
95 might work too. 
98 - libXPM 4.7 or newer
99         Older versions may not work!!! 
100         Available at ftp://sunsite.unc.edu/pub/Linux/libs/X/
102         There is builtin support for XPM files, but it will not
103         load images in some uncommon encodings.
105 - libpng 0.96 or newer and zlib     
106         For PNG image support.
107         http://www.cdrom.com/pub/png/
109 - libtiff 3.4 or newer
110         For TIFF image support.
111         You can get it at ftp://ftp.sgi.com/graphics/tiff
113 - libjpeg 6.0.1 or newer
114         For JPEG image support
115         http://www.ijg.org/
117 - libgif 2.2 or libungif
118         For GIF image support
119         ftp://prtr-13.ucsc.edu/pub/libungif/
121 - GNU xgettext
122         If you want to use translated messages, you will need GNU gettext.
123         Other versions of gettext are not compatible and will not work.
124         Get the GNU version from ftp://ftp.gnu.org
128 CONFIGURE OPTIONS:
129 ==================
131 These options can be passed to the configure script to enable/disable
132 some Window Maker features. Example:
134 ./configure --enable-kde --enable-gnome
136 will configure Window Maker with KDE and GNOME supported compiled in.
139 To get a list of other options, run ./configure --help
141 --with-libs-from
142         specify additional paths for libraries to be searched.
143         The -L flag must precede each path, like:
144         --with-libs-from="-L/opt/libs -L/usr/local/lib"
146 --with-incs-from
147         specify additional paths for header files to be searched.
148         The -I flag must precede each paths, like:
149         --with-incs-from="-I/opt/headers -I/usr/local/include"
151 --enable-single-icon
152         enables the collapsing of all appicons of the WM_CLASS+WM_INSTANCE
153         into a single one. This feature is not supported at all by the
154         developers. If you have some trouble with it, contact it's author:
155         Christopher Seawood <cls@seawood.org>
157 --disable-shm
158         disable use of the MIT shared memory extension. This will slow down
159         texture generation a little bit, but in some cases it seems to be
160         necessary due to a bug that manifests as messed icons and textures.
162 --disable-motif 
163         disable support for mwm window manager hints
165 --enable-openlook
166         enable support for OPEN LOOK(tm) window manager hints
168 --enable-gnome
169         enable support for GNOME window manager hints
171 --enable-kde
172         enable support for kde/kwm window manager hints
174 --enable-lite
175         remove things that are already supported in desktop environments,
176         like KDE and GNOME. Disabled things are: window list, root
177         applications menu, multiple window selection. Note that you will not
178         be able to exit Window Maker from itself anymore; you will have to
179         use kill with the SIGTERM signal or exit it from KDE. It is not
180         advisable to enable it.
182 --enable-modelock
183         XKB language status lock support. If you don't know what it is you
184         probably don't need it.
186 --enable-sound  
187         enable support of sound effects module
189 --disable-xpm   
190         disables use of the XPM library even if it is available on your
191         system.
193 --disable-png   
194         disables use of PNG library
196 --disable-tiff
197         disable use of TIFF library
199 --disable-gif
200         disable use of GIF library
202 --disable-jpeg
203         disable use of JPEG library
205 --disable-shape
206         disables shaped windows (for oclock, xeyes etc.)
208 --enable-debug
209         Do not use it unless you know what you're doing.
212 PLATFORM SPECIFIC NOTES:
213 ========================
215 - DEC/Alpha machines
216         You might need to pass the --disable-shm flag to configure, like
217         ./configure --disable-shm
219 - SCO Unix - run configure like
220         CFLAGS="-belf -DANSICPP" ./configure 
222 - SunOS, Solaris 
223         If you have gcc installed, run configure as:
224         CPP_PATH="gcc -E -x c" ./configure
225         Sun's cpp lacks some features needed by Window Maker and it can
226         cause problems when parsing the config files.
227         You also might need to use the --with-libs-from and --with-incs-from
228         to supply the directory where libtiff is located.
229         Someone mailed me that you also must make /usr/local/lib be the
230         first path in LD_LIBRARY_PATH to make it work.
232         If you have a Ultra Creator 3D or some other machine with high-end
233         graphics, be sure to start the X server with the default visual
234         set to 24bpp or you might experience problems with mangled colors.
235         This is a wmaker bug and will be fixed.
237 - GNU/Linux in general
238         Make sure you have /usr/local/lib in /etc/ld.so.conf and that you
239         run ldconfig after installing.
240         Uninstall any packaged version of Window Maker before installing a new
241         version. 
243 - RedHat GNU/Linux
244         RedHat systems have several annoying problems. If you use it, 
245         be sure to follow the steps below or Window Maker will not work:
247         * if you installed the Window Maker that comes with RedHat, uninstall
248         it before upgrading;
250         * make sure you don't have the LANG and LINGUAS environment variables
251         set to en_RN;
253         * make sure you have /usr/local/bin in your PATH environment
254         variable;
256         * make sure you have /usr/local/lib in /etc/ld.so.conf before running
257         ldconfig;
259         * if you have problems that mention an error message with --no-reexec
260         uninstall libtool-1.2b and install libtool-1.3 instead. libtool-1.3
261         can be found in ftp.gnu.org  Also read the TROUBLESHOOTING section;
263         * if you installed the Window Maker package from RedHat and are
264         installing a new version of it by hand (compiling yourself), uninstall
265         the package from RedHat before.
267         * make sure you have a symbolic link from /usr/include/X11 to
268         /usr/X11R6/include/X11 (if not, type ln -s /usr/X11R6/include/X11
269         /usr/include/X11 )
271         * make sure you have /lib/cpp pointing to the cpp program
273         If you have any doubts in doing any of the stuff above, please
274         don't hesitate to contact the RedHat user support. They will
275         kindly answer to all your questions regarding their system.
276         They also know much more about their own system than us 
277         (we don't use RedHat).
280 - PowerPC MkLinux
281         You will need to have the latest version of Xpmac. Older versions
282         seem to have bugs that cause the system to hang.
284 - Debian GNU/Linux
285         If you want JPEG and TIFF support, make sure you have libtiff-dev 
286         and libjpeg-dev installed.
288 - SuSE GNU/Linux
289         If you installed the Window Maker package from SuSE,
290         uninstall it before trying to compile wmaker or you
291         might have problems.
293 - MetroX (unknown version)
294         MetroX has a bug that corrupts pixmaps that are set as window
295         backgrounds. If you use MetroX and has weird problems with
296         textures, do not use textures in titlebars. Or use a different
297         X server.
299 INSTALLATION:
300 =============
302 Unpack WindowMaker-extra-<version-number>.tar.gz in /usr/local/share
304 You can get the file at ftp://ftp.windowmaker.org. This file is optional
305 and only have a few icons, and themes. Look for the latest <version-number>
306 available.
307 Also there is a WindowMaker-extra.readme to instruct you where that package
308 should go.
311 Build Window Maker
312 ------------------
313         For a quick start, type the following in your shell prompt:
315         ./configure
316         make
318 then, login as root and type:
320         make install
321         ldconfig
323 or if you want to strip the debugging symbols from the binaries and make them
324 smaller, you can instead type:
326         make install-strip
327         ldconfig
329 This will build and install Window Maker with default parameters.
331 If you want to customize some compile-time options, you can do the
332 following. 
334         1. (optional) Look at the CONFIGURE OPTIONS section above for the 
335         options available. Also run:
337         ./configure --help
339         to get a complete listing of other options that are available.
341         2. Run configure with the options you want. For example, if you
342         want to use the --enable-kde option, type:
344         ./configure --enable-kde
346         3. (optional) Edit src/wconfig.h with your favorite text editor 
347         and browse through it for some options you might want to change.
349         4. Compile. Just type:
351         make
353         5. Login as root (if you can't do that, read the "I don't have the 
354         root password :-(" section) and install Window Maker in your system:
355                 su root
356                 make install
359 User specific configuration
360 ---------------------------
362 These instructions do not need to be followed when upgrading Window Maker
363 from an older version, unless stated differently in the NEWS file.
365 Every user on your system that wishes to run Window Maker must do the
366 following:
368         1. Install Window Maker configuration files in your home directory.
369 Type:
370         wmaker.inst
372         wmaker.inst will install Window Maker configuration files and will
373 setup X to automatically launch Window Maker at startup.
375         That's it! 
376         
377         You can type "man wmaker" to get some general help for configuration
378 and other stuff.
380 Read the User Guide for a more in-depth explanation of Window Maker.
382 You might want to take a look at the FAQ too.
385 I don't have the root password :(
386 ---------------------------------
388 If you can't get superuser privileges (can't be root) you can install
389 wmaker in your own home directory. For that, supply the --prefix option
390 when running configure in step 2 of building Window Maker. You will
391 also need to supply the --with-appspath option, to specify the path for
392 WPrefs.app Example:
394 ./configure --prefix=/home/jshmoe --with-appspath=/home/jshmoe/GNUstep/Apps
397 Then make /home/jshmoe/bin be included in your search PATH, add
398 /home/jshmoe/lib to your LD_LIBRARY_PATH environment variable and run 
399 bin/wmaker.inst
401 Of course, /home/jshmoe is supposed to be replaced with your actual home
402 directory path.
406 UPGRADING
407 =========
409 If you are upgrading from an older version of Window Maker:
411         1. Configure and build Window Maker as always
412         2. Install Window Maker (but do not run wmaker.inst)
413         3. Read the NEWS file and update your configuration files, 
414            if necessary.
416 TROUBLESHOOTING
417 ===============
419 When you have some trouble during configuration (while running configure),
420 like not being able to use a graphic format library you think you have
421 installed, look at the config.log file for clues of the problem.
424 == Error with loading fonts, even if they exist.
426 Try rebuilding without NLS support.
428 == Error when configuring
430 ltconfig: unrecognized option `--no-reexec'
431 Try `ltconfig --help' for more information.
432 configure: error: libtool configure failed
434 remove the --no-reexec option from aclocal.m4 and libPropList/aclocal.m4
435 and reconfigure
436 Also make sure the autoconf and automake versions you have installed are:
437 autoconf 2.13
438 automake 1.4
439 libtool 1.3
441 Note that it must not be libtool 1.2b, it must be libtool 1.3, 
442 from the GNU sites.
444 == Cant find proplist.h or libPropList.something
446 Download and install libPropList from the places pointed to
447 somewhere else in this file.
450 == configure doesn't detect libtiff, or other graphic libraries.
452 Delete config.cache, then rerun configure adding the following options to
453 configure (among the other options you use):
454 --with-libs-from="-L/usr/local/lib"
455 --with-incs-from="-I/usr/local/include -I/usr/local/include/tiff"
456 Put the paths where your graphic libs and their corresponding header files are
457 located. You can put multiple paths in any of these options, as the example
458 of --with-incs-from shows. Just put a space between them.
461 == configure doesn't detect libXpm. 
463 * Check if you have a symbolic link from libXpm.so.4.9 to libXpm.so
466 == Segmentation fault on startup
468 * Check if the version of libXPM you have is at least 4.7
470 * Check if you have an updated version of ~/GNUstep/Defaults/WindowMaker
472 If you're not sure, try renaming ~/GNUstep to ~/GNUtmp and then run wmaker.inst
474 == "...: your machine is misconfigured. gethostname() returned (none)"
476 * the hostname of your machine is set to something invalid, that starts
477         with a parenthesis. Do a man hostname for info about how to set it.
480 == The root menu contains only 2 entries. ("XTerm" and "Exit...")
482 * Window Maker is not finding cpp (the C preprocessor). If your cpp is
483 not located in /lib/cpp, edit src/config.h and correct the path in
484 CPP_PATH.
486 == checking lex output file root... configure: error: cannot find output from true; giving up
488 * Read the REQUIREMENTS section of this file.
491 LOCALES/INTERNATIONALIZATION
492 ============================
494 Window Maker has national language support. To enable national language
495 support, you must compile Window Maker with some additional parameters.
498 0 - You must have the GNU gettext package installed. It can be
499 obtained at ftp://prep.ai.mit.edu/pub/gnu/gettext-nnn.tar.gz
501 Steps 1 to 3 can be skipped if you use the Install script.
503 1 - You have to select the languages you want to support. Set the
504 LINGUAS to the list of locales you want. English is always
505 suported. Example:
507 setenv LINGUAS "pt ja de"
508 in csh
512 export LINGUAS;LINGUAS="pt ja de"
513 in sh
515 The list of supported locales can be found in po/README.
516 English is the default language.
518 Read po/README if you wish to translate and maintain locale files 
519 for other languages.
521 2 - Additionally, if your language uses multi-byte characters, such
522 as Japanese or Korean, you must set the MultiByteText option to YES
523 in ~/GNUstep/Defaults/WMGLOBAL and ~/GNUstep/Defaults/WindowMaker
525 3 - Configure, build and install Window Maker normally.
527 4 - To select a particular locale at runtime you must set the LANG
528 environment variable to the locale you want. For example, if you want to set
529 the portuguese locale, you must run
531 setenv LANG pt
533 in csh or
535 export LANG; LANG=pt
537 in Bourne sh and similars
539 Note: If you have the LC_CTYPE environment variable set, you must
540 unset it before running wmaker.
542 For menu definition files, Window Maker searches for them in the
543 following order (for brazilian portuguese, in this case):
545 menu.pt_BR
546 menu.pt
547 menu
550 5 - If you chose a language that uses multi-byte characters, you must
551 configure the fonts appropriately. Read the manual page for XCreateFontSet
552 to have more details about it. You must change the ~/G/D/WindowMaker file
553 for fonts used in titlebars, menus and other things. For fonts used in
554 dialog windows, change ~/G/D/WMGLOBAL. The %d in the font names must not be
555 removed. You can also use the supplied wsetfont script for the task.
556 Read the script itself for instructions.
558 For example, you can specify the following in ~/G/D/WindowMaker:
560 WindowTitleFont = "-*-helvetica-bold-r-normal-*-12-*,-*-*-medium-r-normal-*-14-*";
561 MenuTitleFont = "-*-helvetica-bold-r-normal-*-12-*,-*-*-medium-r-normal-*-14-*";
562 MenuTextFont = "-*-helvetica-medium-r-normal-*-12-*,-*-*-medium-r-normal-*-14-*";
563 IconTitleFont = "-*-helvetica-medium-r-normal-*-8-*,-*-*-medium-r-normal-*-12-*";
564 ClipTitleFont = "-*-helvetica-bold-r-normal-*-10-*,-*-*-medium-r-normal-*-12-*";
565 DisplayFont = "-*-helvetica-medium-r-normal-*-12-*,-*-*-medium-r-normal-*-12-*";
567 and in ~/G/D/WMGLOBAL:
569 SystemFont = "-*-*-medium-r-normal-*-%d-*-*-*-*-*-*-*";
570 BoldSystemFont = "-*-*-medium-r-normal-*-%d-*-*-*-*-*-*-*";
572 The above 2 fonts are only used by applications that use WINGs (WindowMaker
573 and WPrefs.app)
575 The wsetfont script that's supplied will allow you to change the font
576 settings in a easier way. Take a look in the script for details on usage.