Add debianisation code and automatic build script
[wmaker-crm.git] / doc / wmaker.1x
blob57c36dd600d7cd345940dfb05c87df5093dac2a6
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 \-\-no\-cpp
15 disable preprocessing of configuration files
16 .TP
17 .B \-\-no\-dock
18 do not show the application Dock
19 .TP
20 .B \-\-no\-clip
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 \-\-visual\-id
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 .TP
41 .B \-\-help
42 print a brief help message
43 .PP
44 .SH FILES
45 .TP
46 .B ~/GNUstep/Defaults/WindowMaker
47 general Window Maker defaults.
48 .TP
49 .B ~/GNUstep/Defaults/WMState
50 information about the Dock and Clip. DON'T edit this while running
51 Window Maker. It will be overwritten.
52 .TP
53 .B ~/GNUstep/Defaults/WMRootMenu
54 Contains the name of the file to read the root menu from or the
55 menu itself, in property list format.
56 .TP
57 .B ~/GNUstep/Defaults/WMWindowAttributes
58 Attributes for different application classes and instances. Use the
59 Attribute Editor (right drag the application's title bar, select
60 Attributes) instead of modifying this file directly. There are just a
61 few options not available using the Attributes Editor.
62 .TP
63 .B /usr/share/WindowMaker/Defaults/
64 All the above-mentioned files are READ from here if not found except
65 for WMState, which is COPIED from here. No matter where they are read
66 from, if it's necesary to write configuration changes back into this
67 files, user's files will be written to.
68 .TP
69 .B ~/GNUstep/Library/WindowMaker/autostart
70 This script is automatically executed when Window Maker is started.
71 .TP
72 .B ~/GNUstep/Library/WindowMaker/exitscript
73 This script is automatically executed immediately before Window Maker is 
74 exited.
75 .B Note:
76 If you need to run something that requires the X server to be running
77 from this script, make sure you do not use the
78 .I SHUTDOWN
79 command from the root menu to exit Window Maker. Otherwise, the X server
80 might be shut down before the script is executed.
81 .TP
82 .B ~/GNUstep/Library/WindowMaker/
83 The menu file indicated in WMRootMenu is looked for here...
84 .TP
85 .B /etc/X11/WindowMaker/
86 and here, in that order. Unless, the indicated path is an absolute path.
87 .TP
88 .B ~/GNUstep/Library/WindowMaker/Pixmaps/
89 Window Maker looks for pixmaps here
90 .TP
91 .B ~/GNUstep/Library/WindowMaker/Backgrounds/
92 Window Maker looks for backgrounds here
93 .TP
94 .B ~/GNUstep/Library/WindowMaker/Styles/
95 Window Maker looks for style files here (not true... it looks like it
96 does, but you have to specify the full path anyway, it's just a place
97 to keep things nicely ordered)
98 .TP
99 .B ~/GNUstep/Library/WindowMaker/Themes/
100 Window Maker looks for theme files here (ibid)
102 .B /usr/share/WindowMaker/Pixmaps/
103 System wide pixmaps are located here...
105 .B /usr/share/WindowMaker/Pixmaps/
106 and here.
108 .B /usr/share/WindowMaker/Styles/
109 System wide styles are here
111 .B /usr/share/WindowMaker/Themes/
112 Guess... ;-)
113 .SH ENVIRONMENT
114 .IP GNUSTEP_USER_ROOT
115 specifies the initial path for the Defaults directory. "Defaults/" is
116 appended to this variable to determine the actual location of the
117 databases. If the varialbe is not set, it defaults to "~/GNUstep"
118 .IP GNUSTEP_LOCAL_ROOT
119 specifies the location of the system-wide \fBlocal\fP GNUstep
120 directory (this is useful, for example, in those cases where the
121 system-wide location is really a network wide location). If this
122 variable is empty, GNUSTEP_SYSTEM_ROOT is looked for.
123 .IP GNUSTEP_SYSTEM_ROOT
124 specifies the location of the system-wide GNUstep directory. If this
125 variable is empty, it defaults to /etc/GNUstep
126 .SH SEE ALSO
127 The Window Maker User Guide
129 The Window Maker FAQ
131 .BR X (1x),
132 .BR wdwrite (1x),
133 .BR wxcopy (1x),
134 .BR geticonset (1x),
135 .BR seticons (1x),
136 .BR wmaker (1x),
137 .BR wxpaste (1x),
138 .BR getstyle (1x),
139 .BR setstyle (1x),
140 .BR wmsetbg (1x)
141 .SH AUTHOR
142 Window Maker was written by Alfredo K. Kojima <kojima@windowmaker.info>,
143 Dan Pascu <dan@windowmaker.info> with contributions from many people around
144 the Internet.
146 This manual page was written by Marcelo E. Magallon, <mmagallo@debian.org>.