X-Git-Url: https://jasonwoof.com/gitweb/?a=blobdiff_plain;f=html%2Fman.html;h=50600f048ccb70cb8ed3c0bfc3cf11983f796b24;hb=667eb8f7002deec7814f5b36b8d5663d4a01f898;hp=aa954b0a2e3b0dbf6d10e023db13de057e22604b;hpb=2d53c59cc3444ac0223127b6861742e85fa33ce4;p=spectrwm.git diff --git a/html/man.html b/html/man.html index aa954b0..50600f0 100644 --- a/html/man.html +++ b/html/man.html @@ -33,44 +33,8 @@            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-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 scren
-           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
+     key or mouse bindings.  See the BINDINGS section below for defaults and
+     customizations.

CONFIGURATION FILES
     scrotwm first tries to open the user specific file, ~/.scrotwm.conf.  If
@@ -98,6 +62,10 @@                                   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
@@ -116,10 +84,122 @@                                   "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.
+
FILES
     ~/.scrotwm.conf       scrotwm user specific settings.
     /etc/scrotwm.conf     scrotwm global settings.
@@ -128,15 +208,16 @@      scrotwm was inspired by xmonad & dwm.

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

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

-OpenBSD 4.4                    February 3, 2009                              2
+OpenBSD 4.5                     March 10, 2009                               4
- -
+

$scrotwm$ +