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/Linux RedHat 4.2 (primary platform)
  11 - Intel/Linux other distributions
  12 - Sparc/Linux RedHat 5.1
  13 - PowerPC/MkLinux
  14 - Alpha/Linux RedHat 5.1
  15 - FreeBSD
  16 - Solaris 2.5.1, 2.5.2
  17 - Solaris 2.6.0
  18 - Solaris 2.7beta
  19 - SCO Unix
  20 - SGI Irix
  21 - OSF/1
  22 - HP-UX
  23 - AIX 4.1.4 / IBM PowerPC
  24 - AIX 5.3
  25 - DEC Alpha/Digital UNIX 4.x
  26 - XFree86 / OS/2
  27 - Corel NetWinder
  28
  29 Patches to make it work on other platforms are welcome.
  30
  31
  32 REQUIREMENTS:
  33 =============
  34
  35 The following software is required to use Window Maker:
  36
  37 - X11R6.x
  38         Window Maker can be compiled in older versions of X, like X11R5
  39         (Solaris) or X11R4 (OpenWindows) but it will not work 100% correctly.
  40         In such servers there will not be application icons and you'll have
  41         trouble using the dock. Upgrading the client libraries (Xlib, Xt etc)
  42         will help if you can't upgrade the server.
  43
  44 The following is required to build Window Maker:
  45
  46 - Basic obvious stuff
  47         If you will build Window Maker, make sure you have gcc (or some
  48         other ANSI C compiler) and the X header files installed. Specially
  49         for newbie Linux users: you must install all X development packages
  50         and the gcc suite. Otherwise you won't be able to build any X
  51         program, including Window Maker.
  52
  53 - autoconf and automake
  54         autoconf and automake are not required, but if you have them
  55         installed, make sure you have autoconf 2.12 and automake 1.3 or
  56         newer. If you have an older version, disable them by temporarily
  57         renaming them to something else or uninstalling them from your
  58         system.
  59
  60 - lex (or flex) and yacc (or bison)
  61         These are used by libPropList. lex is actually not needed since
  62         it's output file is included, but either me or automake is stupid,
  63         causing the configure script for libPropList to simply abort for no
  64         convincent reason if lex is not found.
  65
  66
  67 OPTIONAL:
  68 =========
  69
  70 These libraries are not required to make Window Maker work, but they
  71 are supported in case you want to use them. Version numbers are those
  72 that I have (and therefore, guraranteed to work), but other versions
  73 might work too. Tell me if you made wmaker work with some library
  74 with a version older than the stated here.
  75
  76
  77 - libXPM 4.7 or newer
  78         Older versions may not work!!!
  79         Available at ftp://sunsite.unc.edu/pub/Linux/libs/X/
  80
  81         There is builtin support for XPM files, but it will not
  82         load images in some uncommon encodings.
  83
  84 - libpng 0.96 or newer and zlib
  85         For PNG image support.
  86
  87 - libtiff 3.4 or newer
  88         For TIFF image support.
  89         You can get it at ftp://ftp.sgi.com/graphics/tiff
  90
  91 - libjpeg 6.0.1 or newer
  92         For JPEG image support
  93
  94 - libgif 2.2 or libungif
  95         For GIF image support
  96
  97 - GNU xgettext
  98         If you want to use translated messages, you will need GNU gettext.
  99         Other versions of gettext are not compatible and will not work.
 100         Get the GNU version from ftp://prep.ai.mit.edu
 101
 102 Most of these can be get from ftp.uu.net/pub/graphics
 103
 104
 105 CONFIGURE OPTIONS:
 106 ==================
 107
 108 These options can be passed to the configure script to enable/disable
 109 some Window Maker features. Example:
 110
 111 ./configure --enable-kanji
 112
 113 will configure Window Maker with kanji (and other multi-byte) characters
 114 support compiled in.
 115
 116
 117 To get a list of other options, run ./configure --help
 118
 119 --enable-sound  enable support of sound effects module
 120
 121 --disable-xpm   disables use of the XPM library even if it is available on
 122         your system.
 123
 124 --disable-png   disables use of PNG library
 125
 126 --disable-tiff  disable use of TIFF library
 127
 128 --disable-gif   disable use of GIF library
 129
 130 --disable-jpeg  disable use of JPEG library
 131
 132 --disable-shape  disables shaped windows (for oclock, xeyes etc.)
 133
 134 --enable-debug  adds extra debugging information. Do not use it
 135         unless you're debugging Window Maker.
 136
 137 --enable-kanji  support to display Kanji characters, Korean, Chinese
 138                 and other languagues that require special characters.
 139
 140 --enable-single-icon  enables the collapsing of all appicons of the
 141          WM_CLASS+WM_INSTANCE into a single one. This feature is not
 142         supported at all by the developers. If you have some trouble with it,
 143         contact it's author: Christopher Seawood <cls@seawood.org>
 144
 145 --disable-shm   disable use of the MIT shared memory extension. This will
 146         slow down texture generation.
 147
 148 --enable-modelock  XKB language status lock support. If you don't know
 149         what it is you probably don't need it.
 150
 151
 152 PLATFORM SPECIFIC NOTES:
 153 ========================
 154 - SCO Unix - run configure like
 155         CFLAGS="-belf -DANSICPP" ./configure
 156
 157 - SunOS, Solaris
 158         If you have gcc installed, run configure as:
 159         CPP_PATH="gcc -E -x c" ./configure
 160         Sun's cpp lacks some features needed by Window Maker and it can
 161         cause problems when parsing the config files.
 162         You also might need to use the --with-gfx-libs and --with-gfx-incs
 163         to supply the directory where libtiff is located.
 164
 165 - RedHat Linux
 166         Make sure you don't have the LANG and LINGUAS environment variables
 167         set to en_RN. Also, make sure you have /usr/local/bin in your
 168         PATH environment variable, as for some mysterious reason the folks
 169         at RedHat did not include it in the default configuration files
 170         in RH 5.{0,1}.
 171
 172 - PowerPC MkLinux
 173         You will need to have the latest version of Xpmac. Older versions
 174         seem to have bugs that cause the system to hang.
 175
 176 - Debian Linux
 177         If you want JPEG and TIFF support, make sure you have libtiff-dev
 178         and libjpeg-dev installed.
 179
 180 - SuSE Linux
 181         If you installed the Window Maker package from SuSE,
 182         uninstall it before trying to compile wmaker or you
 183         might have problems.
 184
 185 - MetroX (unknown version)
 186         MetroX has a bug that corrupts pixmaps that are set as window
 187         backgrounds. If you use MetroX and has weird problems with
 188         textures, do not use textures in titlebars. Or use a different
 189         X server.
 190
 191
 192 INSTALLATION:
 193 =============
 194
 195 Unpack WindowMaker-data.tar.gz and move the pixmaps directory in it
 196 to /usr/local/share/pixmaps
 197
 198 You can get the file at ftp://ftp.windowmaker.org. This file is optional
 199 and only have a few icons.
 200
 201
 202 Build Window Maker
 203 ------------------
 204         For a quick start, type the following in your shell prompt:
 205
 206         ./configure
 207         make
 208
 209 then, login as root and type:
 210
 211         make install
 212
 213 or if you want to strip the debugging symbols from the binaries and make them
 214 smaller, you can instead type:
 215
 216         make install-strip
 217
 218 This will build and install Window Maker with default parameters.
 219
 220 If you want to customize some compile-time options, you can do the
 221 following.
 222
 223         1. (optional) Look at the CONFIGURE OPTIONS section above for the
 224         options available. Also run:
 225
 226         ./configure --help
 227
 228         to get a complete listing of other options that are available.
 229
 230         2. Run configure with the options you want. For example, if you
 231         want to use the --enable-kanji option, type:
 232
 233         ./configure --enable-kanji
 234
 235         3. (optional) Edit src/wconfig.h with your favorite text editor
 236         and browse through it for some options you might want to change.
 237
 238         4. Compile. Just type:
 239
 240         make
 241
 242         5. Login as root (if you can't do that, read the "I don't have the
 243         root password :-(" section) and install Window Maker in your system:
 244                 su root
 245                 make install
 246
 247
 248 User specific configuration
 249 ---------------------------
 250
 251 These instructions do not need to be followed when upgrading Window Maker
 252 from an older version, unless stated differently in the NEWS file.
 253
 254 Every user on your system that wishes to run Window Maker must do the
 255 following:
 256
 257         1. Install Window Maker configuration files in your home directory.
 258 Type:
 259         wmaker.inst
 260
 261         wmaker.inst will install Window Maker configuration files and will
 262 setup X to automatically launch Window Maker at startup.
 263
 264         That's it!
 265
 266         You can type "man wmaker" to get some general help for configuration
 267 and other stuff.
 268
 269 Read the User Guide for a more in-depth explanation of Window Maker.
 270
 271 You might want to take a look at the FAQ too.
 272
 273
 274 I don't have the root password :(
 275 ---------------------------------
 276
 277 If you can't get superuser privileges (can't be root) you can install
 278 wmaker in your own home directory. For that, supply the --prefix option
 279 when running configure in step 2 of building Window Maker. You will
 280 also need to supply the --with-appspath option, to specify the path for
 281 WPrefs.app Example:
 282
 283 ./configure --prefix=/home/jshmoe --with-appspath=/home/jshmoe/GNUstep/Apps
 284
 285 If you use national language support, you must also supply the --with-nlsdir
 286 option, as:
 287
 288 ./configure --prefix=/home/jshmoe --with-appspath=/home/jshmoe/GNUstep/Apps \
 289         --with-nlsdir=/home/jshmoe/lib/locale
 290
 291 Then make /home/jshmoe/bin be included in your search path and run
 292 bin/wmaker.inst
 293
 294
 295 UPGRADING
 296 =========
 297
 298 If you are upgrading from an older version of Window Maker:
 299
 300         1. Configure and build Window Maker as always
 301         2. Install Window Maker (but do not run wmaker.inst)
 302         3. Read the NEWS file and update your configuration files,
 303            if necessary.
 304
 305 TROUBLESHOOTING
 306 ===============
 307
 308 When you have some trouble during configuration (while running configure),
 309 like not being able to use a graphic format library you think you have
 310 installed, look at the config.log file for clues of the problem.
 311
 312
 313 == Error during build of libPropList
 314
 315 make: *** No rule to make target `libPropList.a.c', needed by
 316 `libPropList.a.o'.  Stop.
 317
 318 Make sure the autoconf and automake versions you have installed are at
 319 least:
 320 autoconf 2.12
 321 automake 1.3
 322
 323 If you are using the RPM's that come with RedHat 4.x, don't use them.
 324 It is broken. Uninstall the RPM and reinstall a fresh package from
 325 ftp://prep.ai.mit.edu or any mirror.
 326
 327 == configure doesn't detect libtiff, or other graphic libraries.
 328
 329 Delete config.cache, then rerun configure adding the following options to
 330 configure (among the other options you use):
 331 --with-gfx-libs="-L/usr/local/lib"
 332 --with-gfx-incs="-I/usr/local/include -I/usr/local/include/tiff"
 333 Put the paths where your graphic libs and their corresponding header files are
 334 located. You can put multiple paths in any of these options, as the example
 335 of --with-gfx-incs shows. Just put a space between them.
 336
 337
 338 == configure doesn't detect libXpm.
 339
 340 * Check if you have a symbolic link from libXpm.so.4.9 to libXpm.so
 341
 342
 343 == Segmentation fault on startup
 344
 345 * Check if the version of libXPM you have is at least 4.7
 346
 347 * Check if you have an updated version of ~/GNUstep/Defaults/WindowMaker
 348
 349 If you're not sure, try renaming ~/GNUstep to ~/GNUtmp and then run wmaker.inst
 350
 351 == "...: your machine is misconfigured. gethostname() returned (none)"
 352
 353 * the hostname of your machine is set to something invalid, that starts
 354         with a parenthesis. Do a man hostname for info about how to set it.
 355
 356
 357 == The root menu contains only 2 entries. ("XTerm" and "Exit...")
 358
 359 * Window Maker is not finding cpp (the C preprocessor). If your cpp is
 360 not located in /lib/cpp, edit src/config.h and correct the path in
 361 CPP_PATH.
 362
 363 == checking lex output file root... configure: error: cannot find output from true; giving up
 364
 365 * Read the REQUIREMENTS section of this file.
 366
 367
 368 LOCALES/INTERNATIONALIZATION
 369 ============================
 370
 371 Window Maker has national language support.
 372 To enable national language support, you must compile
 373 Window Maker with some additional parameters.
 374
 375 0 - You must have the GNU gettext package installed. It can be
 376 obtained at ftp://prep.ai.mit.edu/pub/gnu/gettext-nnn.tar.gz
 377
 378 Steps 1 to 3 can be skipped if you use the Install script.
 379
 380 1 - You have to select the languages you want to support. Set the
 381 LINGUAS to the list of locales you want. English is always
 382 suported. Example:
 383
 384 setenv LINGUAS "pt ja de"
 385 in csh
 386
 387 or
 388
 389 export LINGUAS;LINGUAS="pt ja de"
 390 in sh
 391
 392 The list of supported locales can be found in po/README.
 393 English is the default language.
 394
 395 Read po/README if you wish to translate and maintain locale files
 396 for other languages.
 397
 398 2 - Additionally, if your language uses multi-byte characters, such
 399 as Japanese or Korean, you must supply the --enable-kanji flag to configure.
 400
 401 3 - Configure, build and install Window Maker normally.
 402
 403 4 - To select a particular locale at runtime you must set the LANG
 404 environment variable to the locale you want. For example, if you want to set
 405 the portuguese locale, you must run
 406
 407 setenv LANG pt
 408
 409 in csh or
 410
 411 export LANG; LANG=pt
 412
 413 in Bourne sh and similars
 414
 415 Note: If you have the LC_CTYPE environment variable set, you must
 416 unset it before running wmaker.
 417
 418 For menu definition files, Window Maker searches for them in the
 419 following order (for brazilian portuguese, in this case):
 420
 421 menu.pt_BR
 422 menu.pt
 423 menu
 424
 425
 426 5 - If you chose a language that uses multi-byte characters, you must
 427 configure the fonts appropriately. Read the manual page for XCreateFontSet
 428 to have more details about it. You must change the ~/G/D/WindowMaker file
 429 for fonts used in titlebars, menus and other things. For fonts used in
 430 dialog windows, change ~/G/D/WMGLOBAL. Note that at the moment you can only
 431 supply a single font in WMGLOBAL. The %d in the font names must not be
 432 removed.
 433
 434 For example, you can specify the following in ~/G/D/WindowMaker:
 435
 436 WindowTitleFont = "-*-helvetica-bold-r-normal-*-12-*,-*-*-medium-r-normal-*-14-*";
 437 MenuTitleFont = "-*-helvetica-bold-r-normal-*-12-*,-*-*-medium-r-normal-*-14-*";
 438 MenuTextFont = "-*-helvetica-medium-r-normal-*-12-*,-*-*-medium-r-normal-*-14-*";
 439 IconTitleFont = "-*-helvetica-medium-r-normal-*-8-*,-*-*-medium-r-normal-*-12-*";
 440 ClipTitleFont = "-*-helvetica-bold-r-normal-*-10-*,-*-*-medium-r-normal-*-12-*";
 441 DisplayFont = "-*-helvetica-medium-r-normal-*-12-*,-*-*-medium-r-normal-*-12-*";
 442
 443 and in ~/G/D/WMGLOBAL:
 444
 445 SystemFont = "-*-*-medium-r-normal-*-%d-*-*-*-*-*-*-*";
 446 BoldSystemFont = "-*-*-medium-r-normal-*-%d-*-*-*-*-*-*-*";
 447
 448 The above 2 fonts are only used by applications that use WINGs (WindowMaker
 449 and WPrefs.app)