X-Git-Url: https://jasonwoof.com/gitweb/?a=blobdiff_plain;f=html%2Fman.html;h=50600f048ccb70cb8ed3c0bfc3cf11983f796b24;hb=667eb8f7002deec7814f5b36b8d5663d4a01f898;hp=bcb7d6e22f8ff72a279976186d6dc7ca3132ac97;hpb=eace90c56b7d387e1439985acf7ef3e207251a01;p=spectrwm.git diff --git a/html/man.html b/html/man.html index bcb7d6e..50600f0 100644 --- a/html/man.html +++ b/html/man.html @@ -9,7 +9,7 @@ SCROTWM(1)                 OpenBSD Reference Manual                 SCROTWM(1)

NAME
-     scrotwm - small dynamic tiling window manager for X11.
+     scrotwm - window manager for X11

SYNOPSIS
     scrotwm
@@ -21,96 +21,203 @@      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
+           <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-[Return]     Move current window to master area.
-           M-j            Focus next window in workspace.
-           M-[Tab]        Focus next window in workspace.
-           M-k            Focus previous window in workspace.
-           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-S-x          Destroy current window in workspace.
-           M-[Number]     Switch to workspace [Number].
-           M-S-[Number]   Move current window to workspace [Number].
-           M-[RighArrow]  Switch to next workspace with a window in it.
-           M-[LeftArrow]  Switch to previous workspace with a window in it.
-           M-s            Take screenshot of entire screen (if enabled).
-           M-S-s          Take screenshot of selected window (if enabled).
-           M1             Focus window.
+     key or mouse bindings.  See the BINDINGS section below for defaults and
+     customizations.

-FILES
-     ~/.scrotwm.conf
-             This file contains user specific settings.
+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.

-     /etc/scrotwm.conf
-             This file contains global settings.
+     The format of the file is <keyword> = <setting>.  For example:

-     scrotwm first tries to open the user specific file.  If that file is un-
-     available it tries to open the global file next.
+           color_focus = red

-     The format of the file is <keyword> = <setting>.  E.g. 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 window.
-           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 to populate additional information
-                          in the status bar such as battery life etc.
-           bar_delay      Update frequency of external script on the status
-                          bar.
-           spawn_term     External application that gets spawned when M-S-[Re-
-                          turn] is used.
-           dialog_ratio   Some applications have dialog windows that are too
-                          small to be useful.  This ratio is the screen size
-                          as to what they will be resized.  E.g 0.6 is 60% of
-                          the physical screen size.
-           screenshot_enabled
-                          Set to 1 to enable screen-shotting capability.
-
-     Colors need to be specified per the XQueryColor(4) specification and
-     fonts need to be specified per the XQueryFont(4) specification.

-BUGS
-     Currently the menu, invoked with M-p, depends on dmenu.
+           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.
+
+     Colors need to be specified per the XQueryColor(3) specification and
+     fonts need to be specified per the XQueryFont(3) specification.
+
+BINDINGS
+     scrotwm provides many functions (or actions) accessed via key or mouse
+     bindings.
+
+     The current mouse bindings are described below:
+
+           M1               Focus window
+           M-M1             Move window
+           M-M3             Resize window
+           M-S-M3           Resize window while maintaining it centered
+
+     The default key bindings are described below:
+
+           M-S-<Return>     spawn_term
+           M-p              spawn_menu
+           M-S-q            quit
+           M-q              restart scrotwm
+           M-<Space>        cycle_layout
+           M-S-<Space>      reset_layout
+           M-h              master_shrink
+           M-l              master_grow
+           M-,              master_add
+           M-.              master_del
+           M-S-,            stack_inc
+           M-S-.            stack_del
+           M-<Return>       swap_main
+           M-j, M-<TAB>     focus_next
+           M-k, M-S-<TAB>   focus_prev
+           M-m              focus_main
+           M-S-j            swap_next
+           M-S-k            swap_prev
+           M-b              bar_toggle
+           M-x              wind_del
+           M-S-x            wind_kill
+           M-<n>            ws_n
+           M-S-<n>          mvws_n
+           M-<Right>        ws_next
+           M-<Left>         ws_prev
+           M-S-<Right>      screen_next
+           M-S-<Left>       screen_prev
+           M-s              screenshot_all
+           M-S-s            screenshot_wind
+           M-S-v            version
+           M-t              float_toggle
+           M-S <Delete>     spawn_lock
+           M-S-i            spawn_initscr
+
+     The action names and descriptions are listed below:
+
+           spawn_term       Spawn a new terminal
+           spawn_menu       Menu
+           quit             Quit scrotwm
+           restart          Restart scrotwm
+           cycle_layout     Cycle layout
+           reset_layout     Reset layout
+           master_shrink    Shrink master area
+           master_grow      Grow master area
+           master_add       Add windows to master area
+           master_del       Remove windows from master area
+           stack_inc        Add columns/rows to stacking area
+           stack_del        Remove columns/rows from stacking area
+           swap_main        Move current window to master area
+           focus_next       Focus next window in workspace
+           focus_prev       Focus previous window in workspace
+           focus_main       Focus on main window in workspace
+           swap_next        Swap with next window in workspace
+           swap_prev        Swap with previous window in workspace
+           bar_toggle       Toggle status bar in all workspaces
+           wind_del         Delete current window in workspace
+           wind_kill        Destroy current window in workspace
+           ws_n             Switch to workspace n, where n is 1 through 10
+           mvws_n           Move current window to workspace n, where n is 1
+                            through 10
+           ws_next          Switch to next workspace with a window in it
+           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_wind  Take screenshot of selected window (if enabled)
+           version          Toggle version in status bar
+           float_toggle     Toggle focused window between tiled and floating
+           spawn_lock       Lock screen
+           spawn_initscr    Reinitialize physical screens
+
+     Custom bindings in the configuration file are specified as follows:
+
+           bind[<action>] = <keys>
+
+     <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:
+
+           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.

-AUTHORS
-     scrotwm was written by Marco Peereboom <marco@peereboom.us> and Ryan
-     Thomas McBride <mcbride@countersiege.com>.
+FILES
+     ~/.scrotwm.conf       scrotwm user specific settings.
+     /etc/scrotwm.conf     scrotwm global settings.

HISTORY
     scrotwm was inspired by xmonad & dwm.

-     scrotwm first appeared in OpenBSD 4.5.
+AUTHORS
+     scrotwm was written by Marco Peereboom <marco@peereboom.us>, Ryan Thomas
+     McBride <mcbride@countersiege.com> and Darrin Chandler
+     <dwchandler@stilyagin.com>.

-OpenBSD 4.4                    January 25, 2009                              2
- - +BUGS
+     Currently the menu, invoked with M-p, depends on dmenu.

+OpenBSD 4.5                     March 10, 2009                               4
+ +

$scrotwm$ +