summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLoui Chang <louipc.ist@gmail.com>2014-04-30 21:25:06 +0200
committerPhilippe Brochard <hocwp@free.fr>2014-04-30 21:25:06 +0200
commiteacce27c76eb16185ff263e5e2da164afa48aa9e (patch)
tree0798cc4ed03d134409510134c99ff97bb16468bd
parentded0a2dfbca66d41b6ba9f90593b813134e29786 (diff)
downloadxbindkeys-eacce27c76eb16185ff263e5e2da164afa48aa9e.tar.gz
xbindkeys.1: Edit man page for grammar and style
-rw-r--r--xbindkeys.173
1 files changed, 34 insertions, 39 deletions
diff --git a/xbindkeys.1 b/xbindkeys.1
index 243faa9..a329cae 100644
--- a/xbindkeys.1
+++ b/xbindkeys.1
@@ -1,4 +1,4 @@
-.TH XBindKeys 1 "Wed Apr 18 2007"
+.TH XBindKeys 1 "Tue Apr 19 2014"
.UC 1
.SH "NAME"
xbindkeys \- a grabbing keys program for X
@@ -6,8 +6,8 @@ xbindkeys \- a grabbing keys program for X
\fBxbindkeys\fP [ \fIoptions\fP ]
.br
.SH "DESCRIPTION"
-\fIXbindKeys\fP is a program that grab keys and mouse button events
-in X and starts associated shell command.
+\fIXbindKeys\fP is a program that grabs key and mouse button events
+in X and starts associated shell commands.
.LP
.SH "COMMAND LINE OPTIONS"
@@ -26,15 +26,15 @@ Short help on options plus version/author info.
Set X display to use
.TP
\fB-v, --verbose\fP
-More information on xbindkeys when it run
+More information on xbindkeys when it runs
.TP
\fB-k, --key\fP
-Identify one key pressed (useful to fill the configuration file)
+Identify one key pressed (useful for configuration)
.TP
\fB-mk, --multikey\fP
-Identify multi key pressed (useful to fill the configuration file)
+Identify multi key pressed (useful for configuration)
.TP
\fB-g, --geometry\fP
@@ -45,7 +45,7 @@ size and position of window with -k|-mk option
don't start as daemon
.LP
-If guile support have not been disabled:
+If guile support has not been disabled:
.TP
\fB-dg, --defaults-guile\fP
Print a default guile configuration file
@@ -55,25 +55,20 @@ Print a default guile configuration file
Use an alternative guile configuration file
.SH "XBINDKEYSRC"
-XBindKeys uses a configuration files.
-This file is $HOME/.xbindkeysrc, used only for one user.
-All whitespace is ignored in the files except for within
-the commands names double quotes.
+XBindKeys default configuration file is at $HOME/.xbindkeysrc,
+used only for one user.
.LP
-The configuration file consists of commands names in double quotes,
+The configuration file consists of commands in double quotes,
and associated keys in the next line.
.LP
Comments are started with a pound (#) and extend to the end of the line.
.LP
-You can see a default file with the --defaults option or create a default
-$HOME/.xbindkeysrc with
-.nf
- 'xbindkeys --defaults > $HOME/.xbindkeysrc'.
+You can see a default configuration with --defaults
.LP
.fi
.SH "KEYSYMS"
-The program expects combinations of keysyms to be used by using plus(+)
+The program expects combinations of keysyms to be used by using plus (+)
characters to combine them together.
.LP
The format of a command line is:
@@ -83,8 +78,8 @@ The format of a command line is:
associated key
.LP
.fi
-To specify an associated key, you can use 'xbindkeys --key' or
- 'xbindkeys --multikey' and put one of the two lines in the
+To specify an associated key, you can use `xbindkeys --key` or
+ `xbindkeys --multikey` and put one of the two lines in the
configuration file.
.LP
A list of keys is in /usr/include/X11/keysym.h and in
@@ -100,10 +95,11 @@ List of modifiers:
.fi
The release modifier is not a standard X modifier, but you can
use it if you want to catch release events instead of press events.
+Modifiers are not case sensitive.
.LP
-By defaults, xbindkeys does not pay attention with the modifiers
+By defaults, xbindkeys does not pay attention to the modifiers
NumLock, CapsLock and ScrollLock.
-Add the lines above in the configuration file, if you want to pay
+Add the lines below in the configuration file if you want to pay
attention to them.
.LP
keystate_numlock = enable
@@ -114,7 +110,7 @@ attention to them.
.SH "EXAMPLES"
.LP
-# control+shift+q starts an xterm (it's a comment)
+# control+shift+q starts xterm
.nf
"xterm"
.nf
@@ -126,7 +122,7 @@ attention to them.
.nf
Menu
.LP
-# Control + mouse button 1 starts an xterm
+# Control + mouse button 1 starts xterm
.nf
"xterm"
.nf
@@ -145,47 +141,45 @@ attention to them.
Control + b:2 + Release
.SH "SCHEME CONFIGURATION STYLE"
-If the guile support have not been disabled, you can use an alternate
-configuration file written in scheme. xbindkeys read first the scheme
-configuration file, and if this file doesn't exist, it read the
-standard configuration file.
+A scheme configuration can be used if guile support has not been disabled.
+The standard configuration is loaded only if the scheme configuration is not
+available.
.LP
For more details, please see here
.nf
http://www.gnu.org/software/guile/guile.html
.LP
-\fBNote: The guile configuration file is the prefered way if you have a non trivial
-configuration like for example double click, timed click or keys combinations.\fP
+\fBNote: The guile configuration file is prefered for non trivial
+configurations, for example double click, timed click or key combinations.\fP
.LP
-The defaults is ~/.xbindkeysrc.scm
+The default location is ~/.xbindkeysrc.scm
.LP
Use xbindkeys --defaults-guile for more details.
.LP
And xbindkeys --defaults-guile > ~/.xbindkeysrc.scm to use this method.
.SH "NOTE"
-xbindkeys reload its configuration file each time it has changed.
-But if you want to force it reloading its configuration file, you can
-send a HUP signal:
+xbindkeys reloads the configuration file if modified.
+Send a HUP signal to force reloading:
.LP
killall -HUP xbindkeys
.LP
-When HUP signal is send to xbindkeys, changes in $HOME/.xbindkeysrc
-takes effect only after moving mouse.
+When a HUP signal is sent to xbindkeys, changes take effect only after
+moving the mouse.
.SH "BUGS"
-If you find a bug, please send a mail to <hocwp@free.fr>
+If you find a bug, please send mail to <xbindkeys-devel@nongnu.org>
.LP
.SH "HOMEPAGE"
.nf
-http://hocwp.free.fr/xbindkeys
+http://www.nongnu.org/xbindkeys/
.fi
.LP
.SH "AUTHOR"
Philippe Brochard <hocwp@free.fr>
.nf
-Marcello Mathias Herreshoff for the guile support <marcello@hummer.stanford.edu>
+Marcello Mathias Herreshoff for guile support <marcello@hummer.stanford.edu>
.LP
.SH "FILES"
@@ -194,7 +188,8 @@ $HOME/.xbindkeysrc
The users configuration file.
.LP
$HOME/.xbindkeysrc.scm
- The users configuration file in scheme style (if guile support have not been disabled).
+ The users configuration file in scheme
+ (if guile support has not been disabled).
.fi
.LP