patch: fibonacci

[dwm.git] / dwm.1

diff --git a/dwm.1 b/dwm.1
index 38c50b5..764b86f 100644 (file)
--- a/dwm.1
+++ b/dwm.1
@@ -1,138 +1,199 @@
-.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, monocle
+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 layouts windows are managed in a master and stacking area. The master
+area on the left contains one window by default, and the stacking area on the
+right contains all other windows. The number of master area windows can be
+adjusted from zero to an arbitrary number. In monocle 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.
+Each screen contains a small status bar which displays all available tags, the
+layout, the title of the focused window, and the text read from the root window
+name property, if the screen is focused. 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

-prints version information to standard output, then exits.
+prints version information to stderr, then exits.

 .SH USAGE
 .SS Status bar
 .TP
 .SH USAGE
 .SS Status bar
 .TP

-.B Standard input
-is read and displayed in the status text area.
+.B X root window name
+is read and displayed in the status text area. It can be set with the
+.BR xsetroot (1)
+command.

 .TP
 .TP

-.B Button[1,3]
-click on a tag label focuses that
-.B 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 Button2
-click on a tag label toggles that
-.B tag.
+.B Button3
+click on a tag label adds/removes all windows with that tag to/from the view.
+.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
 .SS Keyboard commands
 .TP

-.B Mod1-Return
-Zoom current
-.B window
-to the 
-.B master
-column.
-.TP
-.B Mod1-j
-Focus next
-.B window.
-.TP
-.B Mod1-k
-Focus previous
-.B window.
-.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]
-Apply
-.B nth tag
-to current
-.B window.
-.TP
-.B Mod1-Shift-c
-Close focused
-.B window.
-.TP
-.B Mod1-Shift-q
-Quit
-.B dwm.
-.TP
-.B Mod1-Shift-Return
+.B Mod1\-Shift\-Return

 Start
 Start

-.B terminal.
+.BR st(1).
+.TP
+.B Mod1\-p
+Spawn
+.BR dmenu(1)
+for launching other programs.
+.TP
+.B Mod1\-,
+Focus previous screen, if any.
+.TP
+.B Mod1\-.
+Focus next screen, if any.
+.TP
+.B Mod1\-Shift\-,
+Send focused window to previous screen, if any.
+.TP
+.B Mod1\-Shift\-.
+Send focused window to next screen, if any.
+.TP
+.B Mod1\-b
+Toggles bar on and off.
+.TP
+.B Mod1\-t
+Sets tiled layout.
+.TP
+.B Mod1\-f
+Sets floating layout.
+.TP
+.B Mod1\-m
+Sets monocle layout.
+.TP
+.B Mod1\-space
+Toggles between current and previous layout.
+.TP
+.B Mod1\-j
+Focus next window.
+.TP
+.B Mod1\-k
+Focus previous window.
+.TP
+.B Mod1\-i
+Increase number of windows in master area.
+.TP
+.B Mod1\-d
+Decrease number of windows in master area.
+.TP
+.B Mod1\-l
+Increase master area size.
+.TP
+.B Mod1\-h
+Decrease master area size.

 .TP
 .TP

-.B Mod1-Control-[0..n]
-Toggle
-.B nth tag.
+.B Mod1\-Return
+Zooms/cycles focused window to/from master area (tiled layouts only).

 .TP
 .TP

-.B Mod1-Control-Shift-[0..n]
-Append
-.B nth tag
-to current
-.B window.
+.B Mod1\-Shift\-c
+Close focused window.
+.TP
+.B Mod1\-Shift\-f
+Toggle fullscreen for focused window.
+.TP
+.B Mod1\-Shift\-space
+Toggle focused window between tiled and floating state.
+.TP
+.B Mod1\-Tab
+Toggles to the previously selected tags.
+.TP
+.B Mod1\-Shift\-[1..n]
+Apply nth tag to focused window.
+.TP
+.B Mod1\-Shift\-0
+Apply all tags to focused window.
+.TP
+.B Mod1\-Control\-Shift\-[1..n]
+Add/remove nth tag to/from focused window.
+.TP
+.B Mod1\-[1..n]
+View all windows with nth tag.
+.TP
+.B Mod1\-0
+View all windows with any tag.
+.TP
+.B Mod1\-Control\-[1..n]
+Add/remove all windows with nth tag to/from the view.
+.TP
+.B Mod1\--
+Decrease the gaps around windows.
+.TP
+.B Mod1\-=
+Increase the gaps around windows.
+.TP
+.B Mod1\-Shift-=
+Reset the gaps around windows to
+.BR 0 .
+.TP
+.B Mod1\-Shift\-q
+Quit dwm.
+.TP
+.B Mod1\-Control\-Shift\-q
+Restart 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 focused window while dragging. Tiled windows will be toggled to the floating state.
+.TP
+.B Mod1\-Button2
+Toggles focused window between floating and tiled state.
+.TP
+.B Mod1\-Button3
+Resize focused 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.
 code. This keeps it fast, secure and simple.

-.SH CAVEATS
-The status bar displays
-.BR "broken pipe"
-when
-.B dwm
-has been started by
-.BR xdm (1),
-because it closes standard output before executing
-.B dwm.
+.SH SIGNALS
+.TP
+.B SIGHUP - 1
+Restart the dwm process.
+.TP
+.B SIGTERM - 15
+Cleanly terminate the dwm process.

 .SH SEE ALSO
 .SH SEE ALSO

-.BR dmenu (1)
+.BR dmenu (1),
+.BR st (1)
+.SH ISSUES
+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. Possible workarounds
+are using JDK 1.4 (which doesn't contain the XToolkit/XAWT backend) or setting the
+environment variable
+.BR AWT_TOOLKIT=MToolkit
+(to use the older Motif backend instead) or running
+.B xprop -root -f _NET_WM_NAME 32a -set _NET_WM_NAME LG3D
+or
+.B wmname LG3D
+(to pretend that a non-reparenting window manager is running that the
+XToolkit/XAWT backend can recognize) or when using OpenJDK setting the environment variable
+.BR _JAVA_AWT_WM_NONREPARENTING=1 .
+.SH BUGS
+Send all bug reports with a patch to [email protected].