[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Bug#31396: xbase-clients: no manpages for xkbbell, xkbvleds, xkbwatch



On Thu, Jul 24, 2003 at 13:45:20 -0500, Branden Robinson wrote:

> On Sun, Jul 13, 2003 at 02:00:40PM -0500, Kevin Kreamer wrote:
> > Attached is a man page for xkbbell.  Any feedback you could give
> > would help me improve this man page and help me in writing ones for
> > xkbvleds and xkbwatch.
> 
> It looks pretty good, except for the fact that it's written in
> post-processed format.  I also feel that the licensing statement is too
> vague; it's probably better to put the manpage under an explicit MIT/X
> Consortium-style license.
> 
> However, I can't fault the technical content, so with a little massage
> from a nitpicky person like me, it should be good for an upstream patch.
> 
Hi Branden and Kevin,

I just took Kevin's manpage with a few modifications, and consider
adding it to our xbase-clients package.  I attach it to this message,
and would love to have some comments from Branden about it (if you have
the time to look at it, obviously). :)

Cheers,
Julien
.\" xkbbell.1
.\" Copyright (c) 2003  Kevin Kreamer
.\" 
.\" 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 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" 1 "Release 6.6" "X Version 11"
.SH NAME
xkbbell \- Raise an XKB bell event
.SH SYNOPSIS
.B xkbbell
.RI [ options ...]
.RI [ name ]
.SH DESCRIPTION
.B xkbbell
is an XKB utility program that raises a bell event.
It is useful primarily for debugging the current XKB configuration.
.SH OPTIONS
.TP
.BR \-help ", " \-usage
Print a helpful list of options.
.TP
.BI \-display " dpy"
Specify which display to use.
By default,
.B xkbbell
uses the value of the
.B DISPLAY
environment variable.
.TP
.B \-synch
Turn on synchronization.
The default is to not synchronize.
.TP
.BI \-dev " id"
Specify which device to use. 
.TP
.B \-force
Force an audible bell.
If this option is used,
.I name
is ignored.
.TP
.B \-nobeep
Suppress the server bell; only raise the event.
.TP
.BI \-bf " id"
Specify the bell feedback to use.
.TP
.BI \-kf " id"
Specify the keyboard feedback to use.
.TP
.BI \-v " volume"
Specify the volume to use.
.I volume
may range from \-100 to 100, and defaults to 0.
.TP
.BI \-w " id"
Specify which window to use.
.P
If neither the device nor any feedback options are specified,
.B xkbbell
uses the default values for the core keyboard device.
.SH "ENVIRONMENT VARIABLES"
.TP
.B DISPLAY
This variable is read to determine to which display clients should connect.
.SH "SEE ALSO"
.BR X "(7), " xkbcomp (1).

Attachment: signature.asc
Description: Digital signature


Reply to: