JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
add lteo and tcunha to copyright
[spectrwm.git] / scrotwm.1
index 5b3bbbc..21bc043 100644 (file)
--- a/scrotwm.1
+++ b/scrotwm.1
@@ -13,7 +13,7 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
-.Dd $Mdocdate: January 12 2011 $
+.Dd $Mdocdate: February 8 2012 $
 .Dt SCROTWM 1
 .Os
 .Sh NAME
 .Dt SCROTWM 1
 .Os
 .Sh NAME
@@ -80,12 +80,11 @@ The file supports the following keywords:
 Launch an application in a specified workspace at start-of-day.
 Defined in the format ws[<idx>]:application, e.g. ws[2]:xterm launches an
 xterm in workspace 2.
 Launch an application in a specified workspace at start-of-day.
 Defined in the format ws[<idx>]:application, e.g. ws[2]:xterm launches an
 xterm in workspace 2.
-.It Ic color_focus
-Border color of the currently focussed window.
-.It Ic color_unfocus
-Border color of unfocussed windows.
-.It Ic bar_enabled
-Enable or disable status bar.
+.It Ic bar_action
+External script that populates additional information in the status bar,
+such as battery life.
+.It Ic bar_at_bottom
+Place the statusbar at the bottom of each region instead of the top.
 .It Ic bar_border Ns Bq Ar x
 Color of the status bar border in screen
 .Ar x .
 .It Ic bar_border Ns Bq Ar x
 Color of the status bar border in screen
 .Ar x .
@@ -95,36 +94,51 @@ Disable border by setting to 0.
 .It Ic bar_color Ns Bq Ar x
 Color of the status bar window in screen
 .Ar x .
 .It Ic bar_color Ns Bq Ar x
 Color of the status bar window in screen
 .Ar x .
+.It Ic bar_delay
+Update frequency, in seconds, of external script that populates the status bar.
+.It Ic bar_enabled
+Enable or disable status bar.
+.It Ic bar_font
+Status bar font.
 .It Ic bar_font_color Ns Bq Ar x
 Color of the font in status bar in screen
 .Ar x .
 .It Ic bar_font_color Ns Bq Ar x
 Color of the font in status bar in screen
 .Ar x .
-.It Ic bar_font
-Status bar font.
-.It Ic bar_action
-External script that populates additional information in the status bar,
-such as battery life.
-.It Ic bar_delay
-Update frequency, in seconds, of external script that populates the status bar.
-.It Ic bar_at_bottom
-Place the statusbar at the bottom of each region instead of the top.
 .It Ic bar_justify
 Justify the status bar text. Possible values are
 .Pa left ,
 .Pa center ,
 and
 .Pa right .
 .It Ic bar_justify
 Justify the status bar text. Possible values are
 .Pa left ,
 .Pa center ,
 and
 .Pa right .
-.It Ic stack_enabled
-Enable or disable displaying the current stacking algorithm in the status bar.
+.It Ic bind Ns Bq Ar x
+Bind key combo to action
+.Ar x .
+See the
+.Sx BINDINGS
+section below.
+.It Ic border_width
+Set window border thickness in pixels.
+Disable all borders by setting to 0.
 .It Ic clock_enabled
 Enable or disable displaying the clock in the status bar.
 Disable by setting to 0
 so a custom clock could be used in the
 .Pa bar_action
 script.
 .It Ic clock_enabled
 Enable or disable displaying the clock in the status bar.
 Disable by setting to 0
 so a custom clock could be used in the
 .Pa bar_action
 script.
+.It Ic color_focus
+Border color of the currently focussed window.
+.It Ic color_unfocus
+Border color of unfocussed windows.
 .It Ic 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 Ic 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 Ic disable_border
+Remove border when bar is disabled and there is only one window on the screen.
+.It Ic focus_mode
+Using a value of
+.Pa follow_cursor
+will make the window manager focus the window
+under the mouse when switching workspaces and creating windows.
 .It Ic keyboard_mapping
 Clear all key bindings and load new key bindings from the specified file.
 This allows you to load pre-defined key bindings for your keyboard layout.
 .It Ic keyboard_mapping
 Clear all key bindings and load new key bindings from the specified file.
 This allows you to load pre-defined key bindings for your keyboard layout.
@@ -161,6 +175,23 @@ One should familiarize oneself with these commands before experimenting with the
 option.
 .Pp
 This setting is not retained at restart.
 option.
 .Pp
 This setting is not retained at restart.
+.It Ic modkey
+Change mod key.
+Mod1 is generally the ALT key and Mod4 is the windows key on a PC.
+.It Ic program Ns Bq Ar p
+Define new action to spawn a program
+.Ar p .
+See the
+.Sx PROGRAMS
+section below.
+.It Ic quirk Ns Bq Ar c:n
+Add "quirk" for windows with class
+.Ar c
+and name
+.Ar n .
+See the
+.Sx QUIRKS
+section below.
 .It Ic region
 Allocates a custom region, removing any autodetected regions which occupy the same
 space on the screen.
 .It Ic region
 Allocates a custom region, removing any autodetected regions which occupy the same
 space on the screen.
@@ -170,6 +201,8 @@ e.g.\& screen[1]:800x1200+0+0.
 To make a screen span multiple monitors, create a region big enough to cover
 them all, e.g. screen[1]:2048x768+0+0 makes the screen span two monitors with
 1024x768 resolution sitting one next to the other.
 To make a screen span multiple monitors, create a region big enough to cover
 them all, e.g. screen[1]:2048x768+0+0 makes the screen span two monitors with
 1024x768 resolution sitting one next to the other.
+.It Ic stack_enabled
+Enable or disable displaying the current stacking algorithm in the status bar.
 .It Ic term_width
 Set a preferred minimum width for the terminal.
 If this value is greater than 0,
 .It Ic term_width
 Set a preferred minimum width for the terminal.
 If this value is greater than 0,
@@ -201,46 +234,13 @@ In xterm, for example, one needs to add the following line
 .Pa xterm.urgentOnBell: true
 to
 .Pa .Xdefaults .
 .Pa xterm.urgentOnBell: true
 to
 .Pa .Xdefaults .
-.It Ic window_name_enabled
-Enable or disable displaying the window name in the status bar.
-Enable by setting to 1.
 .It Ic verbose_layout
 Enable or disable displaying the current master and stack values in the status
 bar.
 Enable by setting to 1.
 .It Ic verbose_layout
 Enable or disable displaying the current master and stack values in the status
 bar.
 Enable by setting to 1.
-.It Ic modkey
-Change mod key.
-Mod1 is generally the ALT key and Mod4 is the windows key on a PC.
-.It Ic focus_mode
-Using a value of
-.Pa follow_cursor
-will make the window manager focus the window
-under the mouse when switching workspaces and creating windows.
-.It Ic disable_border
-Remove border when bar is disabled and there is only one window on the screen.
-.It Ic border_width
-Set window border thickness in pixels.
-Disable all borders by setting to 0.
-.It Ic program Ns Bq Ar p
-Define new action to spawn a program
-.Ar p .
-See the
-.Sx PROGRAMS
-section below.
-.It Ic bind Ns Bq Ar x
-Bind key combo to action
-.Ar x .
-See the
-.Sx BINDINGS
-section below.
-.It Ic quirk Ns Bq Ar c:n
-Add "quirk" for windows with class
-.Ar c
-and name
-.Ar n .
-See the
-.Sx QUIRKS
-section below.
+.It Ic window_name_enabled
+Enable or disable displaying the window name in the status bar.
+Enable by setting to 1.
 .El
 .Pp
 Colors need to be specified per the
 .El
 .Pp
 Colors need to be specified per the
@@ -354,6 +354,8 @@ quit
 restart
 .It Cm M- Ns Aq Cm Space
 cycle_layout
 restart
 .It Cm M- Ns Aq Cm Space
 cycle_layout
+.It Cm M-S- Ns Aq Cm \e
+flip_layout
 .It Cm M-S- Ns Aq Cm Space
 stack_reset
 .It Cm M-h
 .It Cm M-S- Ns Aq Cm Space
 stack_reset
 .It Cm M-h
@@ -434,7 +436,7 @@ button2
 width_shrink
 .It Cm M-=
 width_grow
 width_shrink
 .It Cm M-=
 width_grow
-.It Cm M-S-
+.It Cm M-S--
 height_shrink
 .It Cm M-S-=
 height_grow
 height_shrink
 .It Cm M-S-=
 height_grow
@@ -475,6 +477,8 @@ Restart
 .Nm .
 .It Cm cycle_layout
 Cycle layout.
 .Nm .
 .It Cm cycle_layout
 Cycle layout.
+.It Cm flip_layout
+Swap the master and stacking areas.
 .It Cm stack_reset
 Reset layout.
 .It Cm master_shrink
 .It Cm stack_reset
 Reset layout.
 .It Cm master_shrink
@@ -605,6 +609,10 @@ bind[reset] = Mod4+q # bind Windows-key + q to reset
 bind[] = Mod1+q # unbind Alt + q
 .Ed
 .Pp
 bind[] = Mod1+q # unbind Alt + q
 .Ed
 .Pp
+To use the currently defined
+.Ic modkey ,
+specify MOD as the modifier key.
+.Pp
 Multiple key combinations may be bound to the same action.
 .Sh KEYBOARD MAPPING FILES
 Keyboard mapping files for several keyboard layouts are listed
 Multiple key combinations may be bound to the same action.
 .Sh KEYBOARD MAPPING FILES
 Keyboard mapping files for several keyboard layouts are listed
@@ -704,7 +712,9 @@ You can obtain
 .Aq class
 and
 .Aq name
 .Aq class
 and
 .Aq name
-by running xprop(1) and then clicking on the desired window.
+by running
+.Xr xprop 1
+and then clicking on the desired window.
 In the following example the main window of Firefox was clicked:
 .Bd -literal -offset indent
 $ xprop | grep WM_CLASS
 In the following example the main window of Firefox was clicked:
 .Bd -literal -offset indent
 $ xprop | grep WM_CLASS
@@ -840,4 +850,5 @@ was written by:
 .It Cm Pierre-Yves Ritschard Aq pyr@spootnik.org
 .It Cm Tuukka Kataja Aq stuge@xor.fi
 .It Cm Jason L. Wright Aq jason@thought.net
 .It Cm Pierre-Yves Ritschard Aq pyr@spootnik.org
 .It Cm Tuukka Kataja Aq stuge@xor.fi
 .It Cm Jason L. Wright Aq jason@thought.net
+.It Cm Reginald Kennedy Aq rk@rejii.com
 .El
 .El