renamed floating into swimming (this does not clash with C naming conventions and...

[dwm.git] / dwm.1

diff --git a/dwm.1 b/dwm.1
index 1c7a5a6..c48e853 100644 (file)
--- a/dwm.1
+++ b/dwm.1
@@ -1,47 +1,149 @@
-.TH DWM 1 dwm-0.0
+.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

-.SS Overview
-.B dwm
-is a dynamic window manager for X11.
-.SS Options
+dwm is a dynamic window manager for X. It manages windows in tiling and
+swimming layouts. Either layout can be applied dynamically, optimizing the
+environment for the application in use and the task performed.
+.P
+In tiling layout 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 swimming layout windows can be
+resized and moved freely. Dialog windows are always managed swimming,
+regardless of the layout applied.
+.P
+Windows are grouped by tags. Each window can be tagged with one or multiple
+tags. Selecting certain tags displays all windows with these tags.
+.P
+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. 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 small border around windows to indicate the focus state.
+.SH OPTIONS

 .TP
 .B \-v
 .TP
 .B \-v

-prints version information to stdout, then exits.
-.SS Default Key Bindings
-.TP 16
-.I Key 
-.I Action
+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 layout
+label toggles between tiling and swimming layout.
+.TP
+.B Button3
+click on a tag label adds/removes all windows with that tag to/from the view.
+.TP
+.B Button4
+click on the layout label increases the number of windows in the master area (tiling layout only).
+.TP
+.B Button5
+click on the layout label decreases the number of windows in the master area (tiling layout 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
+Start
+.BR xterm (1).
+.TP
+.B Mod1-Tab
+Focus next window.
+.TP
+.B Mod1-Shift-Tab
+Focus previous window.

 .TP
 .B Mod1-Return
 .TP
 .B Mod1-Return

-Zoom
-.B window
-to the 
-.B master
-track
-.TP
-.B Mod1-k
-Focus previous
-.B window
-.TP
-.B Mod1-j
-Focus next
-.B window
-.TP
-.B Mod1-m
-Maximize current
-.B window
-.TP
-.B Mod1-[0..n]
-Focus
+Zooms/cycles current window to/from master area (tiling layout), toggles maximization of current window (swimming layout).
+.TP
+.B Mod1-g
+Grow master area (tiling layout only).
+.TP
+.B Mod1-s
+Shrink master area (tiling layout only).
+.TP
+.B Mod1-i
+Increase the number of windows in the master area (tiling layout only).
+.TP
+.B Mod1-d
+Decrease the number of windows in the master area (tiling layout only).
+.TP
+.B Mod1-Shift-[1..n]
+Apply
+.RB nth
+tag to current window.
+.TP
+.B Mod1-Shift-0
+Apply all tags to current window.
+.TP
+.B Mod1-Control-Shift-[1..n]
+Add/remove

 .B nth
 .B nth

-tag
+tag to/from current window.
+.TP
+.B Mod1-Shift-c
+Close focused window.

 .TP
 .B Mod1-space
 .TP
 .B Mod1-space

-(Re-)arrange
-.B all
-windows tiled
+Toggle between tiling and swimming layout (affects all windows).
+.TP
+.B Mod1-Shift-space
+Toggle focused window between swimming and non-swimming state (tiling layout only).
+.TP
+.B Mod1-[1..n]
+View all windows with
+.BR nth
+tag.
+.TP
+.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 window while dragging (swimming layout only).
+.TP
+.B Mod1-Button2
+Zooms/cycles current window to/from master area (tiling layout), toggles maximization of current window (swimming layout).
+.TP
+.B Mod1-Button3
+Resize current window while dragging (swimming layout only).
+.SH CUSTOMIZATION
+dwm is customized by creating a custom config.h and (re)compiling the source
+code. This keeps it fast, secure and simple.
+.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 .