Initial revision
[wmaker-crm.git] / doc / wmaker.1x
blobd85d13c162f7b73b71be8a28c3ba757d4a6c9615
1 .\" Hey, Emacs!  This is an -*- nroff -*- source file.
2 .TH WindowMaker 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 WindowMaker 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, WindowMaker will automatically manage all screens.
26 If you want WindowMaker 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 WindowMaker 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 WindowMaker defaults.
45 .TP
46 .B ~/GNUstep/Defaults/WMState
47 information about the Dock and Clip. DON'T edit this while running
48 WindowMaker. It will be overwritten.
49 .TP
50 .B ~/GNUstep/Defaults/WMRootMenu
51 Contains the name of the file to read the root menu from.
52 .TP
53 .B ~/GNUstep/Defaults/WMWindowAttributes
54 Attributes for different application classes and instances. Use the
55 Attribute Editor (right drag the application's title bar, select
56 Attributes) instead of modifying this file directly. There are just a
57 few options not available using the Attributes Editor.
58 .TP
59 .B /etc/GNUstep/Defaults/
60 All the above-mentioned files are READ from here if not found except
61 for WMState, which is COPIED from here. No matter where they are read
62 from, if it's necesary to write configuration changes back into this
63 files, user's files will be written to.
64 .TP
65 .B ~/GNUstep/Library/WindowMaker/autostart
66 This script is automatically executed when WindowMaker is started.
67 .TP
68 .B ~/GNUstep/Library/WindowMaker/
69 The menu file indicated in WMRootMenu is looked for here...
70 .TP
71 .B /etc/X11/WindowMaker/
72 and here, in that order.
73 .TP
74 .B ~/GNUstep/Library/WindowMaker/Pixmaps/
75 WindowMaker looks for pixmaps here
76 .TP
77 .B ~/GNUstep/Library/WindowMaker/Backgrounds/
78 WindowMaker looks for backgrounds here
79 .TP
80 .B ~/GNUstep/Library/WindowMaker/Styles/
81 WindowMaker looks for style files here (not true... it looks like it
82 does, but you have to specify the full path anyway, it's just a place
83 to keep things nicely ordered)
84 .TP
85 .B ~/GNUstep/Library/WindowMaker/Themes/
86 WindowMaker looks for theme files here (ibid)
87 .TP
88 .B /usr/share/WindowMaker/Pixmaps/
89 System wide pixmaps are located here...
90 .TP
91 .B /usr/share/WindowMaker/Pixmaps/
92 and here.
93 .TP
94 .B /usr/share/WindowMaker/Styles/
95 System wide styles are here
96 .TP
97 .B /usr/share/WindowMaker/Themes/
98 Guess... ;-)
99 .SH ENVIRONMENT
100 .IP GNUSTEP_USER_ROOT
101 specifies the initial path for the Defaults directory. "Defaults/" is
102 appended to this variable to determine the actual location of the
103 databases. If the varialbe is not set, it defaults to "~/GNUstep"
104 .IP GNUSTEP_LOCAL_ROOT
105 specifies the location of the system-wide \fBlocal\fP GNUstep
106 directory (this is useful, for example, in those cases where the
107 system-wide location is really a network wide location). If this
108 variable is empty, GNUSTEP_SYSTEM_ROOT is looked for.
109 .IP GNUSTEP_SYSTEM_ROOT
110 specifies the location of the system-wide GNUstep directory. If this
111 variable is empty, it defaults to /etc/GNUstep
112 .SH SEE ALSO
113 The WindowMaker User Guide
115 The WindowMaker FAQ
117 .BR X (1x),
118 .BR convertstyle (1),
119 .BR wdwrite (1x),
120 .BR wxcopy (1x),
121 .BR geticonset (1x),
122 .BR seticons (1x),
123 .BR wmaker (1x),
124 .BR wxpaste (1x),
125 .BR getstyle (1x),
126 .BR setstyle (1x),
127 .BR wmsetbg (1x)
128 .SH AUTHOR
129 WindowMaker was written by Alfredo K. Kojima <kojima@windowmaker.org>
130 with help from many contributors.
132 This manual page was written by Marcelo E. Magallon, <mmagallo@debian.org>.