Remove BUGS section, since our dependence on dmenu is no longer

[spectrwm.git] / scrotwm.1

diff --git a/scrotwm.1 b/scrotwm.1
index 10c0d23..617668c 100644 (file)
--- a/scrotwm.1
+++ b/scrotwm.1
@@ -1,5 +1,3 @@
-.\"    $scrotwm$
-.\"

 .\" Copyright (c) 2009 Marco Peereboom <marco@peereboom.us>
 .\" Copyright (c) 2009 Darrin Chandler <dwchandler@stilyagin.com>
 .\"
 .\" Copyright (c) 2009 Marco Peereboom <marco@peereboom.us>
 .\" Copyright (c) 2009 Darrin Chandler <dwchandler@stilyagin.com>
 .\"

@@ -15,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$
+.Dd $Mdocdate: December 6 2011 $

 .Dt SCROTWM 1
 .Os
 .Sh NAME
 .Dt SCROTWM 1
 .Os
 .Sh NAME

@@ -110,6 +108,12 @@ such as battery life.
 Update frequency, in seconds, of external script that populates the status bar.
 .It Cm bar_at_bottom
 Place the statusbar at the bottom of each region instead of the top.
 Update frequency, in seconds, of external script that populates the status bar.
 .It Cm bar_at_bottom
 Place the statusbar at the bottom of each region instead of the top.

+.It Cm bar_justify
+Justify the status bar text. Possible values are
+.Pa left ,
+.Pa center ,
+and
+.Pa right .

 .It Cm stack_enabled
 Enable or disable displaying the current stacking algorithm in the status bar.
 .It Cm clock_enabled
 .It Cm stack_enabled
 Enable or disable displaying the current stacking algorithm in the status bar.
 .It Cm clock_enabled

@@ -122,6 +126,13 @@ script.
 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.
 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 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.
+See the
+.Sx KEYBOARD MAPPING FILES
+section below for a list of keyboard mapping files that have been provided
+for several keyboard layouts.

 .It Cm layout
 Select layout to use at start-of-day.
 Defined in the format
 .It Cm layout
 Select layout to use at start-of-day.
 Defined in the format

@@ -141,7 +152,7 @@ See
 .Pa master_add ,
 .Pa master_del ,
 .Pa stack_inc ,
 .Pa master_add ,
 .Pa master_del ,
 .Pa stack_inc ,

-.Pa stack_del ,
+.Pa stack_dec ,

 and
 .Pa always_raise
 for more information.
 and
 .Pa always_raise
 for more information.

@@ -186,7 +197,8 @@ Enable by setting to 1.
 .It Cm urgent_enabled
 Enable or disable the urgency hint.
 Note that many terminal emulators require this to be enabled for it to
 .It Cm urgent_enabled
 Enable or disable the urgency hint.
 Note that many terminal emulators require this to be enabled for it to

-propagate.  In xterm, for example, one needs to add the following line
+propagate.
+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 .

@@ -243,7 +255,7 @@ To list the available fonts in your system see
 or
 .Xr xlsfonts 1
 manpages.
 or
 .Xr xlsfonts 1
 manpages.

-The 
+The

 .Xr xfontsel 1
 application can help you to show the X Logical Font Description ("XLFD") used
 as setting in the keyword
 .Xr xfontsel 1
 application can help you to show the X Logical Font Description ("XLFD") used
 as setting in the keyword

@@ -305,15 +317,14 @@ fields and will be substituted for values at the time the program is spawned:
 Example:
 .Bd -literal -offset indent
 program[ff] = /usr/local/bin/firefox http://scrotwm.org/
 Example:
 .Bd -literal -offset indent
 program[ff] = /usr/local/bin/firefox http://scrotwm.org/

-bind[ff] = Mod+f # Now Mod+F launched firefox
+bind[ff] = Mod+Shift+b # Now Mod+Shift+B launches firefox

 .Ed
 .Pp
 To undo the previous:
 .Bd -literal -offset indent
 .Ed
 .Pp
 To undo the previous:
 .Bd -literal -offset indent

-bind[] = Mod+f
+bind[] = Mod+Shift+b

 program[ff] =
 .Ed
 program[ff] =
 .Ed

-.Pp

 .Sh BINDINGS
 .Nm
 provides many functions (or actions) accessed via key or mouse bindings.
 .Sh BINDINGS
 .Nm
 provides many functions (or actions) accessed via key or mouse bindings.

@@ -345,7 +356,7 @@ restart
 .It Cm M- Ns Aq Cm Space
 cycle_layout
 .It Cm M-S- Ns Aq Cm Space
 .It Cm M- Ns Aq Cm Space
 cycle_layout
 .It Cm M-S- Ns Aq Cm Space

-reset_layout
+stack_reset

 .It Cm M-h
 master_shrink
 .It Cm M-l
 .It Cm M-h
 master_shrink
 .It Cm M-l

@@ -357,7 +368,7 @@ master_del
 .It Cm M-S-,
 stack_inc
 .It Cm M-S-.
 .It Cm M-S-,
 stack_inc
 .It Cm M-S-.

-stack_del
+stack_dec

 .It Cm M- Ns Aq Cm Return
 swap_main
 .It Xo
 .It Cm M- Ns Aq Cm Return
 swap_main
 .It Xo

@@ -383,13 +394,17 @@ wind_del
 .It Cm M-S-x
 wind_kill
 .It Cm M- Ns Aq Ar n
 .It Cm M-S-x
 wind_kill
 .It Cm M- Ns Aq Ar n

-.Ns ws_ Ns Ar n
+.Pf ws_ Ar n

 .It Cm M-S- Ns Aq Ar n
 .It Cm M-S- Ns Aq Ar n

-.Ns mvws_ Ns Ar n
+.Pf mvws_ Ar n

 .It Cm M- Ns Aq Cm Right
 ws_next
 .It Cm M- Ns Aq Cm Left
 ws_prev
 .It Cm M- Ns Aq Cm Right
 ws_next
 .It Cm M- Ns Aq Cm Left
 ws_prev

+.It Cm M- Ns Aq Cm Up
+ws_next_all
+.It Cm M- Ns Aq Cm Down
+ws_prev_all

 .It Cm M-a
 ws_prior
 .It Cm M-S- Ns Aq Cm Right
 .It Cm M-a
 ws_prior
 .It Cm M-S- Ns Aq Cm Right

@@ -432,11 +447,17 @@ move_right
 move_up
 .It Cm M-S-]
 move_down
 move_up
 .It Cm M-S-]
 move_down

+.It Cm M-S-/
+name_workspace
+.It Cm M-/
+search_workspace
+.It Cm M-s
+search_win

 .El
 .Pp
 The action names and descriptions are listed below:
 .Pp
 .El
 .Pp
 The action names and descriptions are listed below:
 .Pp

-.Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
+.Bl -tag -width "M-j, M-<TAB>XXXX" -offset indent -compact

 .It Cm term
 Spawn a new terminal
 (see
 .It Cm term
 Spawn a new terminal
 (see

@@ -455,7 +476,7 @@ Restart
 .Nm .
 .It Cm cycle_layout
 Cycle layout.
 .Nm .
 .It Cm cycle_layout
 Cycle layout.

-.It Cm reset_layout
+.It Cm stack_reset

 Reset layout.
 .It Cm master_shrink
 Shrink master area.
 Reset layout.
 .It Cm master_shrink
 Shrink master area.

@@ -467,7 +488,7 @@ Add windows to master area.
 Remove windows from master area.
 .It Cm stack_inc
 Add columns/rows to stacking area.
 Remove windows from master area.
 .It Cm stack_inc
 Add columns/rows to stacking area.

-.It Cm stack_del
+.It Cm stack_dec

 Remove columns/rows from stacking area.
 .It Cm swap_main
 Move current window to master area.
 Remove columns/rows from stacking area.
 .It Cm swap_main
 Move current window to master area.

@@ -503,6 +524,10 @@ is 1 through 10.
 Switch to next workspace with a window in it.
 .It Cm ws_prev
 Switch to previous workspace with a window in it.
 Switch to next workspace with a window in it.
 .It Cm ws_prev
 Switch to previous workspace with a window in it.

+.It Cm ws_next_all
+Switch to next workspace.
+.It Cm ws_prev_all
+Switch to previous workspace.

 .It Cm ws_prior
 Switch to last visited workspace.
 .It Cm screen_next
 .It Cm ws_prior
 Switch to last visited workspace.
 .It Cm screen_next

@@ -557,6 +582,12 @@ Move a floating window a step to the right.
 Move a floating window a step upwards.
 .It Cm move_down
 Move a floating window a step downwards.
 Move a floating window a step upwards.
 .It Cm move_down
 Move a floating window a step downwards.

+.It Cm name_workspace
+Name the current workspace.
+.It Cm search_workspace
+Search for a workspace.
+.It Cm search_win
+Search the windows in the current workspace.

 .El
 .Pp
 Custom bindings in the configuration file are specified as follows:
 .El
 .Pp
 Custom bindings in the configuration file are specified as follows:

@@ -576,6 +607,28 @@ bind[] = Mod1+q # unbind Alt + q
 .Ed
 .Pp
 Multiple key combinations may be bound to the same action.
 .Ed
 .Pp
 Multiple key combinations may be bound to the same action.

+.Sh KEYBOARD MAPPING FILES
+Keyboard mapping files for several keyboard layouts are listed
+below.
+These files can be used with the
+.Pa keyboard_mapping
+setting to load pre-defined key bindings for the specified
+keyboard layout.
+.Pp
+.Bl -tag -width "scrotwm_XX.confXXX" -offset indent -compact
+.It Cm scrotwm_cz.conf
+Czech Republic keyboard layout
+.It Cm scrotwm_es.conf
+Spanish keyboard layout
+.It Cm scrotwm_fr.conf
+French keyboard layout
+.It Cm scrotwm_fr_ch.conf
+Swiss French keyboard layout
+.It Cm scrotwm_se.conf
+Swedish keyboard layout
+.It Cm scrotwm_us.conf
+United States keyboard layout
+.El

 .Sh QUIRKS
 .Nm
 provides "quirks" which handle windows that must be treated specially
 .Sh QUIRKS
 .Nm
 provides "quirks" which handle windows that must be treated specially

@@ -666,7 +719,7 @@ quirk[Firefox:Navigator] = FLOAT
 .Ed
 .Pp
 .Nm
 .Ed
 .Pp
 .Nm

-also automatically assigns quirks to windows based on the value 
+also automatically assigns quirks to windows based on the value

 of the window's _NET_WM_WINDOW_TYPE property as follows:
 .Pp
 .Bl -tag -width "_NET_WM_WINDOW_TYPE_TOOLBAR<TAB>XXX" -offset indent -compact
 of the window's _NET_WM_WINDOW_TYPE property as follows:
 .Pp
 .Bl -tag -width "_NET_WM_WINDOW_TYPE_TOOLBAR<TAB>XXX" -offset indent -compact

@@ -682,16 +735,18 @@ FLOAT
 FLOAT
 .El
 .Pp
 FLOAT
 .El
 .Pp

-In all other cases, no automatic quirks are assigned to the window. 
+In all other cases, no automatic quirks are assigned to the window.

 Quirks specified in the configuration file override the automatic quirks.
 .Sh EWMH
 .Nm
 Quirks specified in the configuration file override the automatic quirks.
 .Sh EWMH
 .Nm

-partially implements the Extended Window Manager Hints (EWMH) specification. 
+partially implements the Extended Window Manager Hints (EWMH) specification.

 This enables controlling windows as well as
 .Nm
 This enables controlling windows as well as
 .Nm

-itself from external scripts and programs. This is achieved by 
+itself from external scripts and programs.
+This is achieved by

 .Nm
 .Nm

-responding to certain ClientMessage events. From the terminal these events 
+responding to certain ClientMessage events.
+From the terminal these events

 can be conveniently sent using tools such as
 .Xr wmctrl 1
 and
 can be conveniently sent using tools such as
 .Xr wmctrl 1
 and

@@ -699,8 +754,9 @@ and
 For the
 actual format of these ClientMessage events, see the EWMH specification.
 .Pp
 For the
 actual format of these ClientMessage events, see the EWMH specification.
 .Pp

-The id of the currently focused window is stored in the _NET_ACTIVE_WINDOW 
-property of the root window. This can be used for example to retrieve the 
+The id of the currently focused window is stored in the _NET_ACTIVE_WINDOW
+property of the root window.
+This can be used for example to retrieve the

 title of the currently active window with
 .Xr xprop 1
 and
 title of the currently active window with
 .Xr xprop 1
 and

@@ -710,8 +766,9 @@ $ WINDOWID=`xprop \-root _NET_ACTIVE_WINDOW | grep \-o "0x.*"`
 $ xprop \-id $WINDOWID WM_NAME | grep \-o "\\".*\\""
 .Ed
 .Pp
 $ xprop \-id $WINDOWID WM_NAME | grep \-o "\\".*\\""
 .Ed
 .Pp

-A window can be focused by sending a _NET_ACTIVE_WINDOW client message 
-to the root window. For example, using
+A window can be focused by sending a _NET_ACTIVE_WINDOW client message
+to the root window.
+For example, using

 .Xr wmctrl 1
 to send the message
 (assuming 0x4a0000b is the id of the window to be focused):
 .Xr wmctrl 1
 to send the message
 (assuming 0x4a0000b is the id of the window to be focused):

@@ -719,8 +776,9 @@ to send the message
 $ wmctrl \-i \-a 0x4a0000b
 .Ed
 .Pp
 $ wmctrl \-i \-a 0x4a0000b
 .Ed
 .Pp

-Windows can be closed by sending a _NET_CLOSE_WINDOW client message 
-to the root window. For example, using
+Windows can be closed by sending a _NET_CLOSE_WINDOW client message
+to the root window.
+For example, using

 .Xr wmctrl 1
 to send the message
 (assuming 0x4a0000b is the id of the window to be closed):
 .Xr wmctrl 1
 to send the message
 (assuming 0x4a0000b is the id of the window to be closed):

@@ -728,10 +786,11 @@ to send the message
 $ wmctrl \-i \-c 0x4a0000b
 .Ed
 .Pp
 $ wmctrl \-i \-c 0x4a0000b
 .Ed
 .Pp

-Windows can be floated and un-floated by adding or removing the 
-_NET_WM_STATE_ABOVE atom from the _NET_WM_STATE property of the window. 
-This can be achieved by sending a _NET_WM_STATE client message to the 
-root window. For example, the following toggles the floating state of 
+Windows can be floated and un-floated by adding or removing the
+_NET_WM_STATE_ABOVE atom from the _NET_WM_STATE property of the window.
+This can be achieved by sending a _NET_WM_STATE client message to the
+root window.
+For example, the following toggles the floating state of

 a window using
 .Xr wmctrl 1
 to send the message (assuming 0x4a0000b is the  id of the window floated
 a window using
 .Xr wmctrl 1
 to send the message (assuming 0x4a0000b is the  id of the window floated

@@ -740,8 +799,9 @@ or un-floated):
 $ wmctrl \-i \-r 0x4a0000b \-b toggle,_NET_WM_STATE_ABOVE
 .Ed
 .Pp
 $ wmctrl \-i \-r 0x4a0000b \-b toggle,_NET_WM_STATE_ABOVE
 .Ed
 .Pp

-Floating windows can also be resized and moved by sending a 
-_NET_MOVERESIZE_WINDOW client message to the root window. For example, 
+Floating windows can also be resized and moved by sending a
+_NET_MOVERESIZE_WINDOW client message to the root window.
+For example,

 using
 .Xr wmctrl 1
 to send the message (assuming 0x4a0000b is the id of
 using
 .Xr wmctrl 1
 to send the message (assuming 0x4a0000b is the id of

@@ -753,7 +813,6 @@ $ wmctrl \-i \-r 0x4a0000b \-e 0,100,50,640,480
 This moves the window to (100,50) and resizes it to 640x480.
 .Pp
 Any _NET_MOVERESIZE_WINDOW events received for stacked windows are ignored.
 This moves the window to (100,50) and resizes it to 640x480.
 .Pp
 Any _NET_MOVERESIZE_WINDOW events received for stacked windows are ignored.

-.Pp

 .Sh SIGNALS
 Sending
 .Nm
 .Sh SIGNALS
 Sending
 .Nm

@@ -783,7 +842,3 @@ was written by:
 .It Cm Tuukka Kataja Aq stuge@xor.fi
 .It Cm Jason L. Wright Aq jason@thought.net
 .El
 .It Cm Tuukka Kataja Aq stuge@xor.fi
 .It Cm Jason L. Wright Aq jason@thought.net
 .El

-.Sh BUGS
-Currently the menu, invoked with
-.Cm M-p ,
-depends on dmenu.