fixed a bug reported by sander

[dwm.git] / dwm.1

diff --git a/dwm.1 b/dwm.1
index 56dd8b9..46f0d94 100644 (file)
--- a/dwm.1
+++ b/dwm.1
@@ -1,4 +1,4 @@
-.TH DWM 1 dwm-0.1
+.TH DWM 1 dwm-VERSION

 .SH NAME
 dwm \- dynamic window manager
 .SH SYNOPSIS
 .SH NAME
 dwm \- dynamic window manager
 .SH SYNOPSIS


@@ -6,120 +6,143 @@ dwm \- dynamic window manager
 .RB [ \-v ]
 .SH DESCRIPTION
 .B dwm
 .RB [ \-v ]
 .SH DESCRIPTION
 .B dwm

-is a dynamic window manager for X11. It consists of a small status bar and
-arranges windows in either a tiled or floating mode.
+is a dynamic window manager for X11. 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.

 .P
 .P

-In tiled mode
-.B dwm
-manages all windows in a left master column and a right stacking column. The
-master column contains a single window, the left stacking column all other
-windows. Dialog windows are treated floating.
-.P
-In floating mode
-.B dwm
-manages all windows in a conventional way. They can be resized and moved freely
-with the mouse.
+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.

 .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 a certain tag for viewing will display all windows with that
+tag.

 .P
 .B dwm
 .P
 .B dwm

-reads from standard input to display status text, if written.
-.P
-.B dwm
-draws 1-pixel borders around windows to indicate the focus state and providing 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.
+has a small status bar which displays the text read from standard
+input, if written. Besides that, it displays all available tags, and the title
+of the focused window. It 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.

 .SH OPTIONS
 .TP
 .B \-v
 prints version information to standard output, then exits.
 .SH OPTIONS
 .TP
 .B \-v
 prints version information to standard output, then exits.

-.SH CUSTOMIZATION
-.B dwm
-is customized through editing its source code. It is assumed that
-.B dwm
-users know to patch it for their needs. This keeps it fast, secure and simple,
-because it does not process any input data, except window properties and
-the status text read from standard input.
-.SS Keyboard Control
-.TP 16
-.I Key 
-.I Action
+.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 views all windows with that
+.BR tag .
+.TP
+.B Button3
+click on a tag label adds/removes all windows with that
+.B tag
+to/from the view.
+.SS Keyboard commands
+.TP
+.B Mod1-Shift-Return
+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
 .TP
 .B Mod1-Return

-Zoom
+Zoom current

 .B window
 to the 
 .B master
 column
 .B window
 to the 
 .B master
 column

-.TP
-.B Mod1-k
-Focus previous
-.B window
-.TP
-.B Mod1-j
-Focus next
-.B window
+.RB ( tiling
+mode only).

 .TP
 .B Mod1-m
 Maximize current
 .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
+.BR window .

 .TP
 .B Mod1-Shift-[0..n]
 Apply
 .TP
 .B Mod1-Shift-[0..n]
 Apply

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

 .TP
 .TP

-.B Mod1-Shift-q
-Quit
-.B dwm
+.B Mod1-Control-Shift-[0..n]
+Add/remove
+.B nth tag
+to/from current
+.BR window .

 .TP
 .TP

-.B Mod1-Shift-Return
-Start
-.B terminal
+.B Mod1-Shift-c
+Close focused
+.B window.

 .TP
 .TP

-.B Mod1-Shift-w
-Start
-.B web browser
+.B Mod1-space
+Toggle between
+.B tiled
+and
+.B floating
+mode (affects
+.BR "all windows" ).

 .TP
 .TP

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

 .TP
 .TP

-.B Control-[0..n]
-Append
-.B nth
-tag to cureent
-.B window
-.SS Mouse Control
+.B Mod1-Control-[0..n]
+Add/remove all windows with
+.B tag n
+to/from the view.
+.TP
+.B Mod1-Shift-q
+Quit
+.B dwm.
+.SS Mouse commands

 .TP
 .B Mod1-Button1
 .TP
 .B Mod1-Button1

-Moves current
+Move current

 .B window
 while dragging
 .B window
 while dragging

+.RB ( floating
+mode only).

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

-Lowers current
+Zoom current

 .B window
 .B window

+to the 
+.B master
+column
+.RB ( tiling
+mode only).

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

-Resizes current
+Resize current

 .B window
 while dragging
 .B window
 while dragging

+.RB ( floating
+mode only).
+.SH CUSTOMIZATION
+.B dwm
+is customized by creating a custom config.h and (re)compiling the source
+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)