usr.sbin/usbd/usbd.8

   1 .\" Copyright (c) 1998 The NetBSD Foundation, Inc.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Author: Lennart Augustsson
   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. All advertising materials mentioning features or use of this software
  15 .\"    must display the following acknowledgement:
  16 .\"        This product includes software developed by the NetBSD
  17 .\"        Foundation, Inc. and its contributors.
  18 .\" 4. Neither the name of The NetBSD Foundation nor the names of its
  19 .\"    contributors may be used to endorse or promote products derived
  20 .\"    from this software without specific prior written permission.
  21 .\"
  22 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  23 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  24 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  25 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  26 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  27 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  28 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  29 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  30 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  31 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  32 .\" POSSIBILITY OF SUCH DAMAGE.
  33 .\"
  34 .\" $NetBSD: usbd.8,v 1.2 1998/07/13 11:01:50 augustss Exp $
  35 .\" $FreeBSD: src/usr.sbin/usbd/usbd.8,v 1.20 2003/05/04 22:13:00 murray Exp $
  36 .\" $DragonFly: src/usr.sbin/usbd/usbd.8,v 1.4 2006/07/02 16:24:02 swildner Exp $
  37 .\"
  38 .Dd July 2, 2006
  39 .Dt USBD 8
  40 .Os
  41 .Sh NAME
  42 .Nm usbd
  43 .Nd supervise USB attach/detach
  44 .Sh SYNOPSIS
  45 .Nm
  46 .Op Fl c Ar configfile
  47 .Op Fl d
  48 .Op Fl e
  49 .Op Fl f Ar device
  50 .Op Fl n
  51 .Op Fl t Ar timeout
  52 .Op Fl v
  53 .Sh DESCRIPTION
  54 The
  55 .Nm
  56 utility handles USB device attachment and detachment.
  57 The (multiple)
  58 .Fl f Ar device
  59 command line options specify which controllers it should handle.
  60 Normally this option is not needed.
  61 .Pp
  62 If the
  63 .Dq usb ,
  64 .Dq ohci
  65 and
  66 .Dq uhci
  67 modules are not loaded,
  68 .Nm
  69 will load them automatically.
  70 .Pp
  71 To handle the attachment and detachment of USB devices
  72 .Nm
  73 opens the
  74 .Pa /dev/usb
  75 device and reads events from it.
  76 Whenever a device is attached or
  77 detached the list of actions read from
  78 .Pa /etc/usbd.conf
  79 is searched for a matching entry.
  80 If found, the corresponding action is
  81 executed.
  82 .Pp
  83 The command line options are as follows:
  84 .Bl -tag -width Ds
  85 .It Fl c Ar filename
  86 Name of configuration file.
  87 The default is
  88 .Pa /etc/usbd.conf .
  89 .It Fl d
  90 Enable debugging to the standard output,
  91 and do not disassociate from the controlling terminal.
  92 .It Fl e
  93 Do one device tree exploration, no event queue handling and then exit.
  94 .It Fl f Ar device
  95 Specify the pathname of a USB controller device file.
  96 The flag may be repeated to watch more than one USB controller.
  97 The default is
  98 .Pa /dev/usb0
  99 through
 100 .Pa /dev/usb3 .
 101 Do not specify the device
 102 .Pa /dev/usb
 103 here.
 104 It is used for events only.
 105 .It Fl n
 106 Do not handle the event queue on /dev/usb.
 107 .It Fl t Ar timeout
 108 Set the timeout interval (in seconds) before an exploration happens
 109 without being triggered by a connect or disconnect.
 110 A timeout of 0 means that there is no timeout.  The default is 30.
 111 .It Fl v
 112 Be verbose.
 113 Repeating the flag makes
 114 .Nm
 115 more verbose.
 116 .El
 117 .Sh FILES
 118 .Bl -tag -width /etc/usbd.conf -compact
 119 .It Pa /etc/usbd.conf
 120 .It Pa /dev/usb
 121 .It Pa /dev/usb0
 122 .It Pa /dev/usb1
 123 .It etc .
 124 .El
 125 .Sh SEE ALSO
 126 .Xr usb 4 ,
 127 .Xr usbd.conf 5
 128 .Sh HISTORY
 129 The
 130 .Nm
 131 utility appeared in
 132 .Nx 1.4 .
 133 .Sh AUTHORS
 134 .An -nosplit
 135 The
 136 .Nm
 137 driver was written by
 138 .An Lennart Augustsson Aq augustss@carlstedt.se
 139 for the
 140 .Nx
 141 project.
 142 The event queue handling in
 143 .Nm
 144 was added by
 145 .An Nick Hibma Aq n_hibma@FreeBSD.org .