README

   1
   2                 WindowMaker 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 Description
  18 ===========
  19
  20 WindowMaker is a window manager designed to emulate the look and feel of
  21 part of the NEXTSTEP(tm) GUI. It's supposed to be relatively fast and small,
  22 feature rich, easy to configure and easy to use, with a simple and elegant
  23 appearance borrowed from NEXTSTEP(tm).
  24
  25
  26 User Guide
  27 ==========
  28
  29 The WindowMaker User's Guide can be downloaded from the official ftp
  30 or web sites.
  31 It can also be viewed in HTML format in:
  32 http://people.delphi.com/crc3419/WMUserGuide/index.htm
  33
  34
  35 Directories & Files
  36 ===================
  37
  38 o INSTALL contains installation instructions and some troubleshooting tips.
  39
  40 o Install is a script for configuring and compiling WindowMaker in a easy
  41 way.
  42
  43 o ChangeLog contains the changes since the last version
  44
  45 o BUGS contains a list of the currently known bugs
  46
  47 o FAQ is a list of frequently asked questions. Read it. I won't answer
  48 questions answered in it.
  49
  50 o NEWS is a list of user visible changes since the last version. Read it if
  51 you are upgrading.
  52
  53 o wmlib/ contains the library necessary to write applications that use
  54 WindowMaker specific features, like application defined menus. This library
  55 will be merged into WINGs in the future.
  56
  57 o WINGs/ contain the WINGs (WINGs Is Not GNUstep) tiny widget library. It is
  58 used by wmaker, but can be used by standalone programs as well.
  59
  60 o test/ contains a simple test program that shows some of the things that can
  61 be done with WindowMaker and wmlib
  62
  63 o wrlib/ contains the library used to do image manipulation (loading,
  64 dithering etc.) in WindowMaker. It can be used in other applications.
  65
  66 o util/ contains various utility programs.
  67
  68 o WPrefs/ contains the source code for the WindowMaker Preferences utility.
  69 Read the WPrefs/README file before using it.
  70
  71 o Configuration options can be found in the ~/GNUstep/Defaults/* files
  72 (after installation). The menus can be configured in
  73 ~/GNUstep/Library/WindowMaker/menu
  74
  75 o The default configuration files for the system are installed by default in
  76 /usr/local/share/WindowMaker, along with some other data files.
  77
  78 o src/wconfig.h contains various compile time options you can change to
  79 select some options/features and things like the path for configuration
  80 directory.
  81
  82 o BUGFORM is a form you should fill to send a bugreport. Please use the
  83 form. It makes things easier to me and ensures that you give me a reasonable
  84 amount of information. This form should be sent to developers@windowmaker.org
  85
  86
  87 Mailing List
  88 ============
  89
  90 There is a mailing list for discussing WindowMaker at
  91 wmaker@linuxcenter.com To subscribe to it, send a message containing:
  92         subscribe
  93 in the subject and the body of the message to wmaker-request@linuxcenter.com
  94
  95 If you have some problem installing or using wmaker, it would be advisable
  96 to ask in the mailing list, as the probability of at least one of the 500+
  97 users there having the same problem as you (and solving it) is bigger than
  98 the three of us. The developers are subscribed to the mailing list, so we
  99 will read your post anyway (no need for cc:). For bug reports, fill
 100 the BUGFORM and send it to developers@windowmaker.org  You can also use
 101 the bug tracker page at http://windowmaker.org/cgi-bin/bugs
 102
 103 Important note: when asking for help (in the mailing list or to the
 104 developerts, directly) always send information about the system you are
 105 using. You can use the system information section at the end of BUGFORM
 106 as a guideline. Another thing: please don't send HTML mail. You will
 107 be risking having your mail deleted before being read. Not everybody
 108 uses a browser to read email, wich makes your message an annoyance.
 109 There should be an option in your mail app to disable it.
 110
 111
 112
 113 Running multiple instances of WindowMaker
 114 =========================================
 115
 116 It is not a good idea to run more than one instance of WindowMaker
 117 from the same user (so that wmaker will use the same configuration
 118 files) at the same time. You might get unexpected behaviour when WindowMaker
 119 updates it's configuration files.
 120
 121
 122 Sound support
 123 =============
 124
 125 Sound is supported for Linux and FreeBSD systems with the use of a
 126 separately distributed module. You can download it at:
 127 http://www.frontiernet.net/~southgat/wmsound
 128
 129 Note that you must compile WindowMaker with the --enable-sound configure
 130 flag and set the DisableSound option to NO.
 131
 132
 133 Performance Tuning
 134 ==================
 135
 136 If you want to diminish WindowMaker's memory usage and improve performance,
 137 while keeping a nice appearance and good functionality, follow the items
 138 bellow:
 139
 140 - use solid textures for everything, mainly titlebars and menus. If you
 141   want a nice looking desktop, use the Traditional style.
 142 - turn NewStyle and Superfluous off
 143 - turn on DisableAnimations
 144 - do not bind many shortcuts in the menu and keep only the essential items
 145   in the menu
 146 - turn on DisableClip
 147 - edit wconfig.h and disable the NUMLOCK_HACK and the features you
 148   don't use anyway (keep in mind that some of the #defines might not
 149   work, as they are not fully supported). Make sure to always keep
 150   NumLock and ScrollLock turned off.
 151 - strip down the default IconPath and PixmapPath entries to contain only
 152   the paths that you really have in your system.
 153 - do not use large images in the root background
 154 - remove support for image formats you don't use
 155
 156
 157 Copyrights
 158 ==========
 159
 160 WindowMaker is copyrighted by Alfredo K. Kojima and is licensed through the
 161 GNU General Public License. Read the COPYING file for the complete license.
 162
 163 NeXT, OpenStep and NEXTSTEP are a trademarks of NeXT Computer, Inc.
 164
 165
 166 Authors
 167 =======
 168
 169 The AUTHORS file contains a list of the people who have contributed to the
 170 project. The name of people who have helped with localization (translation)
 171 can be found in po/README and WindowMaker/README
 172
 173 If you have any comments, fixes and bug reports (filled BUGFORMs) send them
 174 to kojima@windowmaker.org
 175
 176
 177 Musicware
 178 =========
 179
 180 If you use WindowMaker and *really* like it, please consider making my day
 181 by sending me a music CD (or a MiniDisc) of your favorite band, singer,
 182 instrumentist, composer or whatever :^). I like listening to music and would
 183 love to get new CDs, especially from other parts of the world. I like almost
 184 any kind of music, from Ozzy Osbourne to Bach (mas não pagode e sertanejo
 185 pelamordideus :), so I will be happy to receive just about anything.
 186
 187 Snail mail address:
 188
 189 Alfredo Kengi Kojima
 190 Rua Firmino O. Bimbi, 255/25B
 191 Porto Alegre - RS
 192 CEP 91751-330
 193 Brazil
 194