summaryrefslogtreecommitdiffstats
path: root/usr.sbin/usbd
diff options
context:
space:
mode:
authorsheldonh <sheldonh@FreeBSD.org>2000-03-01 14:09:25 +0000
committersheldonh <sheldonh@FreeBSD.org>2000-03-01 14:09:25 +0000
commitb2240fc1c08ba82628285458b057b5f795a68a43 (patch)
tree5acb2bdc9bc2d2c26e220a424cc6f0b29df60dec /usr.sbin/usbd
parent3197c29bd1de99eb5100db75bfb4d651f6878fa7 (diff)
downloadFreeBSD-src-b2240fc1c08ba82628285458b057b5f795a68a43.zip
FreeBSD-src-b2240fc1c08ba82628285458b057b5f795a68a43.tar.gz
Remove single-space hard sentence breaks. These degrade the quality
of the typeset output, tend to make diffs harder to read and provide bad examples for new-comers to mdoc.
Diffstat (limited to 'usr.sbin/usbd')
-rw-r--r--usr.sbin/usbd/usbd.830
-rw-r--r--usr.sbin/usbd/usbd.conf.533
2 files changed, 42 insertions, 21 deletions
diff --git a/usr.sbin/usbd/usbd.8 b/usr.sbin/usbd/usbd.8
index c3e3238..814929c 100644
--- a/usr.sbin/usbd/usbd.8
+++ b/usr.sbin/usbd/usbd.8
@@ -51,30 +51,37 @@
.Op Fl v
.Sh DESCRIPTION
.Nm
-handles the USB device attachment and detachment. It does two things.
+handles the USB device attachment and detachment.
+It does two things.
Through opening the
.Pa /dev/usb0 ,
.Pa /dev/usb1 ,
etc. devices, it enables the kernel to do handle change requests from
-attached hubs. This functionality will be removed when the kernel has
-kernel threads. The (multiple)
+attached hubs.
+This functionality will be removed when the kernel has
+kernel threads.
+The (multiple)
.Fl f Ar device
command line options specify which controllers it should handle.
Normally this option is not needed.
.Pp
The second part is the handling of the attachment and detachment of USB
-devices. The device
+devices.
+The device
.Pa /dev/usb
-is opened and events are read from it. Whenever a device is attached or
+is opened and events are read from it.
+Whenever a device is attached or
detached the list of actions read from
.Pa /etc/usbd.conf
-are searched for a matching entry. If found, the corresponding action is
+are searched for a matching entry.
+If found, the corresponding action is
executed.
.Pp
The command line options are as follows:
.Bl -tag -width Ds
.It Fl c Ar filename
-Name of configuration file. The default is
+Name of configuration file.
+The default is
.Pa /etc/usbd.conf.
.It Fl d
Enable debugging to the standard output,
@@ -90,7 +97,8 @@ through
.Pa /dev/usb3 .
Do not specify the device
.Pa /dev/usb
-here. It is used for events only.
+here.
+It is used for events only.
.It Fl n
Do not handle the event queue on /dev/usb.
.It Fl t Ar timeout
@@ -98,7 +106,8 @@ Set the timeout interval (in seconds) before an exploration happens
without being triggered by a connect or disconnect.
A timeout of 0 means that there is no timeout. The default is 30.
.It Fl v
-Be verbose. Repeating the flag makes
+Be verbose.
+Repeating the flag makes
.Nm usbd
more verbose.
.El
@@ -124,7 +133,8 @@ driver was written by
.An Lennart Augustsson Aq augustss@carlstedt.se
for the
.Nx
-project. The event queue handling in
+project.
+The event queue handling in
.Nm usbd
was added by
.An Nick Hibma Aq n_hibma@freebsd.org .
diff --git a/usr.sbin/usbd/usbd.conf.5 b/usr.sbin/usbd/usbd.conf.5
index 07a77b9..5757265 100644
--- a/usr.sbin/usbd/usbd.conf.5
+++ b/usr.sbin/usbd/usbd.conf.5
@@ -41,22 +41,29 @@ The
.Nm
file is the configuration file for the
.Xr usbd 8
-daemon. It provides information to allow execution of userland commands
+daemon.
+It provides information to allow execution of userland commands
on events reported by the
.Xr usb 4
-subsystem in the kernel. Currently the only events are device attach and
+subsystem in the kernel.
+Currently the only events are device attach and
detach, but could in the future be extended to include power management
functions.
.Pp
-The configuration file consists of a sorted list of entries. Each entry
-describes a set of criteria commands. When an event occurs, the criteria
+The configuration file consists of a sorted list of entries.
+Each entry
+describes a set of criteria commands.
+When an event occurs, the criteria
are checked and if met, the commands for that event are executed through
-a shell. The list is sorted and scanned from top to bottom. The first
+a shell. The list is sorted and scanned from top to bottom.
+The first
matching entry is used for an event.
.Pp
-Each entry contains a number of fields. There are 3 types of fields:
+Each entry contains a number of fields.
+There are 3 types of fields:
descriptive fields, selection criteria and commands to execute on
-events. The field name is case sensitive and should be all lower case.
+events.
+The field name is case sensitive and should be all lower case.
Each field can have one or more arguments.
.Pp
The following fields are available:
@@ -79,7 +86,8 @@ Device Subclass
Device Protocol
.It devname Ar string
Device name, for example umass2, or ums0. These device names can contain
-regular expressions. See
+regular expressions.
+See
.Xr regex 3
and
.Xr re_format 7 .
@@ -87,10 +95,13 @@ The device name that is matched can be used in the commands below
through adding ${DEVNAME} somewhere in that string.
.El
.Pp
-String arguments may be quoted. If a string argument contains a space or
-tab character it needs to be enclosed in single or double quotes. If an
+String arguments may be quoted.
+If a string argument contains a space or
+tab character it needs to be enclosed in single or double quotes.
+If an
argument contains a single or double quote, that quote needs to be
-enclosed in double or single quotes respectively. See below for
+enclosed in double or single quotes respectively.
+See below for
examples.
.Pp
Numeric arguments can either be specified in decimal (42), octal (052) or
OpenPOWER on IntegriCloud