summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
Diffstat (limited to 'man')
-rw-r--r--man/Makefile.am12
-rw-r--r--man/xkbbell.man84
-rw-r--r--man/xkbvleds.man83
-rw-r--r--man/xkbwatch.man36
4 files changed, 215 insertions, 0 deletions
diff --git a/man/Makefile.am b/man/Makefile.am
new file mode 100644
index 0000000..4b92e08
--- /dev/null
+++ b/man/Makefile.am
@@ -0,0 +1,12 @@
+
+appmandir = $(APP_MAN_DIR)
+appman_PRE = xkbbell.man xkbvleds.man xkbwatch.man
+appman_DATA = $(appman_PRE:man=$(APP_MAN_SUFFIX))
+
+EXTRA_DIST = $(appman_PRE)
+CLEANFILES = $(appman_DATA)
+SUFFIXES = .$(APP_MAN_SUFFIX) .man
+
+# String replacements in MAN_SUBSTS now come from xorg-macros.m4 via configure
+.man.$(APP_MAN_SUFFIX):
+ $(AM_V_GEN)$(SED) $(MAN_SUBSTS) < $< > $@
diff --git a/man/xkbbell.man b/man/xkbbell.man
new file mode 100644
index 0000000..9a9ba5f
--- /dev/null
+++ b/man/xkbbell.man
@@ -0,0 +1,84 @@
+.\" Copyright (c) 2008, Oracle and/or its affiliates. All rights reserved.
+.\"
+.\" Permission is hereby granted, free of charge, to any person obtaining a
+.\" copy of this software and associated documentation files (the "Software"),
+.\" to deal in the Software without restriction, including without limitation
+.\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
+.\" and/or sell copies of the Software, and to permit persons to whom the
+.\" Software is furnished to do so, subject to the following conditions:
+.\"
+.\" The above copyright notice and this permission notice (including the next
+.\" paragraph) shall be included in all copies or substantial portions of the
+.\" Software.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+.\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+.\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+.\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+.\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+.\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+.\" DEALINGS IN THE SOFTWARE.
+.TH xkbbell __appmansuffix__ __xorgversion__
+.SH NAME
+xkbbell - XKB extension user utility
+.SH SYNOPSIS
+.B xkbbell
+[-display <dpy>]
+[-synch]
+[-dev <id>]
+[-force]
+[-nobeep]
+[-bf <id>]
+[-kf <id>]
+[-v <volume>]
+[-w <id>]
+[-help|-version]
+.SH DESCRIPTION
+user utility
+.SH OPTIONS
+.PP
+.TP 8
+.B \-display <dpy>
+specifies which display to use
+.TP 8
+.B \-synch
+turns on synchronization
+.PP
+.TP 8
+.B \-dev <id>
+specifies which device to use
+.PP
+.TP 8
+.B \-force
+force audible bell
+.PP
+.TP 8
+.B \-nobeep
+suppress server bell, event only
+.PP
+.TP 8
+.B \-bf <id>
+specifies which bell feedback to use
+.PP
+.TP 8
+.B \-kf <id>
+specifies which keyboard feedback to use
+.PP
+.TP 8
+.B \-v <volume>
+specifies which volume to use
+.PP
+.TP 8
+.B \-w <id>
+specifies which window to use
+.PP
+.TP 8
+.B \-help
+print list of options and exit
+.PP
+.TP 8
+.B \-version
+print program version and exit
+.PP
+If neither device nor feedback are specified, xkbbell uses the default values
+for the core keyboard device.
diff --git a/man/xkbvleds.man b/man/xkbvleds.man
new file mode 100644
index 0000000..65a8160
--- /dev/null
+++ b/man/xkbvleds.man
@@ -0,0 +1,83 @@
+.\" Copyright (c) 2008, Oracle and/or its affiliates. All rights reserved.
+.\"
+.\" Permission is hereby granted, free of charge, to any person obtaining a
+.\" copy of this software and associated documentation files (the "Software"),
+.\" to deal in the Software without restriction, including without limitation
+.\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
+.\" and/or sell copies of the Software, and to permit persons to whom the
+.\" Software is furnished to do so, subject to the following conditions:
+.\"
+.\" The above copyright notice and this permission notice (including the next
+.\" paragraph) shall be included in all copies or substantial portions of the
+.\" Software.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+.\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+.\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+.\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+.\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+.\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+.\" DEALINGS IN THE SOFTWARE.
+.TH xkbvleds __appmansuffix__ __xorgversion__
+.SH NAME
+xkbvleds \- XKB extension user utility
+.SH SYNOPSIS
+.B xkbvleds
+[\-indpy <name>]
+[\-watch <leds>]
+[[\-+]automatic]
+[[\-+]explicit]
+[[\-+]name]
+[[\-+]real]
+[[\-+]virtual]
+[\-intersection]
+[\-union]
+.SH DESCRIPTION
+This program is used to display the state of LEDs on an XKB keyboard.
+It reports the changes in the fundamental components of the XKB state
+which includes the effective compatibility state. The default set of LEDs
+is \-union +name +automatic +real.
+.SH OPTIONS
+.PP
+.TP 8
+.B \-indpy <name>
+Mask of LEDs to watch
+.TP 8
+.B \-watch <leds>
+turn on synchronization
+.PP
+.TP 8
+.B \[-+]automatic
+(Don't) watch automatic LEDs
+.PP
+.TP 8
+.B \[-+]explicit
+(Don't) watch explicit LEDs
+.PP
+.TP 8
+.B \[-+]name
+(Don't) watch named LEDs
+.PP
+.TP 8
+.B \[-+]real
+(Don't) watch real LEDs
+.PP
+.TP 8
+.B \[-+]virtual
+(Don't) watch virtual LEDs
+.PP
+.TP 8
+.B \-intersection
+Watch only LEDs in all desired sets
+.PP
+.TP 8
+.B \-union
+Watch LEDs in any desired sets
+.PP
+.TP 8
+.B \-help
+print list of options and exit
+.PP
+.TP 8
+.B \-version
+print program version and exit
diff --git a/man/xkbwatch.man b/man/xkbwatch.man
new file mode 100644
index 0000000..4655f02
--- /dev/null
+++ b/man/xkbwatch.man
@@ -0,0 +1,36 @@
+.\" Copyright (c) 2008, Oracle and/or its affiliates. All rights reserved.
+.\"
+.\" Permission is hereby granted, free of charge, to any person obtaining a
+.\" copy of this software and associated documentation files (the "Software"),
+.\" to deal in the Software without restriction, including without limitation
+.\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
+.\" and/or sell copies of the Software, and to permit persons to whom the
+.\" Software is furnished to do so, subject to the following conditions:
+.\"
+.\" The above copyright notice and this permission notice (including the next
+.\" paragraph) shall be included in all copies or substantial portions of the
+.\" Software.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+.\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+.\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+.\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+.\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+.\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+.\" DEALINGS IN THE SOFTWARE.
+.TH xkbwatch __appmansuffix__ __xorgversion__
+.SH NAME
+xkbwatch - XKB extension user utility
+.SH DESCRIPTION
+This program reports changes in the fundamental components of the XKB keyboard
+state plus the effective compatibility state.
+.SH OPTIONS
+.I Xkbwatch
+accepts all of the standard X Toolkit command line options along with the
+additional options listed below:
+.TP 8
+.B \-version
+This option indicates that the program version should be printed, after
+which the program exits.
+.SH "SEE ALSO"
+X(__miscmansuffix__)