html/man.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
   2 <html>
   3 <head>
   4 <meta http-equiv="content-type" content="text/html; charset=iso-8859-1">
   5 <title>~/scrotwm.1.html</title>
   6 <meta name="Generator" content="Vim/7.3">
   7 <meta name="plugin-version" content="vim7.3_v6">
   8 <meta name="syntax" content="man">
   9 <meta name="settings" content="use_css">
  10 <style type="text/css">
  11 <!--
  12 pre { font-family: monospace; background-color: #000000; color: #ffffff; }
  13 body { font-family: monospace; background-color: #000000; color: #ffffff; }
  14 .PreProc { color: #ff40ff; }
  15 .Statement { color: #ffff00; }
  16 .Title { color: #ff40ff; }
  17 -->
  18 </style>
  19 </head>
  20 <body>
  21 <pre>
  22 <span class="Title">SCROTWM(1)                 OpenBSD Reference Manual                 SCROTWM(1)</span>
  23
  24 <span class="Statement">NAME</span>
  25      scrotwm - window manager for X11
  26
  27 <span class="Statement">SYNOPSIS</span>
  28      scrotwm
  29
  30 <span class="Statement">DESCRIPTION</span>
  31      scrotwm is a minimalistic window manager that tries to stay out of the
  32      way so that valuable screen real estate can be used for much more
  33      important stuff.  It has sane defaults and does not require one to learn
  34      a language to do any configuration.  It was written by hackers for
  35      hackers and it strives to be small, compact and fast.
  36
  37      When scrotwm starts up, it reads settings from its configuration file,
  38      scrotwm.conf.  See the CONFIGURATION FILES section below.
  39
  40      The following notation is used throughout this page:
  41
  42            M       Meta
  43            S       Shift
  44            &lt;Name&gt;  Named key
  45            M1      Mouse button 1
  46            M3      Mouse button 3
  47
  48      scrotwm is very simple in its use.  Most of the actions are initiated via
  49      key or mouse bindings.  See the BINDINGS section below for defaults and
  50      customizations.
  51
  52 <span class="Statement">CONFIGURATION FILES</span>
  53      scrotwm first tries to open the user specific file, ~/.scrotwm.conf.  If
  54      that file is unavailable, it then tries to open the global configuration
  55      file /etc/scrotwm.conf.
  56
  57      The format of the file is &lt;keyword&gt; = &lt;setting&gt;.  For example:
  58
  59            color_focus = red
  60
  61      Enabling or disabling an option is done by using 1 or 0 respectively.
  62
  63      The file supports the following keywords:
  64
  65            color_focus             Border color of the currently focussed
  66                                    window.
  67            color_unfocus           Border color of unfocussed windows.
  68            bar_enabled             Enable or disable status bar.
  69            bar_border[x]           Color of the status bar border in screen x.
  70            bar_color[x]            Color of the status bar window in screen x.
  71            bar_font_color[x]       Color of the font in status bar in screen
  72                                    x.
  73            bar_font                Status bar font.
  74            bar_action              External script that populates additional
  75                                    information in the status bar, such as
  76                                    battery life.
  77            bar_delay               Update frequency, in seconds, of external
  78                                    script that populates the status bar.
  79            bar_at_bottom           Place the statusbar at the bottom of each
  80                                    region instead of the top.
  81            stack_enabled           Enable or disable displaying the current
  82                                    stacking algorithm in the status bar.
  83            clock_enabled           Enable or disable displaying the clock in
  84                                    the status bar.  Disable by setting to 0 so
  85                                    a custom clock could be used in the
  86                                    bar_action script.
  87            dialog_ratio            Some applications have dialogue windows
  88                                    that are too small to be useful.  This
  89                                    ratio is the screen size to what they will
  90                                    be resized.  For example, 0.6 is 60% of the
  91                                    physical screen size.
  92            region                  Allocates a custom region, removing any
  93                                    autodetected regions which occupy the same
  94                                    space on the screen.  Defined in the format
  95                                    screen[&lt;idx&gt;]:WIDTHxHEIGHT+X+Y, e.g.
  96                                    screen[1]:800x1200+0+0.
  97            term_width              Set a preferred minimum width for the
  98                                    terminal If this value is greater than 0,
  99                                    scrotwm will attempt to adjust the font
 100                                    sizes in the terminal to keep the terminal
 101                                    width above this number as the window is
 102                                    resized.  Only <span class="PreProc">xterm(1)</span> is currently
 103                                    supported.  The <span class="PreProc">xterm(1)</span> binary must not be
 104                                    setuid or setgid, which it is by default on
 105                                    most systems.  Users may need to set
 106                                    program[term] (see the PROGRAMS section) to
 107                                    use an alternate copy of the <span class="PreProc">xterm(1)</span>
 108                                    binary without the setgid bit set.
 109            title_class_enabled     Enable or disable displaying the window
 110                                    class in the status bar.  Enable by setting
 111                                    to 1
 112            title_name_enabled      Enable or disable displaying the window
 113                                    title in the status bar.  Enable by setting
 114                                    to 1
 115            modkey                  Change mod key.  Mod1 is generally the ALT
 116                                    key and Mod4 is the windows key on a PC.
 117            focus_mode              Using a value of follow_cursor will make
 118                                    the window manager focus the window under
 119                                    the mouse when switching workspaces and
 120                                    creating windows.
 121            disable_border          Remove border when bar is disabled and
 122                                    there is only one window on the screen.
 123            program[p]              Define new action to spawn a program p.
 124                                    See the PROGRAMS section below.
 125            bind[x]                 Bind key combo to action x.  See the
 126                                    BINDINGS section below.
 127            quirk[c:n]              Add &quot;quirk&quot; for windows with class c and
 128                                    name n.  See the QUIRKS section below.
 129
 130      Colors need to be specified per the <span class="PreProc">XQueryColor(3)</span> specification and
 131      fonts need to be specified per the <span class="PreProc">XQueryFont(3)</span> specification.
 132
 133      To list the available fonts in your system see <span class="PreProc">fc-list(1)</span> or <span class="PreProc">xlsfonts(1)</span>
 134      manpages.  The <span class="PreProc">xfontsel(1)</span> application can help you to show the X Logical
 135      Font Description (&quot;XLFD&quot;) used as setting in the keyword bar_font.
 136
 137 <span class="Statement">PROGRAMS</span>
 138      scrotwm allows you to define custom actions to launch programs of your
 139      choice and then bind them the same as with built-in actions.  See the
 140      BINDINGS section below.
 141
 142      The default programs are described below:
 143
 144            term             xterm
 145            screenshot_all   screenshot.sh full
 146            screenshot_wind  screenshot.sh window
 147            lock             xlock
 148            initscr          initscreen.sh
 149            menu             dmenu_run -fn $bar_font -nb $bar_color -nf
 150                             $bar_font_color -sb $bar_border -sf $bar_color
 151
 152      Custom programs in the configuration file are specified as follows:
 153
 154            program[&lt;name&gt;] = &lt;progpath&gt; [&lt;arg&gt; [... &lt;arg&gt;]]
 155
 156      &lt;name&gt; is any identifier that does not conflict with a built-in action or
 157      keyword, &lt;progpath&gt; is the desired program, and &lt;arg&gt; is zero or more
 158      arguments to the program.
 159
 160      The following variables represent settable values in scrotwm (see the
 161      CONFIGURATION FILES section above), and may be used in the &lt;arg&gt; fields
 162      and will be substituted for values at the time the program is spawned:
 163
 164            $bar_border
 165            $bar_color
 166            $bar_font
 167            $bar_font_color
 168            $color_focus
 169            $color_unfocus
 170
 171      Example:
 172
 173            program[ff] = /usr/local/bin/firefox <a href="http://scrotwm.org/">http://scrotwm.org/</a>
 174            bind[ff] = Mod+f # Now Mod+F launched firefox
 175
 176      To undo the previous:
 177
 178            bind[] = Mod+f
 179            program[ff] =
 180
 181 <span class="Statement">BINDINGS</span>
 182      scrotwm provides many functions (or actions) accessed via key or mouse
 183      bindings.
 184
 185      The current mouse bindings are described below:
 186
 187            M1               Focus window
 188            M-M1             Move window
 189            M-M3             Resize window
 190            M-S-M3           Resize window while maintaining it centered
 191
 192      The default key bindings are described below:
 193
 194            M-S-&lt;Return&gt;     term
 195            M-p              menu
 196            M-S-q            quit
 197            M-q              restart scrotwm
 198            M-&lt;Space&gt;        cycle_layout
 199            M-S-&lt;Space&gt;      reset_layout
 200            M-h              master_shrink
 201            M-l              master_grow
 202            M-,              master_add
 203            M-.              master_del
 204            M-S-,            stack_inc
 205            M-S-.            stack_del
 206            M-&lt;Return&gt;       swap_main
 207            M-j, M-&lt;TAB&gt;     focus_next
 208            M-k, M-S-&lt;TAB&gt;   focus_prev
 209            M-m              focus_main
 210            M-S-j            swap_next
 211            M-S-k            swap_prev
 212            M-b              bar_toggle
 213            M-x              wind_del
 214            M-S-x            wind_kill
 215            M-&lt;n&gt;            ws_n
 216            M-S-&lt;n&gt;          mvws_n
 217            M-&lt;Right&gt;        ws_next
 218            M-&lt;Left&gt;         ws_prev
 219            M-a              ws_prior
 220            M-S-&lt;Right&gt;      screen_next
 221            M-S-&lt;Left&gt;       screen_prev
 222            M-s              screenshot_all
 223            M-S-s            screenshot_wind
 224            M-S-v            version
 225            M-t              float_toggle
 226            M-S &lt;Delete&gt;     lock
 227            M-S-i            initscr
 228
 229      The action names and descriptions are listed below:
 230
 231            term             Spawn a new terminal (see PROGRAMS above)
 232            menu             Menu (see PROGRAMS above)
 233            quit             Quit scrotwm
 234            restart          Restart scrotwm
 235            cycle_layout     Cycle layout
 236            reset_layout     Reset layout
 237            master_shrink    Shrink master area
 238            master_grow      Grow master area
 239            master_add       Add windows to master area
 240            master_del       Remove windows from master area
 241            stack_inc        Add columns/rows to stacking area
 242            stack_del        Remove columns/rows from stacking area
 243            swap_main        Move current window to master area
 244            focus_next       Focus next window in workspace
 245            focus_prev       Focus previous window in workspace
 246            focus_main       Focus on main window in workspace
 247            swap_next        Swap with next window in workspace
 248            swap_prev        Swap with previous window in workspace
 249            bar_toggle       Toggle status bar in all workspaces
 250            wind_del         Delete current window in workspace
 251            wind_kill        Destroy current window in workspace
 252            ws_n             Switch to workspace n, where n is 1 through 10
 253            mvws_n           Move current window to workspace n, where n is 1
 254                             through 10
 255            ws_next          Switch to next workspace with a window in it
 256            ws_prev          Switch to previous workspace with a window in it
 257            ws_prior         Switch to last visited workspace
 258            screen_next      Move pointer to next region
 259            screen_prev      Move pointer to previous region
 260            screenshot_all   Take screenshot of entire screen (if enabled) (see
 261                             PROGRAMS above)
 262            screenshot_wind  Take screenshot of selected window (if enabled)
 263                             (see PROGRAMS above)
 264            version          Toggle version in status bar
 265            float_toggle     Toggle focused window between tiled and floating
 266            lock             Lock screen (see PROGRAMS above)
 267            initscr          Reinitialize physical screens (see PROGRAMS above)
 268
 269      Custom bindings in the configuration file are specified as follows:
 270
 271            bind[&lt;action&gt;] = &lt;keys&gt;
 272
 273      &lt;action&gt; is one of the actions listed above (or empty) and &lt;keys&gt; is in
 274      the form of zero or more modifier keys (MOD, Mod1, Shift, etc.) and one
 275      or more normal keys (b, space, etc.), separated by &quot;+&quot;.  For example:
 276
 277            bind[reset] = Mod4+q # bind Windows-key + q to reset
 278            bind[] = Mod1+q # unbind Alt + q
 279
 280      Multiple key combinations may be bound to the same action.
 281
 282 <span class="Statement">QUIRKS</span>
 283      scrotwm provides &quot;quirks&quot; which handle windows that must be treated
 284      specially in a tiling window manager, such as some dialogs and fullscreen
 285      apps.
 286
 287      The default quirks are described below:
 288
 289            Firefox-bin:firefox-bin                 TRANSSZ
 290            Firefox:Dialog                          FLOAT
 291            Gimp:gimp                               FLOAT + ANYWHERE
 292            MPlayer:xv                              FLOAT + FULLSCREEN
 293            OpenOffice.org 2.4:VCLSalFrame          FLOAT
 294            OpenOffice.org 3.1:VCLSalFrame          FLOAT
 295            pcb:pcb                                 FLOAT
 296            xine:Xine Window                        FLOAT + ANYWHERE
 297            xine:xine Panel                         FLOAT + ANYWHERE
 298            xine:xine Video Fullscreen Window       FULLSCREEN + FLOAT
 299            Xitk:Xitk Combo                         FLOAT + ANYWHERE
 300            Xitk:Xine Window                        FLOAT + ANYWHERE
 301            XTerm:xterm                             XTERM_FONTADJ
 302
 303      The quirks themselves are described below:
 304
 305            FLOAT                  This window should not be tiled, but allowed
 306                                   to float freely.
 307            TRANSSZ                Adjusts size on transient windows that are
 308                                   too small using dialog_ratio (see
 309                                   CONFIGURATION FILES).
 310            ANYWHERE               Allow window to position itself, uncentered.
 311            XTERM_FONTADJ          Adjust xterm fonts when resizing.
 312            FULLSCREEN             Remove border to allow window to use full
 313                                   screen size.
 314
 315      Custom quirks in the configuration file are specified as follows:
 316
 317            quirk[&lt;class&gt;:&lt;name&gt;] = &lt;quirk&gt; [+ &lt;quirk&gt; ...]
 318
 319      &lt;class&gt; and &lt;name&gt; specify the window to which the quirk(s) apply, and
 320      &lt;quirk&gt; is one of the quirks from the list above.  For example:
 321
 322            quirk[MPlayer:xv] = FLOAT + FULLSCREEN # let mplayer play
 323            quirk[pcb:pcb] = NONE  # remove existing quirk
 324
 325      You can obtain &lt;class&gt; and &lt;name&gt; by running <span class="PreProc">xprop(1)</span> and then clicking
 326      on the desired window.  In the following example the main window of
 327      Firefox was clicked:
 328
 329            $ xprop | grep WM_CLASS
 330            WM_CLASS(STRING) = &quot;Navigator&quot;, &quot;Firefox&quot;
 331
 332      Note that grepping for WM_CLASS flips class and name.  In the example
 333      above the quirk entry would be:
 334
 335            quirk[Firefox:Navigator] = FLOAT
 336
 337 <span class="Statement">SIGNALS</span>
 338      Sending scrotwm a HUP signal will retstart it.
 339
 340 <span class="Statement">FILES</span>
 341      ~/.scrotwm.conf       scrotwm user specific settings.
 342      /etc/scrotwm.conf     scrotwm global settings.
 343
 344 <span class="Statement">HISTORY</span>
 345      scrotwm was inspired by xmonad &amp; dwm.
 346
 347 <span class="Statement">AUTHORS</span>
 348
 349      scrotwm was written by Marco Peereboom &lt;marco@peereboom.us&gt;, Ryan Thomas
 350      McBride &lt;mcbride@countersiege.com&gt; and Darrin Chandler
 351      &lt;dwchandler@stilyagin.com&gt;.
 352
 353 <span class="Statement">BUGS</span>
 354      Currently the menu, invoked with M-p, depends on dmenu.
 355
 356 OpenBSD 4.8                      July 15, 2010                     OpenBSD 4.8
 357 </pre>
 358 </body>
 359 </html>