X-Git-Url: https://jasonwoof.com/gitweb/?a=blobdiff_plain;f=html%2Fman.html;h=ea5c6c48991b49f2737a0fb672404936722ea0c3;hb=5cd855abc35e620a2bfaa4a6dac9787bcaa411aa;hp=50600f048ccb70cb8ed3c0bfc3cf11983f796b24;hpb=667eb8f7002deec7814f5b36b8d5663d4a01f898;p=spectrwm.git diff --git a/html/man.html b/html/man.html index 50600f0..ea5c6c4 100644 --- a/html/man.html +++ b/html/man.html @@ -1,7 +1,7 @@ -~/scrotwm.~.html +scrotwm.1.html @@ -49,60 +49,110 @@
     The file supports the following keywords:

-           color_focus            Border color of the currently focussed win-
-                                  dow.
-           color_unfocus          Border color of unfocussed windows.
-           bar_enabled            Enable or disable status bar.
-           bar_border[x]          Color of the status bar border in screen x.
-           bar_color[x]           Color of the status bar window in screen x.
-           bar_font_color[x]      Color of the font in status bar in screen x.
-           bar_font               Status bar font.
-           bar_action             External script that populates additional
-                                  information in the status bar, such as bat-
-                                  tery life.
-           bar_delay              Update frequency, in seconds, of external
-                                  script that populates the status bar.
-           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 bar_ac-
-                                  tion script.
-           spawn_term             External application that gets spawned when
-                                  M-S-<Return> is used.
-           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 re-
-                                  sized.  For example, 0.6 is 60% of the phys-
-                                  ical screen size.
-           region                 Allocates a custom region, removing any au-
-                                  todetected regions which occupy the same
-                                  space on the screen.  Defined in the format
-                                  screen[<idx>]:WIDTHxHEIGHT+X+Y, e.g.
-                                  screen[1]:800x1200+0+0.
-           screenshot_enabled     Enable or disable screenshot capability.
-           screenshot_app         Set to the script that will take screen-
-                                  shots.  It will be called with "full" or
-                                  "window" as parameter 1 to indicate what
-                                  screenshot action is expected.  The script
-                                  shall handle those cases accordingly.
-           term_width             Set a preferred minimum width for the termi-
-                                  nal If this value is greater than 0, scrotwm
-                                  will attempt to adjust the font sizes in the
-                                  terminal to keep the terminal width above
-                                  this number as the window is resized.  Only
-                                  xterm(1) is currently supported.  The
-                                  xterm(1) binary must not be setuid or set-
-                                  gid, which it is by default on most systems.
-                                  Users may need to set spawn term to use an
-                                  alternate copy of the xterm(1) binary with-
-                                  out the setgid bit set.
-           modkey                 Change mod key.  Mod1 is generally the ALT
-                                  key and Mod4 is the windows key on a PC.
-           bind[x]                Bind key combo to action x.  See the
-                                  BINDINGS section below.
+           color_focus             Border color of the currently focussed win-
+                                   dow.
+           color_unfocus           Border color of unfocussed windows.
+           bar_enabled             Enable or disable status bar.
+           bar_border[x]           Color of the status bar border in screen x.
+           bar_color[x]            Color of the status bar window in screen x.
+           bar_font_color[x]       Color of the font in status bar in screen
+                                   x.
+           bar_font                Status bar font.
+           bar_action              External script that populates additional
+                                   information in the status bar, such as bat-
+                                   tery life.
+           bar_delay               Update frequency, in seconds, of external
+                                   script that populates the status bar.
+           stack_enabled           Enable or disable displaying the current
+                                   stacking algorithm in the status bar.
+           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 bar_ac-
+                                   tion script.
+           dialog_ratio            Some applications have dialogue windows
+                                   that are too small to be useful.  This ra-
+                                   tio is the screen size to what they will be
+                                   resized.  For example, 0.6 is 60% of the
+                                   physical screen size.
+           region                  Allocates a custom region, removing any au-
+                                   todetected regions which occupy the same
+                                   space on the screen.  Defined in the format
+                                   screen[<idx>]:WIDTHxHEIGHT+X+Y, e.g.
+                                   screen[1]:800x1200+0+0.
+           term_width              Set a preferred minimum width for the ter-
+                                   minal If this value is greater than 0,
+                                   scrotwm will attempt to adjust the font
+                                   sizes in the terminal to keep the terminal
+                                   width above this number as the window is
+                                   resized.  Only xterm(1) is currently sup-
+                                   ported.  The xterm(1) binary must not be
+                                   setuid or setgid, which it is by default on
+                                   most systems.  Users may need to set pro-
+                                   gram[term] (see the PROGRAMS section) to
+                                   use an alternate copy of the xterm(1) bina-
+                                   ry without the setgid bit set.
+           title_class_enabled     Enable or disable displaying the window
+                                   class in the status bar.  Enable by setting
+                                   to 1
+           title_name_enabled      Enable or disable displaying the window ti-
+                                   tle in the status bar.  Enable by setting
+                                   to 1
+           modkey                  Change mod key.  Mod1 is generally the ALT
+                                   key and Mod4 is the windows key on a PC.
+           program[p]              Define new action to spawn a program p.
+                                   See the PROGRAMS section below.
+           bind[x]                 Bind key combo to action x.  See the
+                                   BINDINGS section below.
+           quirk[c:n]              Add "quirk" for windows with class c and
+                                   name n.  See the QUIRKS section below.

     Colors need to be specified per the XQueryColor(3) specification and
     fonts need to be specified per the XQueryFont(3) specification.

+PROGRAMS
+     scrotwm allows you to define custom actions to launch programs of your
+     choice and then bind them the same as with built-in actions.  See the
+     BINDINGS section below.
+
+     The default programs are described below:
+
+           term             xterm
+           screenshot_all   screenshot.sh full
+           screenshot_wind  screenshot.sh window
+           lock             xlock
+           initscr          initscreen.sh
+           menu             dmenu_run -fn $bar_font -nb $bar_color -nf
+                            $bar_font_color -sb $bar_border -sf $bar_color
+
+     Custom programs in the configuration file are specified as follows:
+
+           program[<name>] = <progpath> [<arg> [... <arg>]]
+
+     <name> is any identifier that does not conflict with a built-in action or
+     keyword, <progpath> is the desired program, and <arg> is zero or more ar-
+     guments to the program.
+
+     The following variables represent settable values in scrotwm (see the
+     CONFIGURATION FILES section above), and may be used in the <arg> fields
+     and will be substituted for values at the time the program is spawned:
+
+           $bar_border
+           $bar_color
+           $bar_font
+           $bar_font_color
+           $color_focus
+           $color_unfocus
+
+     Example:
+
+           program[ff] = /usr/local/bin/firefox http://scrotwm.org/
+           bind[ff] = Mod+f # Now Mod+F launched firefox
+
+     To undo the previous:
+
+           bind[] = Mod+f
+           program[ff] =
+
BINDINGS
     scrotwm provides many functions (or actions) accessed via key or mouse
     bindings.
@@ -116,8 +166,8 @@
     The default key bindings are described below:

-           M-S-<Return>     spawn_term
-           M-p              spawn_menu
+           M-S-<Return>     term
+           M-p              menu
           M-S-q            quit
           M-q              restart scrotwm
           M-<Space>        cycle_layout
@@ -147,13 +197,13 @@            M-S-s            screenshot_wind
           M-S-v            version
           M-t              float_toggle
-           M-S <Delete>     spawn_lock
-           M-S-i            spawn_initscr
+           M-S <Delete>     lock
+           M-S-i            initscr

     The action names and descriptions are listed below:

-           spawn_term       Spawn a new terminal
-           spawn_menu       Menu
+           term             Spawn a new terminal (see PROGRAMS above)
+           menu             Menu (see PROGRAMS above)
           quit             Quit scrotwm
           restart          Restart scrotwm
           cycle_layout     Cycle layout
@@ -180,12 +230,14 @@            ws_prev          Switch to previous workspace with a window in it
           screen_next      Move pointer to next region
           screen_prev      Move pointer to previous region
-           screenshot_all   Take screenshot of entire screen (if enabled)
+           screenshot_all   Take screenshot of entire screen (if enabled) (see
+                            PROGRAMS above)
           screenshot_wind  Take screenshot of selected window (if enabled)
+                            (see PROGRAMS above)
           version          Toggle version in status bar
           float_toggle     Toggle focused window between tiled and floating
-           spawn_lock       Lock screen
-           spawn_initscr    Reinitialize physical screens
+           lock             Lock screen (see PROGRAMS above)
+           initscr          Reinitialize physical screens (see PROGRAMS above)

     Custom bindings in the configuration file are specified as follows:

@@ -193,13 +245,68 @@
     <action> is one of the actions listed above (or empty) and <keys> is in
     the form of zero or more modifier keys (MOD, Mod1, Shift, etc.) and one
-     or more normal keys (b, space, etc.), separated by "+". For example:
+     or more normal keys (b, space, etc.), separated by "+".  For example:

           bind[reset] = Mod4+q # bind Windows-key + q to reset
           bind[] = Mod1+q # unbind Alt + q

     Multiple key combinations may be bound to the same action.

+QUIRKS
+     scrotwm provides "quirks" which handle windows that must be treated spe-
+     cially in a tiling window manager, such as some dialogs and fullscreen
+     apps.
+
+     The default quirks are described below:
+
+           Firefox-bin:firefox-bin                 TRANSSZ
+           Firefox:Dialog                          FLOAT
+           Gimp:gimp                               FLOAT + ANYWHERE
+           MPlayer:xv                              FLOAT + FULLSCREEN
+           OpenOffice.org 2.4:VCLSalFrame          FLOAT
+           OpenOffice.org 3.1:VCLSalFrame          FLOAT
+           pcb:pcb                                 FLOAT
+           xine:Xine Window                        FLOAT + ANYWHERE
+           xine:xine Panel                         FLOAT + ANYWHERE
+           xine:xine Video Fullscreen Window       FULLSCREEN + FLOAT
+           Xitk:Xitk Combo                         FLOAT + ANYWHERE
+           Xitk:Xine Window                        FLOAT + ANYWHERE
+           XTerm:xterm                             XTERM_FONTADJ
+
+     The quirks themselves are described below:
+
+           FLOAT                  This window should not be tiled, but allowed
+                                  to float freely.
+           TRANSSZ                Adjusts size on transient windows that are
+                                  too small using dialog_ratio (see
+                                  CONFIGURATION FILES).
+           ANYWHERE               Allow window to position itself, uncentered.
+           XTERM_FONTADJ          Adjust xterm fonts when resizing.
+           FULLSCREEN             Remove border to allow window to use full
+                                  screen size.
+
+     Custom quirks in the configuration file are specified as follows:
+
+           quirk[<class>:<name>] = <quirk> [+ <quirk> ...]
+
+     <class> and <name> specify the window to which the quirk(s) apply, and
+     <quirk> is one of the quirks from the list above.  For example:
+
+           quirk[MPlayer:xv] = FLOAT + FULLSCREEN # let mplayer play
+           quirk[pcb:pcb] = NONE  # remove existing quirk
+
+     You can obtain <class> and <name> by running xprop(1) and then clicking
+     on the desired window.  In the following example the main window of Fire-
+     fox was clicked:
+
+           $ xprop | grep WM_CLASS
+           WM_CLASS(STRING) = "Navigator", "Firefox"
+
+     Note that grepping for WM_CLASS flips class and name.  In the example
+     above the quirk entry would be:
+
+           quirk[Firefox:Navigator] = FLOAT
+
FILES
     ~/.scrotwm.conf       scrotwm user specific settings.
     /etc/scrotwm.conf     scrotwm global settings.
@@ -215,9 +322,6 @@ BUGS
     Currently the menu, invoked with M-p, depends on dmenu.

-OpenBSD 4.5                     March 10, 2009                               4
+OpenBSD 4.6                     October 2, 2009                              5
-

- -$scrotwm$