wmbutton/wmbutton.1

   1 .\"                                      Hey, EMACS: -*- nroff -*-
   2 .\" First parameter, NAME, should be all caps
   3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
   4 .\" other parameters are allowed: see man(7), man(1)
   5 .TH WMBUTTON 1 "August 20, 2012"
   6 .\" Please adjust this date whenever revising the manpage.
   7 .\"
   8 .\" Some roff macros, for reference:
   9 .\" .nh        disable hyphenation
  10 .\" .hy        enable hyphenation
  11 .\" .ad l      left justify
  12 .\" .ad b      justify to both left and right margins
  13 .\" .nf        disable filling
  14 .\" .fi        enable filling
  15 .\" .br        insert line break
  16 .\" .sp <n>    insert n+1 empty lines
  17 .\" for manpage-specific macros, see man(7)
  18 .SH NAME
  19 wmbutton \- dockable launcher application
  20 .SH SYNOPSIS
  21 .B wmbutton
  22 .\"[-g \fIgeometry\fP] [-d \fIdisplay\fP] [-v] [-f \fIconfigfile\fP] [-h]
  23 [\fIOPTIONS\fP]
  24
  25 .SH DESCRIPTION
  26 This manual page documents briefly the
  27 .B wmbutton
  28 command.
  29 .PP
  30 .\" TeX users may be more comfortable with the \fB<whatever>\fP and
  31 .\" \fI<whatever>\fP escape sequences to invode bold face and italics,
  32 .\" respectively.
  33 \fBwmbutton\fP is a 64x64 pixel application that displays nine buttons and can be used as dockapp for X window managers such as Window Maker, AfterStep, BlackBox, and Enlightenment. Each of these buttons can be configured via a configuration file to run just about any application you would like to. Basically, if you can type it in a shell command, wmbutton can run it.
  34
  35 .PP
  36 \fBwmbutton\fP is configured using a configuration file, ~/.wmbutton (or /etc/wmbutton.conf). Its format is documented in the "Configuration" section below.
  37 .SH OPTIONS
  38 .TP
  39 .B \-g <geometry>
  40 Window Geometry - ie: 64x64+10+10
  41 .TP
  42 .B \-d  <display>
  43 Display -  ie: 127.0.0.1:0.0
  44 .TP
  45 .B \-f  <filename>
  46 Full path to configuration file.
  47 .TP
  48 .B \-b  <filename>
  49 Full path to button xpm.
  50 .TP
  51 .B \-F  <font>
  52 Custom tooltip font (e.g. \-b\&h\-lucidatypewriter\-medium\-*\-*\-*\-12\-*)
  53 .TP
  54 .B \-v
  55 Verbose Mode, gives extra debug output.
  56 .TP
  57 .B \-h
  58 Quick overview of available options.
  59 .TP
  60 .B \-m
  61 Disable Middle Mouse functionality.
  62 .TP
  63 .B \-s
  64 Swap tooltip colors.
  65 .TP
  66 .B \-n
  67 Turn off tooltips.
  68
  69 .SH CONFIGURATION
  70 .TP
  71 The configuration file is case sensitive. A # starts a comment, and lines consisting entirely of whitespace are ignored. The syntax is simply:
  72 .TP
  73 .B <buttonnumber> <command>
  74 .TP
  75 \fBcommand\fP can be anything you can type in as a shell command.
  76 .TP
  77 Buttons are numbered as follows:
  78 .TP
  79 .B Left button
  80 .nf
  81         1 2 3
  82         4 5 6
  83         7 8 9
  84 .fi
  85 .TP
  86 .B Middle button
  87 .nf
  88         11 12 13
  89         14 15 16
  90         17 18 19
  91 .fi
  92 .TP
  93 .B Right button
  94 .nf
  95         21 22 23
  96         24 25 26
  97         27 28 29
  98 .fi
  99
 100 .TP
 101 To use other icons, wmbutton has to be rebuilt. View /usr/share/doc/wmbutton/README.Debian for further information.
 102
 103 .SH FILES
 104 .TP
 105 .I /etc/wmbutton.conf
 106 system wide wmbutton configuration file.
 107 .TP
 108 .I ~/.wmbutton
 109 per user wmbutton configuration file. If it doesn't exist, the system wide wmbutton configuration file will be used.
 110
 111
 112 .SH AUTHOR
 113 wmbutton was written by Edward H. Flora <ehflora@access1.net>, and is licensed under the terms of the GNU  General Public License.
 114 .TP
 115 This manual page was originaly written by Gordon Fraser <gordon@debian.org>, for the Debian GNU/Linux system (but may be used by others). It was updated by Christian Aichinger <Greek0@gmx.net> and Rodolfo García Peñas (kix) <kix@kix.es>.