WindowMaker: New function wGetWorkspaceNumber
[wmaker-crm.git] / WPrefs.app / README
blobd8dffcb8b76627733574c0d9bc97cbe794854e75
2                                   WPrefs.app
3                                   ==========
5                   The WindowMaker Prerefences Application
6                 
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. 
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.
17     To run WPrefs, do not put it in your search path. Instead, run it
18 with the full path, like /usr/local/GNUstep/Applications/WPrefs.app/WPrefs
19 Then, dock it's application icon. The dock will automatically detect it's
20 icon and use it.
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.
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.
36 License
37 -------
39     Like Window Maker, WPrefs is distributed with through the General Public
40 License (as stated in the file COPYING). 
42 Notes
43 -----
45 The mouse speed configuration is saved as a call for xset in 
46 ~/G/D/L/W/autostart. WindowMaker calls this file when it is started.
48 If you don't want or can't use the menu definition section, do not
49 open it's section (or if you do open it, do not Save), or WPrefs will
50 overwrite your ~/G/D/WMRootMenu file.
52 Only options that have different values than what is found in the 
53 system-wide configuration file is saved.
55 WPrefs only supports property list menus. If you have a plain text file
56 menu, it will not be read by WPrefs. You can either recreate the menu from
57 scratch or not use WPrefs for menu definition. The old menu will not be
58 overwritten if you recreate it.
61 Build
62 -----
64 WPrefs will be built automatically and installed with the rest of WindowMaker.
68 Customized Installation
69 -----------------------
71 By default, WPrefs.app will be installed in the GNUstep applications directory, 
72 which is /usr/local/GNUstep/Applications. If you want to install it somewhere 
73 else, like in /some_weird_path/Applications, set the GNUSTEP_LOCAL_ROOT
74 environment variable to some_weird_path before running configure for
75 WindowMaker. You can also configure Window Maker supplying the --with-gnustepdir
76 option to configure, like ./configure --with-gnustepdir=/usr/GNUstep/Applications
77 If you change your mind after installing, you can move the .app directory 
78 to one of the following GNUstep/Applications directories:
80 /usr/GNUstep/Applications
84 /usr/local/GNUstep/Applications
88 ~/GNUstep/Applications
92 Credits
93 -------
95 User interface design, programming and a few icons:
96     Alfredo K. Kojima <kojima@windowmaker.info>         
98 Additional programming:
99     James Thompson <jamest@math.ksu.edu>
100     Dan Pascu <dan@windowmaker.info>
101     ]d <id@windowmaker.info>
103 Icon and image artwork:
104     Jesse Kaufman <glandix@linuxfreak.com>
105     Marco van Hylckama Vlieg <marco@windowmaker.info>
106     See details in README in tiff/ directory
108 WindowMaker
109 -----------
111     If for some weird reason you end up with this preferences program and 
112 don't have Window Maker yet, you can get more information about it at
113 http://windowmaker.info and download it at ftp://ftp.windowmaker.info
116 Contact
117 -------
119 Send comments and bug reports to kojima@windowmaker.info 
120 Use the WindowMaker BUGFORM to report bugs.