fixed order of key bindings described in dwm.1

[dwm.git] / dwm.1

diff --git a/dwm.1 b/dwm.1
index 6ae2c39..5cee3f0 100644 (file)
--- a/dwm.1
+++ b/dwm.1
@@ -1,148 +1,154 @@
-.TH DWM 1 dwm-0.1
+.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. It consists of a small status bar at the
-top of the screen and arranges windows in either a tiled or floating mode.
-.P
-If 
-.B dwm
-is in tiled mode, it consists of two columns. The left master column
-contains only one window per time, the right column contains all other windows 
-in a stack. In tiled mode
-.B dwm
-.B don't
-handles incremental resizals, some terminal programs like
-.B xterm
-may not work correctly with this in tiled mode.
+dwm is a dynamic window manager for X. It manages windows in tiling and
+versatile layouts. Either layout can be applied dynamically, optimizing the
+environment for the application in use and the task performed.

 .P
 .P

-If
-.B dwm
-is in floating mode, it arranges all windows with the reqyested geometry and
-allows the user to move or resize them. Some windows, like
-dialog windows, are treated floating even if
-.B dwm
-is in tiled mode. In floating mode
-.B dwm
-handles incremental resizals.
+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 versatile layout windows can be
+resized and moved freely. Dialog windows are always managed versatile,
+regardless of the layout applied.

 .P
 .P

-Windows are grouped by tags. You can view all windows with a specific tag per
-time.  However, each window is allowed to contain more than one tag, which
-allows to make windows visible in all views.
+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
 .P

-.B dwm
-reads from
-.I stdin
-to display status text, if written.
+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
+versatile window is indicated with an empty square and a maximized
+versatile 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 1-pixel borders around windows to indicate the focus state and save as
-much screen real estate as possible. Unfocused windows contain a small bar
-in front of the window indicating the tags and the window title.
-.SS Options
+dwm draws a small border around windows to indicate the focus state.
+.SH OPTIONS

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

-prints version information to
-.I stdout
-, then exits.
-.SS Customization
-.B dwm
-is customized through editing its source code. It is assumed that
-dwm users are high experienced users who know how a window manager works
-and who are able to patch
-.B dwm
-for their needs. This keeps
-.B dwm
-fast, secure and simple, because it does not process any input data, except
-window properties and the status text read from
-.I stdin .
-.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 versatile 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-Return
 .TP
 .B Mod1-Return

-Zoom
-.B window
-to the 
-.B master
-track
+Zooms/cycles current window to/from master area (tiling layout only).
+.TP
+.B Mod1-j
+Focus next window.

 .TP
 .B Mod1-k
 .TP
 .B Mod1-k

-Focus previous
-.B window
+Focus previous window.

 .TP
 .TP

-.B Mod1-j
-Focus next
-.B window
+.B Mod1-l
+Increase master area width (tiling layout only).

 .TP
 .TP

-.B Mod1-m
-Maximize current
-.B window
+.B Mod1-h
+Decrease master area width (tiling layout only).

 .TP
 .TP

-.B Mod1-[0..n]
-Focus
-.B nth
-tag
+.B Mod1-i
+Increase the number of windows in the master area (tiling layout only).

 .TP
 .TP

-.B Mod1-space
-(Re-)arrange
-.B all
-windows tiled
+.B Mod1-d
+Decrease the number of windows in the master area (tiling layout only).

 .TP
 .TP

-.B Mod1-Shift-space
-(Re-)arrange
-.B all
-windows floating
+.B Mod1-m
+Toggles maximization of current window (versatile layout only).

 .TP
 .TP

-.B Mod1-Shift-[0..n]
+.B Mod1-Shift-[1..n]

 Apply
 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 to current
-.B window
+tag to/from current window.

 .TP
 .TP

-.B Mod1-Shift-q
-Quit
-.B dwm
+.B Mod1-Shift-c
+Close focused window.

 .TP
 .TP

-.B Mod1-Shift-Return
-Start
-.B terminal
+.B Mod1-space
+Toggle between tiling and versatile layout (affects all windows).

 .TP
 .TP

-.B Mod1-Shift-w
-Start
-.B web browser
+.B Mod1-Shift-space
+Toggle focused window between versatile and non-versatile state (tiling layout only).

 .TP
 .TP

-.B Mod1-Shift-l
-Lock
-.B screen
+.B Mod1-[1..n]
+View all windows with
+.BR nth
+tag.

 .TP
 .TP

-.B Control-[0..n]
-Append
-.B nth
-tag to cureent
-.B window
-.SS Default Mouse Bindings
+.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
 .TP
 .B Mod1-Button1

-Moves current
-.B window
-while dragging
+Move current window while dragging (versatile layout only).

 .TP
 .B Mod1-Button2
 .TP
 .B Mod1-Button2

-Lowers current
-.B window
+Zooms/cycles current window to/from master area (tiling layout only).

 .TP
 .B Mod1-Button3
 .TP
 .B Mod1-Button3

-Resizes current
-.B window
-while dragging
+Resize current window while dragging (versatile 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
 .SH BUGS

-Some terminal programs do not behave correctly in tiled mode, because
-incremental resizals are ignored to use maximum screen real estate. You can
-patch the code to fix this.
+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 .