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