fixing mac os/x compile issue
[bbkeys.git] / doc / bbkeysrc.5
blob121c068c0398b2ca84dfd860d746da7a550a9881
1 .\"
2 .\" $Id$
3 .\"
4 .TH BBKEYSRC 5 "January 12, 2002" bbtools bbkeysrc
5 .SH NAME
6 bbkeysrc \- bbkeys keymap configuration file
8 .SH SYNOPSIS
9 .B $HOME/.bbkeysrc
11 .SH DESCRIPTION
13 \fBbbkeys\fR picks up its style-settings from the same places as the other
14 bbtools (such as \fIbbmail(1)\fR).  In most cases, this will be
15 \fI$HOME/.blackboxrc\fR. But its key-grabbings come from $HOME/.bbkeysrc.
16 There are several avenues open to the user to set any key-grabs that the user
17 wishes:
19 .SS "Using \fIbbconf\fR:"
20 This is a Qt-based application available at http://bbconf.sourceforge.net/.
22 .SS "Using \fIbbkeysconf\fR:"
23 This is a Qt-based application previously distributed with bbkeys. It has 
24 been superceded by \fIbbconf\fR, and no further development goes into it.
26 .SS "Without \fIbbkeysconf\fR:"
27 \fBbbkeys\fR can be launched with the \fI-noqt\fR option and whenever the
28 little reconfigure button (the key-hole) on \fBbbkeys\fR is clicked,
29 \fBbbkeys\fR will launch a very simple interactive rc-file generator, called
30 bbkeysconf.pl (written in perl) inside of an xterm.  If you choose not to
31 use the QT bbconf application, bbkeysconf.pl is the recommended way of
32 editting your keybinding rc-file.
34 .SS "Manually editing \fI$HOME/.bbkeysrc\fR:"
35 The format is very easy, and it consists of lines describing the Key to grab,
36 the modifier to grab the key with (if any, or "None" if none), and the action
37 to perform. For example:
39 KeyToGrab(Tab), WithModifier(Mod1), WithAction(NextWindow)
40 .br
41 KeyToGrab(t), WithModifier(Mod1), WithAction(ExecCommand),
42                                            DoThis(xterm)
44 .SH "List of commands"
46 BigNudgeDown
47 .br
48 BigNudgeLeft
49 .br
50 BigNudgeRight
51 .br
52 BigNudgeUp
53 .br
54 Close
55 .br
56 ExecCommand
57 .br
58 HorizontalDecrement
59 .br
60 HorizontalIncrement
61 .br
62 Lower
63 .br
64 MaximizeHorizontal
65 .br
66 MaximizeVertical
67 .br
68 MaximizeWindow
69 .br
70 Minimize
71 .br
72 NextWindow
73 .br
74 NextWindowAllWorkspaces
75 .br
76 NextWorkspace
77 .br
78 NudgeDown
79 .br
80 NudgeLeft
81 .br
82 NudgeUp
83 .br
84 NudgeRight
85 .br
86 PrevWindow
87 .br
88 PrevWorkspace
89 .br
90 Raise
91 .br
92 ShadeWindow
93 .br
94 StickWindow
95 .br
96 ToggleDecor
97 .br
98 Workspace1
99 .br
100 Workspace2
102 Workspace3
104 Workspace4
106 Workspace5
108 Workspace6
110 Workspace7
112 Workspace8
114 Workspace9
116 Workspace10
118 Workspace11
120 Workspace12
122 VerticalIncrement
124 VerticalDecrement
127 .SH "SEE ALSO"
128 .BR bbkeys(1),
129 .BR bbkeys.bb(5)
131 .SH AUTHOR
133 Jason 'vanRijn' Kasper <vR@movingparts.net> - bbkeys
135 Jan Schaumann <jschauma@netmeister.org> - this man page