From 7fa628b28be06ba387faae712c616ebcd5306e57 Mon Sep 17 00:00:00 2001 From: Alan Coopersmith Date: Mon, 18 Aug 2008 15:52:15 -0700 Subject: Add rudimentary man pages for xkbbell, xkbvleds, xkbwatch We've been shipping these in Solaris for years, but they still need work - it's a starting point though. --- Makefile.am | 32 ++++++++++++++++++++++- configure.ac | 1 + xkbbell.man | 82 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ xkbvleds.man | 84 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ xkbwatch.man | 33 ++++++++++++++++++++++++ 5 files changed, 231 insertions(+), 1 deletion(-) create mode 100644 xkbbell.man create mode 100644 xkbvleds.man create mode 100644 xkbwatch.man diff --git a/Makefile.am b/Makefile.am index 8dacbc9..9d1a3cf 100644 --- a/Makefile.am +++ b/Makefile.am @@ -41,9 +41,39 @@ xkbwatch_SOURCES = xkbwatch.c LED.c LED.h LEDP.h utils.c utils.h xkbwatch_CFLAGS = $(XKBWATCH_CFLAGS) xkbwatch_LDADD = $(XKBWATCH_LIBS) -EXTRA_DIST = ChangeLog +# Man pages +appman_PRE = xkbbell.man xkbvleds.man xkbwatch.man + +appmandir = $(APP_MAN_DIR) + +appman_DATA = $(appman_PRE:man=@APP_MAN_SUFFIX@) + +EXTRA_DIST = $(appman_PRE) ChangeLog +CLEANFILES = $(appman_DATA) MAINTAINERCLEANFILES = ChangeLog +# Strings to replace in man pages +XORGRELSTRING = @PACKAGE_STRING@ + XORGMANNAME = X Version 11 + +MAN_SUBSTS = \ + -e 's|__vendorversion__|"$(XORGRELSTRING)" "$(XORGMANNAME)"|' \ + -e 's|__xorgversion__|"$(XORGRELSTRING)" "$(XORGMANNAME)"|' \ + -e 's|__xservername__|Xorg|g' \ + -e 's|__xconfigfile__|xorg.conf|g' \ + -e 's|__projectroot__|$(prefix)|g' \ + -e 's|__apploaddir__|$(appdefaultdir)|' \ + -e 's|__appmansuffix__|$(APP_MAN_SUFFIX)|g' \ + -e 's|__libmansuffix__|$(LIB_MAN_SUFFIX)|g' \ + -e 's|__adminmansuffix__|$(ADMIN_MAN_SUFFIX)|g' \ + -e 's|__miscmansuffix__|$(MISC_MAN_SUFFIX)|g' \ + -e 's|__filemansuffix__|$(FILE_MAN_SUFFIX)|g' + +SUFFIXES = .$(APP_MAN_SUFFIX) .man + +.man.$(APP_MAN_SUFFIX): + sed $(MAN_SUBSTS) < $< > $@ + .PHONY: ChangeLog ChangeLog: diff --git a/configure.ac b/configure.ac index 0402a06..7a2a50e 100644 --- a/configure.ac +++ b/configure.ac @@ -46,6 +46,7 @@ XAW_CHECK_XPRINT_SUPPORT(XKBWATCH) AC_SUBST(XKBWATCH_CFLAGS) AC_SUBST(XKBWATCH_LIBS) +XORG_MANPAGE_SECTIONS XORG_RELEASE_VERSION AC_OUTPUT([Makefile]) diff --git a/xkbbell.man b/xkbbell.man new file mode 100644 index 0000000..c179ed8 --- /dev/null +++ b/xkbbell.man @@ -0,0 +1,82 @@ +.\" Copyright 2008 Sun Microsystems, Inc. All rights reserved. +.\" Use subject to license terms. +.\" +.\" 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, and/or sell copies of the Software, and to permit persons +.\" to whom the Software is furnished to do so, provided that the above +.\" copyright notice(s) and this permission notice appear in all copies of +.\" the Software and that both the above copyright notice(s) and this +.\" permission notice appear in supporting documentation. +.\" +.\" 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 +.\" OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR +.\" HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL +.\" INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING +.\" FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, +.\" NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION +.\" WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.\" Except as contained in this notice, the name of a copyright holder +.\" shall not be used in advertising or otherwise to promote the sale, use +.\" or other dealings in this Software without prior written authorization +.\" of the copyright holder. +.TH xkbbell __appmansuffix__ __xorgversion__ +.SH NAME +xkbbell - XKB extension user utility +.SH SYNOPSIS +.B xkbbell +[-display ] +[-synch] +[-dev ] +[-force] +[-nobeep] +[-bf ] +[-kf ] +[-v ] +[-w ] +.SH DESCRIPTION +user utility +.SH OPTIONS +.PP +.TP 8 +.B \-display +specifies which display to use +.TP 8 +.B \-synch +turns on synchronization +.PP +.TP 8 +.B \-dev +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 +specifies which bell feedback to use +.PP +.TP 8 +.B \-kf +specifies which keyboard feedback to use +.PP +.TP 8 +.B \-v +specifies which volume to use +.PP +.TP 8 +.B \-w +specifies which window to use +.PP +If neither device nor feedback are specified, xkbbell uses the default values +for the core keyboard device. diff --git a/xkbvleds.man b/xkbvleds.man new file mode 100644 index 0000000..056d0d3 --- /dev/null +++ b/xkbvleds.man @@ -0,0 +1,84 @@ +.\" Copyright 2008 Sun Microsystems, Inc. All rights reserved. +.\" Use subject to license terms. +.\" +.\" 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, and/or sell copies of the Software, and to permit persons +.\" to whom the Software is furnished to do so, provided that the above +.\" copyright notice(s) and this permission notice appear in all copies of +.\" the Software and that both the above copyright notice(s) and this +.\" permission notice appear in supporting documentation. +.\" +.\" 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 +.\" OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR +.\" HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL +.\" INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING +.\" FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, +.\" NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION +.\" WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.\" Except as contained in this notice, the name of a copyright holder +.\" shall not be used in advertising or otherwise to promote the sale, use +.\" or other dealings in this Software without prior written authorization +.\" of the copyright holder. +.TH xkbvleds __appmansuffix__ __xorgversion__ +.SH NAME +xkbvleds \- XKB extension user utility +.SH SYNOPSIS +.B xkbvleds +[\-indpy ] +[\-watch ] +[[\-+]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 +Mask of LEDs to watch +.TP 8 +.B \-watch +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 + + diff --git a/xkbwatch.man b/xkbwatch.man new file mode 100644 index 0000000..6d86af3 --- /dev/null +++ b/xkbwatch.man @@ -0,0 +1,33 @@ +.\" Copyright 2008 Sun Microsystems, Inc. All rights reserved. +.\" Use subject to license terms. +.\" +.\" 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, and/or sell copies of the Software, and to permit persons +.\" to whom the Software is furnished to do so, provided that the above +.\" copyright notice(s) and this permission notice appear in all copies of +.\" the Software and that both the above copyright notice(s) and this +.\" permission notice appear in supporting documentation. +.\" +.\" 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 +.\" OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR +.\" HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL +.\" INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING +.\" FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, +.\" NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION +.\" WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.\" Except as contained in this notice, the name of a copyright holder +.\" shall not be used in advertising or otherwise to promote the sale, use +.\" or other dealings in this Software without prior written authorization +.\" of the copyright holder. +.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. -- cgit v1.2.3