README

   1
   2
   3
   4                                 GNU Window Maker
   5                                X11 Window Manager
   6
   7                             <http://windowmaker.org>
   8
   9                                      by
  10
  11                              Alfredo K. Kojima
  12
  13                                  Dan Pascu
  14
  15
  16
  17                                Web/FTP Master
  18
  19                                Phillip Smith
  20
  21
  22
  23                 Congratulations! You have purchased an extremely fine
  24         device that would give you thousands of years of trouble-free
  25         service, except that you undoubtably will destroy it via some
  26         typical bonehead consumer maneuver. Which is why we ask you
  27         to PLEASE FOR GOD'S SAKE READ THIS OWNER'S MANUAL CAREFULLY
  28         BEFORE YOU UNPACK THE DEVICE. YOU ALREADY UNPACKED IT, DIDN'T
  29         YOU? YOU UNPACKED IT AND PLUGGED IT IN AND TURNED IT ON AND
  30         FIDDLED WITH THE KNOBS, AND NOW YOUR CHILD, THE SAME CHILD WHO
  31         ONCE SHOVED A POLISH SAUSAGE INTO YOUR VIDEOCASSETTE RECORDER
  32         AND SET IT ON "FAST FORWARD", THIS CHILD ALSO IS FIDDLING
  33         WITH THE KNOBS, RIGHT?  AND YOU'RE JUST NOW STARTING TO READ
  34         THE INSTRUCTIONS, RIGHT???  WE MIGHT AS WELL JUST BREAK THESE
  35         DEVICES RIGHT AT THE FACTORY BEFORE WE SHIP THEM OUT, YOU
  36         KNOW THAT?
  37                                 -- Dave Barry, "Read This First!"
  38
  39
  40 Description
  41 ===========
  42
  43 Window Maker is the GNU window manager for the X Window System. It was designed
  44 to emulate the look and feel of part of the NEXTSTEP(tm) GUI. It's supposed to
  45 be relatively fast and small, feature rich, easy to configure and easy to use,
  46 with a simple and elegant appearance borrowed from NEXTSTEP(tm).
  47
  48 Window Maker was designed keeping integration with GNUstep in mind and is the
  49 "official" window manager for it. It is also part of the GNU project
  50 (www.gnu.org) Read more about GNUstep further on this file.
  51
  52 Hints (information given by applications to integrate well with the window
  53 manager) for Motif(tm) and NETWM are also supported (NETWM is used by KDE and
  54 GNOME, so they are automatically supported as a result).  So you can replace any
  55 of the window managers for these environments with Window Maker while keeping
  56 most, if not all, of the native window manager functionality.
  57
  58 Window Maker was previously called WindowMaker.
  59
  60 Window Maker has no connection with Windowmaker, the software for making windows
  61 and doors.
  62
  63
  64 Documentation
  65 =============
  66
  67 Read before asking.
  68
  69 * README files all over the source tree have info related to the stuff
  70 in the directories.
  71
  72 * INSTALL has installation instructions and some troubleshooting tips.
  73 You're meant to read it before installing. it was not written just to fill up
  74 space in the package.
  75
  76 * FAQ: Frequently Asked Questions. READ IT!!! FAQ.I18N is for
  77 internationalization related questions.
  78
  79 * NEWS: list user visible changes from the previous version. Read it if
  80 you are upgrading.
  81
  82 * MIRRORS: some alternative places where you can get Window Maker,
  83 including platform specific packages of Window Maker.
  84
  85 * BUGFORM: use it to send bug reports. Please do use it.
  86
  87 * ChangeLog: what changed from the previous version?
  88
  89 * BUGS: list of known bugs
  90
  91 *** Tutorial
  92
  93 There's a tutorial maintained by Georges Tarbouriech at:
  94
  95 http://www.linuxfocus.org/~georges.t/
  96
  97
  98 *** User Guide
  99
 100 The Window Maker User's Guide can be downloaded from the official ftp
 101 or web sites.
 102
 103 The User Guide explains how to use Window Maker, the configuration files
 104 and options.
 105
 106
 107 *** man pages
 108
 109 Type "man wmaker" in the shell prompt to get general help about Window Maker
 110
 111
 112
 113 Directories & Files in the Source Tree
 114 ======================================
 115
 116 * Install is a script for configuring and compiling Window Maker in a easy
 117   way (not that the normal way is difficult, but...).
 118
 119 * AUTHORS: the credits
 120
 121 * TODO: plans for the future
 122
 123 * contrib/ has some contributed patches that are not supported by Window Maker
 124   because they conflict with design philosophies of the developers or some other
 125   reason.
 126
 127 * util/ has various utility programs.
 128
 129 * WPrefs.app/ is the configuration program.
 130
 131 * src/wconfig.h has compile time options you can change to select some
 132   options/features and other stuff.
 133
 134 * WINGs/ NEXTSTEP lookalike widget library
 135
 136 * wrlib/ image processing library
 137
 138 * po/ has message catalogs wich are the translated versions of the messages
 139   displayed by Window Maker.
 140
 141 * docklib-x.x.tar.gz  a library for writing dockapps
 142
 143
 144 HELP ME!!!
 145 ==========
 146
 147 There is a mailing list for discussing Window Maker at
 148 wmaker-user@ilists.windowmaker.org To subscribe to it, send a message to
 149 wmaker-user-subscribe@lists.windowmaker.info
 150
 151 If you got a problem, ask there (after reading the docs, of course). The people
 152 there is more likely to be able to answer your questions than we are.  For bug
 153 reports use the BUGFORM.
 154
 155 If you have a problem with a precompiled version of Window Maker (rpm, deb etc),
 156 first ask the person who made the package.
 157
 158 IMPORTANT NOTE: when asking for help (in the mailing list or to the developerts,
 159 directly) *always* send information about the system you are using. You can use
 160 the system information section at the end of BUGFORM as a guideline. Another
 161 thing: please don't send HTML mail.
 162
 163
 164 There is also a #windowmaker IRC channel at freenode. To join there, connect
 165 your irc client to irc.freenode.net. irc.windowmaker.org will direct you to the
 166 correct IRC network.
 167
 168
 169 GNUstep
 170 =======
 171
 172 GNUstep is a complete object-oriented development system, based on the OpenStep
 173 specification released by NeXT(tm) (now Apple(tm)) and Sun(tm). It will provide
 174 everything one needs to produce cross-platform, object-oriented, graphical (and
 175 non-graphical) applications; providing among other things, base system
 176 libraries, a high-level GUI application framework that uses a Display
 177 PostScript(tm)-like imaging model (DGS), objects for accessing relational
 178 databases, distributed objects and a graphical development environment, with
 179 tools like interface modeller, a project management system (project center) and
 180 other tools.
 181
 182 The GNUstep development system will be used to create a user environment, with
 183 everything needed for a complete graphical user interface, such as a file
 184 viewer, text editors and other applications. Note that the user environment (or
 185 "desktop environment") is only a small part of the whole GNUstep project and
 186 therefore it does not "compete" with other projects like KDE or GNOME, simply
 187 because they are completely different things.
 188
 189 For more information on the GNUstep project, visit: http://www.gnustep.org
 190
 191
 192 Running multiple instances of Window Maker
 193 ==========================================
 194
 195 It is not a good idea to run more than one instance of Window Maker
 196 from the same user (so that wmaker will use the same configuration files) at the
 197 same time. You might get unexpected behaviour when Window Maker updates it's
 198 configuration files.
 199
 200 If you really desire to do this, try running Window Maker with the command line
 201 option --static so that it will not update or change any of the configuration
 202 files.
 203
 204 Sound support
 205 =============
 206
 207 Sound is supported for Linux and FreeBSD systems with the use of a separately
 208 distributed module called WSoundServer. There is also a graphical configuration
 209 tool for setting up your sounds called WSoundPrefs.  You can download these at:
 210 http://shadowmere.student.utwente.nl/
 211
 212 Note that you must compile Window Maker with the --enable-sound configure
 213 flag and set the DisableSound option to NO.
 214
 215
 216 Performance Tuning
 217 ==================
 218
 219 If you want to diminish Window Maker's memory usage and improve performance,
 220 while keeping a nice appearance and good functionality, follow the items bellow:
 221
 222 - use solid textures for everything, mainly titlebars and menus. If you want a
 223   nice looking desktop, use the Traditional style.
 224 - turn NewStyle and Superfluous off
 225 - do not bind many shortcuts in the menu and keep only the essential items in
 226   the menu
 227 - turn on DisableClip
 228 - edit wconfig.h and disable the NUMLOCK_HACK and the features you don't use
 229   anyway (keep in mind that some of the #defines might not work, as they are not
 230   fully supported). Make sure to always keep NumLock and ScrollLock turned off.
 231 - turn on DisableAnimations. You can also #undefine ANIMATIONS in wconfig.h
 232 - strip down the default IconPath and PixmapPath entries to contain only
 233   the paths that you really have in your system.
 234 - do not use large images in the root background
 235 - remove support for image formats you don't use
 236 - to reduce memory usage, disable the icon cache, by setting the RIMAGE_CACHE
 237   environment variable to 0. If you want to increase performance at the cost of
 238   memory usage, set it's value to a value like the number of different icons you
 239   use. Also, disable anti-aliased text support in ~/GNUstep/Defaults/WMGLOBAL.
 240
 241
 242 Keyboard Mouse Control
 243 ======================
 244
 245 Many people ask about adding keyboard control of mouse, like in fvwm, but Window
 246 Maker will not have such feature. The XKB extension supports mouse simulation
 247 from the keyboard, in a much more powerfull fashion than any simulation done by
 248 a window manager.
 249
 250 To enable it, hit the Control+Shift+NumLock or Shift+NumLock key combination.
 251 You should hear the speaker beeping. To disable it, do the same thing.
 252
 253 To control the mouse the numeric keypad is used as follows:
 254 - 4 (left arrow), 7 (Home), 8 (up arrow), 9 (PgUp), 6 (right arrow),
 255 3 (PgDn), 2 (down arrow) and 1 (End) move the mouse to the corresponding
 256 direction;
 257 - holding one of the above keys and then holding the 5 key will move the
 258 pointer faster;
 259 - / will select the first mouse button (left button);
 260 - * will select the second mouse button (middle button);
 261 - - will select the third mouse button (right button);
 262 - 5 will do a click with the currently selected mouse button;
 263 - + will do a double-click with the currently selected button;
 264 - 0 (Ins) will click and hold the currently selected button;
 265 - . (Del) will release the currently selected button that was previously
 266 clicked with the 0 (Ins) key.
 267
 268
 269 The above key values work in a XFree86 3.2 (X11R6.1) X server but your
 270 milleage may vary.
 271
 272
 273 How to make a gdb backtrace
 274 ===========================
 275
 276 Backtraces can help us fix bugs that make Window Maker crash. If you find a bug
 277 that crashes Window Maker, please send a backtrace with your bug report.
 278
 279 To make a usefull backtrace, you need a core file with debugging information
 280 produced by Window Maker when it crashes. It should have been installed without
 281 stripping too.
 282
 283 To compile wmaker with debugging information:
 284
 285   ./configure
 286   make CFLAGS=-g
 287
 288 If you get the dialog window telling you that wmaker crashed and asks you what
 289 to do, tell it to "Abort and leave a core file".
 290
 291   script
 292   cd src
 293   gdb .libs/wmaker path_to_the_core_file
 294
 295 Then, in the gdb prompt type "bt". Quit from gdb by typing "quit" and then, in
 296 the shell prompt, type "exit".
 297
 298 The file named typescript will contain the backtrace.
 299
 300
 301
 302 Copyrights & Disclaimers
 303 ========================
 304
 305 Window Maker is copyrighted by Alfredo K. Kojima and is licensed through the GNU
 306 General Public License. Read the COPYING file for the complete license.
 307
 308 The icons that are distributed with this program and were made by Marco van
 309 Hylckama Vlieg, are licensed through the GNU General Public License. Read the
 310 COPYING file for the complete license.
 311
 312 The icons listed in COPYING.WTFPL and are distributed in this program and were
 313 made by Banlu Kemiyatorn (]d), are licensed through the "do What The Fuck you
 314 want to Public License". Read the COPYING.WTFPL file for the complete license.
 315
 316 NeXT, OpenStep and NEXTSTEP are a trademarks of NeXT Computer, Inc.  All other
 317 trademarks are property of their respective owners.
 318
 319 The authors reserve the right to make changes in the software without prior
 320 notice.
 321
 322
 323 Authors
 324 =======
 325
 326 Alfredo K. Kojima <kojima@windowmaker.info>
 327 Dan Pascu <dan@windowmaker.info>
 328 ]d <id@windowmaker.info>
 329
 330 Please don't ask us questions before reading the documentation (esp. the FAQ,
 331 this file and INSTALL files) and about "cool" things you see in people's desktop
 332 screenshots.
 333
 334
 335 The AUTHORS file contains a list of the people who have contributed to the
 336 project. The name of people who have helped with localization (translation) can
 337 be found in po/README and Window Maker/README
 338
 339 If you have any comments, fixes and bug reports (filled BUGFORMs) send them
 340 to wmaker-dev@lists.windowmaker.org
 341