git: initial import (.gitignore)
[evilwm.git] / evilwm.1
blobf34ff13499c8c339afe58e1ab1f0ab0e21fa0aaa
1 .TH evilwm 1 "October 4, 2009" "" ""
2 .SH NAME
3 evilwm \- Minimalist Window Manager for X
4 .SH SYNOPSIS
5 \fBevilwm\fP
6 [ \fB\-display\fP \fIdisplay\fP ]
7 [ \fB\-term\fP \fItermprog\fP ]
8 [ \fB\-fn\fP \fIfontname\fP ]
9 [ \fB\-fg\fP \fIforeground-colour\fP ]
10 [ \fB\-fc\fP \fIfixed-colour\fP ]
11 [ \fB\-bg\fP \fIbackground-colour\fP ]
12 [ \fB\-bw\fP \fIborderwidth\fP ]
13 [ \fB\-snap\fP \fInum\fP ]
14 [ \fB\-mask1\fP \fImodifiers\fP ]
15 [ \fB\-mask2\fP \fImodifiers\fP ]
16 [ \fB\-altmask\fP \fImodifier\fP ]
17 [ [ \fB\-app\fP \fIname/class\fP ]
18 [ \fB\-geometry\fP \fIgeometry\fP ]
19 [ \fB\-dock\fP ]
20 [ \fB\-vdesk\fP \fIvdesk\fP ]
21 [ \fB\-fixed\fP ] ]...
22 [ \fB\-nosoliddrag\fP ]
23 [ \fB\-V\fP ]
24 .SH DESCRIPTION
25 .B evilwm
26 is a minimalist window manager based on aewm, extended to feature
27 many keyboard controls, and otherwise altered to be more friendly.
28 .PP
30 .BR evilwm ,
31 the focus follows the mouse pointer, and focus is not lost if
32 you stray onto the root window.  The current window border is shaded
33 gold, with other windows left as a dark grey.
34 .PP
35 You can use the mouse to manipulate windows either by click/dragging
36 the 1 pixel border, or by holding down Alt and doing so anywhere in the
37 client window. The controls are:
38 .TP
39 Button 1
40 Move window.
41 .TP
42 Button 2
43 Resize window.
44 .TP
45 Button 3
46 Lower window.
47 .PP
48 Most keyboard controls are used by holding down Control and Alt, then
49 pressing a key. Available functions are:
50 .TP
51 Return
52 Spawn new terminal.
53 .TP
54 Escape
55 Delete current window.  Hold Shift as well to force kill a client.
56 .TP
57 Insert
58 Lower current window.
59 .TP
60 H, J, K, L
61 Move window left, down, up or right (16 pixels).  Holding Shift resizes the
62 window instead.
63 .TP
64 Y, U, B, N
65 Move window to top-left, top-right, bottom-left or
66 bottom-right of screen.
67 .TP
69 Show information about current window.
70 .TP
71 Equals
72 Maximise current window vertically (toggle).
73 .TP
75 Maximise current window (toggle).
76 .TP
78 Toggle visible state of docks (e.g., pagers and launch bars).
79 .PP
80 If compiled with virtual desktop support, these functions are also available: 
81 .TP
83 Fix or unfix current window.
84 .TP
85 1--8
86 Switch virtual desktop.
87 .TP
88 Left
89 Previous virtual desktop.
90 .TP
91 Right
92 Next virtual desktop.
93 .PP
94 In addition to the above, Alt+Tab can be used to cycle through windows
95 on screen.
96 .PP
97 To make 
98 .B evilwm
99 exit, you have to kill the process.
100 .SH OPTIONS
102 \-display \fIdisplay\fP
103 specifies the X display to run on.
105 \-term \fItermprog\fP
106 specifies an alternative program to run when spawning a new terminal (defaults
107 to xterm, or x\-terminal\-emulator in Debian).
109 \-fn \fIfontname\fP
110 specify a font to use when resizing or displaying window titles.
112 \-fg \fIforeground-colour\fP
113 frame colour of currently active window.
115 \-fc \fIfixed-colour\fP
116 frame colour of active fixed windows.
118 \-bg \fIbackground-colour\fP
119 frame colour of inactive windows.
121 \-bw \fIborderwidth\fP
122 width of window borders in pixels.
124 \-snap \fInum\fP
125 enable snap-to-border support.  num gives the proximity in pixels to snap to.
127 \-mask1 \fImodifiers\fP, \-mask2 \fImodifiers\fP, \-altmask \fImodifier\fP
128 override the default keyboard modifiers used to grab keys for window manager
129 functionality.
130 \fImask1\fP is used for most keyboard controls (default: control+alt),
131 and \fImask2\fP is used for mouse button controls and cycling windows
132 (default: alt).
133 \fIaltmask\fP is used to modify the behaviour of certain controls
134 (default: shift).
135 Modifiers may be separated with + signs.
136 Valid modifiers are shift, lock, control, alt, mod1, mod2, mod3, mod4,
137 mod5.
139 \-app \fIname/class\fP
140 match an application by instance name and class (for help in finding
141 these, use the \fBxprop\fP tool to extract the \fIWM_CLASS\fP property).
142 Subsequent \fI\-geometry\fP, \fI\-dock\fP, \fI\-vdesk\fP and \fI\-fixed\fP
143 options will apply to this match.
145 \-g, -geometry \fIgeometry\fP
146 apply a geometry (using a standard X geometry string) to applications matching
147 the last
148 .I \-app.
150 \-dock
151 specify that application should be considered to be a dock, even if it lacks
152 the appropriate property.
154 \-v, -vdesk \fIvdesk\fP
155 specify a default virtual desktop for applications matching the last
156 .I \-app.
157 Note that desktops are numbered from 0.
159 \-f, -fixed
160 specify that application is to start with a fixed client window (\fI\-s\fP is
161 also accepted to be compatible with previous versions).
163 \-nosoliddrag
164 draw a window outline while moving or resizing.
167 print version number.
169 .B evilwm
170 will also read options, one per line, from a file called \fI.evilwmrc\fP
171 in the user's home directory.
172 Options listed in a configuration file should omit the leading dash.
173 Options specified on the command line override those found in the
174 configuration file.
175 .SH FILES
176 .I $HOME/.evilwmrc
177 .SH BUGS
178 The author's idea of friendly may differ to that of many other people.
179 .SH AUTHOR
180 Ciaran Anscomb <evilwm@6809.org.uk>.
182 aewm was written by Decklin Foster <fosterd@hartwick.edu>.
184 9wm was written by David Hogan <dhog@cs.su.oz.au>.
185 .SH "SEE ALSO"
186 .BR xterm (1),
187 .BR xprop (1)