this patch keeps track of global z-layer order of clients which are floating or if...

[dwm.git] / dwm.1

diff --git a/dwm.1 b/dwm.1
index 96fa760..5402be3 100644 (file)
--- a/dwm.1
+++ b/dwm.1
@@ -1,4 +1,4 @@
-.TH DWM 1 dwm-0.2
+.TH DWM 1 dwm-VERSION

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


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

-is a dynamic window manager for X11. It manages windows in tiling and floating
-modes. Either mode can be applied dynamically, depending on the application in
-use and the task performed.
+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.

 .P
 In tiling mode windows are managed in a master and stacking column. The master
 .P
 In tiling mode windows are managed in a master and stacking column. The master

-column contains the window which needs most attention at a time, whereas the
-stacking column contains all other windows in a stack.  Dialog windows are
-managed floating, however. In floating mode windows can be resized and moved
-freely.
+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. All windows with a specific tag can be viewed at a
-time. But each window may contain more than one tag, which makes it visible in
-several 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

-consists of a small status bar which reads the text displayed from standard
-input, if written. It draws 1-pixel borders around windows to indicate the
-focus state. Unfocused windows contain a small bar in front of the window
-displaying the tags and the window title.
+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 tags of
+the focused window are highlighted with a small point.
+.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.

 .SH OPTIONS
 .TP
 .B \-v
 prints version information to standard output, then exits.
 .SH USAGE
 .SH OPTIONS
 .TP
 .B \-v
 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 views all windows with that
+.BR tag ,
+click on the mode label toggles between
+.B tiled
+and
+.B floating
+mode.
+.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 .
+.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
+.BR window .

 .TP
 .TP

-.B Mod1-[0..n]
-Focus
-.B nth
-tag
+.B Mod1-g
+Grow current
+.BR column
+.RB ( tiling
+mode only).

 .TP
 .TP

-.B Mod1-space
-(Re-)arrange
-.B all
-windows tiled
-.TP
-.B Mod1-Shift-space
-(Re-)arrange
-.B all
-windows floating
+.B Mod1-s
+Shrink current
+.BR column
+.RB ( tiling
+mode only).

 .TP
 .TP

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

 Apply
 Apply

-.B nth
-tag to current
-.B window
-.TP
-.B Mod1-Shift-q
-Quit
-.B dwm
-.TP
-.B Mod1-Shift-Return
-Start
-.B terminal
+.B nth tag
+to current
+.BR window .

 .TP
 .TP

-.B Mod1-Shift-w
-Start
-.B web browser
+.B Mod1-Control-Shift-[1..n]
+Add/remove
+.B nth tag
+to/from current
+.BR window .

 .TP
 .TP

-.B Mod1-Shift-l
-Lock
-.B screen
+.B Mod1-Shift-c
+Close focused
+.B window.

 .TP
 .TP

-.B Control-[0..n]
-Append
-.B nth
-tag to current
-.B window
-.TP
-.B Control-Shift-[0..n]
-Replace current
-.B window
-of
-.B nth
-tag with current tag.
-.B window
+.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
 .TP

-.B Control-Button1
-Zooms the clicked
-.B window
-to master column
+.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
 .SH CUSTOMIZATION
 .B dwm

-is customized through editing its source code.  This keeps it fast, secure and
-simple. The source code contains the
-.I CUSTOMIZE
-keyword to highlight relevant portions for customization.
+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 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)