Plug memory and file descriptor leak.

[spectrwm.git] / scrotwm.1

diff --git a/scrotwm.1 b/scrotwm.1
index 0cccc44..a0d249b 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: November 11 2011 $
+.Dd $Mdocdate: January 12 2011 $

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

@@ -75,59 +75,64 @@ For example:
 Enabling or disabling an option is done by using 1 or 0 respectively.
 .Pp
 The file supports the following keywords:
 Enabling or disabling an option is done by using 1 or 0 respectively.
 .Pp
 The file supports the following keywords:

-.Pp
-.Bl -tag -width "title_class_enabledXXX" -offset indent -compact
-.It Cm autorun
+.Bl -tag -width 2m
+.It Ic autorun

 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 Cm color_focus
+.It Ic color_focus

 Border color of the currently focussed window.
 Border color of the currently focussed window.

-.It Cm color_unfocus
+.It Ic color_unfocus

 Border color of unfocussed windows.
 Border color of unfocussed windows.

-.It Cm bar_enabled
+.It Ic bar_enabled

 Enable or disable status bar.
 Enable or disable status bar.

-.It Cm bar_border Ns Bq Ar x
+.It Ic bar_border Ns Bq Ar x

 Color of the status bar border in screen
 .Ar x .
 Color of the status bar border in screen
 .Ar x .

-.It Cm bar_border_width
+.It Ic bar_border_width

 Set status bar border thickness in pixels.
 Disable border by setting to 0.
 Set status bar border thickness in pixels.
 Disable border by setting to 0.

-.It Cm bar_color Ns Bq Ar x
+.It Ic bar_color Ns Bq Ar x

 Color of the status bar window in screen
 .Ar x .
 Color of the status bar window in screen
 .Ar x .

-.It Cm bar_font_color Ns Bq Ar x
+.It Ic bar_font_color Ns Bq Ar x

 Color of the font in status bar in screen
 .Ar x .
 Color of the font in status bar in screen
 .Ar x .

-.It Cm bar_font
+.It Ic bar_font

 Status bar font.
 Status bar font.

-.It Cm bar_action
+.It Ic bar_action

 External script that populates additional information in the status bar,
 such as battery life.
 External script that populates additional information in the status bar,
 such as battery life.

-.It Cm bar_delay
+.It Ic bar_delay

 Update frequency, in seconds, of external script that populates the status bar.
 Update frequency, in seconds, of external script that populates the status bar.

-.It Cm bar_at_bottom
+.It Ic bar_at_bottom

 Place the statusbar at the bottom of each region instead of the top.
 Place the statusbar at the bottom of each region instead of the top.

-.It Cm stack_enabled
+.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.
 Enable or disable displaying the current stacking algorithm in the status bar.

-.It Cm clock_enabled
+.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.
 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 Cm dialog_ratio
+.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.
 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
+.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.
 See the
 .Sx KEYBOARD MAPPING FILES
 section below for a list of keyboard mapping files that have been provided
 for several keyboard layouts.
 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
+.It Ic layout

 Select layout to use at start-of-day.
 Defined in the format
 ws[idx]:master_grow:master_add:stack_inc:layout:always_raise:stack_mode, e.g.
 Select layout to use at start-of-day.
 Defined in the format
 ws[idx]:master_grow:master_add:stack_inc:layout:always_raise:stack_mode, e.g.

@@ -156,7 +161,7 @@ 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 Cm region
+.It Ic region

 Allocates a custom region, removing any autodetected regions which occupy the same
 space on the screen.
 Defined in the format screen[<idx>]:WIDTHxHEIGHT+X+Y,
 Allocates a custom region, removing any autodetected regions which occupy the same
 space on the screen.
 Defined in the format screen[<idx>]:WIDTHxHEIGHT+X+Y,

@@ -165,7 +170,7 @@ 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 Cm term_width
+.It Ic term_width

 Set a preferred minimum width for the terminal.
 If this value is greater than 0,
 .Nm
 Set a preferred minimum width for the terminal.
 If this value is greater than 0,
 .Nm

@@ -182,52 +187,53 @@ Users may need to set program[term] (see the
 section) to use an alternate copy of the
 .Xr xterm 1
 binary without the setgid bit set.
 section) to use an alternate copy of the
 .Xr xterm 1
 binary without the setgid bit set.

-.It Cm title_class_enabled
+.It Ic title_class_enabled

 Enable or disable displaying the window class in the status bar.
 Enable by setting to 1.
 Enable or disable displaying the window class in the status bar.
 Enable by setting to 1.

-.It Cm title_name_enabled
+.It Ic title_name_enabled

 Enable or disable displaying the window title in the status bar.
 Enable by setting to 1.
 Enable or disable displaying the window title in the status bar.
 Enable by setting to 1.

-.It Cm urgent_enabled
+.It Ic urgent_enabled

 Enable or disable the urgency hint.
 Note that many terminal emulators require this to be enabled for it to
 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 .

-.It Cm window_name_enabled
+.It Ic window_name_enabled

 Enable or disable displaying the window name in the status bar.
 Enable by setting to 1.
 Enable or disable displaying the window name in the status bar.
 Enable by setting to 1.

-.It Cm verbose_layout
+.It Ic verbose_layout

 Enable or disable displaying the current master and stack values in the status
 bar.
 Enable by setting to 1.
 Enable or disable displaying the current master and stack values in the status
 bar.
 Enable by setting to 1.

-.It Cm modkey
+.It Ic modkey

 Change mod key.
 Mod1 is generally the ALT key and Mod4 is the windows key on a PC.
 Change mod key.
 Mod1 is generally the ALT key and Mod4 is the windows key on a PC.

-.It Cm focus_mode
+.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.
 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 Cm disable_border
+.It Ic disable_border

 Remove border when bar is disabled and there is only one window on the screen.
 Remove border when bar is disabled and there is only one window on the screen.

-.It Cm border_width
+.It Ic border_width

 Set window border thickness in pixels.
 Disable all borders by setting to 0.
 Set window border thickness in pixels.
 Disable all borders by setting to 0.

-.It Cm program Ns Bq Ar p
+.It Ic program Ns Bq Ar p

 Define new action to spawn a program
 .Ar p .
 See the
 .Sx PROGRAMS
 section below.
 Define new action to spawn a program
 .Ar p .
 See the
 .Sx PROGRAMS
 section below.

-.It Cm bind Ns Bq Ar x
+.It Ic bind Ns Bq Ar x

 Bind key combo to action
 .Ar x .
 See the
 .Sx BINDINGS
 section below.
 Bind key combo to action
 .Ar x .
 See the
 .Sx BINDINGS
 section below.

-.It Cm quirk Ns Bq Ar c:n
+.It Ic quirk Ns Bq Ar c:n

 Add "quirk" for windows with class
 .Ar c
 and name
 Add "quirk" for windows with class
 .Ar c
 and name

@@ -310,12 +316,12 @@ 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
 .Sh BINDINGS
 program[ff] =
 .Ed
 .Sh BINDINGS

@@ -349,7 +355,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

@@ -394,6 +400,10 @@ wind_kill
 ws_next
 .It Cm M- Ns Aq Cm Left
 ws_prev
 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

@@ -436,11 +446,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-f
+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

@@ -459,7 +475,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.

@@ -507,6 +523,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

@@ -561,6 +581,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:

@@ -582,7 +608,8 @@ bind[] = Mod1+q # unbind Alt + q
 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

-below. These files can be used with the
+below.
+These files can be used with the

 .Pa keyboard_mapping
 setting to load pre-defined key bindings for the specified
 keyboard layout.
 .Pa keyboard_mapping
 setting to load pre-defined key bindings for the specified
 keyboard layout.

@@ -594,6 +621,10 @@ Czech Republic keyboard layout
 Spanish keyboard layout
 .It Cm scrotwm_fr.conf
 French keyboard layout
 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
 .It Cm scrotwm_us.conf
 United States keyboard layout
 .El

@@ -710,9 +741,11 @@ Quirks specified in the configuration file override the automatic quirks.
 partially implements the Extended Window Manager Hints (EWMH) specification.
 This enables controlling windows as well as
 .Nm
 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
 .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

@@ -721,7 +754,8 @@ 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
 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
+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

@@ -732,7 +766,8 @@ $ xprop \-id $WINDOWID WM_NAME | grep \-o "\\".*\\""
 .Ed
 .Pp
 A window can be focused by sending a _NET_ACTIVE_WINDOW client message
 .Ed
 .Pp
 A window can be focused by sending a _NET_ACTIVE_WINDOW client message

-to the root window. For example, using
+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):

@@ -741,7 +776,8 @@ $ wmctrl \-i \-a 0x4a0000b
 .Ed
 .Pp
 Windows can be closed by sending a _NET_CLOSE_WINDOW client message
 .Ed
 .Pp
 Windows can be closed by sending a _NET_CLOSE_WINDOW client message

-to the root window. For example, using
+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):

@@ -752,7 +788,8 @@ $ wmctrl \-i \-c 0x4a0000b
 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
 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
+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

@@ -762,7 +799,8 @@ $ wmctrl \-i \-r 0x4a0000b \-b toggle,_NET_WM_STATE_ABOVE
 .Ed
 .Pp
 Floating windows can also be resized and moved by sending a
 .Ed
 .Pp
 Floating windows can also be resized and moved by sending a

-_NET_MOVERESIZE_WINDOW client message to the root window. For example,
+_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

@@ -802,8 +840,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

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