final version -- Gottox verified it using the test driver

[dwm.git] / dwm.1

diff --git a/dwm.1 b/dwm.1
index af13b7d..4a465aa 100644 (file)
--- a/dwm.1
+++ b/dwm.1
@@ -1,32 +1,34 @@
-.TH DWM 1 dwm-VERSION
+.TH DWM 1 dwm\-VERSION

 .SH NAME
 dwm \- dynamic window manager
 .SH SYNOPSIS
 .B dwm
 .RB [ \-v ]
 .SH DESCRIPTION
 .SH NAME
 dwm \- dynamic window manager
 .SH SYNOPSIS
 .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 tiled, monocle
+and floating layouts. Either layout can be applied dynamically, optimising the
+environment for the application in use and the task performed.

 .P
 .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
-resized and moved freely. Dialog windows are always managed floating,
-regardless of the mode selected.
+In tiled layouts 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 monocle layout all windows are
+maximised to the screen size. In floating layout windows can be resized and
+moved freely. Dialog windows are always managed floating, regardless of the
+layout applied.

 .P
 Windows are grouped by tags. Each window can be tagged with one or multiple
 .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
 .P

-.B dwm
-contains a small status bar which displays the text read from standard
-input. It also displays the title and all active tags of the focused window.
+dwm contains a small status bar which displays all available tags, the layout,
+the title of the focused window, and the text read from standard input. A
+floating window is indicated with an empty square and a maximised
+floating window is indicated with a filled square before the windows
+title.  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
 .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 tags
-and title.
+dwm draws a small border around windows to indicate the focus state.

 .SH OPTIONS
 .TP
 .B \-v
 .SH OPTIONS
 .TP
 .B \-v

@@ -38,112 +40,118 @@ prints version information to standard output, then exits.
 is read and displayed in the status text area.
 .TP
 .B Button1
 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 layout
+label toggles between tiled and floating layout.

 .TP
 .B Button3
 .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 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
 .SS Keyboard commands
 .TP

-.B Mod1-Shift-Return
+.B Mod1\-Shift\-Return

 Start
 Start

-.BR xterm (1).
-.TP
-.B Mod1-Tab
-Focus next
-.BR window .
-.TP
-.B Mod1-Shift-Tab
-Focus previous
-.BR 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]
+.BR xterm.
+.TP
+.B Mod1\-b
+Toggles bar on and off.
+.TP
+.B Mod1\-space
+Toggles between layouts.
+.TP
+.B Mod1\-j
+Focus next window.
+.TP
+.B Mod1\-k
+Focus previous window.
+.TP
+.B Mod1\-h
+Decrease master area size.
+.TP
+.B Mod1\-l
+Increase master area size.
+.TP
+.B Mod1\-m
+Toggle focused window between maximisation and normal state.
+.TP
+.B Mod1\-Return
+Zooms/cycles focused window to/from master area (tiled layouts only).
+.TP
+.B Mod1\-Shift\-c
+Close focused window.
+.TP
+.B Mod1\-Shift\-space
+Toggle focused window between tiled and floating state.
+.TP
+.B Mod1\-Tab
+Toggles to the previously selected tags.
+.TP
+.B Mod1\-Shift\-[1..n]

 Apply
 Apply

-.B nth tag
-to current
-.BR window .
+.RB nth
+tag to focused window.

 .TP
 .TP

-.B Mod1-Control-Shift-[0..n]
+.B Mod1\-Shift\-0
+Apply all tags to focused window.
+.TP
+.B Mod1\-Control\-Shift\-[1..n]

 Add/remove
 Add/remove

-.B nth tag
-to/from current
-.BR window .
-.TP
-.B Mod1-Shift-c
-Close focused
-.B window.
-.TP
-.B Mod1-space
-Toggle between
-.B tiled
-and
-.B floating
-mode (affects
-.BR "all windows" ).
-.TP
-.B Mod1-[0..n]
+.B nth
+tag to/from focused window.
+.TP
+.B Mod1\-[1..n]

 View all windows with
 View all windows with

-.BR "tag n" .
+.BR nth
+tag.
+.TP
+.B Mod1\-0
+View all windows with any tag.

 .TP
 .TP

-.B Mod1-Control-[0..n]
+.B Mod1\-Control\-[1..n]

 Add/remove all windows with
 Add/remove all windows with

-.B tag n
-to/from the view.
+.BR nth
+tag to/from the view.

 .TP
 .TP

-.B Mod1-Shift-q
-Quit
-.B dwm.
+.B Mod1\-Shift\-q
+Quit dwm.

 .SS Mouse commands
 .TP
 .SS Mouse commands
 .TP

-.B Mod1-Button1
-Move current
-.B window
-while dragging
-.RB ( floating
-mode only).
-.TP
-.B Mod1-Button2
-Zoom current
-.B window
-to the 
-.B master
-column
-.RB ( tiling
-mode only).
-.TP
-.B Mod1-Button3
-Resize current
-.B window
-while dragging
-.RB ( floating
-mode only).
+.B Mod1\-Button1
+Move focused window while dragging. Tiled windows will be toggled to the floating state.
+.TP
+.B Mod1\-Button2
+Toggles focused window between floating and tiled state.
+.TP
+.B Mod1\-Button3
+Resize focused window while dragging. Tiled windows will be toggled to the floating state.

 .SH CUSTOMIZATION
 .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.
 code. This keeps it fast, secure and simple.

-.SH CAVEATS
-The status bar displays
-.B broken pipe
-when
-.B dwm
-has been started by
-.BR xdm (1),
-because it closes standard output before executing
-.BR dwm .

 .SH SEE ALSO
 .BR dmenu (1)
 .SH SEE ALSO
 .BR dmenu (1)

+.SH BUGS
+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 .
+.P
+GTK 2.10.9+ versions contain a broken
+.BR Save\-As
+file dialog implementation,
+which requests to reconfigure its window size in an endless loop. However, its
+window is still respondable during this state, so you can simply ignore the flicker
+until a new GTK version appears, which will fix this bug, approximately
+GTK 2.10.12+ versions.