usr.bin/bthset/bthset.1

   1 .\"     $NetBSD: bthset.1,v 1.3 2006/07/30 00:03:22 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 2006 Itronix Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. The name of Itronix Inc. may not be used to endorse
  15 .\"    or promote products derived from this software without specific
  16 .\"    prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY ITRONIX INC. ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL ITRONIX INC. BE LIABLE FOR ANY
  22 .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  23 .\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  24 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  25 .\" ON ANY THEORY OF LIABILITY, WHETHER IN
  26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 .\" POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .Dd July 26, 2006
  31 .Dt BTHSET 1
  32 .Os
  33 .Sh NAME
  34 .Nm bthset
  35 .Nd Bluetooth Headset utility
  36 .Sh SYNOPSIS
  37 .Nm
  38 .Op Fl v
  39 .Op Fl c Ar command
  40 .Op Fl m Ar mixer
  41 .Op Fl p Ar file
  42 .Op Fl s Ar channel
  43 .Nm
  44 .Op Fl h
  45 .Sh DESCRIPTION
  46 The
  47 .Nm
  48 utility is used to access a Bluetooth Headset with the
  49 .Xr btsco 4
  50 audio device.
  51 It opens the
  52 .Xr mixer 4
  53 device and creates the control connection
  54 to the headset, then conducts volume settings each way.
  55 When
  56 .Nm
  57 receives a
  58 .Dv SIGUSR1
  59 signal, it will start sending RING codes to the headset until the headset
  60 button is pressed or a
  61 .Dv SIGUSR2
  62 signal is received.
  63 If the headset is ringing and
  64 .Nm
  65 receives a button press notification, the specified
  66 .Ar command
  67 (if any) is executed.
  68 .Pp
  69 When the server channel is specified with the
  70 .Fl s
  71 option, instead of opening the control connection,
  72 .Nm
  73 will listen on the
  74 .Ar channel
  75 for incoming connections from the Headset and register as Headset Audio
  76 Gateway with the local SDP server.
  77 .Pp
  78 The options are as follows:
  79 .Bl -tag -width indent
  80 .It Fl c Ar command
  81 Specify an optional command to be executed when the headset responds to
  82 ringing with a button press event.
  83 This defaults to the contents of the
  84 .Dv BTHSET_COMMAND
  85 environment variable, if set.
  86 .It Fl h
  87 Print usage message.
  88 .It Fl m Ar mixer
  89 Specify the path to the mixer device.
  90 This defaults to the contents of the
  91 .Dv BTHSET_MIXER
  92 environment variable, or
  93 .Pa /dev/mixer
  94 if not set.
  95 .It Fl p Ar file
  96 Write the PID to
  97 .Ar file
  98 so that other programs can find us later.
  99 This defaults to the contents of the
 100 .Dv BTHSET_PIDFILE
 101 environment variable, if set.
 102 .It Fl s Ar channel
 103 Register with the local SDP server as a Headset Audio Gateway and listen for
 104 connections on the given RFCOMM server channel.
 105 .It Fl v
 106 Be verbose.
 107 .El
 108 .Sh EXIT STATUS
 109 .Ex -std
 110 .Sh FILES
 111 .Pa /dev/mixer
 112 .Sh SEE ALSO
 113 .Xr btsco 4 ,
 114 .Xr mixer 4
 115 .Sh AUTHORS
 116 .An Iain Hibbert
 117 for Itronix, Inc