diff options
Diffstat (limited to 'usr/src/man/man5')
-rw-r--r-- | usr/src/man/man5/beastie.4th.5 | 17 | ||||
-rw-r--r-- | usr/src/man/man5/brand.4th.5 | 9 | ||||
-rw-r--r-- | usr/src/man/man5/byteorder.5 | 112 | ||||
-rw-r--r-- | usr/src/man/man5/eventfd.5 | 8 | ||||
-rw-r--r-- | usr/src/man/man5/ieee802.3.5 | 97 | ||||
-rw-r--r-- | usr/src/man/man5/loader.5 | 25 | ||||
-rw-r--r-- | usr/src/man/man5/man.5 | 76 | ||||
-rw-r--r-- | usr/src/man/man5/mdoc.5 | 116 | ||||
-rw-r--r-- | usr/src/man/man5/menu.4th.5 | 7 | ||||
-rw-r--r-- | usr/src/man/man5/pam_timestamp.5 | 9 | ||||
-rw-r--r-- | usr/src/man/man5/zfsloader.5 | 7 |
11 files changed, 271 insertions, 212 deletions
diff --git a/usr/src/man/man5/beastie.4th.5 b/usr/src/man/man5/beastie.4th.5 index 8f2f40bd74..c9ac2e6dd3 100644 --- a/usr/src/man/man5/beastie.4th.5 +++ b/usr/src/man/man5/beastie.4th.5 @@ -34,8 +34,8 @@ The file that goes by the name of is a set of commands designed to draw the ASCII art FreeBSD mascot .Nd known simply as .Ic beastie -.Nd to the right of the boot loader menu. In illumos based systems, the -distribution specific logo is used. +.Nd to the right of the boot loader menu. +In illumos based systems, the distribution specific logo is used. The commands of .Nm by themselves are not enough for most uses. @@ -96,9 +96,11 @@ The environment variables that effect its behavior are: .It Va loader_logo Selects the desired logo in the beastie boot menu. .It Va loader_logo_x -Sets the desired column position of the logo. Default is 46. +Sets the desired column position of the logo. +Default is 46. .It Va loader_logo_y -Sets the desired row position of the logo. Default is 4. +Sets the desired row position of the logo. +Default is 4. .It Va beastie_disable If set to .Dq YES , @@ -106,9 +108,10 @@ the beastie boot menu will be skipped. The beastie boot menu is always skipped if running non-x86 hardware. .It Va loader_delay If set to a number higher than zero, introduces a delay before starting the -beastie boot menu. During the delay the user can press either Ctrl-C to skip -the menu or ENTER to proceed to the menu. The default is to not delay when -loading the menu. +beastie boot menu. +During the delay the user can press either Ctrl-C to skip the menu or ENTER to +proceed to the menu. +The default is to not delay when loading the menu. .El .Sh FILES .Bl -tag -width /boot/forth/loader.4th -compact diff --git a/usr/src/man/man5/brand.4th.5 b/usr/src/man/man5/brand.4th.5 index ce74b382a6..8bb9b7b935 100644 --- a/usr/src/man/man5/brand.4th.5 +++ b/usr/src/man/man5/brand.4th.5 @@ -79,14 +79,17 @@ The default values are 2 (x) and 1 (y). The environment variables that effect its behavior are: .Bl -tag -width bootfile -offset indent .It Va loader_brand -Selects the desired brand in the beastie boot menu. Possible values are: +Selects the desired brand in the beastie boot menu. +Possible values are: .Dq Li illumos (default) or .Dq Li none . .It Va loader_brand_x -Sets the desired column position of the brand. Default is 2. +Sets the desired column position of the brand. +Default is 2. .It Va loader_brand_y -Sets the desired row position of the brand. Default is 1. +Sets the desired row position of the brand. +Default is 1. .El .Sh FILES .Bl -tag -width /boot/forth/loader.4th -compact diff --git a/usr/src/man/man5/byteorder.5 b/usr/src/man/man5/byteorder.5 index 4172008e97..8e091f5f3d 100644 --- a/usr/src/man/man5/byteorder.5 +++ b/usr/src/man/man5/byteorder.5 @@ -20,11 +20,12 @@ .Nd byte order and endianness .Sh DESCRIPTION Integer values which occupy more than 1 byte in memory can be laid out -in different ways on different platforms. In particular, there is a -major split between those which place the least significant byte of an -integer at the lowest address, and those which place the most -significant byte there instead. As this difference relates to which -end of the integer is found in memory first, the term +in different ways on different platforms. +In particular, there is a major split between those which place the least +significant byte of an integer at the lowest address, and those which place the +most significant byte there instead. +As this difference relates to which end of the integer is found in memory first, +the term .Em endian is used to refer to a particular byte order. .Pp @@ -33,24 +34,25 @@ A platform is referred to as using a byte order when it places the most significant byte at the lowest address, and .Em little-endian -when it places the least significant byte first. Some platforms may also -switch between big- and little-endian mode and run code compiled for -either. +when it places the least significant byte first. +Some platforms may also switch between big- and little-endian mode and run code +compiled for either. .Pp Historically, there have also been some systems that utilized .Em middle-endian -byte orders for integers larger than 2 bytes. Such orderings are not in -common use today. +byte orders for integers larger than 2 bytes. +Such orderings are not in common use today. .Pp Endianness is also of particular importance when dealing with values -that are being read into memory from an external source. For example, -network protocols such as IP conventionally define the fields in a -packet as being always stored in big-endian byte order. This means that -a little-endian machine will have to perform transformations on these -fields in order to process them. +that are being read into memory from an external source. +For example, network protocols such as IP conventionally define the fields in a +packet as being always stored in big-endian byte order. +This means that a little-endian machine will have to perform transformations on +these fields in order to process them. .Ss Examples To illustrate endianness in memory, let us consider the decimal integer -2864434397. This number fits in 32 bits of storage (4 bytes). +2864434397. +This number fits in 32 bits of storage (4 bytes). .Pp On a big-endian system, this integer would be written into memory as the bytes 0xAA, 0xBB, 0xCC, 0xDD, in order from lowest memory address to @@ -89,8 +91,8 @@ bytes). On a big-endian system, this would be written into memory as 0x12, then 0x34. .Pp -On a little-endian system, it would be written as 0x34, then 0x12. Note -that this is not at all the same as seeing 0x43 then 0x21 in memory -- +On a little-endian system, it would be written as 0x34, then 0x12. +Note that this is not at all the same as seeing 0x43 then 0x21 in memory -- only the bytes are re-ordered, not any bits (or nybbles) within them. .Pp As before, storing this at address 0x100: @@ -135,15 +137,16 @@ discussing which is also known as .Em middle-endian . While the PDP-11 was a 16-bit little-endian system, it laid out 32-bit -values in a different way from current little-endian systems. First, it -would divide a 32-bit number into two 16-bit numbers. Each 16-bit number -would be stored in little-endian; however, the two 16-bit words would be -stored with the larger 16-bit word appearing first in memory, followed -by the latter. +values in a different way from current little-endian systems. +First, it would divide a 32-bit number into two 16-bit numbers. +Each 16-bit number would be stored in little-endian; however, the two 16-bit +words would be stored with the larger 16-bit word appearing first in memory, +followed by the latter. .Pp The following image illustrates PDP-endian and compares it against -little-endian values. Here, we'll start with the value 0xAABBCCDD and -show how the four bytes for it will be laid out, starting at 0x100. +little-endian values. +Here, we'll start with the value 0xAABBCCDD and show how the four bytes for it +will be laid out, starting at 0x100. .Bd -literal PDP-Endian @@ -162,16 +165,17 @@ show how the four bytes for it will be laid out, starting at 0x100. .Ed .Ss Network Byte Order The term 'network byte order' refers to big-endian ordering, and -originates from the IEEE. Early disagreements over which byte ordering -to use for network traffic prompted RFC1700 to define that all -IETF-specified network protocols use big-endian ordering unless noted -explicitly otherwise. The Internet protocol family (IP, and thus TCP and -UDP etc) particularly adhere to this convention. +originates from the IEEE. +Early disagreements over which byte ordering to use for network traffic prompted +RFC1700 to define that all IETF-specified network protocols use big-endian +ordering unless noted explicitly otherwise. +The Internet protocol family (IP, and thus TCP and UDP etc) particularly adhere +to this convention. .Ss Determining the System's Byte Order -The operating system supports both big-endian and little-endian CPUs. To -make it easier for programs to determine the endianness of the -platform they are being compiled for, functions and macro constants are -provided in the system header files. +The operating system supports both big-endian and little-endian CPUs. +To make it easier for programs to determine the endianness of the platform they +are being compiled for, functions and macro constants are provided in the system +header files. .Pp The endianness of the system can be obtained by including the header .In sys/types.h @@ -186,16 +190,18 @@ for more information. Additionally, the header .In endian.h defines an alternative means for determining the endianness of the -current system. See +current system. +See .Xr endian.h 3HEAD for more information. .Pp -illumos runs on both big- and little-endian systems. When writing -software for which the endianness is important, one must always check -the byte order and convert it appropriately. +illumos runs on both big- and little-endian systems. +When writing software for which the endianness is important, one must always +check the byte order and convert it appropriately. .Ss Converting Between Byte Orders The system provides two different sets of functions to convert values -between big-endian and little-endian. They are defined in +between big-endian and little-endian. +They are defined in .Xr byteorder 3C and .Xr endian 3C . @@ -215,23 +221,24 @@ For example, to convert a 32-bit value, a long, from network byte order to the host's, one would use the function .Xr ntohl 3SOCKET . .Pp -These functions have been standardized by POSIX. However, the 64-bit variants, +These functions have been standardized by POSIX. +However, the 64-bit variants, .Xr ntohll 3SOCKET and .Xr htonll 3SOCKET -are not standardized and may not be found on other systems. For more -information on these functions, see +are not standardized and may not be found on other systems. +For more information on these functions, see .Xr byteorder 3SOCKET . .Pp The second family of functions, .Xr endian 3C , provide a means to convert between the host's byte order -and big-endian and little-endian specifically. While these functions are -similar to those in +and big-endian and little-endian specifically. +While these functions are similar to those in .Xr byteorder 3C , -they more explicitly cover different data conversions. Like them, these -functions operate on either 16-bit, 32-bit, or 64-bit values. When -converting from big-endian, to the host's endianness, the functions +they more explicitly cover different data conversions. +Like them, these functions operate on either 16-bit, 32-bit, or 64-bit values. +When converting from big-endian, to the host's endianness, the functions begin with .Sy betoh . If instead, one is converting data from the host's native endianness to @@ -244,16 +251,15 @@ and convert little-endian data to the host's endianness and from the host's to little-endian respectively. .Pp -These functions -are not standardized and the header they appear in varies between the -BSDs and GNU/Linux. Applications that wish to be portable, should -instead use the +These functions are not standardized and the header they appear in varies +between the BSDs and GNU/Linux. +Applications that wish to be portable, shoulda instead use the .Xr byteorder 3C functions. .Pp All of these functions in both families simply return their input when -the host's native byte order is the same as the desired order. For -example, when calling +the host's native byte order is the same as the desired order. +For example, when calling .Xr htonl 3SOCKET on a big-endian system the original data is returned with no conversion or modification. diff --git a/usr/src/man/man5/eventfd.5 b/usr/src/man/man5/eventfd.5 index bcf9f58347..1466201967 100644 --- a/usr/src/man/man5/eventfd.5 +++ b/usr/src/man/man5/eventfd.5 @@ -22,10 +22,10 @@ .Sh DESCRIPTION .Nm is a Linux-borne facility for sending and receiving user -events via a file descriptor. While the facility itself is somewhat dubious -(it can be mimicked in an entirely portable way with a pipe), it is -small and straightforward and this implementation is entirely compatible -with its Linux antecedent; see +events via a file descriptor. +While the facility itself is somewhat dubious (it can be mimicked in an entirely +portable way with a pipe), it is small and straightforward and this +implementation is entirely compatible with its Linux antecedent; see .Xr eventfd 3C for details. .Sh SEE ALSO diff --git a/usr/src/man/man5/ieee802.3.5 b/usr/src/man/man5/ieee802.3.5 index b77c378db2..a32230c1f0 100644 --- a/usr/src/man/man5/ieee802.3.5 +++ b/usr/src/man/man5/ieee802.3.5 @@ -29,13 +29,14 @@ .Nd IEEE 802.3 Ethernet parameters and statistics .Sh DESCRIPTION The IEEE 802.3 standard specifies the details for Ethernet -networking. This page describes the various statistics and tunables -that device drivers supporting Ethernet commonly offer. +networking. +This page describes the various statistics and tunables that device drivers +supporting Ethernet commonly offer. . Note that not every device or driver supports every one of these values, and many devices offer additional statistics and tunables that -are specific to that hardware. See the device driver's documentation -for those specific details. +are specific to that hardware. +See the device driver's documentation for those specific details. . .Lp Values that are statistics are visible @@ -43,11 +44,12 @@ Values that are statistics are visible whereas properties are visible using the .Xr dladm 1M .Sy show-linkprop -subcommand. Tunables are properties that can be changed using the +subcommand. +Tunables are properties that can be changed using the .Xr dladm 1M .Sy set-linkprop -subcommand. A more useful summary of current operational -state can be seen with the +subcommand. +A more useful summary of current operational state can be seen with the .Xr dladm 1M .Sy show-ether subcommand. @@ -59,11 +61,13 @@ Note that some statistics are available in both 32- and 64-bit counters, in which case the name of the 64 bit statistic will be the same as the 32-bit, but with .Dq Sy 64 -appended. For example, +appended. +For example, .Sy ipackets64 is the 64-bit version of the .Sy ipackets -statistic. These are indicated with the special suffix +statistic. +These are indicated with the special suffix .Op Sy 64 in the table below. . @@ -273,7 +277,8 @@ Transceiver address. .It Sy xcvr_id Transceiver vendor and device ID. .It Sy xcvr_inuse -Identifies the type of transceiver in use. Values are as follows: +Identifies the type of transceiver in use. +Values are as follows: .Bl -column "0" .It 0 Ta Unknown or undefined. .It 1 Ta None. @@ -288,8 +293,9 @@ Identifies the type of transceiver in use. Values are as follows: .Ss Properties The following parameters are accessible with .Xr dladm 1M . -Some of these are normally read-only. Other properties that are not -specific to IEEE 802.3 / Ethernet links are also available via +Some of these are normally read-only. +Other properties that are not specific to IEEE 802.3 / Ethernet links are also +available via .Xr dladm 1M , and are documented in its man page rather than here. . @@ -301,7 +307,8 @@ Link duplex, either "full" or "half". .It Sy state Link state, either "up" or "down". .It Sy mtu -Maximum link frame size in bytes. See +Maximum link frame size in bytes. +See .Sx Jumbo Frames . .It Sy flowctrl Flow control setting, one of \(dqno\(dq, \(dqtx\(dq, \(dqrx\(dq, or \(dqbi\(dq. @@ -343,9 +350,10 @@ Advertising 10 Mbps half-duplex support. Enable 10 Mbps half-duplex. .El .Ss Auto-negotiation -With modern devices, auto-negotiation is normally handled automatically. With -10 Gbps and 1000 Gbps, it is mandatory. (10GBASE-T also requires full-duplex -operation.) It is also +With modern devices, auto-negotiation is normally handled automatically. +With 10 Gbps and 1000 Gbps, it is mandatory (10GBASE-T also requires full-duplex +operation). +It is also .Em strongly recommended for use whenever possible; without auto-negotiation the link will usually not operate unless both partners are configured to use the @@ -385,18 +393,19 @@ property in .Lp Auto-negotiation may also be disabled, by setting the .Sy adv_autoneg_cap -property to 0. In this case, the highest enabled link mode (using the above -list) is +property to 0. +In this case, the highest enabled link mode (using the above list) is .Dq forced for the link. .Ss Flow Control Link layer flow control is available on many modern devices, and is mandatory -for operation at 10 Gbps. It requires that the link be auto-negotiated, and -that the link be full-duplex, in order to function. +for operation at 10 Gbps. +It requires that the link be auto-negotiated, and that the link be full-duplex, +in order to function. .Lp -Flow control is applied when a receiver becomes congested. In this case the -receiver can send a special frame, called a pause frame, to request its -partner cease transmitting for a short period of time. +Flow control is applied when a receiver becomes congested. +In this case the receiver can send a special frame, called a pause frame, to +request its partner cease transmitting for a short period of time. .Lp Flow control can be said to be either symmetric, in which case both partners can send and honor pause frames, or asymmetric, in which case one partner @@ -404,7 +413,8 @@ may not transmit pause frames. .Lp The flow control mode used is driven by the .Sy flowctrl -property. It has the following meanings: +property. +It has the following meanings: .Lp .Bl -column -compact -offset indent Dv .It \(dqno\(dq Ta Neither send, nor honor pause frames. @@ -421,27 +431,30 @@ and .Sy link_asmpause .Pc are based on the properties exchanged in the auto-negotiation and are -confusing as a result. Administrators are advised to use the +confusing as a result. +Administrators are advised to use the .Sy flowctrl property instead. . .Ss Jumbo Frames The IEEE 802.3 standard specifies a standard frame size of 1518 bytes, which includes a 4-byte frame checksum, a 14-byte header, and 1500 bytes -of payload. Most devices support larger frame sizes than this, and -when all possible parties on the same local network can do so, it may be -advantageous to choose a larger frame size; 9000 bytes is the most common -option, as it allows a transport layer to convey 8 KB (8192) of data, while -leaving room for various link, network, and transport layer headers. +of payload. +Most devices support larger frame sizes than this, and when all possible parties +on the same local network can do so, it may be advantageous to choose a larger +frame size; 9000 bytes is the most common option, as it allows a transport layer +to convey 8 KB (8192) of data, while leaving room for various link, network, and +transport layer headers. .Lp Note that the use of frames carrying more than 1500 bytes of payload is not standardized, even though it is common practice. .Lp The .Sy mtu -property is used to configure the frame size. Note that this is the size of -the payload, and excludes the preamble, checksum, and header. It also excludes -the tag for devices that support tagging (see +property is used to configure the frame size. +Note that this is the size of the payload, and excludes the preamble, checksum, +and header. +It also excludes the tag for devices that support tagging (see .Sx Virtual LANs below). .Lp @@ -450,22 +463,24 @@ size, or communication may cease to function properly. .Lp Note that the .Sy mtu -property refers to the link layer property. It may be necessary to configure -upper layer protocols such as IP to use a different size when this changes. +property refers to the link layer property. +It may be necessary to configure upper layer protocols such as IP to use a +different size when this changes. See .Xr ifconfig 1M . . .Ss Virtual LANs Most devices support virtual LANs (and also priority control tagging) though -the use of a 4-byte tag inserted between the frame header and payload. The -details of configuration of this are covered in the +the use of a 4-byte tag inserted between the frame header and payload. +The details of configuration of this are covered in the .Xr dladm 1M manual. . .Ss Data Link Provider Interface (DLPI) Details . The correct method for applications to access Ethernet devices directly -is to use the DLPI. See +is to use the DLPI. +See .Xr dlpi 7P and .Xr libdlpi 3LIB @@ -493,14 +508,16 @@ Additionally, it is possible to configure provide names to interfaces using the .Xr dladm 1M .Sy rename-link -subcommand. Such vanity names are only accessible using DLPI style 1. +subcommand. +Such vanity names are only accessible using DLPI style 1. .Sh NOTES There may be other mechanisms available to configure link layer properties. Historically the .Xr ndd 1M command, and .Xr driver.conf 4 -files could be used to do this. These methods are deprecated in favor of +files could be used to do this. +These methods are deprecated in favor of .Xr dladm 1M properties. . diff --git a/usr/src/man/man5/loader.5 b/usr/src/man/man5/loader.5 index ef651b02a1..655e4ad955 100644 --- a/usr/src/man/man5/loader.5 +++ b/usr/src/man/man5/loader.5 @@ -33,8 +33,9 @@ The .Nm is the final stage of .Nm illumos Ns 's -kernel bootstrapping process. The actual name for the stage depends on -the platform. On IA32 (i386) architectures with BIOS firmware, it is a +kernel bootstrapping process. +The actual name for the stage depends on the platform. +On IA32 (i386) architectures with BIOS firmware, it is a .Pa BTX client and named .Nm zfsloader . @@ -49,17 +50,20 @@ supports booting from .Cm HSFS and .Cm NFS -file systems. Additionally, +file systems. +Additionally, .Nm can load files from the .Cm TFTP -file service. The NFS and TFTP based boot is enabled via +file service. +The NFS and TFTP based boot is enabled via .Xr pxeboot 5 . The .Nm -also does support uncompressing gzip files while reading. The uncompression -will happen automatically if the compressed file is stored without .gz -suffix or if the file is accessed by leaving out the .gz suffix from the name. +also does support uncompressing gzip files while reading. +The uncompression will happen automatically if the compressed file is stored +without .gz suffix or if the file is accessed by leaving out the .gz suffix from +the name. If the file is referred by full name, including .gz suffix, then the file content is read as is and the uncompression is not performed. .Pp @@ -189,8 +193,8 @@ The behavior of this builtin is changed if is loaded. .Pp .It Ic chain Ar device -Chain load another boot loader from the specified device. Device can be either -disk name or partition. +Chain load another boot loader from the specified device. +Device can be either disk name or partition. .Pp .It Ic echo Xo .Op Fl n @@ -399,7 +403,8 @@ Will set .Fl v option. .It Va boot-args -Will set custom arguments for the kernel. If set in +Will set custom arguments for the kernel. +If set in .Nm configuration, the .Nm diff --git a/usr/src/man/man5/man.5 b/usr/src/man/man5/man.5 index 0ed6910e33..6598394cd7 100644 --- a/usr/src/man/man5/man.5 +++ b/usr/src/man/man5/man.5 @@ -21,26 +21,28 @@ .Fl man .Ar .Sh DESCRIPTION -These macros are used to lay out the reference pages in this manual. Note: if +These macros are used to lay out the reference pages in this manual. +Note: if .Ar file contains format input for a preprocessor, the commands shown -above must be piped through the appropriate preprocessor. This is handled -automatically by the +above must be piped through the appropriate preprocessor. +This is handled automatically by the .Xr man 1 -command. See the +command. +See the .Sx Conventions section. .Lp Any text argument .Ar t -may be zero to six words. Quotes may be used to -include SPACE characters in a +may be zero to six words. +Quotes may be used to include SPACE characters in a .Qq word . If .Ar text is empty, the special -treatment is applied to the next input line with text to be printed. In this -way +treatment is applied to the next input line with text to be printed. +In this way .Nm \&.I may be used to italicize a whole line, or .Nm \&.SB @@ -48,7 +50,8 @@ may be used to make small bold letters. .Lp A prevailing indent distance is remembered between successive indented paragraphs, and is reset to default value upon reaching a non-indented -paragraph. Default units for indents +paragraph. +Default units for indents .Nm i are ens. .Lp @@ -108,7 +111,8 @@ Sets prevailing indent to .5i for nested indents. When formatting a manual page, .Nm examines the first line to determine -whether it requires special processing. For example a first line consisting of: +whether it requires special processing. +For example a first line consisting of: .Lp .Dl \&'\e" t .Lp @@ -122,13 +126,14 @@ A typical manual page for a command or function is laid out as follows: .It Nm \&.TH Ar title Op "1-9" . The name of the command or function, which serves as the title of the manual -page. This is followed by the number of the section in which it appears. +page. +This is followed by the number of the section in which it appears. . .It Nm \&.SH NAME . The name, or list of names, by which the command is called, followed by a dash -and then a one-line summary of the action performed. All in roman font, this -section contains no +and then a one-line summary of the action performed. +All in roman font, this section contains no .Xr troff 1 commands or escapes, and no macro requests. It is used to generate the database used by the @@ -139,48 +144,52 @@ command. .Bl -tag -width "Functions:" .It Sy Commands: The syntax of the command and its arguments, as typed on the command line. -When in boldface, a word must be typed exactly as printed. When in italics, a -word can be replaced with an argument that you supply. References to bold or -italicized items are not capitalized in other sections, even when they begin a -sentence. +When in boldface, a word must be typed exactly as printed. +When in italics, a word can be replaced with an argument that you supply. +References to bold or italicized items are not capitalized in other sections, +even when they begin a sentence. .Lp Syntactic symbols appear in roman face: .Bl -tag -width " " .It Op " " An argument, when surrounded by brackets is optional. .It | -Arguments separated by a vertical bar are exclusive. You can supply only one -item from such a list. +Arguments separated by a vertical bar are exclusive. +You can supply only one item from such a list. .It \&.\|.\|. -Arguments followed by an ellipsis can be repeated. When an ellipsis follows a -bracketed set, the expression within the brackets can be repeated. +Arguments followed by an ellipsis can be repeated. +When an ellipsis follows a bracketed set, the expression within the brackets can +be repeated. .El .It Sy Functions: If required, the data declaration, or .Li #include directive, is shown first, -followed by the function declaration. Otherwise, the function declaration is -shown. +followed by the function declaration. +Otherwise, the function declaration is shown. .El . .It Nm \&.SH DESCRIPTION . -A narrative overview of the command or function's external behavior. This -includes how it interacts with files or data, and how it handles the standard -input, standard output and standard error. Internals and implementation details -are normally omitted. This section attempts to provide a succinct overview in -answer to the question, "what does it do?" +A narrative overview of the command or function's external behavior. +This includes how it interacts with files or data, and how it handles the +standard input, standard output and standard error. +Internals and implementation details are normally omitted. +This section attempts to provide a succinct overview in answer to the question, +"what does it do?" .Lp Literal text from the synopsis appears in constant width, as do literal filenames and references to items that appear elsewhere in the reference -manuals. Arguments are italicized. +manuals. +Arguments are italicized. .Lp If a command interprets either subcommands or an input grammar, its command interface or input grammar is normally described in a .Nm USAGE section, which follows the .Nm OPTIONS -section. The +section. +The .Nm DESCRIPTION section only describes the behavior of the command itself, not that of subcommands. @@ -223,14 +232,15 @@ with the command or function. .Sh NOTES The .Nm -package should not be used for new documentation. The +package should not be used for new documentation. +The .Xr mdoc 5 , package is preferred, as it uses semantic markup rather than physical markup. .Sh CODE SET INDEPENDENCE When processed with .Xr mandoc 1 , -this package is Code Set Independent. However, when processed with -legacy tools such as +this package is Code Set Independent. +However, when processed with legacy tools such as .Xr nroff 1 and .Xr troff 1 , diff --git a/usr/src/man/man5/mdoc.5 b/usr/src/man/man5/mdoc.5 index 643a269781..6d81124b02 100644 --- a/usr/src/man/man5/mdoc.5 +++ b/usr/src/man/man5/mdoc.5 @@ -374,8 +374,8 @@ This often contains snippets of well-formed, well-tested invocations. Make sure that examples work properly! .It Em DIAGNOSTICS Documents error and diagnostic messages displayed to the user or -sent to logs. Note that exit -status and return values should be documented in the +sent to logs. +Note that exit status and return values should be documented in the .Em EXIT STATUS and .Em RETURN VALUES @@ -394,100 +394,113 @@ This section is usually absent, but will be present when the interface is specific to one or more architectures. .It Em CODE SET INDEPENDENCE Indicates whether the interface operates correctly with various different -code sets. True independent code sets will support not only ASCII and -Extended UNIX Codesets (EUC), but also other multi-byte encodings such as -UTF-8 and GB2312. +code sets. +True independent code sets will support not only ASCII and Extended UNIX +Codesets (EUC), but also other multi-byte encodings such as UTF-8 and GB2312. .Pp -Generally there will be some limitations that are fairly standard. See -.Xr standards 5 for more information about some of these. Most interfaces -should support at least UTF-8 in addition to ASCII. +Generally there will be some limitations that are fairly standard. +See +.Xr standards 5 +for more information about some of these. +Most interfaces should support at least UTF-8 in addition to ASCII. .It Em INTERFACE STABILITY -Indicates the level of commitment to the interface. Interfaces can be described -with in the following ways: +Indicates the level of commitment to the interface. +Interfaces can be described with in the following ways: .Bl -tag -width Ds .It Nm Standard Indicates that the interface is defined by one or more standards bodies. Generally, changes to the interface will be carefully managed to conform -to the relevant standards. These interfaces are generally the most suitable -for use in portable programs. +to the relevant standards. +These interfaces are generally the most suitable for use in portable programs. .It Nm Committed Indicates that the interface is intended to be preserved for the long-haul, and will rarely, if ever change, and never without notification (barring -extraordinary and extenuating circumstances). These interfaces are -preferred over other interfaces with the exeception of +extraordinary and extenuating circumstances). +These interfaces are preferred over other interfaces with the exeception of .Nm Standard interfaces. .It Nm Uncommitted -Indicates that the interface may change. Generally, changes to these interfaces -should be infrequent, and some effort will be made to address compatibility -considerations when changing or removing such interfaces. However, there is -no firm commitment to the preservation of the interface. Most often this -is applied to interfaces where operational experience with the interface -is still limited and some need to change may be anticipated. +Indicates that the interface may change. +Generally, changes to these interfaces should be infrequent, and some effort +will be made to address compatibility considerations when changing or removing +such interfaces. +However, there is no firm commitment to the preservation of the interface. +Most often this is applied to interfaces where operational experience with the +interface is still limited and some need to change may be anticipated. .Pp Consumers should expect to revalidate any .Nm Uncommitted -interfaces when crossing release boundaries. Products intended for -use on many releases or intended to support compatibility with future -releases should avoid these interfaces. +interfaces when crossing release boundaries. +Products intended for use on many releases or intended to support compatibility +with future releases should avoid these interfaces. .It Nm Volatile -The interface can change at any time for any reason. Often this relates to -interfaces that are part of external software components that are still evolving -rapidly. Consumers should not expect that the interface (either binary or -source level) will be unchanged from one release to the next. +The interface can change at any time for any reason. +Often this relates to interfaces that are part of external software components +that are still evolving rapidly. +Consumers should not expect that the interface (either binary or source level) +will be unchanged from one release to the next. .It Nm Not-an-Interface Describes something that is specifically not intended for programmatic -consumption. For example, specific human-readable output, or the layout -of graphical items on a user interface, may be described this way. Generally -programmatic alternatives to these will be available, and should be used -when programmatic consumption is needed. +consumption. +For example, specific human-readable output, or the layout of graphical items on +a user interface, may be described this way. +Generally programmatic alternatives to these will be available, and should be +used when programmatic consumption is needed. .It Nm Private -This is an internal interface. Generally these interfaces should only be -used within the project, and should not be used by other programs or modules. -The interface can and will change without notice as the project needs, at -any time. +This is an internal interface. +Generally these interfaces should only be used within the project, and should +not be used by other programs or modules. +The interface can and will change without notice as the project needs, at any +time. .Pp Most often, Private interfaces will lack any documentation whatsoever, and generally any undocumented interface can be assumed to be Private. .It Nm Obsolete The interface is not intended for use in new projects or programs, and may -be removed at a future date. The +be removed at a future date. +The .Nm Obsolete word is a modifier that can -be applied to other commitment levels. For example an +be applied to other commitment levels. +For example an .Nm Obsolete Committed interface is unlikely to be removed or changed, but nonetheless new use is discouraged (perhaps a better newer alternative is present). .El .It Em MT-LEVEL This section describes considerations for the interface when used within -programs that use multiple threads. More discussion of these considerations -is made in the MT-Level section of +programs that use multiple threads. +More discussion of these considerations is made in the MT-Level section of .Xr attributes 5 . The interface can be described in the following ways. .Bl -tag -width Ds .It Nm Safe -Indicates the interface is safe for use within multiple threads. There -may be additional caveats that apply, in which case those will be -described. Note that some interfaces have semantics which may affect -other threads, but these should be an intrinsic part of the interface -rather than an unexpected side effect. For example, closing a file in -one thread will cause that file to be closed in all threads. +Indicates the interface is safe for use within multiple threads. +There may be additional caveats that apply, in which case those will be +described. +Note that some interfaces have semantics which may affect other threads, but +these should be an intrinsic part of the interface rather than an unexpected +side effect. +For example, closing a file in one thread will cause that file to be closed in +all threads. .It Nm Unsafe Indicates the interface is unsuitable for concurrent use within multiple -threads. A threaded application may still make use of the interface, but -will be required to provide external synchronization means to ensure that -only a single thread calls the interface at a time. +threads. +A threaded application may still make use of the interface, but will be required +to provide external synchronization means to ensure that only a single thread +calls the interface at a time. .It Nm MT-Safe Indicates that the interface is not only safe for concurrent use, but is -designed for such use. For example, a +designed for such use. +For example, a .Nm Safe interface may make use of a global lock to provide safety, but at reduced internal concurrency, whereas an .Nm MT-Safe interface will be designed to be efficient even when used concurrently. .It Nm Async-Signal-Safe -Indicates that the library is safe for use within a signal handler. An +Indicates that the library is safe for use within a signal handler. +An .Nm MT-Safe interface can be made .Nm Async-Signal-Safe @@ -1261,7 +1274,8 @@ See also and .Sx \&Ox . .Ss \&Cd -Kernel configuration declaration. It is found in pages for +Kernel configuration declaration. +It is found in pages for .Bx and not used here. .Pp diff --git a/usr/src/man/man5/menu.4th.5 b/usr/src/man/man5/menu.4th.5 index e4644008ed..92f15d9d9b 100644 --- a/usr/src/man/man5/menu.4th.5 +++ b/usr/src/man/man5/menu.4th.5 @@ -142,7 +142,8 @@ Default is .It Va loader_menu_title_align Default is to align .Ic loader_menu_title -centered above the menu. This can be set to +centered above the menu. +This can be set to .Dq Li left or .Dq Li right @@ -268,8 +269,8 @@ represents the ASCII decimal value for .Pp For all values of .Dq Li x -above, use any number between 1 through 9. Sorry, double-digits are not -currently supported. +above, use any number between 1 through 9. +Sorry, double-digits are not currently supported. .Sh FILES .Bl -tag -width /boot/forth/loader.4th -compact .It Pa /boot/zfsloader diff --git a/usr/src/man/man5/pam_timestamp.5 b/usr/src/man/man5/pam_timestamp.5 index 7e31657ab1..59b425d8f1 100644 --- a/usr/src/man/man5/pam_timestamp.5 +++ b/usr/src/man/man5/pam_timestamp.5 @@ -15,8 +15,7 @@ .Os .Sh NAME .Nm pam_timestamp -.Nd PAM authentication module using cached successful -authentication attempts +.Nd PAM authentication module using cached successful authentication attempts .Sh SYNOPSIS .Nm pam_timestamp.so.1 .Op Ar debug @@ -50,7 +49,7 @@ and Proper authentication operation requires .Xr pam_unix_cred 5 be stacked above -.Xr pam_timestamp . +.Nm . .Sh OPTIONS .Bl -tag -width Ds .It Dv debug @@ -60,8 +59,8 @@ debugging information at the .Sy LOG_AUTH | LOG_DEBUG level. .It Dv timeout -Specifies the period (in miniutes) for which the timestamp -file is valid. The default value is 5 minutes. +Specifies the period (in miniutes) for which the timestamp file is valid. +The default value is 5 minutes. .El .Sh FILES .Bl -tag -width indent diff --git a/usr/src/man/man5/zfsloader.5 b/usr/src/man/man5/zfsloader.5 index f6b56a9245..ebfed4f0c2 100644 --- a/usr/src/man/man5/zfsloader.5 +++ b/usr/src/man/man5/zfsloader.5 @@ -94,6 +94,7 @@ set currdev=zfs:rpool/ROOT/knowngood: Although setting the .Va currdev as shown in the example above is supported, it is advisable to use loader -beadm command or boot environment menu instead. The reason is, the beadm -or menu selection will also instruct loader to clean up the currently set -configuration and load configuration from the new boot environment. +beadm command or boot environment menu instead. +The reason is, the beadm or menu selection will also instruct loader to clean up +the currently set configuration and load configuration from the new boot +environment. |