JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
renamed CAVEATS into BUGS
[dwm.git] / dwm.1
diff --git a/dwm.1 b/dwm.1
index dd17bbc..51af59a 100644 (file)
--- a/dwm.1
+++ b/dwm.1
@@ -5,28 +5,27 @@ dwm \- dynamic window manager
 .B dwm
 .RB [ \-v ]
 .SH DESCRIPTION
-.B 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.
+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 windows which currently need 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.
+regardless of the mode applied.
 .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
-contains a small status bar which displays all available tags, the title and the
-tags of the focused window, and the text read from standard input.
+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
-.B 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
-and tags.
+dwm draws a small border around windows to indicate the focus state.
 .SH OPTIONS
 .TP
 .B \-v
@@ -38,13 +37,23 @@ prints version information to standard output, then exits.
 is read and displayed in the status text area.
 .TP
 .B Button1
-click on a tag label views all windows with that
-.BR tag .
+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
-.B tag
-to/from the view.
+click on a tag label adds/removes all windows with that tag to/from the view.
+.TP
+.B Button4
+click on the mode label increases the number of windows in the master area (tiling mode only).
+.TP
+.B Button5
+click on the mode label decreases the number of windows in the master area (tiling mode only).
+.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
@@ -52,98 +61,89 @@ Start
 .BR xterm (1).
 .TP
 .B Mod1-Tab
-Focus next
-.BR window .
+Focus next window.
 .TP
 .B Mod1-Shift-Tab
-Focus previous
-.BR window .
+Focus previous window.
 .TP
 .B Mod1-Return
-Zoom current
-.B window
-to the 
-.B master
-column
-.RB ( tiling
-mode only).
-.TP
-.B Mod1-m
-Maximize current
-.BR window .
-.TP
-.B Mod1-Shift-[0..n]
+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-s
+Shrink master area (tiling mode only).
+.TP
+.B Mod1-i
+Increase the number of windows in the master area (tiling mode only).
+.TP
+.B Mod1-d
+Decrease the number of windows in the master area (tiling mode only).
+.TP
+.B Mod1-Shift-[1..n]
 Apply
-.B nth tag
-to current
-.BR window .
+.RB nth
+tag to current window.
 .TP
-.B Mod1-Control-Shift-[0..n]
+.B Mod1-Shift-0
+Apply all tags to current window.
+.TP
+.B Mod1-Control-Shift-[1..n]
 Add/remove
-.B nth tag
-to/from current
-.BR window .
+.B nth
+tag to/from current window.
 .TP
 .B Mod1-Shift-c
-Close focused
-.B window.
+Close focused window.
 .TP
 .B Mod1-space
-Toggle between
-.B tiled
-and
-.B floating
-mode (affects
-.BR "all windows" ).
-.TP
-.B Mod1-[0..n]
+Toggle between tiling and floating mode (affects all windows).
+.TP
+.B Mod1-Shift-space
+Toggle focused window between floating and non-floating state (tiling mode only).
+.TP
+.B Mod1-[1..n]
 View all windows with
-.BR "tag n" .
+.BR nth
+tag.
+.TP
+.B Mod1-0
+View all windows with any tag.
 .TP
-.B Mod1-Control-[0..n]
+.B Mod1-Control-[1..n]
 Add/remove all windows with
-.B tag n
-to/from the view.
+.BR nth
+tag to/from the view.
 .TP
 .B Mod1-Shift-q
-Quit
-.B dwm.
+Quit dwm.
 .SS Mouse commands
 .TP
 .B Mod1-Button1
-Move current
-.B window
-while dragging
-.RB ( floating
-mode only).
+Move current window while dragging (floating mode only).
 .TP
 .B Mod1-Button2
-Zoom current
-.B window
-to the 
-.B master
-column
-.RB ( tiling
-mode only).
+Zoom current window to the master area (tiling mode only).
 .TP
 .B Mod1-Button3
-Resize current
-.B window
-while dragging
-.RB ( floating
-mode only).
+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 displays
-.B broken pipe
-when
-.B dwm
-has been started by
+.SH BUGS
+The status bar may display
+.BR "EOF"
+when dwm has been started by an X session manager like
 .BR xdm (1),
-because it closes standard output before executing
-.BR dwm .
+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)