added the related bug reported by voltaic

[dwm.git] / dwm.1

diff --git a/dwm.1 b/dwm.1
index b0d236c..7ed8ead 100644 (file)
--- a/dwm.1
+++ b/dwm.1
@@ -1,33 +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 certain tags 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 all available tags, the mode, the
-title of the focused window, and the text read from standard input. The
-selected tags are highlighted with a different color, the tags of the focused
-window are highlighted with a small point.
+Each screen contains a small status bar which displays all available tags, the
+layout, the title of the focused window, and the text read from the root window
+name property, if the screen is focused. 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 title.
+dwm draws a small border around windows to indicate the focus state.

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


@@ -35,149 +36,134 @@ prints version information to standard output, then exits.
 .SH USAGE
 .SS Status bar
 .TP
 .SH USAGE
 .SS Status bar
 .TP

-.B Standard input
-is read and displayed in the status text area.
+.B X root window name
+is read and displayed in the status text area. It can be set with the
+.BR xsetroot (1)
+command.

 .TP
 .B Button1
 .TP
 .B Button1

-click on a tag label views all windows with that
-.BR tag ,
-click on the mode label toggles between
-.B tiled
-and
-.B floating
-mode.
+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.
-.TP
-.B Mod1-Button1
-click on a tag label applies that
-.B tag
-to the focused
-.BR window .
-.TP
-.B Mod1-Button3
-click on a tag label adds/removes that
-.B tag
-to/from the focused
-.BR window .
+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-g
-Grow current
-.BR column
-.RB ( tiling
-mode only).
-.TP
-.B Mod1-s
-Shrink current
-.BR column
-.RB ( tiling
-mode only).
-.TP
-.B Mod1-Shift-[1..n]
-Apply
-.B nth tag
-to current
-.BR window .
-.TP
-.B Mod1-Control-Shift-[1..n]
-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-[1..n]
-View all windows with
-.BR "tag n" .
-.TP
-.B Mod1-0
-View all windows with any
-.BR "tag" .
-.TP
-.B Mod1-Control-[1..n]
-Add/remove all windows with
-.B tag n
-to/from the view.
-.TP
-.B Mod1-Shift-q
-Quit
-.B dwm.
+.BR uxterm (1).
+.TP
+.B Mod1\-,
+Focus previous screen, if any.
+.TP
+.B Mod1\-.
+Focus next screen, if any.
+.TP
+.B Mod1\-Shift\-,
+Send focused window to previous screen, if any.
+.TP
+.B Mod1\-Shift\-.
+Send focused window to next screen, if any.
+.TP
+.B Mod1\-b
+Toggles bar on and off.
+.TP
+.B Mod1\-t
+Sets tiled layout.
+.TP
+.B Mod1\-f
+Sets floating layout.
+.TP
+.B Mod1\-m
+Sets monocle layout.
+.TP
+.B Mod1\-space
+Toggles between current and previous layout.
+.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\-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 nth tag to focused window.
+.TP
+.B Mod1\-Shift\-0
+Apply all tags to focused window.
+.TP
+.B Mod1\-Control\-Shift\-[1..n]
+Add/remove nth tag to/from focused window.
+.TP
+.B Mod1\-[1..n]
+View all windows with nth tag.
+.TP
+.B Mod1\-0
+View all windows with any tag.
+.TP
+.B Mod1\-Control\-[1..n]
+Add/remove all windows with nth tag to/from the view.
+.TP
+.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 may display
-.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
+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. Possible workarounds
+are using JDK 1.4 (which doesn't contain the XToolkit/XAWT backend) or setting the
+environment variable
+.BR AWT_TOOLKIT=MToolkit
+(to use the older Motif backend instead) or running
+.B xprop -root -f _NET_WM_NAME 32a -set _NET_WM_NAME LG3D
+or
+.B wmname LG3D
+(to pretend that a non-reparenting window manager is running that the
+XToolkit/XAWT backend can recognize) or when using OpenJDK setting the environment variable
+.BR _JAVA_AWT_WM_NONREPARENTING=1 .
+.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.