code.delx.au - spectrwm/blob - scrotwm.1

   1 .\"     $scrotwm$
   2 .\"
   3 .\" Copyright (c) 2009 Marco Peereboom <marco@peereboom.us>
   4 .\"
   5 .\" Permission to use, copy, modify, and distribute this software for any
   6 .\" purpose with or without fee is hereby granted, provided that the above
   7 .\" copyright notice and this permission notice appear in all copies.
   8 .\"
   9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  10 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  11 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  12 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  13 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  14 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  15 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  16 .\"
  17 .Dd $Mdocdate$
  18 .Dt SCROTWM 1
  19 .Os
  20 .Sh NAME
  21 .Nm scrotwm
  22 .Nd window manager for X11
  23 .Sh SYNOPSIS
  24 .Nm scrotwm
  25 .Sh DESCRIPTION
  26 .Nm
  27 is a minimalistic window manager that tries to stay out of the way so that
  28 valuable screen real estate can be used for much more important stuff.
  29 It has sane defaults and does not require one to learn a language to do any
  30 configuration.
  31 It was written by hackers for hackers and it strives to be small, compact and
  32 fast.
  33 .Pp
  34 When
  35 .Nm
  36 starts up, it reads settings from its configuration file,
  37 .Pa scrotwm.conf .
  38 See the
  39 .Sx CONFIGURATION FILES
  40 section below.
  41 .Pp
  42 The following notation is used throughout this page:
  43 .Pp
  44 .Bl -tag -width Ds -offset indent -compact
  45 .It Cm M
  46 Meta
  47 .It Cm S
  48 Shift
  49 .It Aq Cm Name
  50 Named key
  51 .It Cm M1
  52 Mouse button 1
  53 .It Cm M3
  54 Mouse button 3
  55 .El
  56 .Pp
  57 .Nm
  58 is very simple in its use.
  59 Most of the actions are initiated via keybindings.
  60 The current keybindings are described below:
  61 .Pp
  62 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
  63 .It Cm M-S- Ns Aq Cm Return
  64 Spawn a new terminal
  65 .It Cm M-p
  66 Menu
  67 .It Cm M-S-q
  68 Quit
  69 .It Cm M-q
  70 Restart
  71 .Nm
  72 .It Cm M- Ns Aq Cm Space
  73 Cycle layout
  74 .It Cm M-S- Ns Aq Cm Space
  75 Reset layout
  76 .It Cm M-h
  77 Shrink master area
  78 .It Cm M-l
  79 Grow master area
  80 .It Cm M-,
  81 Add windows to master area
  82 .It Cm M-.
  83 Remove windows from master area
  84 .It Cm M-S-,
  85 Add columns/rows to stacking area
  86 .It Cm M-S-.
  87 Remove columns/rows from stacking area
  88 .It Cm M- Ns Aq Cm Return
  89 Move current window to master area
  90 .It Xo
  91 .Cm M-j ,
  92 .Cm M- Ns Aq Cm TAB
  93 .Xc
  94 Focus next window in workspace
  95 .It Xo
  96 .Cm M-k ,
  97 .Cm M-S- Ns Aq Cm TAB
  98 .Xc
  99 Focus previous window in workspace
 100 .It Cm M-m
 101 Focus on main window in workspace
 102 .It Cm M-S-j
 103 Swap with next window in workspace
 104 .It Cm M-S-k
 105 Swap with previous window in workspace
 106 .It Cm M-b
 107 Toggle status bar in all workspaces
 108 .It Cm M-x
 109 Delete current window in workspace
 110 .It Cm M-S-x
 111 Destroy current window in workspace
 112 .It Cm M- Ns Aq Ar n
 113 Switch to workspace
 114 .Ar n
 115 .It Cm M-S- Ns Aq Ar n
 116 Move current window to workspace
 117 .Ar n
 118 .It Cm M- Ns Aq Cm Right
 119 Switch to next workspace with a window in it
 120 .It Cm M- Ns Aq Cm Left
 121 Switch to previous workspace with a window in it
 122 .It Cm M-S- Ns Aq Cm Right
 123 Move pointer to next region
 124 .It Cm M-S- Ns Aq Cm Left
 125 Move pointer to previous region
 126 .It Cm M-s
 127 Take screenshot of entire screen (if enabled)
 128 .It Cm M-S-s
 129 Take screenshot of selected window (if enabled)
 130 .It Cm M-S-v
 131 Toggle version in status bar
 132 .It Cm M-t
 133 Toggle focused window between tiled and floating
 134 .It Cm M-S Aq Cm Delete
 135 Lock screen
 136 .It Cm M-S-i
 137 Reinitialize physical screens
 138 .It Cm M1
 139 Focus window
 140 .It Cm M-M1
 141 Move window
 142 .It Cm M-M3
 143 Resize window
 144 .It Cm M-S-M3
 145 Resize window while maintaining it centered
 146 .El
 147 .Sh CONFIGURATION FILES
 148 .Nm
 149 first tries to open the user specific file,
 150 .Pa ~/.scrotwm.conf .
 151 If that file is unavailable,
 152 it then tries to open the global configuration file
 153 .Pa /etc/scrotwm.conf .
 154 .Pp
 155 The format of the file is \*(Ltkeyword\*(Gt = \*(Ltsetting\*(Gt.
 156 For example:
 157 .Pp
 158 .Dl color_focus = red
 159 .Pp
 160 Enabling or disabling an option is done by using 1 or 0 respectively.
 161 .Pp
 162 The file supports the following keywords:
 163 .Pp
 164 .Bl -tag -width "screenshot_enabledXXX" -offset indent -compact
 165 .It Cm color_focus
 166 Border color of the currently focussed window.
 167 .It Cm color_unfocus
 168 Border color of unfocussed windows.
 169 .It Cm bar_enabled
 170 Enable or disable status bar.
 171 .It Cm bar_border Ns Bq Ar x
 172 Color of the status bar border in screen
 173 .Ar x .
 174 .It Cm bar_color Ns Bq Ar x
 175 Color of the status bar window in screen
 176 .Ar x .
 177 .It Cm bar_font_color Ns Bq Ar x
 178 Color of the font in status bar in screen
 179 .Ar x .
 180 .It Cm bar_font
 181 Status bar font.
 182 .It Cm bar_action
 183 External script that populates additional information in the status bar,
 184 such as battery life.
 185 .It Cm bar_delay
 186 Update frequency, in seconds, of external script that populates the status bar.
 187 .It Cm clock_enabled
 188 Enable or disable displaying the clock in the status bar.  Disable by
 189 setting to 0 so a custom clock could be used in the bar_action script.
 190 .It Cm spawn_term
 191 External application that gets spawned when
 192 .Cm M-S- Ns Aq Cm Return
 193 is used.
 194 .It Cm dialog_ratio
 195 Some applications have dialogue windows that are too small to be useful.
 196 This ratio is the screen size to what they will be resized.
 197 For example, 0.6 is 60% of the physical screen size.
 198 .It Cm region
 199 Allocates a custom region, removing any autodetected regions which occupy the same
 200 space on the screen.
 201 Defined in the format screen[<idx>]:WIDTHxHEIGHT+X+Y, e.g. screen[1]:800x1200+0+0.
 202 .It Cm screenshot_enabled
 203 Enable or disable screenshot capability.
 204 .It Cm screenshot_app
 205 Set to the script that will take screenshots.
 206 It will be called with "full" or "window" as parameter 1 to indicate what
 207 screenshot action is expected.
 208 The script shall handle those cases accordingly.
 209 .It Cm term_width
 210 Set a preferred minimum width for the terminal
 211 If this value is greater than 0,
 212 .Nm
 213 will attempt to adjust the font sizes in the terminal to keep the terminal
 214 width above this number as the window is resized.
 215 Only
 216 .Xr xterm 1
 217 is currently supported.
 218 The
 219 .Xr xterm 1
 220 binary must not be setuid or setgid, which it is by default on most systems.
 221 Users may need to set spawn term to use an alternate copy of the
 222 .Xr xterm 1
 223 binary without the setgid bit set.
 224 .It Cm modkey
 225 Change mod key.
 226 Mod1 is generally the ALT key and Mod4 is the windows key on a PC.
 227 .El
 228 .Pp
 229 Colors need to be specified per the
 230 .Xr XQueryColor 3
 231 specification and fonts need to be specified per the
 232 .Xr XQueryFont 3
 233 specification.
 234 .Sh FILES
 235 .Bl -tag -width "/etc/scrotwm.confXXX" -compact
 236 .It Pa ~/.scrotwm.conf
 237 .Nm
 238 user specific settings.
 239 .It Pa /etc/scrotwm.conf
 240 .Nm
 241 global settings.
 242 .El
 243 .Sh HISTORY
 244 .Nm
 245 was inspired by xmonad & dwm.
 246 .Sh AUTHORS
 247 .An -nosplit
 248 .Pp
 249 .Nm
 250 was written by
 251 .An Marco Peereboom Aq marco@peereboom.us
 252 and
 253 .An Ryan Thomas McBride Aq mcbride@countersiege.com .
 254 .Sh BUGS
 255 Currently the menu, invoked with
 256 .Cm M-p ,
 257 depends on dmenu.