JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
Redo man
[spectrwm.git] / scrotwm.1
index 72d86bc..ac2ba94 100644 (file)
--- a/scrotwm.1
+++ b/scrotwm.1
@@ -19,7 +19,7 @@
 .Os
 .Sh NAME
 .Nm scrotwm
-.Nd small dynamic tiling window manager for X11.
+.Nd window manager for X11
 .Sh SYNOPSIS
 .Nm scrotwm
 .Sh DESCRIPTION
@@ -29,18 +29,26 @@ valuable screen real estate can be used for much more important stuff.
 It has sane defaults and does not require one to learn a language to do any
 configuration.
 It was written by hackers for hackers and it strives to be small, compact and
-fast. 
+fast.
+.Pp
+When
+.Nm
+starts up, it reads settings from its configuration file,
+.Pa scrotwm.conf .
+See the
+.Sx CONFIGURATION FILES
+section below.
 .Pp
 The following notation is used throughout this page:
 .Pp
 .Bl -tag -width Ds -offset indent -compact
-.It Ic M
+.It Cm M
 Meta
-.It Ic S
+.It Cm S
 Shift
-.It Ic [Name]
+.It Aq Cm Name
 Named key
-.It Ic M1
+.It Cm M1
 Mouse button 1
 .El
 .Pp
@@ -49,116 +57,122 @@ is very simple in its use.
 Most of the actions are initiated via keybindings.
 The current keybindings are described below:
 .Pp
-.Bl -tag -width "C-M-EscapeXXX" -offset indent -compact
-.It Ic M-S-[Return]
-Spawn a new terminal.
-.It Ic M-p
-Menu.
-.It Ic M-S-q
-Quit.
-.It Ic M-q
+.Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
+.It Cm M-S- Ns Aq Cm Return
+Spawn a new terminal
+.It Cm M-p
+Menu
+.It Cm M-S-q
+Quit
+.It Cm M-q
 Restart
-.Nm .
-.It Ic M-[Space]
-Cycle layout.
-.It Ic M-S-[Space]
-Reset layout.
-.It Ic M-h
-Shrink master area.
-.It Ic M-l
-Grow master area.
-.It Ic M-,
-Add windows to master area.
-.It Ic M-.
-Remove windows from master area.
-.It Ic M-[Return]
-Move current window to master area.
-.It Ic M-j
-Focus next window in workspace.
-.It Ic M-[Tab]
-Focus next window in workspace.
-.It Ic M-k
-Focus previous window in workspace.
-.It Ic M-S-[Tab]
-Focus previous window in workspace.
-.It Ic M-m
-Focus on main window in workspace.
-.It Ic M-S-j
-Swap with next window in workspace.
-.It Ic M-S-k
-Swap with previous window in workspace.
-.It Ic M-b
-Toggle status bar in all workspaces.
-.It Ic M-S-x
-Destroy current window in workspace.
-.It Ic M-[Number]
-Switch to workspace [Number].
-.It Ic M-S-[Number]
-Move current window to workspace [Number].
-.It Ic M-[Right]
-Switch to next workspace with a window in it.
-.It Ic M-[Left]
-Switch to previous workspace with a window in it.
-.It Ic M-S-[Right]
-Move pointer to next region.
-.It Ic M-S-[Left]
-Move pointer to previous region.
-.It Ic M-s
-Take screenshot of entire screen (if enabled).
-.It Ic M-S-s
-Take screenshot of selected window (if enabled).
-.It Ic M1
-Focus window.
-.El
-.Pp
-.Pp
-.Sh FILES
-.Bl -tag -width Ds
-.It Pa ~/.scrotwm.conf
-This file contains user specific settings.
-.It Pa /etc/scrotwm.conf
-This file contains global settings.
+.Nm
+.It Cm M- Ns Aq Cm Space
+Cycle layout
+.It Cm M-S- Ns Aq Cm Space
+Reset layout
+.It Cm M-h
+Shrink master area
+.It Cm M-l
+Grow master area
+.It Cm M-,
+Add windows to master area
+.It Cm M-.
+Remove windows from master area
+.It Cm M- Ns Aq Cm Return
+Move current window to master area
+.It Xo
+.Cm M-j ,
+.Cm M- Ns Aq Cm TAB
+.Xc
+Focus next window in workspace
+.It Xo
+.Cm M-k ,
+.Cm M-S- Ns Aq Cm TAB
+.Xc
+Focus previous window in workspace
+.It Cm M-m
+Focus on main window in workspace
+.It Cm M-S-j
+Swap with next window in workspace
+.It Cm M-S-k
+Swap with previous window in workspace
+.It Cm M-b
+Toggle status bar in all workspaces
+.It Cm M-S-x
+Destroy current window in workspace
+.It Cm M- Ns Aq Ar n
+Switch to workspace
+.Ar n
+.It Cm M-S- Ns Aq Ar n
+Move current window to workspace
+.Ar n
+.It Cm M- Ns Aq Cm Right
+Switch to next workspace with a window in it
+.It Cm M- Ns Aq Cm Left
+Switch to previous workspace with a window in it
+.It Cm M-S- Ns Aq Cm Right
+Move pointer to next region
+.It Cm M-S- Ns Aq Cm Left
+Move pointer to previous region
+.It Cm M-s
+Take screenshot of entire screen (if enabled)
+.It Cm M-S-s
+Take screenshot of selected window (if enabled)
+.It Cm M1
+Focus window
 .El
-.Pp
+.Sh CONFIGURATION FILES
 .Nm
-first tries to open the user specific file.
-If that file is unavailable it tries to open the global file next.
+first tries to open the user specific file,
+.Pa ~/.scrotwm.conf .
+If that file is unavailable,
+it then tries to open the global configuration file
+.Pa /etc/scrotwm.conf .
 .Pp
-The format of the file is <keyword> = <setting>.
-E.g. color_focus = red.
+The format of the file is \*(Ltkeyword\*(Gt = \*(Ltsetting\*(Gt.
+For example:
+.Pp
+.Dl color_focus = red
 .Pp
 Enabling or disabling an option is done by using 1 or 0 respectively.
 .Pp
 The file supports the following keywords:
-.Bl -tag -width "C-M-EscapeXXX" -offset indent -compact
-.It Ic color_focus
+.Pp
+.Bl -tag -width "screenshot_enabledXXX" -offset indent -compact
+.It Cm color_focus
 Border color of the currently focussed window.
-.It Ic color_unfocus
+.It Cm color_unfocus
 Border color of unfocussed windows.
-.It Ic bar_enabled
+.It Cm bar_enabled
 Enable or disable status bar.
-.It Ic bar_border[x]
-Color of the status bar border in screen x.
-.It Ic bar_color[x]
-Color of the status bar window in screen x.
-.It Ic bar_font_color[x]
-Color of the font in status bar in screen x.
-.It Ic bar_font
+.It Cm bar_border Ns Bq Ar x
+Color of the status bar border in screen
+.Ar x .
+.It Cm bar_color Ns Bq Ar x
+Color of the status bar window in screen
+.Ar x .
+.It Cm bar_font_color Ns Bq Ar x
+Color of the font in status bar in screen
+.Ar x .
+.It Cm bar_font
 Status bar font.
-.It Ic bar_action
-External script that populates additional information in the status bar such as
-battery life etc.
-.It Ic bar_delay
+.It Cm bar_action
+External script that populates additional information in the status bar,
+such as battery life.
+.It Cm bar_delay
 Update frequency, in seconds, of external script that populates the status bar.
-.It Ic spawn_term
-External application that gets spawned when M-S-[Return] is used.
-.It Ic dialog_ratio
-Some applications have dialog windows that are too small to be useful.
-This ratio is the screen size as to what they will be resized.
-E.g 0.6 is 60% of the physical screen size.
-.It Ic screenshot_enabled
+.It Cm spawn_term
+External application that gets spawned when
+.Cm M-S- Ns Aq Cm Return
+is used.
+.It Cm dialog_ratio
+Some applications have dialogue windows that are too small to be useful.
+This ratio is the screen size to what they will be resized.
+For example, 0.6 is 60% of the physical screen size.
+.It Cm screenshot_enabled
 Enable or disable screenshot capability.
-.It Ic screenshot_app
+.It Cm screenshot_app
 Set to the script that will take screenshots.
 It will be called with "full" or "window" as parameter 1 to indicate what
 screenshot action is expected.
@@ -166,12 +180,22 @@ The script shall handle those cases accordingly.
 .El
 .Pp
 Colors need to be specified per the
-.Xr XQueryColor 4
+.Xr XQueryColor 3
 specification and fonts need to be specified per the
-.Xr XQueryFont 4
+.Xr XQueryFont 3
 specification.
-.Sh BUGS
-Currently the menu, invoked with M-p, depends on dmenu.
+.Sh FILES
+.Bl -tag -width "/etc/scrotwm.confXXX" -compact
+.It Pa ~/.scrotwm.conf
+.Nm
+user specific settings.
+.It Pa /etc/scrotwm.conf
+.Nm
+global settings.
+.El
+.Sh HISTORY
+.Nm
+was inspired by xmonad & dwm.
 .Sh AUTHORS
 .An -nosplit
 .Pp
@@ -180,6 +204,7 @@ was written by
 .An Marco Peereboom Aq marco@peereboom.us
 and
 .An Ryan Thomas McBride Aq mcbride@countersiege.com .
-.Sh HISTORY
-.Nm
-was inspired by xmonad & dwm.
+.Sh BUGS
+Currently the menu, invoked with
+.Cm M-p ,
+depends on dmenu.