Use inotify to check for changes to the defaults database. Workaround for
[wmaker-crm.git] / INSTALL
1
2                 Installation Instructions for Window Maker
3
4
5
6 SUPPORTED PLATFORMS
7 ===================
8 (ie: I've heard someone has compiled it on...)
9
10 - Intel GNU/Linux Conectiva 5.9 (beta)
11 - Intel GNU/Linux Slackware
12 - Intel GNU/Linux Debian
13 - Intel GNU/Linux other distributions
14 - Sparc GNU/Linux RedHat 5.1
15 - PowerPC GNU/MkLinux
16 - Alpha GNU/Linux RedHat 5.1
17 - FreeBSD
18 - NetBSD
19 - OpenBSD
20 - BSDI 4.0
21 - Solaris 2.5.1, 2.5.2
22 - Solaris 2.6.0
23 - Solaris 2.7beta
24 - Solaris 2.8 on Ultra Sparc 10 and E450
25 - SCO Unix
26 - SGI Irix 5.x, 6.5
27 - OSF/1
28 - HP-UX
29 - AIX 3.2.5
30 - AIX 4.1.4 / IBM PowerPC
31 - AIX 4.3.1 / IBM CC compiler
32 - AIX 4.3.2 / IBM PowerPC
33 - AIX 5.3
34 - DEC Alpha/Digital UNIX 4.x
35 - XFree86 / OS/2
36 - Corel NetWinder
37 - SunOS 4.x
38 - PowerMac / Power MachTen 4.1.1 over MacOS
39 - Amiga 3000 running RedHat Linux 5.1 (Rawhide)
40 - IBM S/390 running Linux
41 - IBM S/390 running Conectiva Linux (experimental)
42 - iBook running Darwin
43 - Darwin PPC / Macos X
44 - Windows NT with Cygwin/XFree86
45 - Sony PlayStation2 running Linux
46
47 All registered trademarks are registered by their owners. (duh)
48
49 Patches to make it work on other platforms are welcome. 
50
51
52 REQUIREMENTS:
53 =============
54
55 The following software is required to use Window Maker:
56
57 - X11R6.x       
58         Window Maker can be compiled in older versions of X, like X11R5
59         (Solaris) or X11R4 (OpenWindows) but it will not work 100% correctly.
60         In such servers there will not be application icons and you'll have
61         trouble using the dock. Upgrading the client libraries (Xlib, Xt etc)
62         will help if you can't upgrade the server.
63
64 The following is required to build Window Maker:
65
66 - Basic obvious stuff
67         gcc (or some other ANSI C compiler)
68         glibc development files (usually glibc-devel in Linux distributions)
69         X development files (XFree86-devel or something similar)
70
71 - autoconf, automake and libtool
72         autoconf 2.54
73         automake 1.4
74         libtool 1.4.2
75
76 - Xft2
77         and its dependencies (such as freetype2 and fontconfig)
78         You will also need the development files for it (xft2-devel)
79
80
81 OPTIONAL:
82 =========
83
84 These libraries are not required to make Window Maker work, but they
85 are supported in case you want to use them. Version numbers are those
86 that I have (and therefore, guraranteed to work), but other versions
87 might work too. 
88
89
90 - libXPM 4.7 or newer
91         Older versions may not work!!! 
92         Available at ftp://sunsite.unc.edu/pub/Linux/libs/X/
93
94         There is builtin support for XPM files, but it will not
95         load images in some uncommon encodings.
96
97 - libpng 0.96 or newer and zlib     
98         For PNG image support.
99         http://www.cdrom.com/pub/png/
100
101 - libtiff 3.4 or newer
102         For TIFF image support.
103         You can get it at ftp://ftp.sgi.com/graphics/tiff
104
105 - libjpeg 6.0.1 or newer
106         For JPEG image support
107         http://www.ijg.org/
108
109 - libgif 2.2 or libungif
110         For GIF image support
111         ftp://prtr-13.ucsc.edu/pub/libungif/
112
113 - GNU xgettext
114         If you want to use translated messages, you will need GNU gettext.
115         Other versions of gettext are not compatible and will not work.
116         Get the GNU version from ftp://ftp.gnu.org
117
118
119
120 CONFIGURE OPTIONS:
121 ==================
122
123 If you downloaded the cvs or git versions, type
124
125 ./autogen.sh
126
127 to generate the config files.
128
129 These options can be passed to the configure script to enable/disable
130 some Window Maker features. Example:
131
132 ./configure --enable-modelock --disable-gif
133
134 will configure Window Maker with modelock supported and disable gif support.
135 Normally, you won't need any of them.
136
137 To get a list of other options, run ./configure --help
138
139 --with-libs-from
140         specify additional paths for libraries to be searched.
141         The -L flag must precede each path, like:
142         --with-libs-from="-L/opt/libs -L/usr/local/lib"
143
144 --with-incs-from
145         specify additional paths for header files to be searched.
146         The -I flag must precede each paths, like:
147         --with-incs-from="-I/opt/headers -I/usr/local/include"
148
149 --disable-shm
150         disable use of the MIT shared memory extension. This will slow down
151         texture generation a little bit, but in some cases it seems to be
152         necessary due to a bug that manifests as messed icons and textures.
153
154 --disable-motif 
155         disable support for mwm window manager hints
156
157 --enable-lite
158         remove things that are already supported in desktop environments,
159         like KDE and GNOME. Disabled things are: window list, root
160         applications menu, multiple window selection. Note that you will not
161         be able to exit Window Maker from itself anymore; you will have to
162         use kill with the SIGTERM signal or exit it from KDE. It is not
163         advisable to enable it.
164
165 --enable-modelock
166         XKB language status lock support. If you don't know what it is you
167         probably don't need it.
168
169 --disable-xpm   
170         disables use of the XPM library even if it is available on your
171         system.
172
173 --disable-png   
174         disables use of PNG library
175
176 --disable-tiff
177         disable use of TIFF library
178
179 --disable-gif
180         disable use of GIF library
181
182 --disable-jpeg
183         disable use of JPEG library
184
185 --disable-shape
186         disables shaped windows (for oclock, xeyes etc.)
187
188
189 PLATFORM SPECIFIC NOTES:
190 ========================
191
192 - DEC/Alpha machines
193
194 #>>>>>>>>>>>
195 From: Anton Ivanov <aivanov@eu.level3.net>
196 To: Marcelo E. Magallon <mmagallo@debian.org>
197 Subject: Re: Is the WindowMaker package working ok on Alpha?
198
199 > Hi,
200
201 >  I was reading some docs on the WindowMaker tarball, and found this:
202
203 >  | - DEC/Alpha machines
204 >  |         You might need to pass the --disable-shm flag to configure,
205 >  |         like ./configure --disable-shm
206
207 >  is anyone having problems with WindowMaker on Alpha?  Can someone
208 >  please test this?  Should the flag be passed when building on Alpha?
209
210 Disclaimer: alphas under my command have never run X and are least likely to 
211 suddenly start running it anytime soon.
212
213         Alpha used to have some ridiculously low amount of shared memory
214 configured. 
215 So quite a lot of apps used to barf. Namely - cdrecord, mysql server, etc.
216
217         Check where is yours at the moment and raise it to a more appropriate
218 value by either catting to the appropriate /proc entry or changing the
219 /usr/src/linux/include/asm/shmparam.h.
220
221         Otherwise the shared memory on alpha should be fully functional and I
222 see no reason to disable it. Mine are bumped up to 32 or more on most
223 machines.
224
225         And If I recall correctly the comments in that file are actually
226 wrong. Value is not bytes, but in machine size word. For alpha *8.
227
228         As I said - I do not run X on them so all #include "stdisclaimer.h"
229 apply.
230 #<<<<<<<<<<<<
231
232
233 - SCO Unix - run configure like
234         CFLAGS="-belf -DANSICPP" ./configure 
235
236 - SunOS, Solaris 
237         If you have gcc installed, run configure as:
238         CPP_PATH="gcc -E -x c" ./configure
239         Sun's cpp lacks some features needed by Window Maker and it can
240         cause problems when parsing the config files.
241         You also might need to use the --with-libs-from and --with-incs-from
242         to supply the directory where libtiff is located.
243         Someone mailed me that you also must make /usr/local/lib be the
244         first path in LD_LIBRARY_PATH to make it work.
245
246         If you have a Ultra Creator 3D or some other machine with high-end
247         graphics, be sure to start the X server with the default visual
248         set to 24bpp or you might experience problems with mangled colors.
249         This is a wmaker bug and will be fixed.
250
251 - GNU/Linux in general
252         Make sure you have /usr/local/lib in /etc/ld.so.conf and that you
253         run ldconfig after installing.
254         Uninstall any packaged version of Window Maker before installing a new
255         version. 
256
257 - RedHat GNU/Linux
258         RedHat systems have several annoying problems. If you use it, 
259         be sure to follow the steps below or Window Maker will not work:
260
261         * if you installed the Window Maker that comes with RedHat, uninstall
262         it before upgrading;
263
264         * make sure you don't have the LANG and LINGUAS environment variables
265         set to en_RN;
266
267         * make sure you have /usr/local/bin in your PATH environment
268         variable;
269
270         * make sure you have /usr/local/lib in /etc/ld.so.conf before running
271         ldconfig;
272
273 - PowerPC MkLinux
274         You will need to have the latest version of Xpmac. Older versions
275         seem to have bugs that cause the system to hang.
276
277 - Debian GNU/Linux
278         If you want JPEG and TIFF support, make sure you have libtiff-dev 
279         and libjpeg-dev installed.
280
281 - SuSE GNU/Linux
282         If you installed the Window Maker package from SuSE,
283         uninstall it before trying to compile wmaker or you
284         might have problems.
285
286 - MetroX (unknown version)
287         MetroX has a bug that corrupts pixmaps that are set as window
288         backgrounds. If you use MetroX and has weird problems with
289         textures, do not use textures in titlebars. Or use a different
290         X server.
291
292 INSTALLATION:
293 =============
294
295 Build Window Maker
296 ------------------
297         For a quick start, type the following in your shell prompt:
298
299         ./configure
300         make
301
302 then, login as root and type:
303
304         make install
305         ldconfig
306
307 or if you want to strip the debugging symbols from the binaries and make them
308 smaller, you can instead type:
309
310         make install-strip
311         ldconfig
312
313 This will build and install Window Maker with default parameters.
314
315 If you want to customize some compile-time options, you can do the
316 following. 
317
318         1. (optional) Look at the CONFIGURE OPTIONS section above for the 
319         options available. Also run:
320  
321         ./configure --help
322
323         to get a complete listing of other options that are available.
324
325         2. Run configure with the options you want. For example, if you
326         want to use the --enable-modelock option, type:
327
328         ./configure --enable-modelock
329
330         3. (optional) Edit src/wconfig.h with your favorite text editor 
331         and browse through it for some options you might want to change.
332
333         4. Compile. Just type:
334
335         make
336
337         5. Login as root (if you can't do that, read the "I don't have the 
338         root password :-(" section) and install Window Maker in your system:
339                 su root
340                 make install
341
342
343 User specific configuration
344 ---------------------------
345
346 These instructions do not need to be followed when upgrading Window Maker
347 from an older version, unless stated differently in the NEWS file.
348
349 Every user on your system that wishes to run Window Maker must do the
350 following:
351
352         1. Install Window Maker configuration files in your home directory.
353 Type:
354         wmaker.inst
355
356         wmaker.inst will install Window Maker configuration files and will
357 setup X to automatically launch Window Maker at startup.
358
359         That's it! 
360         
361         You can type "man wmaker" to get some general help for configuration
362 and other stuff.
363
364 Read the User Guide for a more in-depth explanation of Window Maker.
365
366 You might want to take a look at the FAQ too.
367
368
369
370 Installing the extras package
371 -----------------------------
372
373 Unpack WindowMaker-extra-<version-number>.tar.gz in /usr/local/share
374         
375 You can get the file at ftp://ftp.windowmaker.info. This file is optional
376 and only have a few icons, and themes. Look for the latest <version-number>
377 available.
378 Also there is a WindowMaker-extra.readme to instruct you where that package
379 should go.
380
381
382
383 I don't have the root password :(
384 ---------------------------------
385
386 If you can't get superuser privileges (can't be root) you can install
387 wmaker in your own home directory. For that, supply the --prefix option
388 when running configure in step 2 of building Window Maker. You will
389 also need to supply the --with-appspath option, to specify the path for
390 WPrefs.app Example:
391
392 ./configure --prefix=/home/jshmoe --with-appspath=/home/jshmoe/GNUstep/Applications
393
394
395 Then make /home/jshmoe/bin be included in your search PATH, add
396 /home/jshmoe/lib to your LD_LIBRARY_PATH environment variable and run 
397 bin/wmaker.inst
398
399 Of course, /home/jshmoe is supposed to be replaced with your actual home
400 directory path.
401
402
403
404 UPGRADING
405 =========
406
407 If you are upgrading from an older version of Window Maker:
408
409    1. Configure and build Window Maker as always
410    2. Install Window Maker (but do not run wmaker.inst)
411    3. Read the NEWS file and update your configuration files if necessary.
412
413
414 TROUBLESHOOTING
415 ===============
416
417 When you have some trouble during configuration (while running configure),
418 like not being able to use a graphic format library you think you have
419 installed, look at the config.log file for clues of the problem.
420
421
422 == Error with loading fonts, even if they exist.
423
424 Try rebuilding without NLS support.
425
426 == Error when configuring
427
428 ltconfig: unrecognized option `--no-reexec'
429 Try `ltconfig --help' for more information.
430 configure: error: libtool configure failed
431
432 remove the --no-reexec option from aclocal.m4 and reconfigure
433 Also make sure the autoconf and automake versions you have installed are:
434 autoconf 2.13
435 automake 1.4
436 libtool 1.3
437
438 Note that it must not be libtool 1.2b, it must be libtool 1.3, 
439 from the GNU sites.
440
441 == configure doesn't detect libtiff, or other graphic libraries.
442
443 Delete config.cache, then rerun configure adding the following options to
444 configure (among the other options you use):
445 --with-libs-from="-L/usr/local/lib"
446 --with-incs-from="-I/usr/local/include -I/usr/local/include/tiff"
447 Put the paths where your graphic libs and their corresponding header files are
448 located. You can put multiple paths in any of these options, as the example
449 of --with-incs-from shows. Just put a space between them.
450
451
452 == configure doesn't detect libXpm. 
453
454 * Check if you have a symbolic link from libXpm.so.4.9 to libXpm.so
455
456
457 == Segmentation fault on startup
458
459 * Check if the version of libXPM you have is at least 4.7
460
461 * Check if you have an updated version of ~/GNUstep/Defaults/WindowMaker
462
463 If you're not sure, try renaming ~/GNUstep to ~/GNUtmp and then run wmaker.inst
464
465 == "...: your machine is misconfigured. gethostname() returned (none)"
466
467 * the hostname of your machine is set to something invalid, that starts
468         with a parenthesis. Do a man hostname for info about how to set it.
469
470
471 == The root menu contains only 2 entries. ("XTerm" and "Exit...")
472
473 * Window Maker is not finding cpp (the C preprocessor). If your cpp is
474 not located in /lib/cpp, edit src/config.h and correct the path in
475 CPP_PATH.
476
477 == checking lex output file root... configure: error: cannot find output from true; giving up
478
479 * Read the REQUIREMENTS section of this file.
480
481
482 LOCALES/INTERNATIONALIZATION
483 ============================
484
485 Window Maker has national language support. To enable national language
486 support, you must compile Window Maker with some additional parameters.
487
488
489 0 - You must have the GNU gettext package installed. It can be
490 obtained at ftp://prep.ai.mit.edu/pub/gnu/gettext-nnn.tar.gz
491
492 Steps 1 to 3 can be skipped if you use the Install script.
493
494 1 - You have to select the languages you want to support. Set the
495 LINGUAS to the list of locales you want. English is always
496 suported. Example:
497
498 setenv LINGUAS "pt ja de"
499 in csh
500
501 or
502
503 export LINGUAS;LINGUAS="pt ja de"
504 in sh
505
506 The list of supported locales can be found in po/README.
507 English is the default language.
508
509 Read po/README if you wish to translate and maintain locale files 
510 for other languages.
511
512 2 - Additionally, if your language uses multi-byte characters, such
513 as Japanese or Korean, you must set the MultiByteText option to YES
514 in ~/GNUstep/Defaults/WMGLOBAL 
515
516 3 - Configure, build and install Window Maker normally.
517
518 4 - To select a particular locale at runtime you must set the LANG
519 environment variable to the locale you want. For example, if you want to set
520 the portuguese locale, you must run
521
522 setenv LANG pt
523
524 in csh or
525
526 export LANG; LANG=pt
527
528 in Bourne sh and similars
529
530 Note: If you have the LC_CTYPE environment variable set, you must
531 unset it before running wmaker.
532
533 For menu definition files, Window Maker searches for them in the
534 following order (for brazilian portuguese, in this case):
535
536 menu.pt_BR
537 menu.pt
538 menu
539
540