README

   1
   2                 Window Maker X11 Window Manager
   3
   4                    <http://windowmaker.org>
   5                  <ftp://ftp.windowmaker.org>
   6
   7
   8                       Alfredo K. Kojima
   9                    <kojima@windowmaker.org>
  10
  11                           Dan Pascu
  12                     <dan@windowmaker.org>
  13
  14                        Matthew Hawkins
  15                     <matt@windowmaker.org>
  16
  17
  18
  19 Description
  20 ===========
  21
  22 Window Maker is a window manager designed to emulate the look and feel of
  23 part of the NEXTSTEP(tm) GUI. It's supposed to be relatively fast and small,
  24 feature rich, easy to configure and easy to use, with a simple and elegant
  25 appearance borrowed from NEXTSTEP(tm).
  26
  27 Window Maker was previously called WindowMaker.
  28
  29 Window Maker has no connection with Windowmaker, the software for
  30 making windows and doors.
  31
  32
  33 Documentation
  34 =============
  35
  36 * README files all over the source tree have info related to the stuff
  37 in the directories.
  38
  39 * INSTALL has installation instructions and some troubleshooting tips.
  40
  41 * FAQ: Frequently Asked Questions. READ IT!!! FAQ.I18N is for
  42 internationalization related questions.
  43
  44 * NEWS: list user visible changes from the previous version. Read it if
  45 you are upgrading.
  46
  47 * MIRRORS: some alternative places where you can get Window Maker,
  48 including platform specific packages of Window Maker.
  49
  50 * BUGFORM: use it to send bug reports. Please do use it.
  51
  52 * ChangeLog: what changed from the previous version?
  53
  54 * BUGS: list of known bugs
  55
  56
  57 *** User Guide
  58
  59 The Window Maker User's Guide can be downloaded from the official ftp
  60 or web sites.
  61 It can also be viewed in HTML format in:
  62 http://people.delphi.com/crc3419/WMUserGuide/index.htm
  63
  64 The User Guide explains how to use Window Maker, the configuration files
  65 and options.
  66
  67
  68 *** man pages
  69
  70 Type "man wmaker" in the shell prompt to get general help about Window Maker
  71
  72
  73
  74 Directories & Files in the Source Tree
  75 ======================================
  76
  77 * Install is a script for configuring and compiling Window Maker in a easy
  78 way (not that the normal way is difficult, but...).
  79
  80 * AUTHORS: the credits
  81
  82 * TODO: plans for the future
  83
  84 * util/ has various utility programs.
  85
  86 * WPrefs.app/ is the configuration program.
  87
  88 * src/wconfig.h has compile time options you can change to select some
  89 options/features and other stuff.
  90
  91 * WINGs/ NEXTSTEP lookalike widget library
  92
  93 * wrlib/ image processing library
  94
  95 * po/ has message catalogs wich are the translated versions of the messages
  96 displayed by Window Maker.
  97
  98
  99
 100 Mailing List
 101 ============
 102
 103 There is a mailing list for discussing Window Maker at
 104 wmaker@linuxcenter.com To subscribe to it, send a message containing:
 105         subscribe
 106 in the body of the message to wmaker-request@linuxcenter.com
 107
 108 If you got a problem, ask there (after reading the docs, of course). The
 109 people there is more likely to be able to answer your questions than we are.
 110 For bug reports use the BUGFORM.
 111
 112 IMPORTANT NOTE: when asking for help (in the mailing list or to the
 113 developerts, directly) *always* send information about the system you are
 114 using. You can use the system information section at the end of BUGFORM as a
 115 guideline. Another thing: please don't send HTML mail.
 116
 117
 118
 119 Running multiple instances of Window Maker
 120 ==========================================
 121
 122 It is not a good idea to run more than one instance of Window Maker
 123 from the same user (so that wmaker will use the same configuration
 124 files) at the same time. You might get unexpected behaviour when Window Maker
 125 updates it's configuration files.
 126
 127
 128 Sound support
 129 =============
 130
 131 Sound is supported for Linux and FreeBSD systems with the use of a
 132 separately distributed module. You can download it at:
 133 http://www.frontiernet.net/~southgat/wmsound
 134
 135 Note that you must compile Window Maker with the --enable-sound configure
 136 flag and set the DisableSound option to NO.
 137
 138
 139 Performance Tuning
 140 ==================
 141
 142 If you want to diminish Window Maker's memory usage and improve performance,
 143 while keeping a nice appearance and good functionality, follow the items
 144 bellow:
 145
 146 - use solid textures for everything, mainly titlebars and menus. If you
 147   want a nice looking desktop, use the Traditional style.
 148 - turn NewStyle and Superfluous off
 149 - do not bind many shortcuts in the menu and keep only the essential items
 150   in the menu
 151 - turn on DisableClip
 152 - edit wconfig.h and disable the NUMLOCK_HACK and the features you
 153   don't use anyway (keep in mind that some of the #defines might not
 154   work, as they are not fully supported). Make sure to always keep
 155   NumLock and ScrollLock turned off.
 156 - turn on DisableAnimations. You can also #undefine ANIMATIONS in wconfig.h
 157 - strip down the default IconPath and PixmapPath entries to contain only
 158   the paths that you really have in your system.
 159 - do not use large images in the root background
 160 - remove support for image formats you don't use
 161 - to reduce memory usage, disable the icon cache, by setting the RIMAGE_CACHE
 162   environment variable to 0. If you want to increase performance at the cost
 163   of memory usage, set it's value to a value like the number of different
 164   icons you use.
 165
 166
 167 Keyboard Mouse Control
 168 ======================
 169
 170 Many people ask about adding keyboard control of mouse, like in fvwm,
 171 but Window Maker will not have such feature. The XKB extension supports
 172 mouse simulation from the keyboard, in a much more powerfull fashion than
 173 any simulation done by a window manager.
 174
 175 To enable it, hit the Control+Shift+NumLock key combination. You should
 176 hear the speaker beeping. To disable it, do the same thing.
 177
 178 To control the mouse the numeric keypad is used as follows:
 179 - 4 (left arrow), 7 (Home), 8 (up arrow), 9 (PgUp), 6 (right arrow),
 180 3 (PgDn), 2 (down arrow) and 1 (End) move the mouse to the corresponding
 181 direction;
 182 - holding one of the above keys and the holding the 5 key will move the
 183 pointer faster;
 184 - / will select the first mouse button (left button);
 185 - * will select the second mouse button (middle button);
 186 - - will select the third mouse button (right button);
 187 - 5 will do a click with the currently selected mouse button;
 188 - + will do a double-click with the currently selected button;
 189 - 0 (Ins) will click and hold the currently selected button;
 190 - . (Del) will release the currently selected button that was previously
 191 clicked with the 0 (Ins) key.
 192
 193
 194 The above key values work in a XFree86 3.2 (X11R6.1) X server but your
 195 milleage may vary.
 196
 197
 198 How to make a gdb backtrace
 199 ===========================
 200
 201 Backtraces can help us fix bugs that make Window Maker crash. If you
 202 find a bug that crashes Window Maker, please send a backtrace with your
 203 bug report.
 204
 205 To make a usefull backtrace, you need a core file with debugging
 206 information produced by Window Maker when it crashes. The default
 207 for Window Maker is to restart another window manager when it crashes,
 208 so you will not get a core file. You need to edit the src/wconfig.h
 209 file *after* running configure and change the line that looks like:
 210
 211 #undef NO_EMERGENCY_AUTORESTART
 212
 213 to:
 214
 215 #define NO_EMERGENCY_AUTORESTART
 216
 217 Then, in the src directory type:
 218 make CFLAGS=-g
 219 make install
 220
 221 and wait for Window Maker to be installed.
 222
 223 Once having Window Maker installed, start X and reproduce the bug so
 224 that Window Maker crashes. When it does crash, type the following from
 225 your shell:
 226
 227 script
 228 gdb wmaker path_to_the_core_file
 229
 230 Then, in the gdb prompt type "bt". Quit from gdb by typing "quit"
 231 and then, in the shell prompt, type "exit".
 232
 233 The file named typescript will contain the backtrace.
 234
 235
 236
 237 Copyrights
 238 ==========
 239
 240 Window Maker is copyrighted by Alfredo K. Kojima and is licensed through the
 241 GNU General Public License. Read the COPYING file for the complete license.
 242
 243 NeXT, OpenStep and NEXTSTEP are a trademarks of NeXT Computer, Inc.
 244
 245
 246 Authors
 247 =======
 248
 249 The AUTHORS file contains a list of the people who have contributed to the
 250 project. The name of people who have helped with localization (translation)
 251 can be found in po/README and Window Maker/README
 252
 253 If you have any comments, fixes and bug reports (filled BUGFORMs) send them
 254 to developers@windowmaker.org
 255
 256
 257 Musicware
 258 =========
 259
 260 If you use Window Maker and *really* like it, please consider making my day
 261 by sending me a music CD (or a MiniDisc) of your favorite band, singer,
 262 instrumentist, composer or whatever :^). I like listening to music and would
 263 love to get new CDs, especially from other parts of the world. I like almost
 264 any kind of music, from Ozzy Osbourne to Bach (mas não pagode e sertanejo
 265 pelamordideus :), so I will be happy to receive just about anything.
 266
 267 Snail mail address:
 268
 269 Alfredo Kengi Kojima
 270 Rua Firmino O. Bimbi, 255/25B
 271 Porto Alegre - RS
 272 CEP 91751-330
 273 Brazil
 274