SCROTWM(1)                 OpenBSD Reference Manual                 SCROTWM(1)

NAME
     scrotwm - window manager for X11

SYNOPSIS
     scrotwm

DESCRIPTION
     scrotwm is a minimalistic window manager that tries to stay out of the
     way so that valuable screen real estate can be used for much more impor-
     tant stuff.  It has sane defaults and does not require one to learn a
     language to do any configuration.  It was written by hackers for hackers
     and it strives to be small, compact and fast.

     When scrotwm starts up, it reads settings from its configuration file,
     scrotwm.conf.  See the CONFIGURATION FILES section below.

     The following notation is used throughout this page:

           M       Meta
           S       Shift
           <Name>  Named key
           M1      Mouse button 1
           M3      Mouse button 3

     scrotwm is very simple in its use.  Most of the actions are initiated via
     keybindings.  The current keybindings are described below:

           M-S-<Return>     Spawn a new terminal
           M-p              Menu
           M-S-q            Quit
           M-q              Restart scrotwm
           M-<Space>        Cycle layout
           M-S-<Space>      Reset layout
           M-h              Shrink master area
           M-l              Grow master area
           M-,              Add windows to master area
           M-.              Remove windows from master area
           M-S-,            Add columns/rows to stacking area
           M-S-.            Remove columns/rows from stacking area
           M-<Return>       Move current window to master area
           M-j, M-<TAB>     Focus next window in workspace
           M-k, M-S-<TAB>   Focus previous window in workspace
           M-m              Focus on main window in workspace
           M-S-j            Swap with next window in workspace
           M-S-k            Swap with previous window in workspace
           M-b              Toggle status bar in all workspaces
           M-x              Delete current window in workspace
           M-S-x            Destroy current window in workspace
           M-<n>            Switch to workspace n
           M-S-<n>          Move current window to workspace n
           M-<Right>        Switch to next workspace with a window in it
           M-<Left>         Switch to previous workspace with a window in it
           M-S-<Right>      Move pointer to next region
           M-S-<Left>       Move pointer to previous region
           M-s              Take screenshot of entire screen (if enabled)
           M-S-s            Take screenshot of selected window (if enabled)
           M-S-v            Toggle version in status bar
           M-t              Toggle focused window between tiled and floating
           M-S <Delete>     Lock screen
           M-S-i            Reinitialize physical screens
           M1               Focus window
           M-M1             Move window
           M-M3             Resize window
           M-S-M3           Resize window while maintaining it centered

CONFIGURATION FILES
     scrotwm first tries to open the user specific file, ~/.scrotwm.conf.  If
     that file is unavailable, it then tries to open the global configuration
     file /etc/scrotwm.conf.

     The format of the file is <keyword> = <setting>.  For example:

           color_focus = red

     Enabling or disabling an option is done by using 1 or 0 respectively.

     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.

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

FILES
     ~/.scrotwm.conf       scrotwm user specific settings.
     /etc/scrotwm.conf     scrotwm global settings.

HISTORY
     scrotwm was inspired by xmonad & dwm.

AUTHORS
     scrotwm was written by Marco Peereboom <marco@peereboom.us> and Ryan
     Thomas McBride <mcbride@countersiege.com>.

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

OpenBSD 4.5                    February 18, 2009                             3