From 2f3e49717fd3e228db17e6d9232b631b64b82dee Mon Sep 17 00:00:00 2001 From: Marco Peereboom Date: Thu, 29 Jan 2009 22:37:58 +0000 Subject: [PATCH] New man file --- html/man.html | 159 ++++++++++++++++++++++++++++++--------------------------- 1 file changed, 83 insertions(+), 76 deletions(-) diff --git a/html/man.html b/html/man.html index 15bcbd1..3c3db84 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,101 +21,108 @@      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-[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).
-           M1             Focus window.
-
-FILES
-     ~/.scrotwm.conf
-             This file contains user specific settings.
-
-     /etc/scrotwm.conf
-             This file contains global settings.
-
-     scrotwm first tries to open the user specific file.  If that file is un-
-     available it tries to open the global file next.
-
-     The format of the file is <keyword> = <setting>.  E.g. color_focus = red.
+           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, 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)
+           M1               Focus window
+           M-M1             Move window
+           M-M3             Resize window
+
+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 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 that populates additional informa-
-                          tion in the status bar such as battery life etc.
-           bar_delay      Update frequency, in seconds, of external script
-                          that populates 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
-                          Enable or disable screenshot capability.
-           screenshot_app
-                          Set to the script that will take screenshots.  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.
-
-     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.
+           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.
+           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.
+
+     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>.

-HISTORY
-     scrotwm was inspired by xmonad & dwm.
+BUGS
+     Currently the menu, invoked with M-p, depends on dmenu.

-OpenBSD 4.4                    January 27, 2009                              2
+OpenBSD 4.4                    January 29, 2009                              2

-- 1.7.10.4