.IR spell (1)
.SH BUGS
This filter is not a complete interpreter of
-.I troff .
+.IR troff .
For example, macro definitions containing
.L \e$
cause chaos in
-.IR deroff
+.I deroff
when the popular
.L $$
delimiters for
.I Umem
prints summarizes all allocations, not just
memory leaks, but it is faster and requires less memory than
-.I leak .
+.IR leak .
.PP
.I Kmem
is like
.I file
]
.SH DESCRIPTION
-HTML comes in various character set encodings
+HTML comes in various character-set encodings
and has special forms to encode characters. To
-make it easier to process html, uhtml is used
-to normalize it to a unicode only form.
+make it easier to process HTML, uhtml is used
+to normalize it to a Unicode-only form.
.LP
-Uhtml detects the character set of the html input
+Uhtml detects the character set of the HTML input
.I file
and calls
.IR tcs (1)
-to convert it to utf replacing html-entity forms
-by ther unicode character representations except for
-.B lt
-.B gt
-.B amp
-.B quot
+to convert it to UTF replacing HTML-entity forms
+by their Unicode character representations except for
+.BR lt ,
+.BR gt ,
+.BR amp ,
+.BR quot ,
and
-.B apos .
-The converted html is written to
+.BR apos .
+The converted HTML is written to
standard output. If no
.I file
was given, it is read from standard input. If the
.B -p
option is given, the detected character set is printed and
the program exits without conversion.
-In case character set detection fails, the default (utf)
+In case character-set detection fails, the default (UTF)
is assumed. This default can be changed with the
.B -c
option.
.I yyyy/mmdd
(year, month, day)
in the style of the dump file system
-(see Plan 9's \fIfs\fR(4)).
+(see \fIfs\fR(4)).
If
.I vacfile
already exists, an additional backup day is added to the
.I pattern
or
.B exclude
-.I pattern .
+.IR pattern .
When considering whether to include a directory or file
in the vac archive,
the earliest matching pattern in the file
will handle the request given pointers to two functions
.I walk1
and (optionally)
-.I clone .
+.IR clone .
.IR Clone ,
if non-nil, is called to signal the creation of
.I newfid
.IR nntpfs (4),
.IR snap (4),
and
-.B /sys/src/lib9p/ramfs.c
+.B /sys/src/cmd/ramfs.c
are good examples of simple single-threaded file servers.
.PP
In general, the
.PP
.I Closeioproc
terminates the I/O proc and frees the associated
-.B Ioproc .
+.BR Ioproc .
.PP
.I Iocall
is a primitive that may be used to implement
.SH DESCRIPTION
These routines are used by Internet Protocol (IP) programs to
manipulate IP and Ethernet addresses.
-Plan 9, by default, uses V6 format IP addresses. Since V4
+Plan 9, by default, uses V6-format IP addresses. Since V4
addresses fit into the V6 space, all IP addresses can be represented.
IP addresses are stored as a string of 16
.B unsigned
.PP
.I Defmask
returns the standard class A, B, or C mask for
-.I ipaddr .
+.IR ipaddr .
.PP
.I Isv4
returns non-zero if the V6 address is in the V4 space, that is,
descriptor will get encrypted and authenticated and then written to the
file descriptor,
.IR fd .
-.I Pushtls ,
-.IR tlsClient
+.IR Pushtls ,
+.I tlsClient
and
-.IR tlsServer
+.I tlsServer
close the original file descriptor on success.
If
.I dir
with room for
.I nblocks
of maximum block size
-.I blocksize .
+.IR blocksize .
.PP
.I Vtcachefree
frees a cache and all the associated blocks.
.PP
.I Vtlogopen
returns a reference to the log with the given
-.I name .
+.IR name .
If a log with that name does not exist and
.I size
is non-zero,
Run the host command in directory
.IR wdir ,
which is a directory
-.I "on the host system" .
+.IR "on the host system" .
Issue this request before starting the command.
By default, commands are run in the Inferno root directory on the host system.
.TP
.SS "Command execution"
In all cases, the command runs in the host operating system's
own file name space.
-All file names will be interpreted in that space, not Plan9's.
+All file names will be interpreted in that space, not Plan 9's.
For example, on Unix
.B /
-refers to the host's file system root, not Plan9's;
+refers to the host's file system root, not Plan 9's;
the effects of mounts and binds will not be visible.
.SH "SEE ALSO"
.IR os (1)
.SH DESCRIPTION
The Universal Serial Bus is a complex yet popular bus
for connecting all kind of devices to a computer.
-It is a four-wire tree-shaped bus that provides both communication and (limited)
+It is a tree-shaped bus that provides both communication and (limited)
power to devices.
Branching points in the tree are provided by devices called
.IR hubs .
EHCI for USB 2 (up to 480 Mb/s)
and
XHCI for USB 3 (up to 5 Gb/s).
-We currently support all but XHCI, which is still quite new.
.PP
The USB bus is fully controlled by the host; all devices are polled.
Hubs are passive in the sense that they do not poll the devices attached
Specialization continues as subclasses and subsubclasses are explored.
.PP
Enumeration of the bus and initial configuration of devices is done
-by a user level program,
+by a user-level program,
.IR usbd .
Device drivers are implemented by separate user programs, although
some of them may be statically linked into
to resume I/O.
The most common error is
.L crc/timeout
-indicating problems in communication with the device (eg., a physical
+indicating problems in communication with the device (e.g., a physical
detach of the device or a wiring problem).
.PP
For control and isochronous transfers, there is an implicit
(1.5 Mb/s),
.BR full
(12 Mb/s),
-or
.BR high
-(480 Mb/s).
+(480 Mb/s)
+or
+.BR super
+(5 Gb/s).
.TP
Maximum packet size
Used when performing I/O on the data file.
.TP
.BI name " str"
Generates an additional file name,
-.I str ,
+.IR str ,
for the
.B data
file of the endpoint.
.BR rw ,
which creates, respectively, an input, output, or input/output endpoint.
.TP
-.B "speed {low|full|high}
-Set the endpoint speed to full, low, or high, respectively.
+.B "speed {low|full|high|super}
+Set the endpoint speed to full, low, high, or SuperSpeed, respectively.
.TP
.B hub
Tell this driver that the endpoint corresponds to a hub device.
.PD
.PP
-Setup endpoints for hub devices also accept his request:
+Setup endpoints for hub devices also accept
.TP
-.B "newdev {low|full|high} \fIport\fP
+.B "newdev {low|full|high|super} \fIport\fP
Create a new setup endpoint to represent a new device.
The first argument is the device speed.
.I Port
option will print rc commands using
.IR audio/flacenc (1)
to encode and tag audio tracks from the disc to output directory
-.I dir .
+.IR dir .
.SH EXAMPLES
Backup to a BD-R disc:
.br
.B usbevent
(usually seen as
.BR /dev/usbevent )
-which, when read, returns a 6 column, space separated line of
+which, when read, returns a 6-column, space-separated line of
text, one for each event. The columns are:
.B attach
or
.I did
.I csp
and
-.I hname .
+.IR hname .
The
.I addr
is the decimal device address assigned.
is the device class, subclass, protocol indentifier
formatted as 6 digit hexadecimal.
.I Usbd
-assigns a stable device unique name based on the
+assigns a stable device identifier based on the
device descriptor for
-.I hname .
+.IR hname .
This information is read by
.IR nusbrc (8)
and the
.BR /dev )
that includes one directory per storage device, named
.BI sdU N [. M ]
-in correspondence with the usb device unique name
+in correspondence with the USB device identifier
and the storage unit number (or LUN). The LUN is omited
for single lun devices.
.PP
.SS Ethernet
.I Ether
handles USB ethernet devices. The file system provided is
-compatible to
+compatible with
.IR ether (3)
and added to the share
.B usbnet
.SS Audio devices
.I Audio
configures and manages a USB audio device.
-It implements a file system, (normally seen under
-.BI /dev )
-compatible to
+It implements a file system (normally seen under
+.BR /dev ),
+compatible with
.IR audio (3).
.SH SOURCE
.B /sys/src/cmd/nusb
.B wctl
accepts messages to change the size or placement of the associated window,
and to create new windows.
-The messages are in a command-line like format, with a command name,
+The messages are in a command-line-like format, with a command name,
possibly followed by options introduced by a minus sign.
The options must be separated by blanks, for example
.B -dx 100
.B new
commands accept
.B -minx
-.IR n ,
+.RI [±] n ,
.B -miny
-.IR n ,
+.RI [±] n ,
.B -maxx
-.IR n ,
+.RI [±] n ,
and
-.BR -maxy
-.I n
+.B -maxy
+.RI [±] n
options to set the position of the corresponding edge of the window.
They also accept an option
.B -r
proving to the client that it also knows
.I Kn
and therefore
-.I Ks .
+.IR Ks .
.PP
The 64-bit shared secret
.I Kn
.PP
.I Ndb/dnsgetip
resolves and prints A and AAAA records without consulting
-.I ndb/dns .
+.IR ndb/dns .
By default,
.I ndb/dnsgetip
queries A records first and then AAAA records. As with
(default
.BR 0 )
in
-.I arenafile .
+.IR arenafile .
This is useful for reading directly from
the Venti arena partition:
.IP
projects / plan9front.git / commitdiff