doc/bbkeys.1.in

   1 .\"
   2 .\" $Id$
   3 .\"
   4 .TH BBKEYS 1 "January 12, 2002" "bbtools" bbkeys
   5 .SH NAME
   6 bbkeys \- a general XWindow keygrabber
   7
   8 .SH SYNOPSIS
   9 .B bbkeys
  10 [\fIOPTION\fR]
  11
  12 .SH DESCRIPTION
  13 \fBbbkeys\fR is the keygrabber for the blackbox window manager. \fBbbkeys\fR
  14 handles all keybindings and keyboard shortcuts for  blackbox. It uses
  15 blackbox's Image classes for rendering its look and feel so that \fBbbkeys\fR
  16 will render itself to match whatever blackbox style is used. It is highly
  17 configurable either via the \fIbbconf\fR GUI utility or the (now deprecated)
  18 \fIbbkeysconf\fR GUI utility or by hand-editting bbkeys's config file.
  19
  20 .SH USAGE
  21 On startup, \fBbbkeys\fR reads \fI$HOME/.bbkeysrc\fR, which you can edit by
  22 hand or through \fIbbconf\fR or \fIbbkeysconf\fR. This is now configurable
  23 through a command-line switch as show in OPTIONS.
  24
  25 .SH OPTIONS
  26 A summary of the options supported by \fBbbkeys\fR is included below.
  27
  28 .TP
  29 \fB\-c[onfig]\fR \fIfilename\fR
  30 use alternate 'look and feel' config file
  31 .TP
  32 \fB\-rc[file]\fR \fIfilename\fR
  33 use alternate keygrab definition file.  (default is ~/.bbkeysrc)
  34 .TP
  35 \fB\-d[ecorated]\fR
  36 show 'normal' decorated window
  37 .TP
  38 \fB\-display\fR \fIdisplay name\fR
  39 X server to connect to
  40 .TP
  41 \fB\-geom[etry]\fR \fIgeometry\fR
  42 set geometry of the bbkeys window
  43 .TP
  44 \fB\-h[elp]\fR
  45 show summary of options and exit
  46 .TP
  47 \fB\-i[conic]\fR
  48 start bbkeys in a minimized state (will override the -withdrawn option)
  49 .TP
  50 \fB\-m[iniMe]\fR
  51 like Austin Powers 2. bbkeys, but smaller
  52 .TP
  53 \fB\-n[obb]\fR
  54 fall back on default configuration
  55 .TP
  56 \fB\-no[qt]\fR
  57 use non-qt configuration tool
  58 .TP
  59 \fB\-s[hape]\fR
  60 don't display groundplate
  61 .TP
  62 \fB\-t[inyMe]\fR
  63 all you can see is its keyhole
  64 .TP
  65 \fB\-v[ersion]\fR
  66 display version number and exit
  67 .TP
  68 \fB\-w[ithdrawn]\fR
  69 place bbkeys in the Slit
  70
  71 .SH FILES
  72 .nr
  73 Default: \fI$datadir=/usr/local/share/\fR
  74 .br
  75 \fI$HOME/.bbkeysrc\fR maintains keybindings
  76 .br
  77 See \fIbbkeysrc(5)\fR
  78 .SS "Under Blackbox"
  79 .nf
  80 \fI$datadir/bbtools/bbkeys.bb\fR the global style configuration file
  81 \fI$HOME/.bbtools/bbkeys.bb\fR a local style configuration file
  82
  83 .SS "Under other Window managers"
  84 .nf
  85 \fI$datadir/bbtools/bbkeys.nobb\fR the global style configuration file
  86 \fI$HOME/.bbtools/bbkeys.nobb\fR a local style configuration file
  87
  88 .SH VERSION
  89 @VERSION@
  90
  91 .SH BUGS
  92 This application is perfect and should solve all of your problems,  up to and
  93 including male pattern baldness and world hunger. Should you, against all
  94 odds, find any bugs, please report them to the author.
  95
  96
  97 .SH "SEE ALSO"
  98 .BR bbkeysrc(5),
  99 .BR bbkeys.bb(5)
 100
 101 .SH AUTHOR
 102 .nr
 103 Jason 'vanRijn' Kasper <vR@movingparts.net> - bbkeys
 104 .br
 105 Jan Schaumann <jschauma@netmeister.org> - this man page