JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
Make time localized too.
[spectrwm.git] / scrotwm.1
index cb691c5..fe77be1 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.
 .\"
-.Dd $Mdocdate$
+.Dd $Mdocdate: November 11 2011 $
 .Dt SCROTWM 1
 .Os
 .Sh NAME
@@ -120,6 +120,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.
+.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
@@ -139,7 +146,7 @@ See
 .Pa master_add ,
 .Pa master_del ,
 .Pa stack_inc ,
-.Pa stack_del ,
+.Pa stack_dec ,
 and
 .Pa always_raise
 for more information.
@@ -184,7 +191,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
-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 .
@@ -241,7 +249,7 @@ To list the available fonts in your system see
 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
@@ -311,7 +319,6 @@ To undo the previous:
 bind[] = Mod+f
 program[ff] =
 .Ed
-.Pp
 .Sh BINDINGS
 .Nm
 provides many functions (or actions) accessed via key or mouse bindings.
@@ -355,7 +362,7 @@ master_del
 .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
@@ -381,9 +388,9 @@ wind_del
 .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
-.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
@@ -465,7 +472,7 @@ Add windows to master 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.
@@ -574,6 +581,24 @@ bind[] = Mod1+q # unbind Alt + q
 .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_us.conf
+United States keyboard layout
+.El
 .Sh QUIRKS
 .Nm
 provides "quirks" which handle windows that must be treated specially
@@ -664,7 +689,7 @@ quirk[Firefox:Navigator] = FLOAT
 .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
@@ -680,16 +705,18 @@ FLOAT
 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
-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
-itself from external scripts and programs. This is achieved by 
+itself from external scripts and programs.
+This is achieved by
 .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
@@ -697,8 +724,9 @@ and
 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
@@ -708,8 +736,9 @@ $ WINDOWID=`xprop \-root _NET_ACTIVE_WINDOW | grep \-o "0x.*"`
 $ 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):
@@ -717,8 +746,9 @@ to send the message
 $ 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):
@@ -726,10 +756,11 @@ to send the message
 $ 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
@@ -738,8 +769,9 @@ or un-floated):
 $ 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
@@ -751,7 +783,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.
-.Pp
 .Sh SIGNALS
 Sending
 .Nm