From: qwx Date: Tue, 24 Aug 2021 21:45:37 +0000 (+0000) Subject: man page fixes (thanks stuart morrow) X-Git-Url: https://git.lizzy.rs/?a=commitdiff_plain;h=ad26f82e44a5f59383edfde5f4c3727c225f4b0a;p=plan9front.git man page fixes (thanks stuart morrow) --- diff --git a/sys/man/1/deroff b/sys/man/1/deroff index 8a7f74fcb..2d25b2165 100644 --- a/sys/man/1/deroff +++ b/sys/man/1/deroff @@ -83,11 +83,11 @@ but remove lists as well. .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 diff --git a/sys/man/1/leak b/sys/man/1/leak index 34fb471a7..45d91a0a1 100644 --- a/sys/man/1/leak +++ b/sys/man/1/leak @@ -158,7 +158,7 @@ The list is sorted by count in decreasing order. .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 diff --git a/sys/man/1/uhtml b/sys/man/1/uhtml index 4d81c3175..a2eb70e0b 100644 --- a/sys/man/1/uhtml +++ b/sys/man/1/uhtml @@ -12,31 +12,31 @@ uhtml \- convert foreign character set HTML file to unicode .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. diff --git a/sys/man/1/vac b/sys/man/1/vac index c63a77c7d..003df277f 100644 --- a/sys/man/1/vac +++ b/sys/man/1/vac @@ -82,7 +82,7 @@ the files under an extra two levels of directory hierarchy named .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 @@ -184,7 +184,7 @@ All other lines should be of the form .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 diff --git a/sys/man/2/9p b/sys/man/2/9p index c13c4fac1..3c0d910a8 100644 --- a/sys/man/2/9p +++ b/sys/man/2/9p @@ -511,7 +511,7 @@ prone to error, the helper routine 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 @@ -881,7 +881,7 @@ option to increment .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 diff --git a/sys/man/2/ioproc b/sys/man/2/ioproc index 4b69bdba8..6e4b04be8 100644 --- a/sys/man/2/ioproc +++ b/sys/man/2/ioproc @@ -92,7 +92,7 @@ to clear a pending interrupt. .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 diff --git a/sys/man/2/ip b/sys/man/2/ip index b78ea2bfd..3891a6a55 100644 --- a/sys/man/2/ip +++ b/sys/man/2/ip @@ -97,7 +97,7 @@ uchar v4prefix[IPaddrlen]; .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 @@ -222,7 +222,7 @@ operates on v6 addresses. .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, diff --git a/sys/man/2/pushtls b/sys/man/2/pushtls index 72a2605bf..540732a5e 100644 --- a/sys/man/2/pushtls +++ b/sys/man/2/pushtls @@ -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 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 diff --git a/sys/man/2/venti-cache b/sys/man/2/venti-cache index bca14bd7a..1f1b108d2 100644 --- a/sys/man/2/venti-cache +++ b/sys/man/2/venti-cache @@ -126,7 +126,7 @@ and with room for .I nblocks of maximum block size -.I blocksize . +.IR blocksize . .PP .I Vtcachefree frees a cache and all the associated blocks. diff --git a/sys/man/2/venti-log b/sys/man/2/venti-log index a8763202c..311fe2598 100644 --- a/sys/man/2/venti-log +++ b/sys/man/2/venti-log @@ -54,7 +54,7 @@ The logs are named by UTF strings. .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, diff --git a/sys/man/3/cmd b/sys/man/3/cmd index 9138fc5e0..0a887edd7 100644 --- a/sys/man/3/cmd +++ b/sys/man/3/cmd @@ -61,7 +61,7 @@ accepts the following textual commands, allowing quoting as interpreted by 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 @@ -207,10 +207,10 @@ means success, and a non-empty string contains a diagnostic. .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) diff --git a/sys/man/3/usb b/sys/man/3/usb index de66fa46b..42f40ae11 100644 --- a/sys/man/3/usb +++ b/sys/man/3/usb @@ -19,7 +19,7 @@ usb \- USB Host Controller Interface .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 . @@ -41,7 +41,6 @@ UHCI and OHCI for USB 1 (up to 12 Mb/s), 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 @@ -57,7 +56,7 @@ for particular classes of devices (such as mice, keyboards, or audio devices). 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 @@ -179,7 +178,7 @@ in 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 @@ -267,9 +266,11 @@ Speed (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. @@ -426,7 +427,7 @@ state. .TP .BI name " str" Generates an additional file name, -.I str , +.IR str , for the .B data file of the endpoint. @@ -484,16 +485,16 @@ or .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 diff --git a/sys/man/4/cdfs b/sys/man/4/cdfs index 58aca9691..1f26a20fd 100644 --- a/sys/man/4/cdfs +++ b/sys/man/4/cdfs @@ -203,7 +203,7 @@ The 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 diff --git a/sys/man/4/nusb b/sys/man/4/nusb index e7be812e6..cfad251bc 100644 --- a/sys/man/4/nusb +++ b/sys/man/4/nusb @@ -88,7 +88,7 @@ attachment. It provides a filesystem with the file .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 @@ -99,7 +99,7 @@ followed by .I did .I csp and -.I hname . +.IR hname . The .I addr is the decimal device address assigned. @@ -111,9 +111,9 @@ are formatted as 4 digit hexadecimal. 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 @@ -142,7 +142,7 @@ provides a file system (usually seen under .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 @@ -160,7 +160,7 @@ file supplies the device geometry and partitions when read. .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 @@ -232,9 +232,9 @@ and .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 diff --git a/sys/man/4/rio b/sys/man/4/rio index 0ed8d96eb..6823714d0 100644 --- a/sys/man/4/rio +++ b/sys/man/4/rio @@ -225,7 +225,7 @@ When written to, .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 @@ -276,14 +276,14 @@ and .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 diff --git a/sys/man/6/authsrv b/sys/man/6/authsrv index c57237698..31ba8c2b1 100644 --- a/sys/man/6/authsrv +++ b/sys/man/6/authsrv @@ -283,7 +283,7 @@ The server replies with its own authenticator, proving to the client that it also knows .I Kn and therefore -.I Ks . +.IR Ks . .PP The 64-bit shared secret .I Kn diff --git a/sys/man/8/ndb b/sys/man/8/ndb index f6da3bbb8..58794b442 100644 --- a/sys/man/8/ndb +++ b/sys/man/8/ndb @@ -764,7 +764,7 @@ option enables caching which is handy for debugging the dns code. .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 diff --git a/sys/man/8/venti-backup b/sys/man/8/venti-backup index 599a6d01a..fb08d0b32 100644 --- a/sys/man/8/venti-backup +++ b/sys/man/8/venti-backup @@ -66,7 +66,7 @@ option specifies that the arena starts at byte (default .BR 0 ) in -.I arenafile . +.IR arenafile . This is useful for reading directly from the Venti arena partition: .IP