Updating to version 0.20.2
[wmaker-crm.git] / doc / wmaker.1x
blob011b4260f98fe202b93635593a0d389c9839e636
1 .\" Hey, Emacs!  This is an -*- nroff -*- source file.
2 .TH Window\ Maker 1x "August 1998"
3 .SH NAME
4 wmaker \- X11 window manager with a NEXTSTEP look
5 .SH SYNOPSIS
6 .B wmaker
7 .I "[-options]"
8 .SH "DESCRIPTION"
9 Window Maker is a X11 window manager with a NEXTSTEP look. It tries to
10 emulate NeXT's look as much as possible, but it deviates from it as
11 necessary.
12 .SH "OPTIONS"
13 .TP
14 .B \-nocpp
15 disable preprocessing of configuration files
16 .TP
17 .B \-nodock
18 do not show the application Dock
19 .TP
20 .B \-noclip
21 do not show the workspace Clip
22 .TP
23 .B \-display host:display.screen
24 specify display to use.
25 On multiheaded machines, Window Maker will automatically manage all screens.
26 If you want Window Maker to manage only a specific screen, you must supply
27 the screen number you want to have managed with the 
28 .B \-display
29 command line argument. For example, if you want Window Maker to manage only
30 screen 1, start it as:
31 .B wmaker -display :0.1
32 .TP
33 .B \-version
34 display version number and exit
35 .TP
36 .B \-visualid
37 specify the ID of the visual to use. See
38 .BR xdpyinfo (1x)
39 for a list of visuals available in your display.
40 .PP
41 .SH FILES
42 .TP
43 .B ~/GNUstep/Defaults/WindowMaker
44 general Window Maker defaults.
45 .TP
46 .B ~/GNUstep/Defaults/WMState
47 information about the Dock and Clip. DON'T edit this while running
48 Window Maker. It will be overwritten.
49 .TP
50 .B ~/GNUstep/Defaults/WMRootMenu
51 Contains the name of the file to read the root menu from or the
52 menu itself, in property list format.
53 .TP
54 .B ~/GNUstep/Defaults/WMWindowAttributes
55 Attributes for different application classes and instances. Use the
56 Attribute Editor (right drag the application's title bar, select
57 Attributes) instead of modifying this file directly. There are just a
58 few options not available using the Attributes Editor.
59 .TP
60 .B /usr/share/WindowMaker/Defaults/
61 All the above-mentioned files are READ from here if not found except
62 for WMState, which is COPIED from here. No matter where they are read
63 from, if it's necesary to write configuration changes back into this
64 files, user's files will be written to.
65 .TP
66 .B ~/GNUstep/Library/WindowMaker/autostart
67 This script is automatically executed when Window Maker is started.
68 .TP
69 .B ~/GNUstep/Library/WindowMaker/exitscript
70 This script is automatically executed immediately before Window Maker is 
71 exited.
72 .B Note:
73 If you need to run something that requires the X server to be running
74 from this script, make sure you do not use the
75 .I SHUTDOWN
76 command from the root menu to exit Window Maker. Otherwise, the X server
77 might be shut down before the script is executed.
78 .TP
79 .B ~/GNUstep/Library/WindowMaker/
80 The menu file indicated in WMRootMenu is looked for here...
81 .TP
82 .B /etc/X11/WindowMaker/
83 and here, in that order. Unless, the indicated path is an absolute path.
84 .TP
85 .B ~/GNUstep/Library/WindowMaker/Pixmaps/
86 Window Maker looks for pixmaps here
87 .TP
88 .B ~/GNUstep/Library/WindowMaker/Backgrounds/
89 Window Maker looks for backgrounds here
90 .TP
91 .B ~/GNUstep/Library/WindowMaker/Styles/
92 Window Maker looks for style files here (not true... it looks like it
93 does, but you have to specify the full path anyway, it's just a place
94 to keep things nicely ordered)
95 .TP
96 .B ~/GNUstep/Library/WindowMaker/Themes/
97 Window Maker looks for theme files here (ibid)
98 .TP
99 .B /usr/share/WindowMaker/Pixmaps/
100 System wide pixmaps are located here...
102 .B /usr/share/WindowMaker/Pixmaps/
103 and here.
105 .B /usr/share/WindowMaker/Styles/
106 System wide styles are here
108 .B /usr/share/WindowMaker/Themes/
109 Guess... ;-)
110 .SH ENVIRONMENT
111 .IP GNUSTEP_USER_ROOT
112 specifies the initial path for the Defaults directory. "Defaults/" is
113 appended to this variable to determine the actual location of the
114 databases. If the varialbe is not set, it defaults to "~/GNUstep"
115 .IP GNUSTEP_LOCAL_ROOT
116 specifies the location of the system-wide \fBlocal\fP GNUstep
117 directory (this is useful, for example, in those cases where the
118 system-wide location is really a network wide location). If this
119 variable is empty, GNUSTEP_SYSTEM_ROOT is looked for.
120 .IP GNUSTEP_SYSTEM_ROOT
121 specifies the location of the system-wide GNUstep directory. If this
122 variable is empty, it defaults to /etc/GNUstep
123 .SH SEE ALSO
124 The Window Maker User Guide
126 The Window Maker FAQ
128 .BR X (1x),
129 .BR wdwrite (1x),
130 .BR wxcopy (1x),
131 .BR geticonset (1x),
132 .BR seticons (1x),
133 .BR wmaker (1x),
134 .BR wxpaste (1x),
135 .BR getstyle (1x),
136 .BR setstyle (1x),
137 .BR wmsetbg (1x)
138 .SH AUTHOR
139 Window Maker was written by Alfredo K. Kojima <kojima@windowmaker.org>,
140 Dan Pascu <dan@windowmaker.org> with contributions from many people around
141 the Internet.
143 This manual page was written by Marcelo E. Magallon, <mmagallo@debian.org>.