.TH XKBIND 1 "Feb 2011" "Version 2010.05.20"
.SH NAME
xkbind - X Keyboard Extension Indicator for the X Window System
.SH SYNOPSIS
.nh
.B "xkbind -help"
.br
.B "xkbind -version"
.br
.B "xkbind [-display \fIdisplayname\fP] [-force] [-nodetach] [-defgrp \fIgroup\fP] [-deflbl \fIlabel\fP] [-label0 \fIlabel\fP] [-label1 \fIlabel\fP] [-label2 \fIlabel\fP] [-label3 \fIlabel\fP] [-iname \fI<name list>\fP] [-iclass \fI<class list>\fP] [-ireverse] [-inowild]"
.hy
.SH DESCRIPTION
The \fIxkbind\fP program
(X Keyboard Extension Indicator)
is a small and light indicator
of keyboard layout (XKB group)
for  the X Window System;
it shows current keyboard layout
in titles of top-level windows.
\fIxkbind\fP allows to simulate
separate keyboard layout
for each handled window
and it works with most of window managers.
.P
\fIxkbind\fP exits 0 on success,
and greater than 0 if an error occurs.
.SH OPTIONS
\fIxkbind\fP accepts a number options
most of which can be specified
either on the command line,
in the user's $HOME/.xkbindrc,
$HOME/.Xdefaults (or $HOME/.Xresources),
or in the system-wide configuration file.
Description of all the acceptable options
is given below.
The command line option is specified first
with correspondent X resource name (if any)
in parenthesis afteward.
Options specified on the command line
have the highest priority.
The \-version and \-help options interpreted
even if \fIxkbind\fP can not open the display.
.TP
.B \-help
Print a short help message to stderr and exit.
.TP
.B \-version
Print a version number of \fIxkbind\fP to stderr and exit.
.TP
.B \-force
Do not allow \fIxkbind\fP automatically check
existence of its own copy
already running on the specified X server.
.TP
.B \-nodetach
Do not detach as a background process.
.TP
.B \-display \fIdisplayname\fP (display)
The X server to use.
This option overrides the contents
of DISPLAY environment variable.
.TP
.B \-defgrp \fIgroup\fP (defgroup)
Group number that \fIxkbind\fP initially
binds to each handled window.
.TP
.B \-deflbl \fIlabel\fP (label.default)
The default value for options \fBlabel.group[0-3]\fP.
.TP
.B \-label[0-3] \fIlabel\fP (label.group[0-3])
A label string for the specified keyboard group.
.TP
.B \-iname \fI<name list>\fP (ignore.name)
Space- or tab-separated list of window names
(WM_CLASS(res_name) property) that should
be ignored by \fIxkbind\fP.
.TP
.B \-iclass \fI<class list>\fP (ignore.class)
Space- or tab-separated list of window classes
(WM_CLASS(res_class) property) that should
be ignored by \fIxkbind\fP.
.TP
.B \-reverse (ignore.reverse)
Indicates that the "ignore list"
in options \fBignore.name\fP and \fBignore.class\fP
should be interpreted as "accept list"
.TP
.B \-nowild (ignore.usewild)
Disable pattern matching while searching in window lists.
.SH RESOURCES
The format of the option in the X resources files
is "Xkbind.option: value",
where the option name is the one specified below.
.TP
.B display
The X server to use.
The default is the contents
of environment variable DISPLAY.
.TP
.B defgroup
Group number that \fIxkbind\fP initially
binds to each handled window.
The default is the current group when
the program starts.
.TP
.B label.default
The default value for options \fBlabel.group[0-3]\fP.
It defaults itself to the empty string.
.TP
.B label.group[0-3]
A label string for the specified keyboard group.
The default is the value of \fIlabel.default\fP option.
.TP
.B ignore.name
Space- or tab-separated list
of window names (WM_CLASS(res_name) property)
that should be ignored by \fIxkbind\fP.
.TP
.B ignore.class
Space- or tab-separated list
of window classes (WM_CLASS(res_class) property)
that should be ignored by \fIxkbind\fP.
.TP
.B ignore.reverse
Specifies whether or not an "ignore list"
in options \fBignore.name\fP and \fBignore.class\fP
should be interpreted as an "accept list".
The default is "False".
.TP
.B ignore.usewild
Specifies whether or not
symbols '*', '?' and '\\'
in the name and class lists
should be interpreted in the special way
(like in the shell pattern matching).
The default is "True".
.SH SIGNALS
.TP
.B SIGALRM
.TP
.B SIGVTALRM
.TP
.B SIGHUP
.TP
.B SIGPROF
\fIxkbind\fP ignores these signals.
.TP
.B SIGINT
.TP
.B SIGTERM
.TP
.B SIGABRT
\fIxkbind\fP performs cleanup and normal exit.
.SH ENVIRONMENT
.TP
.B DISPLAY
Default host and display number.
.SH FILES
\fIxkbind\fP reads configuration options from
the following files in the order of priority:
.TP
.B $HOME/.xkbindrc
User's private configuration file.
.TP
.B $HOME/.Xresources or $HOME/.Xdefaults
User's X defaults file.
.TP
.B /etc/local/lib/xkbind/app-defaults/Xkbind
System-wide X defaults file.
The actual pathname may differ on your system.
.SH BUGS
Compount text encoding of international characters
in label strings is not implemented.
.SH AUTHORS
Copyright (C) 2004 CHG

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA