add plugins dir to Makefile.am
[wmaker-crm.git] / INSTALL
blob9b85716ae20bc18d449b20ac6347351960535e0a
2                 Installation Instructions for Window Maker
6 SUPPORTED PLATFORMS
7 ===================
8 (ie: I've heard someone has compiled it on...)
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 - SCO Unix
25 - SGI Irix 5.x, 6.5
26 - OSF/1
27 - HP-UX
28 - AIX 3.2.5
29 - AIX 4.1.4 / IBM PowerPC
30 - AIX 4.3.1 / IBM CC compiler
31 - AIX 4.3.2 / IBM PowerPC
32 - AIX 5.3
33 - DEC Alpha/Digital UNIX 4.x
34 - XFree86 / OS/2
35 - Corel NetWinder
36 - SunOS 4.x
37 - PowerMac / Power MachTen 4.1.1 over MacOS
38 - Amiga 3000 running RedHat Linux 5.1 (Rawhide)
39 - IBM S/390 running Linux
40 - iBook running Darwin
42 Patches to make it work on other platforms are welcome. 
45 REQUIREMENTS:
46 =============
48 The following software is required to use Window Maker:
50 - X11R6.x       
51         Window Maker can be compiled in older versions of X, like X11R5
52         (Solaris) or X11R4 (OpenWindows) but it will not work 100% correctly.
53         In such servers there will not be application icons and you'll have
54         trouble using the dock. Upgrading the client libraries (Xlib, Xt etc)
55         will help if you can't upgrade the server.
57 The following is required to build Window Maker:
59 - Basic obvious stuff
60         If you will build Window Maker, make sure you have gcc (or some
61         other ANSI C compiler) and the X header files installed. Specially
62         for newbie Linux users: you must install all X development packages
63         and the gcc suite. Otherwise you won't be able to build any X
64         program, including Window Maker.
66 - libPropList
67         This library can be found in ftp://ftp.windowmaker.org/pub/libs
68         or in ftp://ftp.gnome.org/pub/libPropList
69         Install it before building Window Maker.
71 - autoconf, automake and libtool
72         These tools are NOT needed, but IF you have one or
73         more of them installed, make sure you have ALL of the following 
74         with exactly these versions:
75                 autoconf 2.13
76                 automake 1.4
77                 libtool 1.3
78         If you have a different version, disable them by temporarily
79         renaming them to something else or uninstalling them from your
80         system. If you don't develop software you don't need them,
81         so you can safely uninstall. 
83 - lex (or flex) and yacc (or bison)
84         These are used by libPropList. lex is actually not needed since
85         it's output file is included, but either me or automake is stupid,
86         causing the configure script for libPropList to simply abort for no
87         convincent reason if lex is not found.
90 OPTIONAL:
91 =========
93 These libraries are not required to make Window Maker work, but they
94 are supported in case you want to use them. Version numbers are those
95 that I have (and therefore, guraranteed to work), but other versions
96 might work too. 
99 - libXPM 4.7 or newer
100         Older versions may not work!!! 
101         Available at ftp://sunsite.unc.edu/pub/Linux/libs/X/
103         There is builtin support for XPM files, but it will not
104         load images in some uncommon encodings.
106 - libpng 0.96 or newer and zlib     
107         For PNG image support.
108         http://www.cdrom.com/pub/png/
110 - libtiff 3.4 or newer
111         For TIFF image support.
112         You can get it at ftp://ftp.sgi.com/graphics/tiff
114 - libjpeg 6.0.1 or newer
115         For JPEG image support
116         http://www.ijg.org/
118 - libgif 2.2 or libungif
119         For GIF image support
120         ftp://prtr-13.ucsc.edu/pub/libungif/
122 - GNU xgettext
123         If you want to use translated messages, you will need GNU gettext.
124         Other versions of gettext are not compatible and will not work.
125         Get the GNU version from ftp://ftp.gnu.org
129 CONFIGURE OPTIONS:
130 ==================
132 These options can be passed to the configure script to enable/disable
133 some Window Maker features. Example:
135 ./configure --enable-kde --enable-gnome
137 will configure Window Maker with KDE and GNOME supported compiled in.
140 To get a list of other options, run ./configure --help
142 --with-libs-from
143         specify additional paths for libraries to be searched.
144         The -L flag must precede each path, like:
145         --with-libs-from="-L/opt/libs -L/usr/local/lib"
147 --with-incs-from
148         specify additional paths for header files to be searched.
149         The -I flag must precede each paths, like:
150         --with-incs-from="-I/opt/headers -I/usr/local/include"
152 --enable-single-icon
153         enables the collapsing of all appicons of the WM_CLASS+WM_INSTANCE
154         into a single one. This feature is not supported at all by the
155         developers. If you have some trouble with it, contact it's author:
156         Christopher Seawood <cls@seawood.org>
158 --disable-shm
159         disable use of the MIT shared memory extension. This will slow down
160         texture generation a little bit, but in some cases it seems to be
161         necessary due to a bug that manifests as messed icons and textures.
163 --disable-motif 
164         disable support for mwm window manager hints
166 --enable-openlook
167         enable support for OPEN LOOK(tm) window manager hints
169 --enable-gnome
170         enable support for GNOME window manager hints
172 --enable-kde
173         enable support for kde/kwm window manager hints
175 --enable-lite
176         remove things that are already supported in desktop environments,
177         like KDE and GNOME. Disabled things are: window list, root
178         applications menu, multiple window selection. Note that you will not
179         be able to exit Window Maker from itself anymore; you will have to
180         use kill with the SIGTERM signal or exit it from KDE. It is not
181         advisable to enable it.
183 --enable-modelock
184         XKB language status lock support. If you don't know what it is you
185         probably don't need it.
187 --enable-sound  
188         enable support of sound effects module
190 --disable-xpm   
191         disables use of the XPM library even if it is available on your
192         system.
194 --disable-png   
195         disables use of PNG library
197 --disable-tiff
198         disable use of TIFF library
200 --disable-gif
201         disable use of GIF library
203 --disable-jpeg
204         disable use of JPEG library
206 --disable-shape
207         disables shaped windows (for oclock, xeyes etc.)
210 PLATFORM SPECIFIC NOTES:
211 ========================
213 - DEC/Alpha machines
215 #>>>>>>>>>>>
216 From: Anton Ivanov <aivanov@eu.level3.net>
217 To: Marcelo E. Magallon <mmagallo@debian.org>
218 Subject: Re: Is the WindowMaker package working ok on Alpha?
220 > Hi,
222 >  I was reading some docs on the WindowMaker tarball, and found this:
224 >  | - DEC/Alpha machines
225 >  |         You might need to pass the --disable-shm flag to configure,
226 >  |         like ./configure --disable-shm
228 >  is anyone having problems with WindowMaker on Alpha?  Can someone
229 >  please test this?  Should the flag be passed when building on Alpha?
231 Disclaimer: alphas under my command have never run X and are least likely to 
232 suddenly start running it anytime soon.
234         Alpha used to have some ridiculously low amount of shared memory
235 configured. 
236 So quite a lot of apps used to barf. Namely - cdrecord, mysql server, etc.
238         Check where is yours at the moment and raise it to a more appropriate
239 value by either catting to the appropriate /proc entry or changing the
240 /usr/src/linux/include/asm/shmparam.h.
242         Otherwise the shared memory on alpha should be fully functional and I
243 see no reason to disable it. Mine are bumped up to 32 or more on most
244 machines.
246         And If I recall correctly the comments in that file are actually
247 wrong. Value is not bytes, but in machine size word. For alpha *8.
249         As I said - I do not run X on them so all #include "stdisclaimer.h"
250 apply.
251 #<<<<<<<<<<<<
254 - SCO Unix - run configure like
255         CFLAGS="-belf -DANSICPP" ./configure 
257 - SunOS, Solaris 
258         If you have gcc installed, run configure as:
259         CPP_PATH="gcc -E -x c" ./configure
260         Sun's cpp lacks some features needed by Window Maker and it can
261         cause problems when parsing the config files.
262         You also might need to use the --with-libs-from and --with-incs-from
263         to supply the directory where libtiff is located.
264         Someone mailed me that you also must make /usr/local/lib be the
265         first path in LD_LIBRARY_PATH to make it work.
267         If you have a Ultra Creator 3D or some other machine with high-end
268         graphics, be sure to start the X server with the default visual
269         set to 24bpp or you might experience problems with mangled colors.
270         This is a wmaker bug and will be fixed.
272 - GNU/Linux in general
273         Make sure you have /usr/local/lib in /etc/ld.so.conf and that you
274         run ldconfig after installing.
275         Uninstall any packaged version of Window Maker before installing a new
276         version. 
278 - RedHat GNU/Linux
279         RedHat systems have several annoying problems. If you use it, 
280         be sure to follow the steps below or Window Maker will not work:
282         * if you installed the Window Maker that comes with RedHat, uninstall
283         it before upgrading;
285         * make sure you don't have the LANG and LINGUAS environment variables
286         set to en_RN;
288         * make sure you have /usr/local/bin in your PATH environment
289         variable;
291         * make sure you have /usr/local/lib in /etc/ld.so.conf before running
292         ldconfig;
294         * if you have problems that mention an error message with --no-reexec
295         uninstall libtool-1.2b and install libtool-1.3 instead. libtool-1.3
296         can be found in ftp.gnu.org  Also read the TROUBLESHOOTING section;
298         * if you installed the Window Maker package from RedHat and are
299         installing a new version of it by hand (compiling yourself), uninstall
300         the package from RedHat before.
302         * make sure you have a symbolic link from /usr/include/X11 to
303         /usr/X11R6/include/X11 (if not, type ln -s /usr/X11R6/include/X11
304         /usr/include/X11 )
306         * make sure you have /lib/cpp pointing to the cpp program
308         If you have any doubts in doing any of the stuff above, please
309         don't hesitate to contact the RedHat user support. They will
310         kindly answer to all your questions regarding their system.
311         They also know much more about their own system than us 
312         (we don't use RedHat).
315 - PowerPC MkLinux
316         You will need to have the latest version of Xpmac. Older versions
317         seem to have bugs that cause the system to hang.
319 - Debian GNU/Linux
320         If you want JPEG and TIFF support, make sure you have libtiff-dev 
321         and libjpeg-dev installed.
323 - SuSE GNU/Linux
324         If you installed the Window Maker package from SuSE,
325         uninstall it before trying to compile wmaker or you
326         might have problems.
328 - MetroX (unknown version)
329         MetroX has a bug that corrupts pixmaps that are set as window
330         backgrounds. If you use MetroX and has weird problems with
331         textures, do not use textures in titlebars. Or use a different
332         X server.
334 INSTALLATION:
335 =============
337 Unpack WindowMaker-extra-<version-number>.tar.gz in /usr/local/share
339 You can get the file at ftp://ftp.windowmaker.org. This file is optional
340 and only have a few icons, and themes. Look for the latest <version-number>
341 available.
342 Also there is a WindowMaker-extra.readme to instruct you where that package
343 should go.
346 Build Window Maker
347 ------------------
348         For a quick start, type the following in your shell prompt:
350         ./configure
351         make
353 then, login as root and type:
355         make install
356         ldconfig
358 or if you want to strip the debugging symbols from the binaries and make them
359 smaller, you can instead type:
361         make install-strip
362         ldconfig
364 This will build and install Window Maker with default parameters.
366 If you want to customize some compile-time options, you can do the
367 following. 
369         1. (optional) Look at the CONFIGURE OPTIONS section above for the 
370         options available. Also run:
372         ./configure --help
374         to get a complete listing of other options that are available.
376         2. Run configure with the options you want. For example, if you
377         want to use the --enable-kde option, type:
379         ./configure --enable-kde
381         3. (optional) Edit src/wconfig.h with your favorite text editor 
382         and browse through it for some options you might want to change.
384         4. Compile. Just type:
386         make
388         5. Login as root (if you can't do that, read the "I don't have the 
389         root password :-(" section) and install Window Maker in your system:
390                 su root
391                 make install
394 User specific configuration
395 ---------------------------
397 These instructions do not need to be followed when upgrading Window Maker
398 from an older version, unless stated differently in the NEWS file.
400 Every user on your system that wishes to run Window Maker must do the
401 following:
403         1. Install Window Maker configuration files in your home directory.
404 Type:
405         wmaker.inst
407         wmaker.inst will install Window Maker configuration files and will
408 setup X to automatically launch Window Maker at startup.
410         That's it! 
411         
412         You can type "man wmaker" to get some general help for configuration
413 and other stuff.
415 Read the User Guide for a more in-depth explanation of Window Maker.
417 You might want to take a look at the FAQ too.
420 I don't have the root password :(
421 ---------------------------------
423 If you can't get superuser privileges (can't be root) you can install
424 wmaker in your own home directory. For that, supply the --prefix option
425 when running configure in step 2 of building Window Maker. You will
426 also need to supply the --with-appspath option, to specify the path for
427 WPrefs.app Example:
429 ./configure --prefix=/home/jshmoe --with-appspath=/home/jshmoe/GNUstep/Apps
432 Then make /home/jshmoe/bin be included in your search PATH, add
433 /home/jshmoe/lib to your LD_LIBRARY_PATH environment variable and run 
434 bin/wmaker.inst
436 Of course, /home/jshmoe is supposed to be replaced with your actual home
437 directory path.
441 UPGRADING
442 =========
444 If you are upgrading from an older version of Window Maker:
446         1. Configure and build Window Maker as always
447         2. Install Window Maker (but do not run wmaker.inst)
448         3. Read the NEWS file and update your configuration files, 
449            if necessary.
451 TROUBLESHOOTING
452 ===============
454 When you have some trouble during configuration (while running configure),
455 like not being able to use a graphic format library you think you have
456 installed, look at the config.log file for clues of the problem.
459 == Error with loading fonts, even if they exist.
461 Try rebuilding without NLS support.
463 == Error when configuring
465 ltconfig: unrecognized option `--no-reexec'
466 Try `ltconfig --help' for more information.
467 configure: error: libtool configure failed
469 remove the --no-reexec option from aclocal.m4 and libPropList/aclocal.m4
470 and reconfigure
471 Also make sure the autoconf and automake versions you have installed are:
472 autoconf 2.13
473 automake 1.4
474 libtool 1.3
476 Note that it must not be libtool 1.2b, it must be libtool 1.3, 
477 from the GNU sites.
479 == Cant find proplist.h or libPropList.something
481 Download and install libPropList from the places pointed to
482 somewhere else in this file.
485 == configure doesn't detect libtiff, or other graphic libraries.
487 Delete config.cache, then rerun configure adding the following options to
488 configure (among the other options you use):
489 --with-libs-from="-L/usr/local/lib"
490 --with-incs-from="-I/usr/local/include -I/usr/local/include/tiff"
491 Put the paths where your graphic libs and their corresponding header files are
492 located. You can put multiple paths in any of these options, as the example
493 of --with-incs-from shows. Just put a space between them.
496 == configure doesn't detect libXpm. 
498 * Check if you have a symbolic link from libXpm.so.4.9 to libXpm.so
501 == Segmentation fault on startup
503 * Check if the version of libXPM you have is at least 4.7
505 * Check if you have an updated version of ~/GNUstep/Defaults/WindowMaker
507 If you're not sure, try renaming ~/GNUstep to ~/GNUtmp and then run wmaker.inst
509 == "...: your machine is misconfigured. gethostname() returned (none)"
511 * the hostname of your machine is set to something invalid, that starts
512         with a parenthesis. Do a man hostname for info about how to set it.
515 == The root menu contains only 2 entries. ("XTerm" and "Exit...")
517 * Window Maker is not finding cpp (the C preprocessor). If your cpp is
518 not located in /lib/cpp, edit src/config.h and correct the path in
519 CPP_PATH.
521 == checking lex output file root... configure: error: cannot find output from true; giving up
523 * Read the REQUIREMENTS section of this file.
526 LOCALES/INTERNATIONALIZATION
527 ============================
529 Window Maker has national language support. To enable national language
530 support, you must compile Window Maker with some additional parameters.
533 0 - You must have the GNU gettext package installed. It can be
534 obtained at ftp://prep.ai.mit.edu/pub/gnu/gettext-nnn.tar.gz
536 Steps 1 to 3 can be skipped if you use the Install script.
538 1 - You have to select the languages you want to support. Set the
539 LINGUAS to the list of locales you want. English is always
540 suported. Example:
542 setenv LINGUAS "pt ja de"
543 in csh
547 export LINGUAS;LINGUAS="pt ja de"
548 in sh
550 The list of supported locales can be found in po/README.
551 English is the default language.
553 Read po/README if you wish to translate and maintain locale files 
554 for other languages.
556 2 - Additionally, if your language uses multi-byte characters, such
557 as Japanese or Korean, you must set the MultiByteText option to YES
558 in ~/GNUstep/Defaults/WMGLOBAL 
560 3 - Configure, build and install Window Maker normally.
562 4 - To select a particular locale at runtime you must set the LANG
563 environment variable to the locale you want. For example, if you want to set
564 the portuguese locale, you must run
566 setenv LANG pt
568 in csh or
570 export LANG; LANG=pt
572 in Bourne sh and similars
574 Note: If you have the LC_CTYPE environment variable set, you must
575 unset it before running wmaker.
577 For menu definition files, Window Maker searches for them in the
578 following order (for brazilian portuguese, in this case):
580 menu.pt_BR
581 menu.pt
582 menu
585 5 - If you chose a language that uses multi-byte characters, you must
586 configure the fonts appropriately. Read the manual page for XCreateFontSet
587 to have more details about it. You must change the ~/G/D/WindowMaker file
588 for fonts used in titlebars, menus and other things. For fonts used in
589 dialog windows, change ~/G/D/WMGLOBAL. The %d in the font names must not be
590 removed. You can also use the supplied wsetfont script for the task.
591 Read the script itself for instructions.
593 For example, you can specify the following in ~/G/D/WindowMaker:
595 WindowTitleFont = "-*-helvetica-bold-r-normal-*-12-*,-*-*-medium-r-normal-*-14-*";
596 MenuTitleFont = "-*-helvetica-bold-r-normal-*-12-*,-*-*-medium-r-normal-*-14-*";
597 MenuTextFont = "-*-helvetica-medium-r-normal-*-12-*,-*-*-medium-r-normal-*-14-*";
598 IconTitleFont = "-*-helvetica-medium-r-normal-*-8-*,-*-*-medium-r-normal-*-12-*";
599 ClipTitleFont = "-*-helvetica-bold-r-normal-*-10-*,-*-*-medium-r-normal-*-12-*";
600 DisplayFont = "-*-helvetica-medium-r-normal-*-12-*,-*-*-medium-r-normal-*-12-*";
602 and in ~/G/D/WMGLOBAL:
604 SystemFont = "-*-*-medium-r-normal-*-%d-*-*-*-*-*-*-*";
605 BoldSystemFont = "-*-*-medium-r-normal-*-%d-*-*-*-*-*-*-*";
607 The above 2 fonts are only used by applications that use WINGs (WindowMaker
608 and WPrefs.app)
610 The wsetfont script that's supplied will allow you to change the font
611 settings in a easier way. Take a look in the script for details on usage.