JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
added MODKEY-{plus,minus} shortcuts (increasing/decreasing master clients)
[dwm.git] / dwm.1
diff --git a/dwm.1 b/dwm.1
index 96dd8d3..8742fa8 100644 (file)
--- a/dwm.1
+++ b/dwm.1
@@ -5,111 +5,140 @@ dwm \- dynamic window manager
 .B dwm
 .RB [ \-v ]
 .SH DESCRIPTION
-.B dwm
-is a dynamic window manager for X11. It manages windows in tiling and floating
-modes. Either mode can be applied dynamically, optimizing the environment for
-the application in use and the task performed.
+dwm is a dynamic window manager for X. It manages windows in tiling and
+floating modes. Either mode can be applied dynamically, optimizing the
+environment for the application in use and the task performed.
 .P
-In tiling mode windows are managed in a master and stacking column. The master
-column contains the window which currently needs most attention, whereas the
-stacking column contains all other windows. In floating mode windows can be
+In tiling mode windows are managed in a master and stacking area. The master
+area contains the window which currently needs most attention, whereas the
+stacking area contains all other windows. In floating mode windows can be
 resized and moved freely. Dialog windows are always managed floating,
 regardless of the mode selected.
 .P
 Windows are grouped by tags. Each window can be tagged with one or multiple
-tags. Selecting a certain tag for viewing will display all windows with that
-tag.
+tags. Selecting certain tags displays all windows with these tags.
 .P
-.B dwm
-has a small status bar which displays the text read from standard
-input, if written. Besides that, it displays all available tags, and the title
-of the focused window. It draws a 1-pixel border around windows to
-indicate the focus state. Unfocused windows contain a small bar in front of
-them displaying their tags and title.
+dwm contains a small status bar which displays all available tags, the mode,
+the title of the focused window, and the text read from standard input. The
+selected tags are indicated with a different color. The tags of the focused
+window are indicated with a filled square in the top left corner.  The tags
+which are applied to one or more windows are indicated with an empty square in
+the top left corner.
+.P
+dwm draws a 1-pixel border around windows to indicate the focus state.
+Unfocused windows contain a small bar in front of them displaying their title.
 .SH OPTIONS
 .TP
 .B \-v
 prints version information to standard output, then exits.
 .SH USAGE
+.SS Status bar
+.TP
+.B Standard input
+is read and displayed in the status text area.
+.TP
+.B Button1
+click on a tag label to display all windows with that tag, click on the mode
+label toggles between tiling and floating mode.
+.TP
+.B Button3
+click on a tag label adds/removes all windows with that tag to/from the view.
+.TP
+.B Mod1-Button1
+click on a tag label applies that tag to the focused window.
+.TP
+.B Mod1-Button3
+click on a tag label adds/removes that tag to/from the focused window.
+.SS Keyboard commands
+.TP
+.B Mod1-Shift-Return
+Start
+.BR xterm (1).
+.TP
+.B Mod1-Tab
+Focus next window.
+.TP
+.B Mod1-Shift-Tab
+Focus previous window.
 .TP
 .B Mod1-Return
-Zoom current
-.B window
-to the 
-.B master
-column.
+Zooms/cycles current window to/from master area (tiling mode), toggles maximization current window (floating mode).
+.TP
+.B Mod1-g
+Grow master area (tiling mode only).
 .TP
-.B Mod1-h
-Focus previous
-.B tag.
+.B Mod1-s
+Shrink master area (tiling mode only).
 .TP
-.B Mod1-j
-Focus next
-.B window.
+.B Mod1-plus
+Increase clients of master area (tiling mode only).
 .TP
-.B Mod1-k
-Focus previous
-.B window.
+.B Mod1-minus
+Decrease clients of master area (tiling mode only).
+.TP
+.B Mod1-Shift-[1..n]
+Apply
+.RB nth
+tag to current window.
 .TP
-.B Mod1-l
-Focus next
-.B tag.
+.B Mod1-Shift-0
+Apply all tags to current window.
 .TP
-.B Mod1-m
-Maximize current
-.B window.
+.B Mod1-Control-Shift-[1..n]
+Add/remove
+.B nth
+tag to/from current window.
 .TP
-.B Mod1-[0..n]
-Focus
-.B nth tag.
+.B Mod1-Shift-c
+Close focused window.
 .TP
 .B Mod1-space
-Toggle between
-.B tiled
-and
-.B floating
-mode (affects
-.BR "all windows" ).
-.TP
-.B Mod1-Shift-[0..n]
-Apply
-.B nth tag
-to current
-.B window.
+Toggle between tiling and floating mode (affects all windows).
 .TP
-.B Mod1-Shift-q
-Quit
-.B dwm.
+.B Mod1-Shift-space
+Toggle focused window between floating and non-floating state (tiling mode only).
 .TP
-.B Mod1-Shift-Return
-Start
-.B terminal.
+.B Mod1-[1..n]
+View all windows with
+.BR nth
+tag.
 .TP
-.B Mod1-Control-[0..n]
-Append
-.B nth tag
-to current
-.B window.
+.B Mod1-0
+View all windows with any tag.
+.TP
+.B Mod1-Control-[1..n]
+Add/remove all windows with
+.BR nth
+tag to/from the view.
+.TP
+.B Mod1-Shift-q
+Quit dwm.
+.SS Mouse commands
 .TP
 .B Mod1-Button1
-Move current
-.B window
-while dragging.
+Move current window while dragging (floating mode only).
 .TP
 .B Mod1-Button2
-Zoom current
-.B window
-to the 
-.B master
-column.
+Zoom current window to the master area (tiling mode only).
 .TP
 .B Mod1-Button3
-Resize current
-.B window
-while dragging.
+Resize current window while dragging (floating mode only).
 .SH CUSTOMIZATION
-.B dwm
-is customized by creating a custom config.h and (re)compiling the source
+dwm is customized by creating a custom config.h and (re)compiling the source
 code. This keeps it fast, secure and simple.
+.SH CAVEATS
+The status bar may display
+.BR "EOF"
+when dwm has been started by an X session manager like
+.BR xdm (1),
+because those close standard output before executing dwm.
+.P
+Java applications which use the XToolkit/XAWT backend may draw grey windows
+only. The XToolkit/XAWT backend breaks ICCCM-compliance in recent JDK 1.5 and early
+JDK 1.6 versions, because it assumes a reparenting window manager. As a workaround
+you can use JDK 1.4 (which doesn't contain the XToolkit/XAWT backend) or you
+can set the following environment variable (to use the older Motif
+backend instead):
+.BR AWT_TOOLKIT=MToolkit .
 .SH SEE ALSO
 .BR dmenu (1)