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 small dynamic tiling 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 The following notation is used throughout this page:
  35 .Pp
  36 .Bl -tag -width Ds -offset indent -compact
  37 .It Ic M
  38 Meta
  39 .It Ic S
  40 Shift
  41 .It Ic [Name]
  42 Named key
  43 .It Ic M1
  44 Mouse button 1
  45 .El
  46 .Pp
  47 .Nm
  48 is very simple in its use.
  49 Most of the actions are initiated via keybindings.
  50 The current keybindings are described below:
  51 .Pp
  52 .Bl -tag -width "C-M-EscapeXXX" -offset indent -compact
  53 .It Ic M-S-[Return]
  54 Spawn a new terminal.
  55 .It Ic M-p
  56 Menu.
  57 .It Ic M-S-q
  58 Quit.
  59 .It Ic M-q
  60 Restart
  61 .Nm .
  62 .It Ic M-[Space]
  63 Cycle layout.
  64 .It Ic M-S-[Space]
  65 Reset layout.
  66 .It Ic M-h
  67 Shrink master area.
  68 .It Ic M-l
  69 Grow master area.
  70 .It Ic M-,
  71 Add windows to master area.
  72 .It Ic M-.
  73 Remove windows from master area.
  74 .It Ic M-[Return]
  75 Move current window to master area.
  76 .It Ic M-j
  77 Focus next window in workspace.
  78 .It Ic M-[Tab]
  79 Focus next window in workspace.
  80 .It Ic M-k
  81 Focus previous window in workspace.
  82 .It Ic M-S-[Tab]
  83 Focus previous window in workspace.
  84 .It Ic M-m
  85 Focus on main window in workspace.
  86 .It Ic M-S-j
  87 Swap with next window in workspace.
  88 .It Ic M-S-k
  89 Swap with previous window in workspace.
  90 .It Ic M-b
  91 Toggle status bar in all workspaces.
  92 .It Ic M-S-x
  93 Destroy current window in workspace.
  94 .It Ic M-[Number]
  95 Switch to workspace [Number].
  96 .It Ic M-S-[Number]
  97 Move current window to workspace [Number].
  98 .It Ic M-[RighArrow]
  99 Switch to next workspace with a window in it.
 100 .It Ic M-[LeftArrow]
 101 Switch to previous workspace with a window in it.
 102 .It Ic M1
 103 Focus window.
 104 .El
 105 .Pp
 106 .Pp
 107 .Sh FILES
 108 .Bl -tag -width Ds
 109 .It Pa ~/.scrotwm.conf
 110 This file contains user specific settings.
 111 .It Pa /etc/scrotwm.conf
 112 This file contains global settings.
 113 .El
 114 .Pp
 115 .Nm
 116 first tries to open the user specific file.
 117 If that file is unavailable it tries to open the global file next.
 118 .Pp
 119 The format of the file is <keyword> = <setting>.
 120 E.g. color_focus = red.
 121 .Pp
 122 The file supports the following keywords:
 123 .Bl -tag -width "C-M-EscapeXXX" -offset indent -compact
 124 .It Ic color_focus
 125 Border color of the currently focussed window.
 126 .It Ic color_unfocus
 127 Border color of unfocussed windows.
 128 .It Ic bar_enabled
 129 Enable or disable status bar.
 130 .It Ic bar_border[x]
 131 Color of the status bar border in screen x.
 132 .It Ic bar_color[x]
 133 Color of the status bar window in screen x.
 134 .It Ic bar_font_color[x]
 135 Color of the font in status bar in screen x.
 136 .It Ic bar_font
 137 Status bar font.
 138 .It Ic bar_action
 139 External script to populate additional information in the status bar such as
 140 battery life etc.
 141 .It Ic bar_delay
 142 Update frequency of external script on the status bar.
 143 .It Ic spawn_term
 144 External application that gets spawned when M-S-[Return] is used.
 145 .It Ic dialog_ratio
 146 Some applications have dialog windows that are too small to be useful.
 147 This ratio is the screen size as to what they will be resized.
 148 E.g 0.6 is 60% of the physical screen size.
 149 .El
 150 .Pp
 151 Colors need to be specified per the
 152 .Xr XQueryColor 4
 153 specification and fonts need to be specified per the
 154 .Xr XQueryFont 4
 155 specification.
 156 .Sh BUGS
 157 Currently the menu, invoked with M-p, depends on dmenu.
 158 .Sh AUTHORS
 159 .An -nosplit
 160 .Pp
 161 .Nm
 162 was written by
 163 .An Marco Peereboom Aq marco@peereboom.us
 164 and
 165 .An Ryan Thomas McBride Aq mcbride@countersiege.com .
 166 .Sh HISTORY
 167 .Nm
 168 was inspired by xmonad & dwm.
 169 .Pp
 170 .Nm
 171 first appeared in
 172 .Ox 4.5 .