diff options
Diffstat (limited to 'usr.bin/usbhidaction/usbhidaction.1')
| -rw-r--r-- | usr.bin/usbhidaction/usbhidaction.1 | 154 |
1 files changed, 154 insertions, 0 deletions
diff --git a/usr.bin/usbhidaction/usbhidaction.1 b/usr.bin/usbhidaction/usbhidaction.1 new file mode 100644 index 0000000..b0b491e --- /dev/null +++ b/usr.bin/usbhidaction/usbhidaction.1 @@ -0,0 +1,154 @@ +.\" $FreeBSD$ +.\" $NetBSD: usbhidaction.1,v 1.8 2003/02/25 10:35:59 wiz Exp $ +.\" +.\" Copyright (c) 2000 The NetBSD Foundation, Inc. +.\" All rights reserved. +.\" +.\" This code is derived from software contributed to The NetBSD Foundation +.\" by Lennart Augustsson (lennart@augustsson.net). +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed by the NetBSD +.\" Foundation, Inc. and its contributors. +.\" 4. Neither the name of The NetBSD Foundation nor the names of its +.\" contributors may be used to endorse or promote products derived +.\" from this software without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS +.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED +.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS +.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.Dd April 9, 2003 +.Dt USBHIDACTION 1 +.Os +.Sh NAME +.Nm usbhidaction +.Nd perform actions according to USB HID controls +.Sh SYNOPSIS +.Nm +.Fl c Ar config-file +.Op Fl d +.Op Fl i +.Fl f Ar device +.Op Fl p Ar pidfile +.Op Fl v +.Ar arg ... +.Sh DESCRIPTION +.Nm +can be used to execute commands when certain values appear on HID controls. +The normal operation for this program is to read the configuration file +and then become a daemon and execute commands as the HID items specify. +If a read from the HID device fails the program dies; this will make it +die when the USB device is unplugged. +.Pp +The options are as follows: +.Bl -tag -width Ds +.It Fl c Ar config-file +Specify a path name for the config file. +.It Fl d +Toggle the daemon flag. +.It Fl i +Ignore HID items in the config file that does not exist in the device. +.It Fl f Ar device +Specify a path name for the device to operate on. +If +.Ar device +is numeric, it is taken to be the USB HID device number. +If it is a relative +path, it is taken to be the name of the device under +.Pa /dev . +An absolute path is taken to be the literal device pathname. +.It Fl p Ar pidfile +Specify an alternate file in which to store the process ID. +.It Fl v +Be verbose, and do not become a daemon. +.El +.Pp +The config file will be re-read if the process gets a HUP signal. +.Sh CONFIGURATION +The configuration file has a very simple format. +Each line describes an +action; if a line begins with a whitespace it is considered a continuation +of the previous line. +Lines beginning with `#' are considered as comments. +.Pp +Each line has three parts: a name of a USB HID item, a value for that item, +and an action. +There must be whitespace between the parts. +.Pp +The item names are similar to those used by +.Xr usbhidctl 1 , +but each part must be prefixed by its page name. +.Pp +The value is simply a numeric value. +When the item reports this value +the action will be performed. +If the value is `*' it will match any value. +.Pp +The action is a normal command that is executed with +.Xr system 3 . +Before it is executed some substitution will occur: +`$n' will be replaced by the nth argument on the +command line, `$V' will be replaced by the numeric value +of the HID item, `$N' will be replaced by the name +of the control, and `$H' will be replaced by the name +of the HID device. +.Sh FILES +.Bl -tag -indent +.It Pa /usr/share/misc/usb_hid_usages +The HID usage table. +.It Pa /var/run/usbaction.pid +The default location of the pid file. +.El +.Sh EXAMPLES +The following configuration file can be used to control a pair +of Philips USB speakers with the HID controls on the speakers. +.Bd -literal -offset indent +# Configuration for various Philips USB speakers +Consumer:Consumer_Control.Consumer:Volume_Up 1 + mixerctl -f $1 -n -w fea8-i7-master++ +Consumer:Consumer_Control.Consumer:Volume_Down 1 + mixerctl -f $1 -n -w fea8-i7-master-- +Consumer:Consumer_Control.Consumer:Mute 1 + mixerctl -f $1 -n -w fea8-i7-mute++ +Consumer:Consumer_Control.Consumer:Channel_Top.Microsoft:Base_Up 1 + mixerctl -f $1 -n -w fea8-i7-bass++ +Consumer:Consumer_Control.Consumer:Channel_Top.Microsoft:Base_Down 1 + mixerctl -f $1 -n -w fea8-i7-bass-- +.Ed +.Pp +A sample invocation using this configuration would be +.Bd -literal -offset indent +usbhidaction -f /dev/uhid1 -c conf /dev/mixer1 +.Ed +.Sh SEE ALSO +.Xr usbhidctl 1 , +.Xr usbhid 3 , +.Xr uhid 4 , +.Xr usb 4 +.Sh HISTORY +The +.Nm +command first appeared in +.Nx 1.6 . +The +.Nm +command appeard in +.Fx 5.1 . |
