JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
updated man page, added CAVEATS section
[dwm.git] / dwm.1
1 .TH DWM 1 dwm-VERSION
2 .SH NAME
3 dwm \- dynamic window manager
4 .SH SYNOPSIS
5 .B dwm
6 .RB [ \-v ]
7 .SH DESCRIPTION
8 .B dwm
9 is a dynamic window manager for X11. It manages windows in tiling and floating
10 modes. Either mode can be applied dynamically, optimizing the environment for
11 the application in use and the task performed.
12 .P
13 In tiling mode windows are managed in a master and stacking column. The master
14 column contains the window which currently needs most attention, whereas the
15 stacking column contains all other windows. In floating mode windows can be
16 resized and moved freely. Dialog windows are always managed floating,
17 regardless of the mode selected.
18 .P
19 Windows are grouped by tags. Each window can be tagged with one or multiple
20 tags. Selecting a certain tag for viewing will display all windows with that
21 tag.
22 .P
23 .B dwm
24 has a small status bar which displays the text read from standard
25 input, if written. Besides that, it displays all available tags, and the title
26 of the focused window. It draws a 1-pixel border around windows to
27 indicate the focus state. Unfocused windows contain a small bar in front of
28 them displaying their tags and title.
29 .SH OPTIONS
30 .TP
31 .B \-v
32 prints version information to standard output, then exits.
33 .SH USAGE
34 .SS Status bar
35 .TP
36 .B Standard input
37 is read and displayed in the status text area.
38 .TP
39 .B Button[1,3]
40 click on a tag label focuses that
41 .B tag.
42 .TP
43 .B Button2
44 click on a tag label toggles that
45 .B tag.
46 .TP
47 .B Button[1,4]
48 click on the bar focuses the previous
49 .B tag.
50 .TP
51 .B Button[2,5]
52 click on the bar focuses the next
53 .B tag.
54 .SS Keyboard commands
55 .TP
56 .B Mod1-Return
57 Zoom current
58 .B window
59 to the 
60 .B master
61 column.
62 .TP
63 .B Mod1-h
64 Focus previous
65 .B tag.
66 .TP
67 .B Mod1-j
68 Focus next
69 .B window.
70 .TP
71 .B Mod1-k
72 Focus previous
73 .B window.
74 .TP
75 .B Mod1-l
76 Focus next
77 .B tag.
78 .TP
79 .B Mod1-m
80 Maximize current
81 .B window.
82 .TP
83 .B Mod1-[0..n]
84 Focus
85 .B nth tag.
86 .TP
87 .B Mod1-space
88 Toggle between
89 .B tiled
90 and
91 .B floating
92 mode (affects
93 .BR "all windows" ).
94 .TP
95 .B Mod1-Shift-[0..n]
96 Apply
97 .B nth tag
98 to current
99 .B window.
100 .TP
101 .B Mod1-Shift-c
102 Close focused
103 .B window.
104 .TP
105 .B Mod1-Shift-q
106 Quit
107 .B dwm.
108 .TP
109 .B Mod1-Shift-Return
110 Start
111 .B terminal.
112 .TP
113 .B Mod1-Control-[0..n]
114 Toggle
115 .B nth tag.
116 .TP
117 .B Mod1-Control-Shift-[0..n]
118 Append
119 .B nth tag
120 to current
121 .B window.
122 .SS Mouse commands
123 .TP
124 .B Mod1-Button1
125 Move current
126 .B window
127 while dragging.
128 .TP
129 .B Mod1-Button2
130 Zoom current
131 .B window
132 to the 
133 .B master
134 column.
135 .TP
136 .B Mod1-Button3
137 Resize current
138 .B window
139 while dragging.
140 .SH CUSTOMIZATION
141 .B dwm
142 is customized by creating a custom config.h and (re)compiling the source
143 code. This keeps it fast, secure and simple.
144 .SH CAVEATS
145 The status bar displays
146 .BR "broken pipe"
147 when
148 .B dwm
149 has been started by
150 .BR xdm (1),
151 because it closes standard output before executing
152 .B dwm.
153 .SH SEE ALSO
154 .BR dmenu (1)