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 * BUGFORM: use it to send bug reports. Please do use it.
  83
  84 * ChangeLog: what changed from the previous version?
  85
  86 * BUGS: list of known bugs
  87
  88
  89 *** User Guide
  90
  91 The Window Maker User's Guide can be downloaded from the official ftp
  92 or web sites.
  93
  94 The User Guide explains how to use Window Maker, the configuration files
  95 and options.
  96
  97
  98 *** man pages
  99
 100 Type "man wmaker" in the shell prompt to get general help about Window Maker
 101
 102
 103
 104 Directories & Files in the Source Tree
 105 ======================================
 106
 107 * Install is a script for configuring and compiling Window Maker in a easy
 108   way (not that the normal way is difficult, but...).
 109
 110 * AUTHORS: the credits
 111
 112 * TODO: plans for the future
 113
 114 * util/ has various utility programs.
 115
 116 * WPrefs.app/ is the configuration program.
 117
 118 * src/wconfig.h has compile time options you can change to select some
 119   options/features and other stuff.
 120
 121 * WINGs/ NEXTSTEP lookalike widget library
 122
 123 * wrlib/ image processing library
 124
 125 * po/ has message catalogs wich are the translated versions of the messages
 126   displayed by Window Maker.
 127
 128 * docklib-x.x.tar.gz  a library for writing dockapps
 129
 130
 131 HELP ME!!!
 132 ==========
 133
 134 There is a mailing list for discussing Window Maker at
 135 wmaker-user@lists.windowmaker.org To subscribe to it, send a message to
 136 wmaker-user-subscribe@lists.windowmaker.info
 137
 138 If you got a problem, ask there (after reading the docs, of course). The people
 139 there is more likely to be able to answer your questions than we are.  For bug
 140 reports use the BUGFORM.
 141
 142 If you have a problem with a precompiled version of Window Maker (rpm, deb etc),
 143 first ask the person who made the package.
 144
 145 IMPORTANT NOTE: when asking for help (in the mailing list or to the developerts,
 146 directly) *always* send information about the system you are using. You can use
 147 the system information section at the end of BUGFORM as a guideline. Another
 148 thing: please don't send HTML mail.
 149
 150
 151 There is also a #windowmaker IRC channel at freenode. To join there, connect
 152 your irc client to irc.freenode.net. irc.windowmaker.org will direct you to the
 153 correct IRC network.
 154
 155
 156 GNUstep
 157 =======
 158
 159 GNUstep is a complete object-oriented development system, based on the OpenStep
 160 specification released by NeXT(tm) (now Apple(tm)) and Sun(tm). It will provide
 161 everything one needs to produce cross-platform, object-oriented, graphical (and
 162 non-graphical) applications; providing among other things, base system
 163 libraries, a high-level GUI application framework that uses a Display
 164 PostScript(tm)-like imaging model (DGS), objects for accessing relational
 165 databases, distributed objects and a graphical development environment, with
 166 tools like interface modeller, a project management system (project center) and
 167 other tools.
 168
 169 The GNUstep development system will be used to create a user environment, with
 170 everything needed for a complete graphical user interface, such as a file
 171 viewer, text editors and other applications. Note that the user environment (or
 172 "desktop environment") is only a small part of the whole GNUstep project and
 173 therefore it does not "compete" with other projects like KDE or GNOME, simply
 174 because they are completely different things.
 175
 176 For more information on the GNUstep project, visit: http://www.gnustep.org
 177
 178
 179 Running multiple instances of Window Maker
 180 ==========================================
 181
 182 It is not a good idea to run more than one instance of Window Maker
 183 from the same user (so that wmaker will use the same configuration files) at the
 184 same time. You might get unexpected behaviour when Window Maker updates it's
 185 configuration files.
 186
 187 If you really desire to do this, try running Window Maker with the command line
 188 option --static so that it will not update or change any of the configuration
 189 files.
 190
 191
 192 Performance Tuning
 193 ==================
 194
 195 If you want to diminish Window Maker's memory usage and improve performance,
 196 while keeping a nice appearance and good functionality, follow the items bellow:
 197
 198 - use solid textures for everything, mainly titlebars and menus. If you want a
 199   nice looking desktop, use the Traditional style.
 200 - turn NewStyle and Superfluous off
 201 - do not bind many shortcuts in the menu and keep only the essential items in
 202   the menu
 203 - turn on DisableClip
 204 - edit wconfig.h and disable the NUMLOCK_HACK and the features you don't use
 205   anyway (keep in mind that some of the #defines might not work, as they are not
 206   fully supported). Make sure to always keep NumLock and ScrollLock turned off.
 207 - turn on DisableAnimations. You can also #undefine ANIMATIONS in wconfig.h
 208 - strip down the default IconPath and PixmapPath entries to contain only
 209   the paths that you really have in your system.
 210 - do not use large images in the root background
 211 - remove support for image formats you don't use
 212 - to reduce memory usage, disable the icon cache, by setting the RIMAGE_CACHE
 213   environment variable to 0. If you want to increase performance at the cost of
 214   memory usage, set it's value to a value like the number of different icons you
 215   use. Also, disable anti-aliased text support in ~/GNUstep/Defaults/WMGLOBAL.
 216
 217
 218 Keyboard Mouse Control
 219 ======================
 220
 221 Many people ask about adding keyboard control of mouse, like in fvwm, but Window
 222 Maker will not have such feature. The XKB extension supports mouse simulation
 223 from the keyboard, in a much more powerfull fashion than any simulation done by
 224 a window manager.
 225
 226 To enable it, hit the Control+Shift+NumLock or Shift+NumLock key combination.
 227 You should hear the speaker beeping. To disable it, do the same thing.
 228
 229 To control the mouse the numeric keypad is used as follows:
 230 - 4 (left arrow), 7 (Home), 8 (up arrow), 9 (PgUp), 6 (right arrow),
 231 3 (PgDn), 2 (down arrow) and 1 (End) move the mouse to the corresponding
 232 direction;
 233 - holding one of the above keys and then holding the 5 key will move the
 234 pointer faster;
 235 - / will select the first mouse button (left button);
 236 - * will select the second mouse button (middle button);
 237 - - will select the third mouse button (right button);
 238 - 5 will do a click with the currently selected mouse button;
 239 - + will do a double-click with the currently selected button;
 240 - 0 (Ins) will click and hold the currently selected button;
 241 - . (Del) will release the currently selected button that was previously
 242 clicked with the 0 (Ins) key.
 243
 244
 245 The above key values work in a XFree86 3.2 (X11R6.1) X server but your
 246 milleage may vary.
 247
 248
 249 How to make a gdb backtrace
 250 ===========================
 251
 252 Backtraces can help us fix bugs that make Window Maker crash. If you find a bug
 253 that crashes Window Maker, please send a backtrace with your bug report.
 254
 255 To make a usefull backtrace, you need a core file with debugging information
 256 produced by Window Maker when it crashes. It should have been installed without
 257 stripping too.
 258
 259 To compile wmaker with debugging information:
 260
 261   ./configure
 262   make CFLAGS=-g
 263
 264 If you get the dialog window telling you that wmaker crashed and asks you what
 265 to do, tell it to "Abort and leave a core file".
 266
 267   script
 268   cd src
 269   gdb .libs/wmaker path_to_the_core_file
 270
 271 Then, in the gdb prompt type "bt". Quit from gdb by typing "quit" and then, in
 272 the shell prompt, type "exit".
 273
 274 The file named typescript will contain the backtrace.
 275
 276
 277
 278 Copyrights & Disclaimers
 279 ========================
 280
 281 Window Maker is copyrighted by Alfredo K. Kojima and is licensed through the GNU
 282 General Public License. Read the COPYING file for the complete license.
 283
 284 The icons that are distributed with this program and were made by Marco van
 285 Hylckama Vlieg, are licensed through the GNU General Public License. Read the
 286 COPYING file for the complete license.
 287
 288 The icons listed in COPYING.WTFPL and are distributed in this program and were
 289 made by Banlu Kemiyatorn (]d), are licensed through the "do What The Fuck you
 290 want to Public License". Read the COPYING.WTFPL file for the complete license.
 291
 292 NeXT, OpenStep and NEXTSTEP are a trademarks of NeXT Computer, Inc.  All other
 293 trademarks are property of their respective owners.
 294
 295 The authors reserve the right to make changes in the software without prior
 296 notice.
 297
 298
 299 Authors
 300 =======
 301
 302 Alfredo K. Kojima <kojima@windowmaker.info>
 303 Dan Pascu <dan@windowmaker.info>
 304 ]d <id@windowmaker.info>
 305
 306 Please don't ask us questions before reading the documentation (esp. the FAQ,
 307 this file and INSTALL files) and about "cool" things you see in people's desktop
 308 screenshots.
 309
 310
 311 The AUTHORS file contains a list of the people who have contributed to the
 312 project. The name of people who have helped with localization (translation) can
 313 be found in po/README and Window Maker/README
 314
 315 If you have any comments, fixes and bug reports (filled BUGFORMs) send them
 316 to wmaker-dev@lists.windowmaker.org
 317