JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
fixed XSync handling and finished man page
[dwm.git] / dwm.1
1 .TH DWM 1 dwm-0.1
2 .SH NAME
3 dwm \- dynamic window manager
4 .SH SYNOPSIS
5 .B dwm
6 .RB [ \-v ]
7 .SH DESCRIPTION
8 .SS Overview
9 .B dwm
10 is a dynamic window manager for X11. It consists of a small status bar at the
11 top of the screen and arranges windows in either a tiled or floating mode.
12 .P
13 If 
14 .B dwm
15 is in tiled mode, it consists of two columns. The left master column
16 contains only one window per time, the right column contains all other windows 
17 in a stack. In tiled mode
18 .B dwm
19 .B don't
20 handles incremental resizals, some terminal programs like
21 .B xterm
22 may not work correctly with this in tiled mode.
23 .P
24 If
25 .B dwm
26 is in floating mode, it arranges all windows with the reqyested geometry and
27 allows the user to move or resize them. Some windows, like
28 dialog windows, are treated floating even if
29 .B dwm
30 is in tiled mode. In floating mode
31 .B dwm
32 handles incremental resizals.
33 .P
34 Windows are grouped by tags. You can view all windows with a specific tag per
35 time.  However, each window is allowed to contain more than one tag, which
36 allows to make windows visible in all views.
37 .P
38 .B dwm
39 reads from
40 .I stdin
41 to display status text, if written.
42 .P
43 .B dwm
44 draws 1-pixel borders around windows to indicate the focus state and save as
45 much screen real estate as possible. Unfocused windows contain a small bar
46 in front of the window indicating the tags and the window title.
47 .SS Options
48 .TP
49 .B \-v
50 prints version information to
51 .I stdout
52 , then exits.
53 .SS Customization
54 .B dwm
55 is customized through editing its source code. It is assumed that
56 dwm users are high experienced users who know how a window manager works
57 and who are able to patch
58 .B dwm
59 for their needs. This keeps
60 .B dwm
61 fast, secure and simple, because it does not process any input data, except
62 window properties and the status text read from
63 .I stdin .
64 .SS Default Key Bindings
65 .TP 16
66 .I Key  
67 .I Action
68 .TP
69 .B Mod1-Return
70 Zoom
71 .B window
72 to the 
73 .B master
74 track
75 .TP
76 .B Mod1-k
77 Focus previous
78 .B window
79 .TP
80 .B Mod1-j
81 Focus next
82 .B window
83 .TP
84 .B Mod1-m
85 Maximize current
86 .B window
87 .TP
88 .B Mod1-[0..n]
89 Focus
90 .B nth
91 tag
92 .TP
93 .B Mod1-space
94 (Re-)arrange
95 .B all
96 windows tiled
97 .TP
98 .B Mod1-Shift-space
99 (Re-)arrange
100 .B all
101 windows floating
102 .TP
103 .B Mod1-Shift-[0..n]
104 Apply
105 .B nth
106 tag to current
107 .B window
108 .TP
109 .B Mod1-Shift-q
110 Quit
111 .B dwm
112 .TP
113 .B Mod1-Shift-Return
114 Start
115 .B terminal
116 .TP
117 .B Mod1-Shift-w
118 Start
119 .B web browser
120 .TP
121 .B Mod1-Shift-l
122 Lock
123 .B screen
124 .TP
125 .B Control-[0..n]
126 Append
127 .B nth
128 tag to cureent
129 .B window
130 .SS Default Mouse Bindings
131 .TP
132 .B Mod1-Button1
133 Moves current
134 .B window
135 while dragging
136 .TP
137 .B Mod1-Button2
138 Lowers current
139 .B window
140 .TP
141 .B Mod1-Button3
142 Resizes current
143 .B window
144 while dragging
145 .SH BUGS
146 Some terminal programs do not behave correctly in tiled mode, because
147 incremental resizals are ignored to use maximum screen real estate. You can
148 patch the code to fix this.