WPrefs.app/README

   1
   2                                   WPrefs.app
   3                                   ==========
   4
   5                   The WindowMaker Prerefences Application
   6
   7
   8     WPrefs.app is the preferences "editor" for the WindowMaker window
   9 manager. It can be used to set most of the preference options of WindowMaker
  10 and define it's applications menu. It also can change some settings
  11 that do not belong to WindowMaker.
  12
  13     Although WPrefs.app is designed to be easy to use, you should read the
  14 user guide to be fully aware of all available options and other features
  15 of WindowMaker that are not related to configuration.
  16
  17     To run WPrefs, do not put it in your search path. Instead, run it
  18 with the full path, like /usr/local/GNUstep/Apps/WPrefs.app/WPrefs
  19 Then, dock it's application icon. The dock will automatically detect it's
  20 icon and use it.
  21
  22     If you change configuration often, you might want to leave WPrefs
  23 always running, leaving it hidden while not in use. You can also make it
  24 be automatically started with WindowMaker and toggle the Start Hidden
  25 option in the attributes panel for the WPrefs window. Of course, it will
  26 use some memory, but by leaving it hidden it'll probably be swapped out and
  27 stay there until you unhide it.
  28
  29     WPrefs is still under development. Some of the configuration options are
  30 not yet configurable from WPrefs, notably the appearance related options.
  31 It might contain bugs that can corrupt your configuration files, so backup
  32 the contents of the ~/GNUstep/Defaults directory before using it.
  33
  34
  35
  36 License
  37 -------
  38
  39     Like Window Maker, WPrefs is distributed with through the General Public
  40 License (as stated in the file COPYING).
  41
  42 The graphical artwork included with WPrefs is NOT licensed through the GPL.
  43 It is licensed through the OpenContent License, instead. Please read the
  44 COPYING.OPL file for the detailed license.
  45
  46
  47 Notes
  48 -----
  49
  50 The mouse speed configuration is saved as a call for xset in
  51 ~/G/D/L/W/autostart. WindowMaker calls this file when it is started.
  52
  53 If you don't want or can't use the menu definition section, do not
  54 open it's section (or if you do open it, do not Save), or WPrefs will
  55 overwrite your ~/G/D/WMRootMenu file.
  56
  57 Only options that have different values than what is found in the
  58 system-wide configuration file is saved.
  59
  60 WPrefs only supports property list menus. If you have a plain text file
  61 menu, it will not be read by WPrefs. You can either recreate the menu from
  62 scratch or not use WPrefs for menu definition. The old menu will not be
  63 overwritten if you recreate it.
  64
  65
  66 Build
  67 -----
  68
  69 WPrefs will be built automatically and installed with the rest of WindowMaker.
  70
  71
  72
  73 Customized Installation
  74 -----------------------
  75
  76 By default, WPrefs.app will be installed in the GNUstep applications
  77 directory, which is /usr/local/GNUstep/Apps. If you want to install it
  78 somewhere else, like in /some_weird_path/Apps, set the GNUSTEP_LOCAL_ROOT
  79 environment variable to some_weird_path before running configure for
  80 WindowMaker. You can also configure Window Maker supplying the --with-appspath
  81 option to configure, like ./configure --with-appspath=/usr/GNUstep/Apps
  82 If you change your mind after installing, you can move the .app directory
  83 to one of the following GNUstep/Apps directories:
  84
  85 /usr/GNUstep/Apps
  86
  87 OR
  88
  89 /usr/local/GNUstep/Apps
  90
  91 OR
  92
  93 ~/GNUstep/Apps
  94
  95
  96
  97 Credits
  98 -------
  99
 100 User interface design, programming and a few icons:
 101     Alfredo K. Kojima <kojima@windowmaker.org>
 102
 103 Additional programming:
 104     James Thompson <jamest@math.ksu.edu>
 105     Dan Pascu <dan@windowmaker.org>
 106     ]d <id@windowmaker.org>
 107
 108 Icon and image artwork:
 109     Jesse Kaufman <glandix@linuxfreak.com>
 110     Marco van Hylckama Vlieg <marco@windowmaker.org>
 111     See details in README in tiff/ directory
 112
 113 WindowMaker
 114 -----------
 115
 116     If for some weird reason you end up with this preferences program and
 117 don't have Window Maker yet, you can get more information about it at
 118 http://windowmaker.org and download it at ftp://ftp.windowmaker.org
 119
 120
 121 Contact
 122 -------
 123
 124 Send comments and bug reports to kojima@windowmaker.org
 125 Use the WindowMaker BUGFORM to report bugs.
 126