annotate dwm.1 @ 469:a2cc7adf9d4d

improved intro comment in dwm.h, updated config.mk
author arg@mmvi
date Wed, 20 Sep 2006 09:40:35 +0200
parents 78d36a1dd1d9
children 9d728cba93d6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
212
5b13a18800de applied Sanders man page/Makefile patch
arg@10ksloc.org
parents: 201
diff changeset
1 .TH DWM 1 dwm-VERSION
0
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
2 .SH NAME
39
0932ed0753dc another change
Anselm R. Garbe <garbeam@wmii.de>
parents: 38
diff changeset
3 dwm \- dynamic window manager
0
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
4 .SH SYNOPSIS
38
678730a1339b updated man page
Anselm R. Garbe <garbeam@wmii.de>
parents: 34
diff changeset
5 .B dwm
0
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
6 .RB [ \-v ]
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
7 .SH DESCRIPTION
445
00584fe34361 made markups in dwm.1 more consistent
Anselm R. Garbe <arg@10kloc.org>
parents: 444
diff changeset
8 dwm is a dynamic window manager for X. It manages windows in tiling and
00584fe34361 made markups in dwm.1 more consistent
Anselm R. Garbe <arg@10kloc.org>
parents: 444
diff changeset
9 floating modes. Either mode can be applied dynamically, optimizing the
00584fe34361 made markups in dwm.1 more consistent
Anselm R. Garbe <arg@10kloc.org>
parents: 444
diff changeset
10 environment for the application in use and the task performed.
79
aabebd6e61f3 fixed XSync handling and finished man page
Anselm R. Garbe <garbeam@wmii.de>
parents: 68
diff changeset
11 .P
82
3954fc13b2e8 simplified man page
Anselm R. Garbe <garbeam@wmii.de>
parents: 80
diff changeset
12 In tiling mode windows are managed in a master and stacking column. The master
174
48c820470858 applied Sanders doc changes, added a PHONY line and changed the output of config.h creation somewhat
arg@10ksloc.org
parents: 171
diff changeset
13 column contains the window which currently needs most attention, whereas the
48c820470858 applied Sanders doc changes, added a PHONY line and changed the output of config.h creation somewhat
arg@10ksloc.org
parents: 171
diff changeset
14 stacking column contains all other windows. In floating mode windows can be
48c820470858 applied Sanders doc changes, added a PHONY line and changed the output of config.h creation somewhat
arg@10ksloc.org
parents: 171
diff changeset
15 resized and moved freely. Dialog windows are always managed floating,
48c820470858 applied Sanders doc changes, added a PHONY line and changed the output of config.h creation somewhat
arg@10ksloc.org
parents: 171
diff changeset
16 regardless of the mode selected.
79
aabebd6e61f3 fixed XSync handling and finished man page
Anselm R. Garbe <garbeam@wmii.de>
parents: 68
diff changeset
17 .P
174
48c820470858 applied Sanders doc changes, added a PHONY line and changed the output of config.h creation somewhat
arg@10ksloc.org
parents: 171
diff changeset
18 Windows are grouped by tags. Each window can be tagged with one or multiple
449
78d36a1dd1d9 really small changes to dwm.1
Anselm R. Garbe <arg@10kloc.org>
parents: 445
diff changeset
19 tags. Selecting certain tags displays all windows with that tag.
79
aabebd6e61f3 fixed XSync handling and finished man page
Anselm R. Garbe <garbeam@wmii.de>
parents: 68
diff changeset
20 .P
445
00584fe34361 made markups in dwm.1 more consistent
Anselm R. Garbe <arg@10kloc.org>
parents: 444
diff changeset
21 dwm contains a small status bar which displays all available tags, the mode,
00584fe34361 made markups in dwm.1 more consistent
Anselm R. Garbe <arg@10kloc.org>
parents: 444
diff changeset
22 the title of the focused window, and the text read from standard input. The
444
48038934d05d small addition to dwm.1
Anselm R. Garbe <arg@10kloc.org>
parents: 421
diff changeset
23 selected tags are highlighted with a different color, the tags of the focused
48038934d05d small addition to dwm.1
Anselm R. Garbe <arg@10kloc.org>
parents: 421
diff changeset
24 window are highlighted with a small point.
316
d69cdb180a3e small changes to dwm.1, rearranged order within main event loop
Anselm R.Garbe <arg@10ksloc.org>
parents: 293
diff changeset
25 .P
445
00584fe34361 made markups in dwm.1 more consistent
Anselm R. Garbe <arg@10kloc.org>
parents: 444
diff changeset
26 dwm draws a 1-pixel border around windows to indicate the focus state.
342
a1901753deef updated man page
Anselm R. Garbe <arg@10kloc.org>
parents: 341
diff changeset
27 Unfocused windows contain a small bar in front of them displaying their title.
80
8125f908c80c several additions in mouse handling ;)
Anselm R. Garbe <garbeam@wmii.de>
parents: 79
diff changeset
28 .SH OPTIONS
0
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
29 .TP
491f34c11291 initial import
Anselm R. Garbe <garbeam@wmii.de>
parents:
diff changeset
30 .B \-v
80
8125f908c80c several additions in mouse handling ;)
Anselm R. Garbe <garbeam@wmii.de>
parents: 79
diff changeset
31 prints version information to standard output, then exits.
82
3954fc13b2e8 simplified man page
Anselm R. Garbe <garbeam@wmii.de>
parents: 80
diff changeset
32 .SH USAGE
256
b37acb9ead8c updated dwm(1)
Anselm R.Garbe <arg@10ksloc.org>
parents: 238
diff changeset
33 .SS Status bar
b37acb9ead8c updated dwm(1)
Anselm R.Garbe <arg@10ksloc.org>
parents: 238
diff changeset
34 .TP
259
d661ecce0c75 applied Sanders fixes to dwm.1
Anselm R.Garbe <arg@10ksloc.org>
parents: 258
diff changeset
35 .B Standard input
d661ecce0c75 applied Sanders fixes to dwm.1
Anselm R.Garbe <arg@10ksloc.org>
parents: 258
diff changeset
36 is read and displayed in the status text area.
256
b37acb9ead8c updated dwm(1)
Anselm R.Garbe <arg@10ksloc.org>
parents: 238
diff changeset
37 .TP
288
b7865e6feef2 applied sanders man page patch, removed button2 from bar click
Anselm R.Garbe <arg@10ksloc.org>
parents: 270
diff changeset
38 .B Button1
449
78d36a1dd1d9 really small changes to dwm.1
Anselm R. Garbe <arg@10kloc.org>
parents: 445
diff changeset
39 click on a tag label to display all windows with that tag, click on the mode
78d36a1dd1d9 really small changes to dwm.1
Anselm R. Garbe <arg@10kloc.org>
parents: 445
diff changeset
40 label toggles between tiled and floating mode.
262
d659a2dce2b5 implemented viewextend and added M-S-C-n shortcuts for extending the current view... updated man page (works great!) nice feature
Anselm R.Garbe <arg@10ksloc.org>
parents: 259
diff changeset
41 .TP
270
dacd3f3c5823 implemented restack behavior (floats are on top in tiled mode)
Anselm R.Garbe <arg@10ksloc.org>
parents: 267
diff changeset
42 .B Button3
445
00584fe34361 made markups in dwm.1 more consistent
Anselm R. Garbe <arg@10kloc.org>
parents: 444
diff changeset
43 click on a tag label adds/removes all windows with that tag to/from the view.
398
9c703e528e58 applied sanders patch
Anselm R. Garbe <arg@10kloc.org>
parents: 396
diff changeset
44 .TP
9c703e528e58 applied sanders patch
Anselm R. Garbe <arg@10kloc.org>
parents: 396
diff changeset
45 .B Mod1-Button1
445
00584fe34361 made markups in dwm.1 more consistent
Anselm R. Garbe <arg@10kloc.org>
parents: 444
diff changeset
46 click on a tag label applies that tag to the focused window.
398
9c703e528e58 applied sanders patch
Anselm R. Garbe <arg@10kloc.org>
parents: 396
diff changeset
47 .TP
9c703e528e58 applied sanders patch
Anselm R. Garbe <arg@10kloc.org>
parents: 396
diff changeset
48 .B Mod1-Button3
445
00584fe34361 made markups in dwm.1 more consistent
Anselm R. Garbe <arg@10kloc.org>
parents: 444
diff changeset
49 click on a tag label adds/removes that tag to/from the focused window.
256
b37acb9ead8c updated dwm(1)
Anselm R.Garbe <arg@10ksloc.org>
parents: 238
diff changeset
50 .SS Keyboard commands
55
fcbf7213d96f continued with man page
Anselm R. Garbe <garbeam@wmii.de>
parents: 39
diff changeset
51 .TP
293
093744cc5353 applied jk_to_tab patch
Anselm R.Garbe <arg@10ksloc.org>
parents: 288
diff changeset
52 .B Mod1-Shift-Return
093744cc5353 applied jk_to_tab patch
Anselm R.Garbe <arg@10ksloc.org>
parents: 288
diff changeset
53 Start
093744cc5353 applied jk_to_tab patch
Anselm R.Garbe <arg@10ksloc.org>
parents: 288
diff changeset
54 .BR xterm (1).
093744cc5353 applied jk_to_tab patch
Anselm R.Garbe <arg@10ksloc.org>
parents: 288
diff changeset
55 .TP
093744cc5353 applied jk_to_tab patch
Anselm R.Garbe <arg@10ksloc.org>
parents: 288
diff changeset
56 .B Mod1-Tab
445
00584fe34361 made markups in dwm.1 more consistent
Anselm R. Garbe <arg@10kloc.org>
parents: 444
diff changeset
57 Focus next window.
293
093744cc5353 applied jk_to_tab patch
Anselm R.Garbe <arg@10ksloc.org>
parents: 288
diff changeset
58 .TP
093744cc5353 applied jk_to_tab patch
Anselm R.Garbe <arg@10ksloc.org>
parents: 288
diff changeset
59 .B Mod1-Shift-Tab
445
00584fe34361 made markups in dwm.1 more consistent
Anselm R. Garbe <arg@10kloc.org>
parents: 444
diff changeset
60 Focus previous window.
293
093744cc5353 applied jk_to_tab patch
Anselm R.Garbe <arg@10ksloc.org>
parents: 288
diff changeset
61 .TP
55
fcbf7213d96f continued with man page
Anselm R. Garbe <garbeam@wmii.de>
parents: 39
diff changeset
62 .B Mod1-Return
445
00584fe34361 made markups in dwm.1 more consistent
Anselm R. Garbe <arg@10kloc.org>
parents: 444
diff changeset
63 Zoom current window to the master column (tiling mode only).
55
fcbf7213d96f continued with man page
Anselm R. Garbe <garbeam@wmii.de>
parents: 39
diff changeset
64 .TP
fcbf7213d96f continued with man page
Anselm R. Garbe <garbeam@wmii.de>
parents: 39
diff changeset
65 .B Mod1-m
445
00584fe34361 made markups in dwm.1 more consistent
Anselm R. Garbe <arg@10kloc.org>
parents: 444
diff changeset
66 Maximize current window.
55
fcbf7213d96f continued with man page
Anselm R. Garbe <garbeam@wmii.de>
parents: 39
diff changeset
67 .TP
415
ad2b6ce6e95b I really need column growing, now pushing upstream
Anselm R. Garbe <arg@10kloc.org>
parents: 398
diff changeset
68 .B Mod1-g
445
00584fe34361 made markups in dwm.1 more consistent
Anselm R. Garbe <arg@10kloc.org>
parents: 444
diff changeset
69 Grow current column (tiling mode only).
415
ad2b6ce6e95b I really need column growing, now pushing upstream
Anselm R. Garbe <arg@10kloc.org>
parents: 398
diff changeset
70 .TP
421
ca2d99d8b8fc well ok, added Mod-s to default bindings (however, I don't need it)
Anselm R. Garbe <arg@10kloc.org>
parents: 415
diff changeset
71 .B Mod1-s
445
00584fe34361 made markups in dwm.1 more consistent
Anselm R. Garbe <arg@10kloc.org>
parents: 444
diff changeset
72 Shrink current column (tiling mode only).
421
ca2d99d8b8fc well ok, added Mod-s to default bindings (however, I don't need it)
Anselm R. Garbe <arg@10kloc.org>
parents: 415
diff changeset
73 .TP
396
be3be9590d5c changed shortcut into Mod1-0
Anselm R. Garbe <arg@10kloc.org>
parents: 395
diff changeset
74 .B Mod1-Shift-[1..n]
293
093744cc5353 applied jk_to_tab patch
Anselm R.Garbe <arg@10ksloc.org>
parents: 288
diff changeset
75 Apply
445
00584fe34361 made markups in dwm.1 more consistent
Anselm R. Garbe <arg@10kloc.org>
parents: 444
diff changeset
76 .RB nth
00584fe34361 made markups in dwm.1 more consistent
Anselm R. Garbe <arg@10kloc.org>
parents: 444
diff changeset
77 tag to current window.
293
093744cc5353 applied jk_to_tab patch
Anselm R.Garbe <arg@10ksloc.org>
parents: 288
diff changeset
78 .TP
396
be3be9590d5c changed shortcut into Mod1-0
Anselm R. Garbe <arg@10kloc.org>
parents: 395
diff changeset
79 .B Mod1-Control-Shift-[1..n]
293
093744cc5353 applied jk_to_tab patch
Anselm R.Garbe <arg@10ksloc.org>
parents: 288
diff changeset
80 Add/remove
445
00584fe34361 made markups in dwm.1 more consistent
Anselm R. Garbe <arg@10kloc.org>
parents: 444
diff changeset
81 .B nth
00584fe34361 made markups in dwm.1 more consistent
Anselm R. Garbe <arg@10kloc.org>
parents: 444
diff changeset
82 tag to/from current window.
293
093744cc5353 applied jk_to_tab patch
Anselm R.Garbe <arg@10ksloc.org>
parents: 288
diff changeset
83 .TP
093744cc5353 applied jk_to_tab patch
Anselm R.Garbe <arg@10ksloc.org>
parents: 288
diff changeset
84 .B Mod1-Shift-c
445
00584fe34361 made markups in dwm.1 more consistent
Anselm R. Garbe <arg@10kloc.org>
parents: 444
diff changeset
85 Close focused window.
55
fcbf7213d96f continued with man page
Anselm R. Garbe <garbeam@wmii.de>
parents: 39
diff changeset
86 .TP
fcbf7213d96f continued with man page
Anselm R. Garbe <garbeam@wmii.de>
parents: 39
diff changeset
87 .B Mod1-space
445
00584fe34361 made markups in dwm.1 more consistent
Anselm R. Garbe <arg@10kloc.org>
parents: 444
diff changeset
88 Toggle between tiled and floating mode (affects all windows).
56
b72b7086c385 continued with man page
Anselm R. Garbe <garbeam@wmii.de>
parents: 55
diff changeset
89 .TP
396
be3be9590d5c changed shortcut into Mod1-0
Anselm R. Garbe <arg@10kloc.org>
parents: 395
diff changeset
90 .B Mod1-[1..n]
293
093744cc5353 applied jk_to_tab patch
Anselm R.Garbe <arg@10ksloc.org>
parents: 288
diff changeset
91 View all windows with
445
00584fe34361 made markups in dwm.1 more consistent
Anselm R. Garbe <arg@10kloc.org>
parents: 444
diff changeset
92 .BR nth
00584fe34361 made markups in dwm.1 more consistent
Anselm R. Garbe <arg@10kloc.org>
parents: 444
diff changeset
93 tag.
56
b72b7086c385 continued with man page
Anselm R. Garbe <garbeam@wmii.de>
parents: 55
diff changeset
94 .TP
396
be3be9590d5c changed shortcut into Mod1-0
Anselm R. Garbe <arg@10kloc.org>
parents: 395
diff changeset
95 .B Mod1-0
445
00584fe34361 made markups in dwm.1 more consistent
Anselm R. Garbe <arg@10kloc.org>
parents: 444
diff changeset
96 View all windows with any tag.
395
7528080beb0e added viewall to mainstream (only Ross Mohns version, not the toggle)
Anselm R. Garbe <arg@10kloc.org>
parents: 394
diff changeset
97 .TP
396
be3be9590d5c changed shortcut into Mod1-0
Anselm R. Garbe <arg@10kloc.org>
parents: 395
diff changeset
98 .B Mod1-Control-[1..n]
288
b7865e6feef2 applied sanders man page patch, removed button2 from bar click
Anselm R.Garbe <arg@10ksloc.org>
parents: 270
diff changeset
99 Add/remove all windows with
445
00584fe34361 made markups in dwm.1 more consistent
Anselm R. Garbe <arg@10kloc.org>
parents: 444
diff changeset
100 .BR nth
00584fe34361 made markups in dwm.1 more consistent
Anselm R. Garbe <arg@10kloc.org>
parents: 444
diff changeset
101 tag to/from the view.
264
afcea99a4f3f updated man page, added CAVEATS section
Anselm R.Garbe <arg@10ksloc.org>
parents: 262
diff changeset
102 .TP
293
093744cc5353 applied jk_to_tab patch
Anselm R.Garbe <arg@10ksloc.org>
parents: 288
diff changeset
103 .B Mod1-Shift-q
445
00584fe34361 made markups in dwm.1 more consistent
Anselm R. Garbe <arg@10kloc.org>
parents: 444
diff changeset
104 Quit dwm.
256
b37acb9ead8c updated dwm(1)
Anselm R.Garbe <arg@10ksloc.org>
parents: 238
diff changeset
105 .SS Mouse commands
82
3954fc13b2e8 simplified man page
Anselm R. Garbe <garbeam@wmii.de>
parents: 80
diff changeset
106 .TP
59
5d4653de9a1c implemented dwm reading status text from stdin
Anselm R. Garbe <garbeam@wmii.de>
parents: 58
diff changeset
107 .B Mod1-Button1
445
00584fe34361 made markups in dwm.1 more consistent
Anselm R. Garbe <arg@10kloc.org>
parents: 444
diff changeset
108 Move current window while dragging (floating mode only).
59
5d4653de9a1c implemented dwm reading status text from stdin
Anselm R. Garbe <garbeam@wmii.de>
parents: 58
diff changeset
109 .TP
238
969fb6be25e1 applied sander's patch
Anselm R.Garbe <arg@10ksloc.org>
parents: 232
diff changeset
110 .B Mod1-Button2
445
00584fe34361 made markups in dwm.1 more consistent
Anselm R. Garbe <arg@10kloc.org>
parents: 444
diff changeset
111 Zoom current window to the master column (tiling mode only).
238
969fb6be25e1 applied sander's patch
Anselm R.Garbe <arg@10ksloc.org>
parents: 232
diff changeset
112 .TP
59
5d4653de9a1c implemented dwm reading status text from stdin
Anselm R. Garbe <garbeam@wmii.de>
parents: 58
diff changeset
113 .B Mod1-Button3
445
00584fe34361 made markups in dwm.1 more consistent
Anselm R. Garbe <arg@10kloc.org>
parents: 444
diff changeset
114 Resize current window while dragging (floating mode only).
82
3954fc13b2e8 simplified man page
Anselm R. Garbe <garbeam@wmii.de>
parents: 80
diff changeset
115 .SH CUSTOMIZATION
445
00584fe34361 made markups in dwm.1 more consistent
Anselm R. Garbe <arg@10kloc.org>
parents: 444
diff changeset
116 dwm is customized by creating a custom config.h and (re)compiling the source
174
48c820470858 applied Sanders doc changes, added a PHONY line and changed the output of config.h creation somewhat
arg@10ksloc.org
parents: 171
diff changeset
117 code. This keeps it fast, secure and simple.
264
afcea99a4f3f updated man page, added CAVEATS section
Anselm R.Garbe <arg@10ksloc.org>
parents: 262
diff changeset
118 .SH CAVEATS
347
e438c8ba86f6 yet another fix
Anselm R. Garbe <arg@10kloc.org>
parents: 346
diff changeset
119 The status bar may display
445
00584fe34361 made markups in dwm.1 more consistent
Anselm R. Garbe <arg@10kloc.org>
parents: 444
diff changeset
120 .BR "broken pipe"
00584fe34361 made markups in dwm.1 more consistent
Anselm R. Garbe <arg@10kloc.org>
parents: 444
diff changeset
121 when dwm has been started by
264
afcea99a4f3f updated man page, added CAVEATS section
Anselm R.Garbe <arg@10ksloc.org>
parents: 262
diff changeset
122 .BR xdm (1),
445
00584fe34361 made markups in dwm.1 more consistent
Anselm R. Garbe <arg@10kloc.org>
parents: 444
diff changeset
123 because it closes standard output before executing dwm.
201
124671c251ee updated man page
arg@10ksloc.org
parents: 174
diff changeset
124 .SH SEE ALSO
124671c251ee updated man page
arg@10ksloc.org
parents: 174
diff changeset
125 .BR dmenu (1)