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