minor update, tab to space

[dwm.git] / dwm.1

diff --git a/dwm.1 b/dwm.1
index 56dd8b9..038682b 100644 (file)
--- a/dwm.1
+++ b/dwm.1
@@ -1,125 +1,219 @@
-.TH DWM 1 dwm-0.1
+.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 consists of a small status bar and
-arranges windows in either a tiled or floating mode.
+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 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.
+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
 .P

-In floating mode
-.B dwm
-manages all windows in a conventional way. They can be resized and moved freely
-with the mouse.
+Windows are grouped by tags. Each window can be tagged with one or multiple
+tags. Selecting certain tags displays all windows with these tags.

 .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.
+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
 .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.
+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.
-.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
-.TP
-.B Mod1-Return
-Zoom
-.B window
-to the 
-.B master
-column
-.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
+prints version information to stderr, then exits.
+.SH USAGE
+.SS Status bar

 .TP
 .TP

-.B Mod1-Shift-Return
-Start
-.B terminal
+.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
+.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
+.B Button3
+click on a tag label adds/removes all windows with that tag to/from the view.
+.TP
+.B Super\-Button1
+click on a tag label applies that tag to the focused window.
+.TP
+.B Super\-Button3
+click on a tag label adds/removes that tag to/from the focused window.
+.SS Keyboard commands
+.TP
+.B Super\-,
+Focus previous screen, if any.
+.TP
+.B Super\-.
+Focus next screen, if any.
+.TP
+.B Super\-Shift\-,
+Send focused window to previous screen, if any.
+.TP
+.B Super\-Shift\-.
+Send focused window to next screen, if any.
+.TP
+.B Super\-t
+Sets tiled layout.
+.TP
+.B Super\-m
+Sets monocle layout.
+.TP
+.B Super\-f
+Sets spiral layout.
+.TP
+.B Super\-r
+Sets dwindle layout.
+.TP
+.B Super\-Shift\-f
+Toggle fullscreen for focused window.
+.TP
+.B Super\-B
+Toggles bar on and off.
+.TP
+.B Super\-space
+Toggles between current and previous layout.
+.TP
+.B Super\-Shift\-space
+Toggle focused window between tiled and floating state.
+.TP
+.B Super\-i
+Increase number of windows in master area.

 .TP
 .TP

-.B Mod1-Shift-w
+.B Super\-d
+Decrease number of windows in master area.
+.TP
+.B Super\-j
+Focus next window.
+.TP
+.B Super\-k
+Focus previous window.
+.TP
+.B Super\-l
+Increase master area size.
+.TP
+.B Super\-h
+Decrease master area size.
+.TP
+.B Super\-Tab
+Toggles to the previously selected tags.
+.TP
+.B Super\-Shift\-[1..n]
+Apply nth tag to focused window.
+.TP
+.B Super\-Shift\-0
+Apply all tags to focused window.
+.TP
+.B Super\-Control\-Shift\-[1..n]
+Add/remove nth tag to/from focused window.
+.TP
+.B Super\-[1..n]
+View all windows with nth tag.
+.TP
+.B Super\-0
+View all windows with any tag.
+.TP
+.B Super\-Control\-[1..n]
+Add/remove all windows with nth tag to/from the view.
+.TP
+.B Super\--
+Increase the window size.
+.TP
+.B Super\-+
+Decrease the window size.
+.TP
+.B Super\-=
+Reset the windows size.
+.TP
+.B Super\-Shift\-q
+Quit dwm.
+.TP
+.B Super\-Control\-Shift\-q
+Restart dwm.
+.SS Launch and Actions
+.TP
+.B Super\-q
+Close focused window.
+.TP
+.B Super\-p
+Spawn
+.BR dmenu(1)
+for launching other programs.
+.TP
+.B Super\-Return

 Start
 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 Mouse Control
-.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
+.BR st(1).
+.TP
+.B Super\-L
+Lock screen,
+.BR slock.
+.TP
+.B Super\-w
+Web browser
+.BR firefox.
+.TP
+.B Super\-n
+Network
+.BR nmtui.
+.TP
+.B Super\-v
+View system status
+.BR htop.
+.TP
+.B Super\-s
+Sound
+.BR alsamixer.
+.SS Mouse commands
+.TP
+.B Super\-Button1
+Move focused window while dragging. Tiled windows will be toggled to the floating state.
+.TP
+.B Super\-Button2
+Toggles focused window between floating and tiled state.
+.TP
+.B Super\-Button3
+Resize focused window while dragging. Tiled windows will be toggled to the floating state.
+.SH CUSTOMIZATION
+dwm is customized by creating a custom config.h and (re)compiling the source
+code. This keeps it fast, secure and simple.
+.SH SIGNALS
+.TP
+.B SIGHUP - 1
+Restart the dwm process.
+.TP
+.B SIGTERM - 15
+Cleanly terminate the dwm process.
+.SH SEE ALSO
+.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].