renamed monocle into maxmise, documented the keybindings in dwm(1)

[dwm.git] / dwm.1

diff --git a/dwm.1 b/dwm.1
index b4cc4f4..4737ba2 100644 (file)
--- a/dwm.1
+++ b/dwm.1
@@ -1,31 +1,34 @@
-.TH DWM 1 dwm-VERSION
+.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

-.B dwm
-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.
+dwm is a dynamic window manager for X. It manages windows in tiled, maximised
+and floating layouts. Either layout can be applied dynamically, optimising the
+environment for the application in use and the task performed.

 .P
 .P

-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.
+In tiled layout windows are managed in a master and stacking area. The master
+area contains the window which currently needs most attention, whereas the
+stacking area contains all other windows. In maximised layout all windows are
+maximised to the screen size. In floating layout windows can be resized and
+moved freely. Dialog windows are always managed floating, regardless of the
+layout applied.

 .P
 Windows are grouped by tags. Each window can be tagged with one or multiple
 .P
 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.
+tags. Selecting certain tags displays all windows with these tags.

 .P
 .P

-.B dwm
-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.
+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
+floating window is indicated with an empty square and a maximised
+floating 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
+dwm draws a small border around windows to indicate the focus state.

 .SH OPTIONS
 .TP
 .B \-v
 .SH OPTIONS
 .TP
 .B \-v

@@ -33,101 +36,131 @@ prints version information to standard output, then exits.
 .SH USAGE
 .SS Status bar
 .TP
 .SH USAGE
 .SS Status bar
 .TP

-Writing to standard input displays the text in the status text area.
+.B Standard input
+is read and displayed in the status text area.

 .TP
 .TP

-.B Button[1-3]
-click onto a tag label focuses the specifc tag.
+.B Button1
+click on a tag label to display all windows with that tag, click on the layout
+label toggles between tiled and floating layout.

 .TP
 .TP

-.B Button[1,4]
-click focuses the previous tag.
+.B Button3
+click on a tag label adds/removes all windows with that tag to/from the view.

 .TP
 .TP

-.B Button[2,5]
-click focuses the next tag.
+.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
 .SS Keyboard commands
 .TP

-.B Mod1-Return
-Zoom current
-.B window
-to the 
-.B master
-column.
-.TP
-.B Mod1-h
-Focus previous
-.B tag.
-.TP
-.B Mod1-j
-Focus next
-.B window.
-.TP
-.B Mod1-k
-Focus previous
-.B window.
-.TP
-.B Mod1-l
-Focus next
-.B tag.
-.TP
-.B Mod1-m
-Maximize current
-.B window.
-.TP
-.B Mod1-[0..n]
-Focus
-.B nth tag.
-.TP
-.B Mod1-space
-Toggle between
-.B tiled
-and
-.B floating
-mode (affects
-.BR "all windows" ).
-.TP
-.B Mod1-Shift-[0..n]
+.B Mod1\-Shift\-Return
+Start
+.BR xterm.
+.TP
+.B Mod1\-Return
+Zooms/cycles current window to/from master area (tiled layout only).
+.TP
+.B Mod1\-Tab
+Toggles to the previously selected tags.
+.TP
+.B Mod1\-t
+Applies tiled layout.
+.TP
+.B Mod1\-f
+Applies loating layout.
+.TP
+.B Mod1\-m
+Applies maximised layout.
+.TP
+.B Mod1\-space
+Toggles between layouts.
+.TP
+.B Mod1\-b
+Shows/hides the status bar.
+.TP
+.B Mod1\-h
+Decreases the master area width about 5% (tiled layout only).
+.TP
+.B Mod1\-j
+Focus next window.
+.TP
+.B Mod1\-k
+Focus previous window.
+.TP
+.B Mod1\-l
+Increases the master area width about 5% (tiled layout only).
+.TP
+.B Mod1\-r
+Re-applies tagging rules to all windows.
+.TP
+.B Mod1\-Shift\-[1..n]

 Apply
 Apply

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

 .TP
 .TP

-.B Mod1-Shift-c
-Close focused
-.B window.
+.B Mod1\-Shift\-0
+Apply all tags to current window.

 .TP
 .TP

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

 .TP
 .TP

-.B Mod1-Shift-Return
-Start
-.B terminal.
+.B Mod1\-Shift\-c
+Close focused window.
+.TP
+.B Mod1\-Shift\-space
+Toggle focused window between tiled and floating state.
+.TP
+.B Mod1\-[1..n]
+View all windows with
+.BR nth
+tag.

 .TP
 .TP

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

-.B Mod1-Button1
-Move current
-.B window
-while dragging.
-.TP
-.B Mod1-Button2
-Zoom current
-.B window
-to the 
-.B master
-column.
-.TP
-.B Mod1-Button3
-Resize current
-.B window
-while dragging.
+.B Mod1\-Button1
+Move current window while dragging. Tiled windows will be toggled to the floating state.
+.TP
+.B Mod1\-Button2
+Zooms/cycles current window to/from master area. If it is floating (but not fixed) it will be toggled to the tiled state instead.
+.TP
+.B Mod1\-Button3
+Resize current window while dragging. Tiled windows will be toggled to the floating state.

 .SH CUSTOMIZATION
 .SH CUSTOMIZATION

-.B dwm
-is customized by creating a custom config.h and (re)compiling the source
+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)
 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 .
+.P
+Recent GTK 2.10.9+ versions contain a broken
+.BR Save\-As
+file dialog implementation,
+which requests to reconfigure its window size in an endless loop. However, its
+window is still respondable during this state, so you can simply ignore the flicker
+until a new GTK version appears, which will fix this bug, approximately
+GTK 2.10.12+ versions.