man page fixes (thanks stuart morrow)
This commit is contained in:
parent
fb2e0a1987
commit
ad26f82e44
18 changed files with 62 additions and 61 deletions
|
@ -83,11 +83,11 @@ but remove lists as well.
|
||||||
.IR spell (1)
|
.IR spell (1)
|
||||||
.SH BUGS
|
.SH BUGS
|
||||||
This filter is not a complete interpreter of
|
This filter is not a complete interpreter of
|
||||||
.I troff .
|
.IR troff .
|
||||||
For example, macro definitions containing
|
For example, macro definitions containing
|
||||||
.L \e$
|
.L \e$
|
||||||
cause chaos in
|
cause chaos in
|
||||||
.IR deroff
|
.I deroff
|
||||||
when the popular
|
when the popular
|
||||||
.L $$
|
.L $$
|
||||||
delimiters for
|
delimiters for
|
||||||
|
|
|
@ -158,7 +158,7 @@ The list is sorted by count in decreasing order.
|
||||||
.I Umem
|
.I Umem
|
||||||
prints summarizes all allocations, not just
|
prints summarizes all allocations, not just
|
||||||
memory leaks, but it is faster and requires less memory than
|
memory leaks, but it is faster and requires less memory than
|
||||||
.I leak .
|
.IR leak .
|
||||||
.PP
|
.PP
|
||||||
.I Kmem
|
.I Kmem
|
||||||
is like
|
is like
|
||||||
|
|
|
@ -12,31 +12,31 @@ uhtml \- convert foreign character set HTML file to unicode
|
||||||
.I file
|
.I file
|
||||||
]
|
]
|
||||||
.SH DESCRIPTION
|
.SH DESCRIPTION
|
||||||
HTML comes in various character set encodings
|
HTML comes in various character-set encodings
|
||||||
and has special forms to encode characters. To
|
and has special forms to encode characters. To
|
||||||
make it easier to process html, uhtml is used
|
make it easier to process HTML, uhtml is used
|
||||||
to normalize it to a unicode only form.
|
to normalize it to a Unicode-only form.
|
||||||
.LP
|
.LP
|
||||||
Uhtml detects the character set of the html input
|
Uhtml detects the character set of the HTML input
|
||||||
.I file
|
.I file
|
||||||
and calls
|
and calls
|
||||||
.IR tcs (1)
|
.IR tcs (1)
|
||||||
to convert it to utf replacing html-entity forms
|
to convert it to UTF replacing HTML-entity forms
|
||||||
by ther unicode character representations except for
|
by their Unicode character representations except for
|
||||||
.B lt
|
.BR lt ,
|
||||||
.B gt
|
.BR gt ,
|
||||||
.B amp
|
.BR amp ,
|
||||||
.B quot
|
.BR quot ,
|
||||||
and
|
and
|
||||||
.B apos .
|
.BR apos .
|
||||||
The converted html is written to
|
The converted HTML is written to
|
||||||
standard output. If no
|
standard output. If no
|
||||||
.I file
|
.I file
|
||||||
was given, it is read from standard input. If the
|
was given, it is read from standard input. If the
|
||||||
.B -p
|
.B -p
|
||||||
option is given, the detected character set is printed and
|
option is given, the detected character set is printed and
|
||||||
the program exits without conversion.
|
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
|
is assumed. This default can be changed with the
|
||||||
.B -c
|
.B -c
|
||||||
option.
|
option.
|
||||||
|
|
|
@ -82,7 +82,7 @@ the files under an extra two levels of directory hierarchy named
|
||||||
.I yyyy/mmdd
|
.I yyyy/mmdd
|
||||||
(year, month, day)
|
(year, month, day)
|
||||||
in the style of the dump file system
|
in the style of the dump file system
|
||||||
(see Plan 9's \fIfs\fR(4)).
|
(see \fIfs\fR(4)).
|
||||||
If
|
If
|
||||||
.I vacfile
|
.I vacfile
|
||||||
already exists, an additional backup day is added to the
|
already exists, an additional backup day is added to the
|
||||||
|
@ -184,7 +184,7 @@ All other lines should be of the form
|
||||||
.I pattern
|
.I pattern
|
||||||
or
|
or
|
||||||
.B exclude
|
.B exclude
|
||||||
.I pattern .
|
.IR pattern .
|
||||||
When considering whether to include a directory or file
|
When considering whether to include a directory or file
|
||||||
in the vac archive,
|
in the vac archive,
|
||||||
the earliest matching pattern in the file
|
the earliest matching pattern in the file
|
||||||
|
|
|
@ -511,7 +511,7 @@ prone to error, the helper routine
|
||||||
will handle the request given pointers to two functions
|
will handle the request given pointers to two functions
|
||||||
.I walk1
|
.I walk1
|
||||||
and (optionally)
|
and (optionally)
|
||||||
.I clone .
|
.IR clone .
|
||||||
.IR Clone ,
|
.IR Clone ,
|
||||||
if non-nil, is called to signal the creation of
|
if non-nil, is called to signal the creation of
|
||||||
.I newfid
|
.I newfid
|
||||||
|
@ -881,7 +881,7 @@ option to increment
|
||||||
.IR nntpfs (4),
|
.IR nntpfs (4),
|
||||||
.IR snap (4),
|
.IR snap (4),
|
||||||
and
|
and
|
||||||
.B /sys/src/lib9p/ramfs.c
|
.B /sys/src/cmd/ramfs.c
|
||||||
are good examples of simple single-threaded file servers.
|
are good examples of simple single-threaded file servers.
|
||||||
.PP
|
.PP
|
||||||
In general, the
|
In general, the
|
||||||
|
|
|
@ -92,7 +92,7 @@ to clear a pending interrupt.
|
||||||
.PP
|
.PP
|
||||||
.I Closeioproc
|
.I Closeioproc
|
||||||
terminates the I/O proc and frees the associated
|
terminates the I/O proc and frees the associated
|
||||||
.B Ioproc .
|
.BR Ioproc .
|
||||||
.PP
|
.PP
|
||||||
.I Iocall
|
.I Iocall
|
||||||
is a primitive that may be used to implement
|
is a primitive that may be used to implement
|
||||||
|
|
|
@ -97,7 +97,7 @@ uchar v4prefix[IPaddrlen];
|
||||||
.SH DESCRIPTION
|
.SH DESCRIPTION
|
||||||
These routines are used by Internet Protocol (IP) programs to
|
These routines are used by Internet Protocol (IP) programs to
|
||||||
manipulate IP and Ethernet addresses.
|
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.
|
addresses fit into the V6 space, all IP addresses can be represented.
|
||||||
IP addresses are stored as a string of 16
|
IP addresses are stored as a string of 16
|
||||||
.B unsigned
|
.B unsigned
|
||||||
|
@ -222,7 +222,7 @@ operates on v6 addresses.
|
||||||
.PP
|
.PP
|
||||||
.I Defmask
|
.I Defmask
|
||||||
returns the standard class A, B, or C mask for
|
returns the standard class A, B, or C mask for
|
||||||
.I ipaddr .
|
.IR ipaddr .
|
||||||
.PP
|
.PP
|
||||||
.I Isv4
|
.I Isv4
|
||||||
returns non-zero if the V6 address is in the V4 space, that is,
|
returns non-zero if the V6 address is in the V4 space, that is,
|
||||||
|
|
|
@ -78,10 +78,10 @@ returns a file descriptor for the TLS data channel. Anything written to this
|
||||||
descriptor will get encrypted and authenticated and then written to the
|
descriptor will get encrypted and authenticated and then written to the
|
||||||
file descriptor,
|
file descriptor,
|
||||||
.IR fd .
|
.IR fd .
|
||||||
.I Pushtls ,
|
.IR Pushtls ,
|
||||||
.IR tlsClient
|
.I tlsClient
|
||||||
and
|
and
|
||||||
.IR tlsServer
|
.I tlsServer
|
||||||
close the original file descriptor on success.
|
close the original file descriptor on success.
|
||||||
If
|
If
|
||||||
.I dir
|
.I dir
|
||||||
|
|
|
@ -126,7 +126,7 @@ and
|
||||||
with room for
|
with room for
|
||||||
.I nblocks
|
.I nblocks
|
||||||
of maximum block size
|
of maximum block size
|
||||||
.I blocksize .
|
.IR blocksize .
|
||||||
.PP
|
.PP
|
||||||
.I Vtcachefree
|
.I Vtcachefree
|
||||||
frees a cache and all the associated blocks.
|
frees a cache and all the associated blocks.
|
||||||
|
|
|
@ -54,7 +54,7 @@ The logs are named by UTF strings.
|
||||||
.PP
|
.PP
|
||||||
.I Vtlogopen
|
.I Vtlogopen
|
||||||
returns a reference to the log with the given
|
returns a reference to the log with the given
|
||||||
.I name .
|
.IR name .
|
||||||
If a log with that name does not exist and
|
If a log with that name does not exist and
|
||||||
.I size
|
.I size
|
||||||
is non-zero,
|
is non-zero,
|
||||||
|
|
|
@ -61,7 +61,7 @@ accepts the following textual commands, allowing quoting as interpreted by
|
||||||
Run the host command in directory
|
Run the host command in directory
|
||||||
.IR wdir ,
|
.IR wdir ,
|
||||||
which is a directory
|
which is a directory
|
||||||
.I "on the host system" .
|
.IR "on the host system" .
|
||||||
Issue this request before starting the command.
|
Issue this request before starting the command.
|
||||||
By default, commands are run in the Inferno root directory on the host system.
|
By default, commands are run in the Inferno root directory on the host system.
|
||||||
.TP
|
.TP
|
||||||
|
@ -207,10 +207,10 @@ means success, and a non-empty string contains a diagnostic.
|
||||||
.SS "Command execution"
|
.SS "Command execution"
|
||||||
In all cases, the command runs in the host operating system's
|
In all cases, the command runs in the host operating system's
|
||||||
own file name space.
|
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
|
For example, on Unix
|
||||||
.B /
|
.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.
|
the effects of mounts and binds will not be visible.
|
||||||
.SH "SEE ALSO"
|
.SH "SEE ALSO"
|
||||||
.IR os (1)
|
.IR os (1)
|
||||||
|
|
|
@ -19,7 +19,7 @@ usb \- USB Host Controller Interface
|
||||||
.SH DESCRIPTION
|
.SH DESCRIPTION
|
||||||
The Universal Serial Bus is a complex yet popular bus
|
The Universal Serial Bus is a complex yet popular bus
|
||||||
for connecting all kind of devices to a computer.
|
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.
|
power to devices.
|
||||||
Branching points in the tree are provided by devices called
|
Branching points in the tree are provided by devices called
|
||||||
.IR hubs .
|
.IR hubs .
|
||||||
|
@ -41,7 +41,6 @@ UHCI and OHCI for USB 1 (up to 12 Mb/s),
|
||||||
EHCI for USB 2 (up to 480 Mb/s)
|
EHCI for USB 2 (up to 480 Mb/s)
|
||||||
and
|
and
|
||||||
XHCI for USB 3 (up to 5 Gb/s).
|
XHCI for USB 3 (up to 5 Gb/s).
|
||||||
We currently support all but XHCI, which is still quite new.
|
|
||||||
.PP
|
.PP
|
||||||
The USB bus is fully controlled by the host; all devices are polled.
|
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
|
Hubs are passive in the sense that they do not poll the devices attached
|
||||||
|
@ -57,7 +56,7 @@ for particular classes of devices (such as mice, keyboards, or audio devices).
|
||||||
Specialization continues as subclasses and subsubclasses are explored.
|
Specialization continues as subclasses and subsubclasses are explored.
|
||||||
.PP
|
.PP
|
||||||
Enumeration of the bus and initial configuration of devices is done
|
Enumeration of the bus and initial configuration of devices is done
|
||||||
by a user level program,
|
by a user-level program,
|
||||||
.IR usbd .
|
.IR usbd .
|
||||||
Device drivers are implemented by separate user programs, although
|
Device drivers are implemented by separate user programs, although
|
||||||
some of them may be statically linked into
|
some of them may be statically linked into
|
||||||
|
@ -179,7 +178,7 @@ in
|
||||||
to resume I/O.
|
to resume I/O.
|
||||||
The most common error is
|
The most common error is
|
||||||
.L crc/timeout
|
.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).
|
detach of the device or a wiring problem).
|
||||||
.PP
|
.PP
|
||||||
For control and isochronous transfers, there is an implicit
|
For control and isochronous transfers, there is an implicit
|
||||||
|
@ -267,9 +266,11 @@ Speed
|
||||||
(1.5 Mb/s),
|
(1.5 Mb/s),
|
||||||
.BR full
|
.BR full
|
||||||
(12 Mb/s),
|
(12 Mb/s),
|
||||||
or
|
|
||||||
.BR high
|
.BR high
|
||||||
(480 Mb/s).
|
(480 Mb/s)
|
||||||
|
or
|
||||||
|
.BR super
|
||||||
|
(5 Gb/s).
|
||||||
.TP
|
.TP
|
||||||
Maximum packet size
|
Maximum packet size
|
||||||
Used when performing I/O on the data file.
|
Used when performing I/O on the data file.
|
||||||
|
@ -426,7 +427,7 @@ state.
|
||||||
.TP
|
.TP
|
||||||
.BI name " str"
|
.BI name " str"
|
||||||
Generates an additional file name,
|
Generates an additional file name,
|
||||||
.I str ,
|
.IR str ,
|
||||||
for the
|
for the
|
||||||
.B data
|
.B data
|
||||||
file of the endpoint.
|
file of the endpoint.
|
||||||
|
@ -484,16 +485,16 @@ or
|
||||||
.BR rw ,
|
.BR rw ,
|
||||||
which creates, respectively, an input, output, or input/output endpoint.
|
which creates, respectively, an input, output, or input/output endpoint.
|
||||||
.TP
|
.TP
|
||||||
.B "speed {low|full|high}
|
.B "speed {low|full|high|super}
|
||||||
Set the endpoint speed to full, low, or high, respectively.
|
Set the endpoint speed to full, low, high, or SuperSpeed, respectively.
|
||||||
.TP
|
.TP
|
||||||
.B hub
|
.B hub
|
||||||
Tell this driver that the endpoint corresponds to a hub device.
|
Tell this driver that the endpoint corresponds to a hub device.
|
||||||
.PD
|
.PD
|
||||||
.PP
|
.PP
|
||||||
Setup endpoints for hub devices also accept his request:
|
Setup endpoints for hub devices also accept
|
||||||
.TP
|
.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.
|
Create a new setup endpoint to represent a new device.
|
||||||
The first argument is the device speed.
|
The first argument is the device speed.
|
||||||
.I Port
|
.I Port
|
||||||
|
|
|
@ -203,7 +203,7 @@ The
|
||||||
option will print rc commands using
|
option will print rc commands using
|
||||||
.IR audio/flacenc (1)
|
.IR audio/flacenc (1)
|
||||||
to encode and tag audio tracks from the disc to output directory
|
to encode and tag audio tracks from the disc to output directory
|
||||||
.I dir .
|
.IR dir .
|
||||||
.SH EXAMPLES
|
.SH EXAMPLES
|
||||||
Backup to a BD-R disc:
|
Backup to a BD-R disc:
|
||||||
.br
|
.br
|
||||||
|
|
|
@ -88,7 +88,7 @@ attachment. It provides a filesystem with the file
|
||||||
.B usbevent
|
.B usbevent
|
||||||
(usually seen as
|
(usually seen as
|
||||||
.BR /dev/usbevent )
|
.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:
|
text, one for each event. The columns are:
|
||||||
.B attach
|
.B attach
|
||||||
or
|
or
|
||||||
|
@ -99,7 +99,7 @@ followed by
|
||||||
.I did
|
.I did
|
||||||
.I csp
|
.I csp
|
||||||
and
|
and
|
||||||
.I hname .
|
.IR hname .
|
||||||
The
|
The
|
||||||
.I addr
|
.I addr
|
||||||
is the decimal device address assigned.
|
is the decimal device address assigned.
|
||||||
|
@ -111,9 +111,9 @@ are formatted as 4 digit hexadecimal.
|
||||||
is the device class, subclass, protocol indentifier
|
is the device class, subclass, protocol indentifier
|
||||||
formatted as 6 digit hexadecimal.
|
formatted as 6 digit hexadecimal.
|
||||||
.I Usbd
|
.I Usbd
|
||||||
assigns a stable device unique name based on the
|
assigns a stable device identifier based on the
|
||||||
device descriptor for
|
device descriptor for
|
||||||
.I hname .
|
.IR hname .
|
||||||
This information is read by
|
This information is read by
|
||||||
.IR nusbrc (8)
|
.IR nusbrc (8)
|
||||||
and the
|
and the
|
||||||
|
@ -142,7 +142,7 @@ 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 ]
|
||||||
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
|
and the storage unit number (or LUN). The LUN is omited
|
||||||
for single lun devices.
|
for single lun devices.
|
||||||
.PP
|
.PP
|
||||||
|
@ -160,7 +160,7 @@ file supplies the device geometry and partitions when read.
|
||||||
.SS Ethernet
|
.SS Ethernet
|
||||||
.I Ether
|
.I Ether
|
||||||
handles USB ethernet devices. The file system provided is
|
handles USB ethernet devices. The file system provided is
|
||||||
compatible to
|
compatible with
|
||||||
.IR ether (3)
|
.IR ether (3)
|
||||||
and added to the share
|
and added to the share
|
||||||
.B usbnet
|
.B usbnet
|
||||||
|
@ -232,9 +232,9 @@ and
|
||||||
.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 under
|
It implements a file system (normally seen under
|
||||||
.BI /dev )
|
.BR /dev ),
|
||||||
compatible to
|
compatible with
|
||||||
.IR audio (3).
|
.IR audio (3).
|
||||||
.SH SOURCE
|
.SH SOURCE
|
||||||
.B /sys/src/cmd/nusb
|
.B /sys/src/cmd/nusb
|
||||||
|
|
|
@ -225,7 +225,7 @@ When written to,
|
||||||
.B wctl
|
.B wctl
|
||||||
accepts messages to change the size or placement of the associated window,
|
accepts messages to change the size or placement of the associated window,
|
||||||
and to create new windows.
|
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.
|
possibly followed by options introduced by a minus sign.
|
||||||
The options must be separated by blanks, for example
|
The options must be separated by blanks, for example
|
||||||
.B -dx 100
|
.B -dx 100
|
||||||
|
@ -276,14 +276,14 @@ and
|
||||||
.B new
|
.B new
|
||||||
commands accept
|
commands accept
|
||||||
.B -minx
|
.B -minx
|
||||||
.IR n ,
|
.RI [±] n ,
|
||||||
.B -miny
|
.B -miny
|
||||||
.IR n ,
|
.RI [±] n ,
|
||||||
.B -maxx
|
.B -maxx
|
||||||
.IR n ,
|
.RI [±] n ,
|
||||||
and
|
and
|
||||||
.BR -maxy
|
.B -maxy
|
||||||
.I n
|
.RI [±] n
|
||||||
options to set the position of the corresponding edge of the window.
|
options to set the position of the corresponding edge of the window.
|
||||||
They also accept an option
|
They also accept an option
|
||||||
.B -r
|
.B -r
|
||||||
|
|
|
@ -283,7 +283,7 @@ The server replies with its own authenticator,
|
||||||
proving to the client that it also knows
|
proving to the client that it also knows
|
||||||
.I Kn
|
.I Kn
|
||||||
and therefore
|
and therefore
|
||||||
.I Ks .
|
.IR Ks .
|
||||||
.PP
|
.PP
|
||||||
The 64-bit shared secret
|
The 64-bit shared secret
|
||||||
.I Kn
|
.I Kn
|
||||||
|
|
|
@ -764,7 +764,7 @@ option enables caching which is handy for debugging the dns code.
|
||||||
.PP
|
.PP
|
||||||
.I Ndb/dnsgetip
|
.I Ndb/dnsgetip
|
||||||
resolves and prints A and AAAA records without consulting
|
resolves and prints A and AAAA records without consulting
|
||||||
.I ndb/dns .
|
.IR ndb/dns .
|
||||||
By default,
|
By default,
|
||||||
.I ndb/dnsgetip
|
.I ndb/dnsgetip
|
||||||
queries A records first and then AAAA records. As with
|
queries A records first and then AAAA records. As with
|
||||||
|
|
|
@ -66,7 +66,7 @@ option specifies that the arena starts at byte
|
||||||
(default
|
(default
|
||||||
.BR 0 )
|
.BR 0 )
|
||||||
in
|
in
|
||||||
.I arenafile .
|
.IR arenafile .
|
||||||
This is useful for reading directly from
|
This is useful for reading directly from
|
||||||
the Venti arena partition:
|
the Venti arena partition:
|
||||||
.IP
|
.IP
|
||||||
|
|
Loading…
Reference in a new issue