nusb(4): minor man page corrections

This commit is contained in:
stanley lieber 2011-08-17 21:58:38 -05:00
parent 1f80ddafb8
commit 0a28f2abe1

View file

@ -48,7 +48,7 @@ upon attachment of the device to the bus. All drivers except
take the decimal usb take the decimal usb
.I devid .I devid
of the device they should handle as ther last argument. A of the device they should handle as ther last argument. A
drivers instance handles only one device at a time. driver's instance handles only one device at a time.
.PP .PP
Drivers that provide file systems make them available as shares under Drivers that provide file systems make them available as shares under
.B /shr .B /shr
@ -65,9 +65,9 @@ Options
.B \-d .B \-d
and and
.B \-D .B \-D
present on most drivers trigger debug diagnostics and trigger debug diagnostics and file system debugging
file system debugging diagnostics. diagnostics for most drivers. Repeating any one of these may
Repeating any one of these may increase verbosity. increase verbosity.
.SS Hubs .SS Hubs
.I Usbd .I Usbd
enumerates the tree of USB hubs and configures the device on enumerates the tree of USB hubs and configures the device on
@ -75,7 +75,7 @@ attachment. It provides a filesystem with the the file
.B usbevent .B usbevent
(usualy seen as (usualy seen as
.BR /dev/usbevent ) .BR /dev/usbevent )
wich when read, returns a 5 column space separated line of which, when read, returns a 5 column, space separated line of
text, one for each event. The columns are: text, one for each event. The columns are:
.B attach .B attach
or or
@ -109,11 +109,11 @@ The option
.B \-a .B \-a
accelerates the mouse to level accelerates the mouse to level
.I n .I n
(similar to the kernel mouse driver acceleration). (similar to the kernel's mouse driver acceleration).
.SS Disks .SS Disks
.I Disk .I Disk
configures and manages USB mass storage devices. It configures and manages USB mass storage devices. It
provides a file system (usually seen at provides a file system (usually seen under
.BR /dev ) .BR /dev )
that includes one directory per storage device, named that includes one directory per storage device, named
.BI sdU N . M .BI sdU N . M
@ -137,28 +137,26 @@ The
file supplies the device geometry and partitions when read. file supplies the device geometry and partitions when read.
.SS Serial and JTAG ports .SS Serial and JTAG ports
.I Serial .I Serial
provides a file system (usually seen at provides a file system (usually seen under
.BR /dev ) .BR /dev )
that includes two files, that includes one directory per USB serial port, named
.BI eiaU N , .BI eiaU N
or
.BI eiaU N . M.
In this directory there are two files,
.BR eiaU ,
similar to similar to
.BI eia N .BI eia N
in in
.IR uart (3) .IR uart (3),
but where
.I N
is the
.I devid
or
.IR devid . lun,
and and
.BI eiaU N ctl, .BR eiaUctl ,
which admits writes in the same format as which admits writes in the same format as
.BI eia N ctl .BI eia N ctl
in in
.IR uart (3). .IR uart (3).
Reading from Reading from
.BI eiaU N ctl .B eiaUctl
gives the serial port's settings in the same format as gives the serial port's settings in the same format as
.BI eia N status .BI eia N status
in in
@ -168,24 +166,19 @@ Options are similar to those of
.PP .PP
JTAG ports are similar JTAG ports are similar
but the files are named but the files are named
.BI jtag N .B jtag
and and
.BI jtag N ctl . .BR jtagctl .
. .
.SS Audio devices .SS Audio devices
.I Audio .I Audio
configures and manages a USB audio device. configures and manages a USB audio device.
It implements a file system, (normally seen at It implements a file system, (normally seen under
.BI /dev ) .BI /dev )
containing files containing the files
.BR volume .BR volume
and and
.BR audio . .BR audio .
.SS Ptp devices
.I Ptp
supports PTP (picture transfer protocol) devices like cameras.
The filesystem can be accessed under
.BI /shr/sdU devid .0 .
.SH SOURCE .SH SOURCE
.B /sys/src/cmd/nusb .B /sys/src/cmd/nusb
.SH "SEE ALSO" .SH "SEE ALSO"
@ -198,7 +191,7 @@ The filesystem can be accessed under
.IR kbdfs (8) .IR kbdfs (8)
.SH BUGS .SH BUGS
The various device drivers are generic USB drivers and The various device drivers are generic USB drivers and
may work only for certain devices on each class. may work only for certain devices of each class.
.PP .PP
USB ATA storage devices are not supported. USB ATA storage devices are not supported.
.PP .PP
@ -207,6 +200,6 @@ and control of the
.B dcd .B dcd
and and
.B dsr .B dsr
signals and some of the extra features are unimplemented. signals and some of the extra features are not implemented.
For Ftdi, only the Sheevaplug and Guruplug have been tried. For Ftdi, only the Sheevaplug and Guruplug have been tried.
There is support for the EHCI debug port, but it loses bytes. There is support for the EHCI debug port, but it loses bytes.