JasonWoof Got questions, comments, patches, etc.? Contact Jason Woofenden
Add rudimentary man with the key bindings.
[spectrwm.git] / 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 is a 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 .El
44 .Pp
45 .Nm
46 is very simple in its use.
47 Most of the actions are initiated via keybindings.
48 The current keybindings are described below:
49 .Pp
50 .Bl -tag -width "C-M-EscapeXXX" -offset indent -compact
51 .It Ic M-S-[Return]
52 Spawn a new terminal.
53 .It Ic M-p
54 Menu.
55 .It Ic M-S-q
56 Quit.
57 .It Ic M-q
58 Restart
59 .Nm .
60 .It Ic M-[Space]
61 Cycle layout.
62 .It Ic M-S-[Space]
63 Reset layout.
64 .It Ic M-h
65 Shrink master area.
66 .It Ic M-l
67 Grow master area.
68 .It Ic M-,
69 Add windows to master area.
70 .It Ic M-.
71 Remove windows from master area.
72 .It Ic M-[Return]
73 Move current window to master area.
74 .It Ic M-j
75 Focus next window in workspace.
76 .It Ic M-[Tab]
77 Focus next window in workspace.
78 .It Ic M-k
79 Focus previous window in workspace.
80 .It Ic M-S-[Tab]
81 Focus previous window in workspace.
82 .It Ic M-m
83 Focus on main window in workspace.
84 .It Ic M-S-j
85 Swap with next window in workspace.
86 .It Ic M-S-k
87 Swap with previous window in workspace.
88 .It Ic M-b
89 Toggle status bar in all workspaces.
90 .It Ic M-S-x
91 Destroy current window in workspace.
92 .It Ic M-[Number]
93 Switch to workspace [Number].
94 .It Ic M-S-[Number]
95 Move current window to workspace [Number].
96 .It Ic M-[RighArrow]
97 Switch to next workspace with a window in it.
98 .It Ic M-[LeftArrow]
99 Switch to previous workspace with a window in it.
100 .El
101 .Pp
102 .Pp
103 .Sh FILES
104 .Bl -tag -width Ds
105 .It Pa ~/.scrotwm.conf
106 .It Pa /etc/scrotwm.conf
107 .El
108 .Sh AUTHORS
109 .An -nosplit
110 .Pp
111 .Nm
112 was written by
113 .An Marco Peereboom Aq marco@peereboom.us
114 and
115 .An Ryan Thomas McBride Aq mcbride@countersiege.com .
116 .Sh HISTORY
117 .Nm
118 was inspired by xmonad & dwm.
119 .Pp
120 .Nm
121 first appeared in
122 .Ox 4.5 .