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). As an exception, the icons and
  41 original graphical artwork included with WPrefs has the additional
  42 restriction that they must not be redistributed without the rest of the
  43 Window Maker distribution. In other words, you can use and distribute the
  44 WPrefs icons freely, as long as they are distributed for use with Window
  45 Maker (ripping the icons and putting them in your program is prohibited).
  46
  47
  48 Notes
  49 -----
  50
  51 The mouse speed configuration is saved as a call for xset in
  52 ~/G/D/L/W/autostart. WindowMaker calls this file when it is started.
  53
  54 If you don't want or can't use the menu definition section, do not
  55 open it's section (or if you do open it, do not Save), or WPrefs will
  56 overwrite your ~/G/D/WMRootMenu file.
  57
  58 Only options that have different values than what is found in the
  59 system-wide configuration file is saved.
  60
  61 WPrefs only supports property list menus. If you have a plain text file
  62 menu, it will not be read by WPrefs. You can either recreate the menu from
  63 scratch or not use WPrefs for menu definition. The old menu will not be
  64 overwritten if you recreate it.
  65
  66
  67 Build
  68 -----
  69
  70 WPrefs will be built automatically and installed with the rest of WindowMaker.
  71
  72
  73
  74 Customized Installation
  75 -----------------------
  76
  77 By default, WPrefs.app will be installed in the GNUstep applications
  78 directory, which is /usr/local/GNUstep/Apps. If you want to install it
  79 somewhere else, like in /some_weird_path/Apps, set the GNUSTEP_LOCAL_ROOT
  80 environment variable to some_weird_path before running configure for
  81 WindowMaker. You can also configure Window Maker supplying the --with-appspath
  82 option to configure, like ./configure --with-appspath=/usr/GNUstep/Apps
  83 If you change your mind after installing, you can move the .app directory
  84 to one of the following GNUstep/Apps directories:
  85
  86 /usr/GNUstep/Apps
  87
  88 OR
  89
  90 /usr/local/GNUstep/Apps
  91
  92 OR
  93
  94 ~/GNUstep/Apps
  95
  96
  97
  98 Credits
  99 -------
 100
 101 User interface design, programming and a few icons:
 102     Alfredo K. Kojima <kojima@windowmaker.org>
 103
 104 Additional programming:
 105     James Thompson <jamest@math.ksu.edu>
 106
 107 Icon and image artwork:
 108     Marco van Hylckama Vlieg <fatal@global.uibk.ac.at>
 109
 110
 111 WindowMaker
 112 -----------
 113
 114     If for some weird reason you end up with this preferences program and
 115 don't have Window Maker yet, you can get more information about it at
 116 http://windowmaker.org and download it at ftp://ftp.windowmaker.org
 117
 118
 119 Contact
 120 -------
 121
 122 Send comments and bug reports to kojima@windowmaker.org
 123 Use the WindowMaker BUGFORM to report bugs.
 124