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 .El
  54 .Pp
  55 .Nm
  56 is very simple in its use.
  57 Most of the actions are initiated via keybindings.
  58 The current keybindings are described below:
  59 .Pp
  60 .Bl -tag -width "M-j, M-<TAB>XXX" -offset indent -compact
  61 .It Cm M-S- Ns Aq Cm Return
  62 Spawn a new terminal
  63 .It Cm M-p
  64 Menu
  65 .It Cm M-S-q
  66 Quit
  67 .It Cm M-q
  68 Restart
  69 .Nm
  70 .It Cm M- Ns Aq Cm Space
  71 Cycle layout
  72 .It Cm M-S- Ns Aq Cm Space
  73 Reset layout
  74 .It Cm M-h
  75 Shrink master area
  76 .It Cm M-l
  77 Grow master area
  78 .It Cm M-,
  79 Add windows to master area
  80 .It Cm M-.
  81 Remove windows from master area
  82 .It Cm M- Ns Aq Cm Return
  83 Move current window to master area
  84 .It Xo
  85 .Cm M-j ,
  86 .Cm M- Ns Aq Cm TAB
  87 .Xc
  88 Focus next window in workspace
  89 .It Xo
  90 .Cm M-k ,
  91 .Cm M-S- Ns Aq Cm TAB
  92 .Xc
  93 Focus previous window in workspace
  94 .It Cm M-m
  95 Focus on main window in workspace
  96 .It Cm M-S-j
  97 Swap with next window in workspace
  98 .It Cm M-S-k
  99 Swap with previous window in workspace
 100 .It Cm M-b
 101 Toggle status bar in all workspaces
 102 .It Cm M-S-x
 103 Destroy current window in workspace
 104 .It Cm M- Ns Aq Ar n
 105 Switch to workspace
 106 .Ar n
 107 .It Cm M-S- Ns Aq Ar n
 108 Move current window to workspace
 109 .Ar n
 110 .It Cm M- Ns Aq Cm Right
 111 Switch to next workspace with a window in it
 112 .It Cm M- Ns Aq Cm Left
 113 Switch to previous workspace with a window in it
 114 .It Cm M-S- Ns Aq Cm Right
 115 Move pointer to next region
 116 .It Cm M-S- Ns Aq Cm Left
 117 Move pointer to previous region
 118 .It Cm M-s
 119 Take screenshot of entire screen (if enabled)
 120 .It Cm M-S-s
 121 Take screenshot of selected window (if enabled)
 122 .It Cm M1
 123 Focus window
 124 .El
 125 .Sh CONFIGURATION FILES
 126 .Nm
 127 first tries to open the user specific file,
 128 .Pa ~/.scrotwm.conf .
 129 If that file is unavailable,
 130 it then tries to open the global configuration file
 131 .Pa /etc/scrotwm.conf .
 132 .Pp
 133 The format of the file is \*(Ltkeyword\*(Gt = \*(Ltsetting\*(Gt.
 134 For example:
 135 .Pp
 136 .Dl color_focus = red
 137 .Pp
 138 Enabling or disabling an option is done by using 1 or 0 respectively.
 139 .Pp
 140 The file supports the following keywords:
 141 .Pp
 142 .Bl -tag -width "screenshot_enabledXXX" -offset indent -compact
 143 .It Cm color_focus
 144 Border color of the currently focussed window.
 145 .It Cm color_unfocus
 146 Border color of unfocussed windows.
 147 .It Cm bar_enabled
 148 Enable or disable status bar.
 149 .It Cm bar_border Ns Bq Ar x
 150 Color of the status bar border in screen
 151 .Ar x .
 152 .It Cm bar_color Ns Bq Ar x
 153 Color of the status bar window in screen
 154 .Ar x .
 155 .It Cm bar_font_color Ns Bq Ar x
 156 Color of the font in status bar in screen
 157 .Ar x .
 158 .It Cm bar_font
 159 Status bar font.
 160 .It Cm bar_action
 161 External script that populates additional information in the status bar,
 162 such as battery life.
 163 .It Cm bar_delay
 164 Update frequency, in seconds, of external script that populates the status bar.
 165 .It Cm spawn_term
 166 External application that gets spawned when
 167 .Cm M-S- Ns Aq Cm Return
 168 is used.
 169 .It Cm dialog_ratio
 170 Some applications have dialogue windows that are too small to be useful.
 171 This ratio is the screen size to what they will be resized.
 172 For example, 0.6 is 60% of the physical screen size.
 173 .It Cm screenshot_enabled
 174 Enable or disable screenshot capability.
 175 .It Cm screenshot_app
 176 Set to the script that will take screenshots.
 177 It will be called with "full" or "window" as parameter 1 to indicate what
 178 screenshot action is expected.
 179 The script shall handle those cases accordingly.
 180 .El
 181 .Pp
 182 Colors need to be specified per the
 183 .Xr XQueryColor 3
 184 specification and fonts need to be specified per the
 185 .Xr XQueryFont 3
 186 specification.
 187 .Sh FILES
 188 .Bl -tag -width "/etc/scrotwm.confXXX" -compact
 189 .It Pa ~/.scrotwm.conf
 190 .Nm
 191 user specific settings.
 192 .It Pa /etc/scrotwm.conf
 193 .Nm
 194 global settings.
 195 .El
 196 .Sh HISTORY
 197 .Nm
 198 was inspired by xmonad & dwm.
 199 .Sh AUTHORS
 200 .An -nosplit
 201 .Pp
 202 .Nm
 203 was written by
 204 .An Marco Peereboom Aq marco@peereboom.us
 205 and
 206 .An Ryan Thomas McBride Aq mcbride@countersiege.com .
 207 .Sh BUGS
 208 Currently the menu, invoked with
 209 .Cm M-p ,
 210 depends on dmenu.