Add debianisation code and automatic build script
[wmaker-crm.git] / debian / manpages / wmaker.1x
1 .\" Hey, Emacs!  This is an -*- nroff -*- source file.
2 .TH "Window Maker" 1x "January 1999" "Debian Project"
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 .PP
13 \fIPlease note this manpage has been modified to reflect changes in the
14 Debian installation of Window Maker.\fP
15 .SH "OPTIONS"
16 .TP
17 .B \-display host:display.screen
18 specify display to use.
19 On multiheaded machines, Window Maker will automatically manage all screens.
20 If you want Window Maker to manage only a specific screen, you must supply
21 the screen number you want to have managed with the 
22 .B \-display
23 command line argument. For example, if you want Window Maker to manage only
24 screen 1, start it as:
25 .B wmaker -display :0.1
26 .TP
27 .B \-\-no\-cpp
28 disable preprocessing of configuration files
29 .TP
30 .B \-\-no\-dock
31 do not show the application Dock
32 .TP
33 .B \-\-no\-clip
34 do not show the workspace Clip
35 .TP
36 .B \-\-no\-autolaunch
37 do not autolaunch applications
38 .TP
39 .B \-\-dont\-restore
40 do not restore saved session
41 .TP
42 .B \-\-locale locale
43 specify the locale to use
44 .TP
45 .B \-\-create-stdcmap
46 create the standard colormap hint in PseudoColor visuals
47 .TP
48 .B \-\-visual\-id
49 visual id of visual to use
50 .TP
51 .B \-\-static
52 do not update or save configurations
53 .TP
54 .B \-\-version
55 display version number and exit
56 .TP
57 .B \-\-visual\-id
58 specify the ID of the visual to use. See
59 .BR xdpyinfo (1x)
60 for a list of visuals available in your display.
61 .TP
62 .B \-\-help
63 print a brief help message
64 .PP
65 .SH FILES
66 .TP
67 .B ~/GNUstep/Defaults/WindowMaker
68 general Window Maker defaults.
69 .TP
70 .B ~/GNUstep/Defaults/WMState
71 information about the Dock and Clip. DON'T edit this while running
72 Window Maker. It will be overwritten.
73 .TP
74 .B ~/GNUstep/Defaults/WMRootMenu
75 Contains the name of the file to read the root menu from or the
76 menu itself, in property list format.
77 .TP
78 .B ~/GNUstep/Defaults/WMWindowAttributes
79 Attributes for different application classes and instances. Use the
80 Attribute Editor (right drag the application's title bar, select
81 Attributes) instead of modifying this file directly. There are just a
82 few options not available using the Attributes Editor.
83 .TP
84 .B /etc/GNUstep/Defaults/
85 All the above-mentioned files are READ from here if not found except
86 for WMState, which is COPIED from here. No matter where they are read
87 from, if it's necesary to write configuration changes back into this
88 files, user's files will be written to.
89 .TP
90 .B ~/GNUstep/Library/WindowMaker/autostart
91 This script is automatically executed when Window Maker is started.
92 .TP
93 .B ~/GNUstep/Library/WindowMaker/exitscript
94 This script is automatically executed immediately before Window Maker is 
95 exited.
96 .B Note:
97 If you need to run something that requires the X server to be running
98 from this script, make sure you do not use the
99 .I SHUTDOWN
100 command from the root menu to exit Window Maker. Otherwise, the X server
101 might be shut down before the script is executed.
102 .TP
103 .B ~/GNUstep/Library/WindowMaker/
104 The menu file indicated in WMRootMenu is looked for here...
105 .TP
106 .B /etc/X11/WindowMaker/
107 and here, in that order. Unless, the indicated path is an absolute path.
108 .TP
109 .B ~/GNUstep/Library/WindowMaker/Pixmaps/
110 Window Maker looks for \fBpixmaps\fP here
111 .TP
112 .B ~/GNUstep/Library/Icons/
113 Window Maker looks for \fBicons\fP here
114 .TP
115 .B ~/GNUstep/Library/WindowMaker/Backgrounds/
116 Window Maker looks for backgrounds here
117 .TP
118 .B ~/GNUstep/Library/WindowMaker/Styles/
119 Window Maker looks for style files here (not true... it looks like it
120 does, but you have to specify the full path anyway, it's just a place
121 to keep things nicely ordered)
122 .TP
123 .B ~/GNUstep/Library/WindowMaker/Themes/
124 Window Maker looks for theme files here (ibid)
125 .TP
126 .B /usr/share/WindowMaker/Pixmaps/
127 System-wide (Window Maker-specific) pixmaps are located here
128 .TP
129 .B /usr/share/WindowMaker/Styles/
130 System wide styles are here
131 .TP
132 .B /usr/share/WindowMaker/Themes/
133 Guess... ;-)
134 .SH ENVIRONMENT
135 .IP GNUSTEP_USER_ROOT
136 specifies the initial path for the Defaults directory. "Defaults/" is
137 appended to this variable to determine the actual location of the
138 databases. If the varialbe is not set, it defaults to "~/GNUstep"
139 .IP GNUSTEP_LOCAL_ROOT
140 specifies the location of the system-wide \fBlocal\fP GNUstep
141 directory (this is useful, for example, in those cases where the
142 system-wide location is really a network wide location). If this
143 variable is empty, GNUSTEP_SYSTEM_ROOT is looked for.
144 .IP GNUSTEP_SYSTEM_ROOT
145 specifies the location of the system-wide GNUstep directory. If this
146 variable is empty, it defaults to /etc/GNUstep
147 .SH SEE ALSO
148 The Window Maker User Guide
149 .PP
150 The Window Maker FAQ
151 .PP
152 .BR X (1x),
153 .BR wdwrite (1x),
154 .BR wxcopy (1x),
155 .BR geticonset (1x),
156 .BR seticons (1x),
157 .BR wmaker (1x),
158 .BR wxpaste (1x),
159 .BR getstyle (1x),
160 .BR setstyle (1x),
161 .BR wmsetbg (1x)
162 .SH AUTHOR
163 Window Maker was written by Alfredo K. Kojima <kojima@windowmaker.info>,
164 Dan Pascu <dan@windowmaker.info> with contributions from many people around
165 the Internet.
166 .PP
167 This manual page was written by Marcelo E. Magallon, <mmagallo@debian.org>.