fixed XSync handling and finished man page

[dwm.git] / dwm.1

diff --git a/dwm.1 b/dwm.1
index 1e312e9..6ae2c39 100644 (file)
--- a/dwm.1
+++ b/dwm.1
@@ -1,4 +1,4 @@
-.TH DWM 1 dwm-0.0
+.TH DWM 1 dwm-0.1
 .SH NAME
 dwm \- dynamic window manager
 .SH SYNOPSIS
@@ -7,8 +7,142 @@ dwm \- dynamic window manager
 .SH DESCRIPTION
 .SS Overview
 .B dwm
-is a dynamic window manager for X11.
+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.
+.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.
+.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.
+.P
+.B dwm
+reads from
+.I stdin
+to display status text, if written.
+.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
 .TP
 .B \-v
-prints version information to stdout, then exits.
+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
+.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
+.B nth
+tag
+.TP
+.B Mod1-space
+(Re-)arrange
+.B all
+windows tiled
+.TP
+.B Mod1-Shift-space
+(Re-)arrange
+.B all
+windows floating
+.TP
+.B Mod1-Shift-[0..n]
+Apply
+.B nth
+tag to current
+.B window
+.TP
+.B Mod1-Shift-q
+Quit
+.B dwm
+.TP
+.B Mod1-Shift-Return
+Start
+.B terminal
+.TP
+.B Mod1-Shift-w
+Start
+.B web browser
+.TP
+.B Mod1-Shift-l
+Lock
+.B screen
+.TP
+.B Control-[0..n]
+Append
+.B nth
+tag to cureent
+.B window
+.SS Default Mouse Bindings
+.TP
+.B Mod1-Button1
+Moves current
+.B window
+while dragging
+.TP
+.B Mod1-Button2
+Lowers current
+.B window
+.TP
+.B Mod1-Button3
+Resizes current
+.B window
+while dragging
+.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.