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