Index: head/contrib/groff/man/groff_out.man =================================================================== --- head/contrib/groff/man/groff_out.man (revision 151501) +++ head/contrib/groff/man/groff_out.man (revision 151502) @@ -1,1897 +1,2106 @@ '\" e .\" The above line should force the use of eqn as a preprocessor .ig groff_out.5 -Last update: 13 Apr 2003 +Last update: 2 Jul 2005 This file is part of groff, the GNU roff type-setting system. -Copyright (C) 1989, 2001, 2002, 2003 Free Software Foundation, Inc. +Copyright (C) 1989, 2001, 2002, 2003, 2004, 2005 +Free Software Foundation, Inc. rewritten from scrach 2001 by Bernd Warken Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with the Invariant Sections being this .ig-section and AUTHORS, with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the Free Documentation License is included as a file called FDL in the main directory of the groff source package. .. . .\" -------------------------------------------------------------------- .\" Setup .\" -------------------------------------------------------------------- . +.do nr groff_out_C \n[.C] +.cp 0 +. .mso www.tmac . .if n \{\ . mso tty-char.tmac . ftr CR R . ftr CI I . ftr CB B .\} . .if '\*[.T]'dvi' \ . ftr CB CW . .if t \{\ .EQ delim $$ .EN .\} . .\" ----------------- Document configuration . .\" Number register to decide whether the commands `{' and `}' are used .\" 0: disable (actual default); 1: enable .nr @USE_ENV_STACK 0 . .ig Unfortunately, old versions of groff used an illogical position change after some D\~commands (Dp, DP, Dt). If the number register @STUPID_DRAWING_POSITIONING is 1 (actual default) then change position after these commands, otherwise the position is not changed. .. .nr @STUPID_DRAWING_POSITIONING 1 . .\" ----------------- Syntactical definitions . .\" comments when escapes are switched off .de c .. .\" Begin of macro definitions .eo . .de Text . nop \)\$* .. .c follow-up line for a .TP header .de TP+ . br . ns . TP \$1 .. .c a bulleted paragraph .de Topic . TP 2m . nop \[bu] .. .de ShellCommand . br . IR "shell>" "\h'1m'\f[CB]\$*\f[]\/" .. .ec .\" End of macro definitions . .c ----------------- Semantical definitions . .nr @maxcolor 65536 .ds @backslash \[rs]\" .ds @linebreak \f[R]\[la]line_break\[ra]\f[]\" . .\" Begin of macro definitions .eo . .c format: .unit .de unit . BR \$@ .. .c argument in italic with punctuation .de argument . if (\n[.$] == 0) \ . return . IR \$@ .. .c comma separated list of indexed variables .de list1..n . ds @arg1 \$1\" . nop \c . ie t \ . nop $\*[@arg1] sub 1$, $\*[@arg1] sub 2$, .\|.\|., $\*[@arg1] sub n$ \c . el \{\ . IR \*[@arg1]1 , . IR \*[@arg1]2 , . nop \&..., . I \*[@arg1]n . \} . rm @arg1 .. .de offset . if (\n[.$] < 2) \ . ab `.offset' needs at least 2 arguments . ds @arg1 \$1\" . ds @arg2 \$2\" . shift 2 . nop (\f[I]\,\*[@arg1]\/\f[],\ \f[I]\,\*[@arg2]\/\f[])\$* . rm @arg1 . rm @arg2 .. .de indexed_offset . if (\n[.$] < 4) \ . ab `.indexed_offset' needs at least 4 arguments . ds @arg1 \$1\" . ds @index1 \$2\" . ds @arg2 \$3\" . ds @index2 \$4\" . shift 4 . ie t \{\ . ie \B'\*[@index1]' \{\ . nop ($\*[@arg1] sub roman \*[@index1]$,\ \c . \} . el \{\ . nop ($\*[@arg1] sub \*[@index1]$,\ \c . \} . ie \B'\*[@index2]' \{\ . nop $\*[@arg2] sub roman \*[@index2]$)\$* \c . \} . el \{\ . nop $\*[@arg2] sub \*[@index2]$)\$* \c . \} . \} . el \{\ . nop (\f[I]\*[@arg1]\*[@index1]\f[],\ \c . nop \f[I]\*[@arg2]\*[@index2]\f[])\$* \c . \} . rm @arg1 . rm @arg2 . rm @index1 . rm @index2 .. .c format: .command "" .de command . ds @arg1 \$1\" . ds @arg2 \$2\" . shift 2 . IP "\f[B]\*[@arg1]\f[]\ \f[I]\,\*[@arg2]\/\f[]\$*" . rm @arg1 . rm @arg2 .. .c format: .command+ "" .c continue previous .command heading .de command+ . ds @arg1 \$1\" . ds @arg2 \$2\" . shift 2 . TP+ . Text "\f[B]\*[@arg1]\f[]\ \f[I]\,\*[@arg2]\/\f[]\$*" . rm @arg1 . rm @arg2 .. .c format: .D-command "" .de D-command . ds @sub \$1\" . shift 1 . IP "\f[B]D\*[@sub]\f[]\ \f[I]\,\$*\/\f[]\|\*[@linebreak]" . rm @sub .. .c format: .D-command+ "" .c continue previous .D-command heading .de D-command+ . ds @sub \$1\" . shift 1 . TP+ . Text "\f[B]D\*[@sub]\f[]\ \f[I]\,\$*\/\f[]\*[@linebreak]" . rm @sub .. .de Da-command . shift 1 . ie t \ . ds @args $h sub 1$\~$v sub 1$ $h sub 2$\~$v sub 2$\" . el \ . ds @args \f[I]h1\~v1 h2\~v2\f[]\" . IP "\f[B]Da\f[]\ \*[@args]\|\*[@linebreak]" . rm @args .. .c graphics command .D with a variable number of arguments .c format: .D-multiarg .de D-multiarg . ds @sub \$1\" . shift 1 . ie t \{\ . ds @args "$h sub 1$\~$v sub 1$ $h sub 2$\~$v sub 2$ .\|.\|. \" . as @args "$h sub n$\~$v sub n$\" . \} . el \ . ds @args \f[I]h1\~v1 h2\~v2\f[] ... \f[I]\,hn\~vn\f[]\" . IP "\f[B]D\*[@sub]\f[]\ \*[@args]\|\*[@linebreak]" . rm @args . rm @sub .. .c format: .x-command "" .de x-command . ds @sub \$1\" . shift 1 . ds @args . if (\n[.$] > 0) \ . ds @args \ \f[I]\,\$*\/\f[]\" . IP "\f[B]x\*[@sub]\f[]\*[@args]\f[]\|\*[@linebreak]" . rm @sub . rm @args .. .de xsub . RI "(" "\$1" " control command)" . br .. .ec .\" End of macro definitions . . .\" -------------------------------------------------------------------- .\" Title .\" -------------------------------------------------------------------- . .TH GROFF_OUT @MAN5EXT@ "@MDATE@" "Groff Version @VERSION@" . .SH NAME groff_out \- groff intermediate output format . . .\" -------------------------------------------------------------------- .SH DESCRIPTION .\" -------------------------------------------------------------------- . -This manual page describes the intermediate output format of the GNU +This manual page describes the +.I intermediate output +format of the GNU .BR roff (@MAN7EXT@) -text processing system. +text processing system +.BR groff (@MAN1EXT@). . This output is produced by a run of the GNU -.BR troff (@MAN1EXT@) -program before it is fed into a device postprocessor program. +.BR @g@troff (@MAN1EXT@) +program. . +It contains already all device-specific information, but it is not yet +fed into a device postprocessor program. +. +. .P -As the GNU roff processor +As the GNU +.I roff +processor .BR groff (@MAN1EXT@) -is a wrapper program around troff that automatically calls a +is a wrapper program around +.B @g@troff +that automatically calls a postprocessor, this output does not show up normally. . This is why it is called .I intermediate within the .I groff .IR system . . The .B groff program provides the option .B -Z -to inhibit postprocessing, such that the produced intermediate output +to inhibit postprocessing, such that the produced +.I intermediate output is sent to standard output just like calling -.B troff +.B @g@troff manually. . +. .P In this document, the term -.I troff output -describes what is output by the GNU troff program, while +.I @g@troff output +describes what is output by the GNU +.B @g@troff +program, while .I intermediate output refers to the language that is accepted by the parser that prepares this output for the postprocessors. . This parser is smarter on whitespace and implements obsolete elements for compatibility, otherwise both formats are the same. . -The pre-groff roff versions are denoted as -.I classical -.IR troff . +Both formats can be viewed directly with +.BR \%gxditview (@MAN1EXT@). . +. .P -The main purpose of the intermediate output concept is to facilitate -the development of postprocessors by providing a common programming -interface for all devices. +The main purpose of the +.I intermediate output +concept is to facilitate the development of postprocessors by +providing a common programming interface for all devices. . It has a language of its own that is completely different from the .BR groff (@MAN7EXT@) language. . While the .I groff language is a high-level programming language for text processing, the -intermediate output language is a kind of low-level assembler language -by specifying all positions on the page for writing and drawing. +.I intermediate output +language is a kind of low-level assembler language by specifying all +positions on the page for writing and drawing. . +. .P -The intermediate output produced by -.I groff +The +.RI pre- groff +.I roff +versions are denoted as +.I classical +.IR troff . +The +.I intermediate output +produced by +.B groff is fairly readable, while .I classical troff output was hard to understand because of strange habits that are still supported, but not used any longer by .I GNU -.IR troff . +.IR @g@troff . . . .\" -------------------------------------------------------------------- .SH "LANGUAGE CONCEPTS" .\" -------------------------------------------------------------------- . During the run of -.BR troff , -the roff input is cracked down to the information on what has to be -printed at what position on the intended device. +.BR @g@troff , +the +.I roff +input is cracked down to the information on what has to be printed at +what position on the intended device. . -So the language of the intermediate output format can be quite small. +So the language of the +.I intermediate output +format can be quite small. . Its only elements are commands with or without arguments. . -In this document, the term "command" always refers to the intermediate -output language, never to the roff language used for document -formatting. +In this document, the term "command" always refers to the +.I intermediate output +language, never to the +.I roff +language used for document formatting. . There are commands for positioning and text writing, for drawing, and for device controlling. . . .\" -------------------------------------------------------------------- .SS "Separation" .\" -------------------------------------------------------------------- . .I Classical troff output had strange requirements on whitespace. . The -.I groff +.B groff output parser, however, is smart about whitespace by making it maximally optional. . -The whitespace characters, i.e.\& the +The whitespace characters, i.e., the .IR tab , .IR space , and .I newline characters, always have a syntactical meaning. . They are never printable because spacing within the output is always done by positioning commands. . +. .P Any sequence of .I space or .I tab characters is treated as a single -.B syntactical -.BR space . +.I syntactical +.IR space . . It separates commands and arguments, but is only required when there would occur a clashing between the command code and the arguments without the space. . Most often, this happens when variable length command names, arguments, argument lists, or command clusters meet. . Commands and arguments with a known, fixed length need not be -separated by syntactical space. +separated by +.I syntactical +.IR space . . +. .P A line break is a syntactical element, too. . Every command argument can be followed by whitespace, a comment, or a newline character. . Thus a -.B syntactical line break -is defined to consist of optional syntactical space that is optionally -followed by a comment, and a newline character. +.I syntactical line break +is defined to consist of optional +.I syntactical space +that is optionally followed by a comment, and a newline character. . +. .P The normal commands, those for positioning and text, consist of a single letter taking a fixed number of arguments. . For historical reasons, the parser allows to stack such commands on -the same line, but fortunately, in groff intermediate output, every -command with at least one argument is followed by a line break, thus -providing excellent readability. +the same line, but fortunately, in +.I groff intermediate +.IR output , +every command with at least one argument is followed by a line break, +thus providing excellent readability. . .P The other commands \[em] those for drawing and device controlling \[em] have a more complicated structure; some recognize long command names, and some take a variable number of arguments. . So all .B D and .B x commands were designed to request a .I syntactical line break after their last argument. . Only one command, .RB ` x\ X ' has an argument that can stretch over several lines, all other commands must have all of their arguments on the same line as the -command, i.e.\& the arguments may not be splitted by a line break. +command, i.e., the arguments may not be splitted by a line break. . .P -Empty lines, i.e.\& lines containing only space and/or a comment, can +Empty lines, i.e., lines containing only space and/or a comment, can occur everywhere. . They are just ignored. . . .\" -------------------------------------------------------------------- .SS "Argument Units" .\" -------------------------------------------------------------------- . Some commands take integer arguments that are assumed to represent values in a measurement unit, but the letter for the corresponding .I scale indicator is not written with the output command arguments; see .BR groff (@MAN7EXT@) -and the groff info file for more on this topic. +and the +.I groff info file +for more on this topic. . Most commands assume the scale indicator\~\c .unit u , the basic unit of the device, some use\~\c .unit z , the .I scaled point unit of the device, while others, such as the color commands expect plain integers. . Note that these scale indicators are relative to the chosen device. . They are defined by the parameters specified in the device's .I DESC file; see .BR groff_font (@MAN5EXT@). . +. .P Note that single characters can have the eighth bit set, as can the names of fonts and special characters. . The names of characters and fonts can be of arbitrary length. . A character that is to be printed will always be in the current font. . +. .P A string argument is always terminated by the next whitespace character (space, tab, or newline); an embedded .B # character is regarded as part of the argument, not as the beginning of a comment command. . An integer argument is already terminated by the next non-digit character, which then is regarded as the first character of the next argument or command. . . .\" -------------------------------------------------------------------- .SS "Document Parts" .\" -------------------------------------------------------------------- -A correct intermediate output document consists of two parts, the -prologue and the body. +A correct +.I intermediate output +document consists of two parts, the +.I prologue +and the +.IR body . . .P The task of the .I prologue is to set the general device parameters using three exactly specified commands. . The .I groff prologue is guaranteed to consist of the following three lines (in that order): .RS .P .B x\ T .I device .br .B x\ res .I n\ h\ v .br .B x init .RE .P with the arguments set as outlined in the section .BR "Device Control Commands" . . -But the parser for the intermediate output format is able to swallow -additional whitespace and comments as well. +But the parser for the +.I intermediate output +format is able to swallow additional whitespace and comments as well. . +. .P The .I body is the main section for processing the document data. . Syntactically, it is a sequence of any commands different from the -ones used in the prologue. +ones used in the +.IR prologue . . Processing is terminated as soon as the first .B x\ stop -command is encountered; the last line of any groff intermediate output +command is encountered; the last line of any +.I groff intermediate output always contains such a command. . +. .P -Semantically, the body is page oriented. +Semantically, the +.I body +is page oriented. . A new page is started by a .BR p \~command. . Positioning, writing, and drawing commands are always done within the current page, so they cannot occur before the first .BR p \~command. . Absolute positioning (by the .B H and .BR V \~commands) is done relative to the current page, all other positioning is done relative to the current location within this page. . . .\" -------------------------------------------------------------------- .SH "COMMAND REFERENCE" .\" -------------------------------------------------------------------- . -This section describes all intermediate output commands, the classical -commands as well as the +This section describes all +.I intermediate output +commands, the classical commands as well as the .I groff extensions. . . .\" -------------------------------------------------------------------- .SS "Comment Command" .\" -------------------------------------------------------------------- . .TP .BI # anything \[la]end_of_line\[ra] A comment. . Ignore any characters from the .BR # \~\c character up to the next newline character. . .P -This command is the only possibility for commenting in the intermediate -output. +This command is the only possibility for commenting in the +.I intermediate +.IR output . . Each comment can be preceded by arbitrary .I syntactical .IR space ; every command can be terminated by a comment. . . .\" -------------------------------------------------------------------- .SS "Simple Commands" .\" -------------------------------------------------------------------- . The commands in this subsection have a command code consisting of a single character, taking a fixed number of arguments. . Most of them are commands for positioning and text writing. . These commands are smart about whitespace. . Optionally, .I syntactical space can be inserted before, after, and between the command letter and its arguments. . All of these commands are stackable, i.e., they can be preceded by other simple commands or followed by arbitrary other commands on the same line. . -A separating syntactical space is only necessary when two integer -arguments would clash or if the preceding argument ends with a string -argument. +A separating +.I syntactical space +is only necessary when two integer arguments would clash or if the +preceding argument ends with a string argument. . . .if (\n[@USE_ENV_STACK] == 1) \{\ .command { Open a new environment by copying the actual device configuration data to the environment stack. . The current environment is setup by the device specification and manipulated by the setting commands. . . .command } Close the actual environment (opened by a preceding .BR { \~command) and restore the previous environment from the environment stack as the actual device configuration data. . \} \" endif @USE_ENV_STACK . . .command C xxx \[la]white_space\[ra] Print a special groff character named .argument xxx . . -The trailing syntactical space or line break is necessary to allow -character names of arbitrary length. +The trailing +.I syntactical space +or +.I line break +is necessary to allow character names of arbitrary length. . -The character is printed at the current print position; -the character's size is read from the font file. +The character is printed at the current print position; the +character's size is read from the font file. . The print position is not changed. . . .command c c Print character\~\c .argument c at the current print position; the character's size is read from the font file. . The print position is not changed. . . .command f n Set font to font number\~\c .argument n (a non-negative integer). . . .command H n Move right to the absolute vertical position\~\c .argument n (a non-negative integer in basic units\~\c .unit u ) relative to left edge of current page. . . .command h n Move .argument n (a non-negative integer) basic units\~\c .unit u horizontally to the right. . -.I [54] +.I [CSTR\~#54] allows negative values for .I n also, but .I groff doesn't use this. . . .command m "color_scheme \f[R][\f[]component .\|.\|.\f[R]]\f[]" Set the color for text (glyphs), line drawing, and the outline of graphic objects using different color schemes; the analoguous command for the filling color of graphic objects is .BR DF . . The color components are specified as integer arguments between 0 and \n[@maxcolor]. . The number of color components and their meaning vary for the different color schemes. . -These commands are generated by the groff escape sequence +These commands are generated by the +.I groff +escape sequence .BR \*[@backslash]m . . No position changing. . -These commands are a groff extension. +These commands are a +.I groff +extension. . . .RS . .command mc "cyan magenta yellow" Set color using the CMY color scheme, having the 3\~color components cyan, magenta, and yellow. . . .command md Set color to the default color value (black in most cases). . No component arguments. . . .command mg "gray" Set color to the shade of gray given by the argument, an integer between 0 (black) and \n[@maxcolor] (white). . . .command mk "cyan magenta yellow black" Set color using the CMYK color scheme, having the 4\~color components cyan, magenta, yellow, and black. . .command mr "red green blue" Set color using the RGB color scheme, having the 3\~color components red, green, and blue. . .RE . . .command N n Print character with index\~\c .argument n (an integer, normally non-negative) of the current font. . The print position is not changed. . If .B \-T\~html is used, negative values are emitted also to indicate an unbreakable space with given width. . For example, .B N\~-193 represents an unbreakable space which has a width of 193u. . -This command is a groff extension. +This command is a +.I groff +extension. . . .command n b\ a Inform the device about a line break, but no positioning is done by this command. . -In classical troff, the integer arguments +In +.I classical +.IR troff , +the integer arguments .argument b and\~\c .argument a informed about the space before and after the current line to -make the intermediate output more human readable without performing -any action. +make the +.I intermediate output +more human readable without performing any action. . -In groff, they are just ignored, but they must be provided for -compatibility reasons. +In +.IR groff , +they are just ignored, but they must be provided for compatibility +reasons. . . .command p n Begin a new page in the outprint. . The page number is set to\~\c .argument n . . This page is completely independent of pages formerly processed even if those have the same page number. . The vertical position on the outprint is automatically set to\~0. . All positioning, writing, and drawing is always done relative to a page, so a .BR p \~command must be issued before any of these commands. . . .command s n Set point size to .argument n scaled points (this is unit\~\c .unit z in GNU -.BR troff ). +.BR @g@troff ). . -Classical troff used the unit +.I Classical troff +used the unit .I points (\c .unit p ) instead; see section .BR COMPATIBILITY . . . .command t xxx \[la]white_space\[ra] .command+ t "xxx dummy_arg" \[la]white_space\[ra] -Print a word, i.e.\& a sequence of characters +Print a word, i.e., a sequence of characters .argument xxx terminated by a space character or a line break; an optional second integer argument is ignored (this allows the formatter to generate an even number of arguments). . The first character should be printed at the current position, the current horizontal position should then be increased by the width of the first character, and so on for each character. . The widths of the characters are read from the font file, scaled for the current point size, and rounded to a multiple of the horizontal resolution. . Special characters cannot be printed using this command (use the .B C command for named characters). . -This command is a groff extension; it is only used for devices whose +This command is a +.I groff +extension; it is only used for devices whose .I DESC file contains the .B tcommand keyword; see .BR groff_font (@MAN5EXT@). . . .command u "n xxx" \[la]white_space\[ra] Print word with track kerning. . This is the same as the .B t command except that after printing each character, the current horizontal position is increased by the sum of the width of that character and\~\c .argument n (an integer in basic units\~\c .unit u ). -This command is a groff extension; it is only used for devices whose +This command is a +.I groff +extension; it is only used for devices whose .I DESC file contains the .B tcommand keyword; see .BR groff_font (@MAN5EXT@). . . .command V n Move down to the absolute vertical position\~\c .argument n (a non-negative integer in basic units\~\c .unit u ) relative to upper edge of current page. . . .command v n Move .argument n basic units\~\c .unit u down .RI ( n is a non-negative integer). . -.I [54] +.I [CSTR\~#54] allows negative values for .I n also, but .I groff doesn't use this. . . .command w Informs about a paddable whitespace to increase readability. . The spacing itself must be performed explicitly by a move command. . . .\" -------------------------------------------------------------------- .SS "Graphics Commands" .\" -------------------------------------------------------------------- . -Each graphics or drawing command in the intermediate output starts -with the letter\~\c +Each graphics or drawing command in the +.I intermediate output +starts with the letter\~\c .B D followed by one or two characters that specify a subcommand; this is followed by a fixed or variable number of integer arguments that are separated by a single space character. . A -.BR D \ command -may not be followed by another command on the same line -(apart from a comment), so each -.BR D \ command -is terminated by a syntactical line break. +.B D\c +\~command +may not be followed by another command on the same line (apart from a +comment), so each +.B D\c +\~command +is terminated by a +.I syntactical line +.IR break . . +. .P -.I troff +.B @g@troff output follows the classical spacing rules (no space between command and subcommand, all arguments are preceded by a single space character), but the parser allows optional space between the command letters and makes the space before the first argument optional. . As usual, each space can be any sequence of tab and space characters. . +. .P Some graphics commands can take a variable number of arguments. . In this case, they are integers representing a size measured in basic units\~\c .unit u . . The arguments called .list1..n h stand for horizontal distances where positive means right, negative left. . The arguments called .list1..n v stand for vertical distances where positive means down, negative up. . All these distances are offsets relative to the current location. . +. .P Unless indicated otherwise, each graphics command directly corresponds to a similar .I groff .B \*[@backslash]D escape sequence; see .BR groff (@MAN7EXT@). . +. .P -Unknown D\~commands are assumed to be device-specific. +Unknown +.B D\c +\~commands are assumed to be device-specific. . Its arguments are parsed as strings; the whole information is then sent to the postprocessor. . +. .P In the following command reference, the syntax element .I \[la]line_break\[ra] means a .I syntactical line break as defined in section .BR Separation . . . .D-multiarg ~ Draw B-spline from current position to offset .indexed_offset h 1 v 1 , then to offset .indexed_offset h 2 v 2 if given, etc.\& up to .indexed_offset h n v n . -This command takes a variable number of argument pairs; -the current position is moved to the terminal point of the drawn curve. +This command takes a variable number of argument pairs; the current +position is moved to the terminal point of the drawn curve. . . .Da-command Draw arc from current position to .indexed_offset h 1 v 1 \|+\|\c .indexed_offset h 2 v 2 with center at .indexed_offset h 1 v 1 ; then move the current position to the final point of the arc. . . .D-command C d .D-command+ C d dummy_arg Draw a solid circle using the current fill color with diameter\~\c .argument d (integer in basic units\~\c .unit u ) with leftmost point at the current position; then move the current position to the rightmost point of the circle. . An optional second integer argument is ignored (this allows to the formatter to generate an even number of arguments). . -This command is a groff extension. +This command is a +.I groff +extension. . . .D-command c d Draw circle line with diameter\~\c .argument d (integer in basic units\~\c .unit u ) with leftmost point at the current position; then move the current position to the rightmost point of the circle. . . .D-command E "h v" Draw a solid ellipse in the current fill color with a horizontal diameter of\~\c .argument h and a vertical diameter of\~\c .argument v (both integers in basic units\~\c .unit u ) with the leftmost point at the current position; then move to the rightmost point of the ellipse. . -This command is a groff extension. +This command is a +.I groff +extension. . . .D-command e "h v" Draw an outlined ellipse with a horizontal diameter of\~\c .argument h and a vertical diameter of\~\c .argument v (both integers in basic units\~\c .unit u ) with the leftmost point at current position; then move to the rightmost point of the ellipse. . . .D-command F "color_scheme \f[R][\f[]component .\|.\|.\f[R]]\f[]" Set fill color for solid drawing objects using different color schemes; the analoguous command for setting the color of text, line graphics, and the outline of graphic objects is .BR m . . The color components are specified as integer arguments between 0 and \n[@maxcolor]. . The number of color components and their meaning vary for the different color schemes. . -These commands are generated by the groff escape sequences +These commands are generated by the +.I groff +escape sequences .B \*[@backslash]D'F\ .\|.\|.' and .B \*[@backslash]M (with no other corresponding graphics commands). . No position changing. . -This command is a groff extension. +This command is a +.I groff +extension. . . .RS . .D-command Fc "cyan magenta yellow" Set fill color for solid drawing objects using the CMY color scheme, having the 3\~color components cyan, magenta, and yellow. . . .D-command Fd Set fill color for solid drawing objects to the default fill color value (black in most cases). . No component arguments. . . .D-command Fg "gray" Set fill color for solid drawing objects to the shade of gray given by the argument, an integer between 0 (black) and \n[@maxcolor] (white). . . .D-command Fk "cyan magenta yellow black" Set fill color for solid drawing objects using the CMYK color scheme, having the 4\~color components cyan, magenta, yellow, and black. . .D-command Fr "red green blue" Set fill color for solid drawing objects using the RGB color scheme, having the 3\~color components red, green, and blue. . .RE . . .D-command f n The argument .argument n must be an integer in the range -32767 to 32767. . .RS .TP .RI "0 \[<=] " n " \[<=] 1000" Set the color for filling solid drawing objects to a shade of gray, where 0 corresponds to solid white, 1000 (the default) to solid black, and values in between to intermediate shades of gray; this is obsoleted by command .BR DFg . . .TP .IR n " < 0 or " n " > 1000" Set the filling color to the color that is currently being used for the text and the outline, see command .BR m . For example, the command sequence . .nf .ft CB .RS .RS mg 0 0 \n[@maxcolor] Df -1 .RE .ft .fi . sets all colors to blue. .RE . +. .P No position changing. . -This command is a groff extension. +This command is a +.I groff +extension. . .RE . . .D-command l "h v" Draw line from current position to offset .offset h v (integers in basic units\~\c .unit u ); then set current position to the end of the drawn line. . . .D-multiarg p Draw a polygon line from current position to offset .offset h1 v1 , from there to offset .offset h2 v2 , etc.\& up to offset .offset hn vn , and from there back to the starting position. . .ie (\n[@STUPID_DRAWING_POSITIONING] == 1) \{\ For historical reasons, the position is changed by adding the sum of all arguments with odd index to the actual horizontal position and the even ones to the vertical position. . Although this doesn't make sense it is kept for compatibility. . \} .el \{\ As the polygon is closed, the end of drawing is the starting point, so the position doesn't change. \} . -This command is a groff extension. +This command is a +.I groff +extension. . . .D-multiarg P The same macro as the corresponding .B Dp command with the same arguments, but draws a solid polygon in the current fill color rather than an outlined polygon. . .ie (\n[@STUPID_DRAWING_POSITIONING] == 1) \{\ The position is changed in the same way as with .BR Dp . \} .el \ No position changing. . -This command is a groff extension. +This command is a +.I groff +extension. . . .D-command t n Set the current line thickness to\~\c .argument n (an integer in basic units\~\c .unit u ) if .argument n >0; if .argument n =0 select the smallest available line thickness; if .argument n <0 set the line thickness proportional to the point size (this is the default before the first .B Dt command was specified). . .ie (\n[@STUPID_DRAWING_POSITIONING] == 1) \{\ For historical reasons, the horizontal position is changed by adding the argument to the actual horizontal position, while the vertical position is not changed. . Although this doesn't make sense it is kept for compatibility. . \} .el \ No position changing. . -This command is a groff extension. +This command is a +.I groff +extension. . . .\" -------------------------------------------------------------------- .SS "Device Control Commands" .\" -------------------------------------------------------------------- . Each device control command starts with the letter .B x followed by a space character (optional or arbitrary space/\:tab in -groff) and a subcommand letter or word; each argument (if any) must be -preceded by a syntactical space. +.IR groff ) +and a subcommand letter or word; each argument (if any) must be +preceded by a +.I syntactical +.IR space . . All .B x commands are terminated by a .IR "syntactical line break" ; no device control command can be followed by another command on the same line (except a comment). . .P The subcommand is basically a single letter, but to increase -readability, it can be written as a word, i.e.\& an arbitrary sequence +readability, it can be written as a word, i.e., an arbitrary sequence of characters terminated by the next tab, space, or newline character. . All characters of the subcommand word but the first are simply ignored. . For example, -.I troff +.B @g@troff outputs the initialization command .B x\ i as .B x\ init and the resolution command .B x\ r as .BR "x\ res" . . But writings like .B x\ i_like_groff and .B x\ roff_is_groff resp.\& are accepted as well to mean the same commands. . .P In the following, the syntax element .I \[la]line_break\[ra] means a .I syntactical line break as defined in section .BR Separation . . .x-command F name .xsub Filename Use .argument name as the intended name for the current file in error reports. . -This is useful for remembering the original file name when groff uses -an internal piping mechanism. +This is useful for remembering the original file name when +.B groff +uses an internal piping mechanism. . The input file is not changed by this command. . -This command is a groff extension. +This command is a +.I groff +extension. . . .x-command f "n\ s" .xsub font Mount font position\~\c .argument n (a non-negative integer) with font named\~\c .argument s (a text word), cf. .BR groff_font (@MAN5EXT@). . . .x-command H n .xsub Height Set character height to\~\c .argument n (a positive integer in scaled points\~\c .unit z ). . -Classical troff used the unit -points (\c +.I Classical troff +used the unit points (\c .unit p ) instead; see section .BR COMPATIBILITY . . . .x-command i .xsub init Initialize device. . -This is the third command of the prologue. +This is the third command of the +.IR prologue . . . .x-command p .xsub pause Parsed but ignored. . The classical documentation reads .I pause device, can be .IR restarted . . . .x-command r "n\ h\ v" .xsub resolution Resolution is\~\c .argument n , while .argument h is the minimal horizontal motion, and .argument v the minimal vertical motion possible with this device; all arguments are positive integers in basic units\~\c .unit u per inch. . -This is the second command of the prologue. +This is the second command of the +.IR prologue . . . .x-command S n .xsub Slant Set slant to\~\c .argument n degrees (an integer in basic units\~\c .unit u ). . . .x-command s .xsub stop Terminates the processing of the current file; issued as the last -command of any intermediate troff output. +command of any +.I intermediate @g@troff +.IR output . . . .x-command t .xsub trailer Generate trailer information, if any. . In -.IR groff , +.BR groff , this is actually just ignored. . . .x-command T xxx .xsub Typesetter Set name of device to word .argument xxx , a sequence of characters ended by the next whitespace character. . The possible device names coincide with those from the groff .B -T option. . -This is the first command of the prologue. +This is the first command of the +.IR prologue . . . .x-command u n .xsub underline Configure underlining of spaces. . If .argument n is\~1, start underlining of spaces; if .argument n is\~0, stop underlining of spaces. . This is needed for the .B cu request in -.I nroff +.B @g@nroff mode and is ignored otherwise. . -This command is a groff extension. +This command is a +.I groff +extension. . . .x-command X anything .xsub X-escape Send string .argument anything uninterpreted to the device. . If the line following this command starts with a .B + character this line is interpreted as a continuation line in the following sense. . The .B + is ignored, but a newline character is sent instead to the device, the rest of the line is sent uninterpreted. . The same applies to all following lines until the first character of a line is not a .B + character. . This command is generated by the .I groff escape sequence .BR \*[@backslash]X . . -The line-continuing feature is a groff extension. +The line-continuing feature is a +.I groff +extension. . . .\" -------------------------------------------------------------------- .SS "Obsolete Command" .\" -------------------------------------------------------------------- . In .I classical troff output, the writing of a single character was mostly done by a very strange command that combined a horizontal move and the printing of a character. . It didn't have a command code, but is represented by a 3-character argument consisting of exactly 2\~digits and a character. . .TP .argument ddc Move right .argument dd (exactly two decimal digits) basic units\~\c .unit u , then print character\~\c .argument c . . +. .RS .P -In groff, arbitrary syntactical space around and within this command -is allowed to be added. +In +.IR groff , +arbitrary +.I syntactical space +around and within this command is allowed to be added. . Only when a preceding command on the same line ends with an argument of variable length a separating space is obligatory. . In .I classical .IR troff , large clusters of these and other commands were used, mostly without spaces; this made such output almost unreadable. . .RE . +. .P For modern high-resolution devices, this command does not make sense because the width of the characters can become much larger than two decimal digits. . -In groff, this is only used for the devices +In +.BR groff , +this is only used for the devices .BR X75 , .BR X75-12 , .BR X100 , and .BR X100-12 . . For other devices, the commands .B t and\~\c .B u provide a better functionality. . . .\" -------------------------------------------------------------------- .SH "POSTPROCESSING" .\" -------------------------------------------------------------------- . The .I roff postprocessors are programs that have the task to translate the -intermediate output into actions that are sent to a device. +.I intermediate output +into actions that are sent to a device. . A device can be some piece of hardware such as a printer, or a software file format suitable for graphical or text processing. . The .I groff system provides powerful means that make the programming of such postprocessors an easy task. .P -There is a library function that parses the intermediate output and -sends the information obtained to the device via methods of a class -with a common interface for each device. +There is a library function that parses the +.I intermediate output +and sends the information obtained to the device via methods of a +class with a common interface for each device. . So a .I groff postprocessor must only redefine the methods of this class. . For details, see the reference in section .BR FILES . . . .\" -------------------------------------------------------------------- .SH "EXAMPLES" .\" -------------------------------------------------------------------- . -This section presents the intermediate output generated from the same -input for three different devices. +This section presents the +.I intermediate output +generated from the same input for three different devices. . The input is the sentence .I hell world -fed into groff on the command line. +fed into +.B groff +on the command line. . +. .Topic High-resolution device .I ps . -.RS . +.RS .P .ShellCommand echo "hell world" | groff -Z -T ps . +. .P .nf .ft CB x T ps x res 72000 1 1 x init p1 x font 5 TR f5 s10000 V12000 H72000 thell wh2500 tw H96620 torld n12000 0 x trailer V792000 x stop .ft P .fi .RE . +. .P This output can be fed into the postprocessor .BR grops (@MAN1EXT@) to get its representation as a PostScript file. . . .Topic Low-resolution device .I latin1 . -.RS . +.RS .P This is similar to the high-resolution device except that the positioning is done at a minor scale. . Some comments (lines starting with .IR # ) were added for clarification; they were not generated by the formatter. . +. .P .ShellCommand echo "hell world" | groff -Z -T latin1 . +. .P .nf -.I # prologue +.I "# prologue" .ft CB x T latin1 x res 240 24 40 x init -.I # begin a new page +.I "# begin a new page" .ft CB p1 -.I # font setup +.I "# font setup" .ft CB x font 1 R f1 s10 -.I # initial positioning on the page +.I "# initial positioning on the page" .ft CB V40 H0 -.I # write text `hell' +.I "# write text `hell'" .ft CB thell -.I # inform about a space, and do it by a horizontal jump +.I "# inform about a space, and do it by a horizontal jump" .ft CB wh24 -.I # write text `world' +.I "# write text `world'" .ft CB tworld -.I # announce line break, but do nothing because ... +.I "# announce line break, but do nothing because ..." .ft CB n40 0 -.I # ... the end of the document has been reached +.I "# ... the end of the document has been reached" .ft CB x trailer V2640 x stop .ft P .fi .RE . +. .P This output can be fed into the postprocessor .BR grotty (@MAN1EXT@) to get a formatted text document. . . .Topic Classical style output . -.RS . +.RS .P As a computer monitor has a very low resolution compared to modern -printers the intermediate output for the X\~devices can use the -jump-and-write command with its 2-digit displacements. +printers the +.I intermediate output +for the X\~devices can use the jump-and-write command with its 2-digit +displacements. . +. .P .ShellCommand echo "hell world" | groff -Z -T X100 . +. .P .nf .ft CB x T X100 x res 100 1 1 x init p1 x font 5 TR f5 s10 V16 H100 -.I # write text with old-style jump-and-write command +.I "# write text with old-style jump-and-write command" .ft CB ch07e07l03lw06w11o07r05l03dh7 n16 0 x trailer V1100 x stop .ft P .fi .RE . +. .P This output can be fed into the postprocessor -.BR xditview (1x) +.BR \%xditview (1x) or -.BR gxditview (@MAN1EXT@) +.BR \%gxditview (@MAN1EXT@) for displaying in\~X. . +. .P Due to the obsolete jump-and-write command, the text clusters in the classical output are almost unreadable. . . .\" -------------------------------------------------------------------- .SH "COMPATIBILITY" .\" -------------------------------------------------------------------- . -The intermediate output language of the +The +.I intermediate output +language of the .I classical troff was first documented in -.IR [97] . +.IR [CSTR\~#97] . . The -.I groff -intermediate output format is compatible with this specification -except for the following features. +.I groff intermediate output +format is compatible with this specification except for the following +features. +. +. .Topic The classical quasi device independence is not yet implemented. . +. .Topic The old hardware was very different from what we use today. . -So the groff devices are also fundamentally different from the ones in -classical troff. +So the +.I groff +devices are also fundamentally different from the ones in +.I classical +.IR troff . . For example, the classical PostScript device was called .I post and had a resolution of 720 units per inch, -while groff's +while +.IR groff 's .I ps device has a resolution of 72000 units per inch. . Maybe, by implementing some rescaling mechanism similar to the classical quasi device independence, these could be integrated into -modern groff. +modern +.IR groff . . +. .Topic The B-spline command .B D~ -is correctly handled by the intermediate output parser, but the -drawing routines aren't implemented in some of the postprocessor -programs. +is correctly handled by the +.I intermediate output +parser, but the drawing routines aren't implemented in some of the +postprocessor programs. +. +. .Topic The argument of the commands .B s and .B x H has the implicit unit scaled point\~\c .unit z -in groff, while classical troff had point (\c +in +.IR groff , +while +.I classical troff +had point (\c .unit p ). . -This isn't an incompatibility, but a compatible extension, -for both units coincide for all devices without a +This isn't an incompatibility, but a compatible extension, for both +units coincide for all devices without a .I sizescale -parameter, including all classical and the groff text devices. +parameter, including all classical and the +.I groff +text devices. . -The few groff devices with a sizescale parameter either did -not exist, had a different name, or seem to have had a different -resolution. +The few +.I groff +devices with a sizescale parameter either did not exist, had a +different name, or seem to have had a different resolution. . So conflicts with classical devices are very unlikely. . +. .ie (\n[@STUPID_DRAWING_POSITIONING] == 1) \{\ .Topic The position changing after the commands .BR Dp , .BR DP , and .B Dt is illogical, but as old versions of groff used this feature it is kept for compatibility reasons. .\} \" @STUPID_DRAWING_POSITIONING .el \{\ .Topic Temporarily, there existed some confusion on the positioning after the .B D -commands that are groff extensions. +commands that are +.I groff +extensions. . This has been clarified by establishing the classical rule for all groff drawing commands: . +. .RS .P -.I The position after a graphic object has been drawn is at its end; -.I for circles and ellipses, the "end" is at the right side. +.ft I +The position after a graphic object has been drawn is at its end; +for circles and ellipses, the "end" is at the right side. +.ft .RE . +. .P From this, the positionings specified for the drawing commands above follow quite naturally. .\} \" @STUPID_DRAWING_POSITIONING . .P -The differences between groff and classical troff are documented in +The differences between +.I groff +and +.I classical troff +are documented in .BR groff_diff (@MAN7EXT@). . . .\" -------------------------------------------------------------------- .SH "FILES" .\" -------------------------------------------------------------------- . .TP .BI @FONTDIR@/dev name /DESC Device description file for device .IR name . . .TP .IB \[la]groff_source_dir\[ra] /src/libs/libdriver/input.cpp -Defines the parser and postprocessor for the intermediate output. +Defines the parser and postprocessor for the +.I intermediate +.IR output . . It is located relative to the top directory of the .I groff source tree, e.g. .IR @GROFFSRCDIR@ . . This parser is the definitive specification of the -.I groff -intermediate output format. +.I groff intermediate output +format. . . .\" -------------------------------------------------------------------- .SH "SEE ALSO" .\" -------------------------------------------------------------------- . A reference like .BR groff (@MAN7EXT@) refers to a manual page; here -.I groff +.B groff in section\~\c .I @MAN7EXT@ of the man-page documentation system. . To read the example, look up section\~@MAN7EXT@ in your desktop help system or call from the shell prompt . +. .RS .P .ShellCommand man @MAN7EXT@ groff .RE . +. .P For more details, see .BR man (1). . +. .TP .BR groff (@MAN1EXT@) option .B -Z and further readings on groff. . +. .TP .BR groff (@MAN7EXT@) for details of the .I groff language such as numerical units and escape sequences. . +. .TP .BR groff_font (@MAN5EXT@) for details on the device scaling parameters of the .B DESC file. . +. .TP -.BR troff (@MAN1EXT@) +.BR @g@troff (@MAN1EXT@) generates the device-independent intermediate output. . +. .TP .BR roff (@MAN7EXT@) for historical aspects and the general structure of roff systems. . +. .TP .BR groff_diff (@MAN7EXT@) The differences between the intermediate output in groff and classical troff. . +. +.TP +.BR gxditview (@MAN1EXT@) +Viewer for the +.I intermediate +.IR output . +. +. .P .BR \%grodvi (@MAN1EXT@), .BR \%grohtml (@MAN1EXT@), .BR \%grolbp (@MAN1EXT@), .BR \%grolj4 (@MAN1EXT@), .BR \%grops (@MAN1EXT@), .BR \%grotty (@MAN1EXT@) .br .RS the groff postprocessor programs. .RE . +. .P For a treatment of all aspects of the groff system within a single document, see the .I groff info .IR file . . It can be read within the integrated help systems, within .BR emacs (1) or from the shell prompt by . .RS .ShellCommand info groff .RE . +. .P The .I classical troff output language is described in two AT&T Bell Labs CSTR documents available on-line at .URL http://\:cm.bell-labs.com/\:cm/\:cs/\:cstr.html \ "Bell Labs CSTR site" . . +. .TP .I [CSTR #97] .I A Typesetter-independent TROFF by .I Brian Kernighan is the original and most concise documentation on the output language; see .URL http://\:cm.bell-labs.com/\:cm/\:cs/\:cstr/\:97.ps.gz CSTR\~#97 . . +. .TP .I [CSTR\~#54] The 1992 revision of the .I Nroff/\:Troff User's Manual by .I J.\& F.\& Osanna and .I Brian Kernighan isn't as concise as .I [CSTR\~#97] -regarding the output language; -see +regarding the output language; see .URL http://\:cm.bell-labs.com/\:cm/\:cs/\:cstr/\:54.ps.gz CSTR\~#54 . . . .\" -------------------------------------------------------------------- .SH "AUTHORS" .\" -------------------------------------------------------------------- . -Copyright (C) 1989, 2001, 2002, 2003 Free Software Foundation, Inc. +Copyright (C) 1989, 2001, 2002, 2003, 2004 Free Software Foundation, Inc. +. +. .P This document is distributed under the terms of the FDL (GNU Free Documentation License) version 1.1 or later. . You should have received a copy of the FDL with this package; it is also available on-line at the .URL http://\:www.gnu.org/\:copyleft/\:fdl.html "GNU copyleft site" . . +. .P This document is part of .IR groff , -the GNU roff distribution. +the GNU +.I roff +distribution. . It is based on a former version \- published under the GPL \- that described only parts of the .I groff extensions of the output language. . -It has been rewritten 2002 by -.MTO bwarken@mayn.de "Bernd Warken" -and is maintained by +It has been rewritten 2002 by \m[blue]Bernd Warken\m[] and is +maintained by .MTO wl@gnu.org "Werner Lemberg" . +. +.cp \n[groff_out_C] . .\" -------------------------------------------------------------------- .\" Emacs settings .\" -------------------------------------------------------------------- .\" .\" Local Variables: .\" mode: nroff .\" End: Index: head/contrib/groff/tmac/doc-common =================================================================== --- head/contrib/groff/tmac/doc-common (revision 151501) +++ head/contrib/groff/tmac/doc-common (revision 151502) @@ -1,1124 +1,1124 @@ .\" Copyright (c) 1991, 1993 .\" The Regents of the University of California. All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. -.\" 3. All advertising materials mentioning features or use of this software -.\" must display the following acknowledgement: -.\" This product includes software developed by the University of -.\" California, Berkeley and its contributors. +.\" 3. [Deleted. See +.\" ftp://ftp.cs.berkeley.edu/pub/4bsd/README.Impt.License.Change] .\" 4. Neither the name of the University nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" @(#)doc-common 8.1 (Berkeley) 06/08/93 .\" .\" %beginstrip% . . .\" Macro Identifiers. For each user macro a corresponding register with .\" the same name must exist. Its value must not be zero. . .nr %A 1 .nr %B 1 .nr %D 1 .nr %I 1 .nr %J 1 .nr %N 1 .nr %O 1 .nr %P 1 .nr %Q 1 .nr %R 1 .nr %T 1 .nr %V 1 .nr Ac 3 .nr Ad 12n .nr An 12n .nr Ao 12n .nr Ap 2 .nr Aq 12n .nr Ar 12n .nr At 1 .nr Bc 3 .nr Bf 8n\" ? .nr Bk 8n\" ? .nr Bl 1 .nr Bo 12n .nr Bq 12n .nr Brc 3 .nr Bro 12n .nr Brq 12n .nr Bsx 1 .nr Bt 8n\" ? .nr Bx 1 .nr Cd 12n .nr Cm 10n .nr D1 8n\" ? .nr Dc 3 .nr Dl 8n\" ? .nr Dt 8n\" ? .nr Do 12n .nr Dq 12n .nr Ds 6n\" many manpages still use this as a -width value .nr Dv 12n .nr Ec 3 .nr Ef 8n\" ? .nr Ek 8n\" ? .nr El 1 .nr Em 10n .nr En 12n .nr Eo 12n .nr Eq 12n .nr Er 17n .nr Es 12n .nr Ev 15n .nr Ex 1 .nr Fa 12n .nr Fc 3 .nr Fd 12n\" ? .nr Fl 10n .nr Fn 16n .nr Fo 16n .nr Fr 12n\" ? .nr Ft 8n\" ? .nr Fx 1 .nr Ic 10n .nr In 12n .nr It 8n\" ? .nr Lb 11n .nr Li 16n .nr Lk 6n\" ? .nr Lp 8n\" ? .nr Me 6n .nr Ms 6n .nr Mt 6n\" ? .nr Nd 8n\" ? .nr Nm 10n .nr No 12n .nr Ns 2 .nr Nx 1 .nr Oc 3 .nr Oo 10n .nr Op 14n .nr Os 6n\" ? .nr Ox 1 .nr Pa 32n .nr Pc 3 .nr Pf 12n .nr Po 12n .nr Pp 8n\" ? .nr Pq 12n .nr Qc 3 .nr Ql 16n .nr Qo 12n .nr Qq 12n .nr Rv 1 .nr Sc 3 .nr Sh 8n .nr Sm 8n\" ? .nr So 12n .nr Sq 12n .nr Ss 8n .nr St 8n\" ? .nr Sx 16n .nr Sy 6n .nr Ta 2 .nr Tn 10n .nr Ud 8n\" ? .nr Ux 1 .nr Va 12n .nr Vt 8n\" ? .nr Xc 3 .nr Xo 1 .nr Xr 10n . . .\" macros which must be processed after the closing delimiter of `Op' .\" and friends .ds doc-after-Ao .ds doc-after-Bo .ds doc-after-Bro .ds doc-after-Do .ds doc-after-Eo .ds doc-after-Fo .ds doc-after-Ns .ds doc-after-Oo .ds doc-after-Po .ds doc-after-Qo .ds doc-after-So .ds doc-after-Xo . . .nr doc-display-indent 6n . . .\" space strings . .ds doc-soft-space " \" .ds doc-hard-space \~ .ds doc-tab \t . . .eo . . .\" punctuation values (suffix=3, prefix=4) . .nr doc-punct. 3 .nr doc-punct, 3 .nr doc-punct: 3 .nr doc-punct; 3 .nr doc-punct( 4 .nr doc-punct) 3 .nr doc-punct[ 4 .nr doc-punct] 3 .nr doc-punct? 3 .nr doc-punct! 3 . . .\" header assembly macros . .\" NS doc-document-title global string .\" NS the title of the manual page . .ds doc-document-title UNTITLED . . .\" NS doc-volume global string .\" NS the volume where the manual page belongs to . .ds doc-volume LOCAL . . .\" NS doc-section global string .\" NS the manual section . .ds doc-section Null . . .\" NS Dt user macro (not parsed, not callable) .\" NS document title .\" NS .\" NS modifies: .\" NS doc-document-title .\" NS doc-section .\" NS doc-volume .\" NS .\" NS local variables: .\" NS doc-volume-as-XXX .\" NS doc-volume-ds-XXX .\" NS .\" NS width register `Dt' set above . .\" an alternative, more detailed scheme for naming the manual sections .\" .ds doc-volume-operating-system BSD .nr doc-volume-operating-system-ateol 0 .ds doc-volume-ds-1 General Commands Manual .ds doc-volume-ds-2 System Calls Manual .ds doc-volume-ds-3 Library Functions Manual .ds doc-volume-ds-4 Kernel Interfaces Manual .ds doc-volume-ds-5 File Formats Manual .ds doc-volume-ds-6 Games Manual .ds doc-volume-ds-7 Miscellaneous Information Manual .ds doc-volume-ds-8 System Manager's Manual .ds doc-volume-ds-9 Kernel Developer's Manual . .ds doc-volume-ds-USD User's Supplementary Documents .ds doc-volume-ds-PS1 Programmer's Supplementary Documents .ds doc-volume-ds-AMD Ancestral Manual Documents .ds doc-volume-ds-SMM System Manager's Manual .ds doc-volume-ds-URM User's Reference Manual .ds doc-volume-ds-PRM Programmer's Manual .ds doc-volume-ds-KM Kernel Manual .ds doc-volume-ds-IND Manual Master Index .ds doc-volume-ds-LOCAL Local Manual .ds doc-volume-ds-CON Contributed Software Manual . .als doc-volume-ds-MMI doc-volume-ds-IND .als doc-volume-ds-LOC doc-volume-ds-LOCAL . .ds doc-volume-as-alpha alpha .als doc-volume-as-Alpha doc-volume-as-alpha .ds doc-volume-as-acorn26 acorn26 .ds doc-volume-as-acorn32 acorn32 .ds doc-volume-as-algor algor .ds doc-volume-as-amd64 amd64 .ds doc-volume-as-amiga amiga .ds doc-volume-as-arc arc .ds doc-volume-as-arm26 arm26 .ds doc-volume-as-arm32 arm32 .ds doc-volume-as-atari atari .ds doc-volume-as-bebox bebox .ds doc-volume-as-cats cats .ds doc-volume-as-cesfic cesfic .ds doc-volume-as-cobalt cobalt .ds doc-volume-as-dreamcast dreamcast .ds doc-volume-as-evbarm evbarm .ds doc-volume-as-evbmips evbmips .ds doc-volume-as-evbppc evbppc .ds doc-volume-as-evbsh3 evbsh3 .ds doc-volume-as-hp300 hp300 .ds doc-volume-as-hp700 hp700 .ds doc-volume-as-hpcarm hpcarm .ds doc-volume-as-hpcmips hpcmips .ds doc-volume-as-hpcsh hpcsh .ds doc-volume-as-i386 i386 .ds doc-volume-as-luna68k luna68k .ds doc-volume-as-m68k m68k .ds doc-volume-as-mac68k mac68k .ds doc-volume-as-macppc macppc .ds doc-volume-as-mips mips .ds doc-volume-as-mipsco mipsco .ds doc-volume-as-mmeye mmeye .ds doc-volume-as-mvme68k mvme68k .ds doc-volume-as-mvmeppc mvmeppc .ds doc-volume-as-netwinder netwinder .ds doc-volume-as-news68k news68k .ds doc-volume-as-newsmips newsmips .ds doc-volume-as-next68k next68k .ds doc-volume-as-ofppc ofppc .ds doc-volume-as-pc532 pc532 .ds doc-volume-as-playstation2 playstation2 .ds doc-volume-as-pmax pmax .ds doc-volume-as-pmppc pmppc .ds doc-volume-as-powerpc powerpc .ds doc-volume-as-prep prep .ds doc-volume-as-sandpoint sandpoint .ds doc-volume-as-sbmips sbmips .ds doc-volume-as-sgimips sgimips .ds doc-volume-as-sh3 sh3 .ds doc-volume-as-shark shark .ds doc-volume-as-sparc sparc .ds doc-volume-as-sparc64 sparc64 .ds doc-volume-as-sun2 sun2 .ds doc-volume-as-sun3 sun3 .ds doc-volume-as-tahoe tahoe .ds doc-volume-as-vax vax .ds doc-volume-as-x68k x68k .ds doc-volume-as-x86_64 x86_64 . .de Dt . \" reset default arguments . ds doc-document-title UNTITLED . ds doc-volume LOCAL . ds doc-section Null . . if !"\$1"" \ . ds doc-document-title "\$1 . . if !"\$2"" \{\ . ds doc-section \$2 . ie \B\$2 \{\ . if ((\$2 >= 1) & (\$2 <= 9)) \{\ . ie \n[doc-volume-operating-system-ateol] \{\ . ds doc-volume "\*[doc-volume-ds-\$2] \*[doc-volume-operating-system] . if \A\$3 \{\ . if d doc-volume-as-\$3 \ . as doc-volume "/\*[doc-volume-as-\$3] . \}\} . el \{\ . ds doc-volume "\*[doc-volume-operating-system] . if \A\$3 \{\ . if d doc-volume-as-\$3 \ . as doc-volume "/\*[doc-volume-as-\$3] . \} . as doc-volume " \*[doc-volume-ds-\$2] . \}\}\} . el \{\ . ie "\$2"unass" \ . ds doc-volume DRAFT . el \{ .ie "\$2"draft" \ . ds doc-volume DRAFT . el .if "\$2"paper" \ . ds doc-volume UNTITLED . \}\} . if \A\$3 \{\ . if d doc-volume-ds-\$3 \ . ds doc-volume "\*[doc-volume-ds-\$3] . \}\}\} . . if !"\$3"" \ . if "\*[doc-volume]"LOCAL" \ . ds doc-volume \$3 .. . . .\" NS doc-default-operating-system global string .\" NS the exact (default) version of the operating system .\" NS .\" NS override this in `mdoc.local', if necessary . .ds doc-default-operating-system BSD . . .\" NS doc-operating-system global string .\" NS the exact version of the operating system . .ds doc-operating-system . . .\" NS Os user macro (not parsed, not callable) .\" NS operating system .\" NS .\" NS modifies: .\" NS doc-operating-system .\" NS .\" NS local variables: .\" NS doc-operating-system-XXX-XXX .\" NS .\" NS width register `Os' set above . .ds doc-operating-system-ATT-7 7th\~Edition .als doc-operating-system-ATT-7th doc-operating-system-ATT-7 .ds doc-operating-system-ATT-3 System\~III .als doc-operating-system-ATT-III doc-operating-system-ATT-3 .ds doc-operating-system-ATT-V System\~V .ds doc-operating-system-ATT-V.2 System\~V Release\~2 .ds doc-operating-system-ATT-V.3 System\~V Release\~3 .ds doc-operating-system-ATT-V.4 System\~V Release\~4 . .ds doc-operating-system-BSD-3 3rd\~Berkeley Distribution .ds doc-operating-system-BSD-4 4th\~Berkeley Distribution .ds doc-operating-system-BSD-4.1 4.1\~Berkeley Distribution .ds doc-operating-system-BSD-4.2 4.2\~Berkeley Distribution .ds doc-operating-system-BSD-4.3 4.3\~Berkeley Distribution .ds doc-operating-system-BSD-4.3T 4.3-Tahoe Berkeley Distribution .ds doc-operating-system-BSD-4.3R 4.3-Reno Berkeley Distribution .als doc-operating-system-BSD-4.3t doc-operating-system-BSD-4.3T .als doc-operating-system-BSD-4.3r doc-operating-system-BSD-4.3R .ds doc-operating-system-BSD-4.4 4.4BSD . .ds doc-operating-system-NetBSD-0.8 0.8 .ds doc-operating-system-NetBSD-0.8a 0.8A .ds doc-operating-system-NetBSD-0.9 0.9 .ds doc-operating-system-NetBSD-0.9a 0.9A .ds doc-operating-system-NetBSD-1.0 1.0 .ds doc-operating-system-NetBSD-1.0a 1.0A .ds doc-operating-system-NetBSD-1.1 1.1 .ds doc-operating-system-NetBSD-1.2 1.2 .ds doc-operating-system-NetBSD-1.2a 1.2A .ds doc-operating-system-NetBSD-1.2b 1.2B .ds doc-operating-system-NetBSD-1.2c 1.2C .ds doc-operating-system-NetBSD-1.2d 1.2D .ds doc-operating-system-NetBSD-1.2e 1.2E .ds doc-operating-system-NetBSD-1.3 1.3 .ds doc-operating-system-NetBSD-1.3a 1.3A .ds doc-operating-system-NetBSD-1.4 1.4 .ds doc-operating-system-NetBSD-1.4.1 1.4.1 .ds doc-operating-system-NetBSD-1.4.2 1.4.2 .ds doc-operating-system-NetBSD-1.4.3 1.4.3 .ds doc-operating-system-NetBSD-1.5 1.5 .ds doc-operating-system-NetBSD-1.5.1 1.5.1 .ds doc-operating-system-NetBSD-1.5.2 1.5.2 .ds doc-operating-system-NetBSD-1.5.3 1.5.3 .ds doc-operating-system-NetBSD-1.6 1.6 .ds doc-operating-system-NetBSD-1.6.1 1.6.1 .ds doc-operating-system-NetBSD-1.6.2 1.6.2 .ds doc-operating-system-NetBSD-2.0 2.0 +.ds doc-operating-system-NetBSD-2.0.1 2.0.1 +.ds doc-operating-system-NetBSD-2.0.2 2.0.2 .ds doc-operating-system-NetBSD-2.1 2.1 . .ds doc-operating-system-FreeBSD-1.0 1.0 .ds doc-operating-system-FreeBSD-1.1 1.1 .ds doc-operating-system-FreeBSD-1.1.5 1.1.5 .ds doc-operating-system-FreeBSD-1.1.5.1 1.1.5.1 .ds doc-operating-system-FreeBSD-2.0 2.0 .ds doc-operating-system-FreeBSD-2.0.5 2.0.5 .ds doc-operating-system-FreeBSD-2.1 2.1 .ds doc-operating-system-FreeBSD-2.1.5 2.1.5 .ds doc-operating-system-FreeBSD-2.1.6 2.1.6 .ds doc-operating-system-FreeBSD-2.1.7 2.1.7 .ds doc-operating-system-FreeBSD-2.2 2.2 .ds doc-operating-system-FreeBSD-2.2.1 2.2.1 .ds doc-operating-system-FreeBSD-2.2.2 2.2.2 .ds doc-operating-system-FreeBSD-2.2.5 2.2.5 .ds doc-operating-system-FreeBSD-2.2.6 2.2.6 .ds doc-operating-system-FreeBSD-2.2.7 2.2.7 .ds doc-operating-system-FreeBSD-2.2.8 2.2.8 .ds doc-operating-system-FreeBSD-3.0 3.0 .ds doc-operating-system-FreeBSD-3.1 3.1 .ds doc-operating-system-FreeBSD-3.2 3.2 .ds doc-operating-system-FreeBSD-3.3 3.3 .ds doc-operating-system-FreeBSD-3.4 3.4 .ds doc-operating-system-FreeBSD-3.5 3.5 .ds doc-operating-system-FreeBSD-4.0 4.0 .ds doc-operating-system-FreeBSD-4.1 4.1 .ds doc-operating-system-FreeBSD-4.1.1 4.1.1 .ds doc-operating-system-FreeBSD-4.2 4.2 .ds doc-operating-system-FreeBSD-4.3 4.3 .ds doc-operating-system-FreeBSD-4.4 4.4 .ds doc-operating-system-FreeBSD-4.5 4.5 .ds doc-operating-system-FreeBSD-4.6 4.6 .ds doc-operating-system-FreeBSD-4.6.2 4.6.2 .ds doc-operating-system-FreeBSD-4.7 4.7 .ds doc-operating-system-FreeBSD-4.8 4.8 .ds doc-operating-system-FreeBSD-4.9 4.9 .ds doc-operating-system-FreeBSD-4.10 4.10 .ds doc-operating-system-FreeBSD-5.0 5.0 .ds doc-operating-system-FreeBSD-5.1 5.1 .ds doc-operating-system-FreeBSD-5.2 5.2 .ds doc-operating-system-FreeBSD-5.2.1 5.2.1 .ds doc-operating-system-FreeBSD-5.3 5.3 . .de Os . ie "\$1"" \ . ds doc-operating-system "\*[doc-default-operating-system] . el \{ .ie "\$1"ATT" \{\ . ds doc-operating-system AT&T . if \A\$2 \{\ . ie d doc-operating-system-ATT-\$2 \ . as doc-operating-system " \*[doc-operating-system-ATT-\$2] . el \ . as doc-operating-system " UNIX . \}\} . el \{ .ie "\$1"BSD" \{\ . if \A\$2 \{\ . ie d doc-operating-system-BSD-\$2 \ . ds doc-operating-system "\*[doc-operating-system-BSD-\$2] . el \ . tm mdoc warning: .Os: Unknown BSD version `\$2' (#\n[.c]) . \}\} . el \{ .ie "\$1"FreeBSD" \{\ . ds doc-operating-system FreeBSD . if \A\$2 \{\ . ie d doc-operating-system-FreeBSD-\$2 \ . as doc-operating-system \~\*[doc-operating-system-FreeBSD-\$2] . el \ . tm mdoc warning: .Os: Unknown FreeBSD version `\$2' (#\n[.c]) . \}\} . el \{ .ie "\$1"NetBSD" \{\ . ds doc-operating-system NetBSD . if \A\$2 \{\ . ie d doc-operating-system-NetBSD-\$2 \ . as doc-operating-system \~\*[doc-operating-system-NetBSD-\$2] . el \ . tm mdoc warning: .Os: Unknown NetBSD version `\$2' (#\n[.c]) . \}\} . el \{\ . ds doc-operating-system \$1 . if !"\$2"" \ . as doc-operating-system " \$2 . \}\}\}\}\} .. . . .\" NS doc-date-string global string .\" NS the manual page date as set by `Dd' . .ds doc-date-string . . .\" NS Dd user macro (not parsed, not callable) .\" NS set document date .\" NS .\" NS modifies: .\" NS doc-date-string .\" NS .\" NS local variables: .\" NS doc-date-XXX .\" NS .\" NS width register `Dd' set above . .ds doc-date-1 January .ds doc-date-2 February .ds doc-date-3 March .ds doc-date-4 April .ds doc-date-5 May .ds doc-date-6 June .ds doc-date-7 July .ds doc-date-8 August .ds doc-date-9 September .ds doc-date-10 October .ds doc-date-11 November .ds doc-date-12 December . .de Dd . ie \n[.$] \{\ . ie (\n[.$] == 3) \ . ds doc-date-string \$1\~\$2 \$3 . el \{\ . ds doc-date-string "\*[doc-date-\n[mo]] . as doc-date-string \~\n[dy], \n[year] . \} . \} . el \ . ds doc-date-string Epoch .. . . .\" NS doc-hyphen-flags global register .\" NS the parameter for the `.hy' request .\" NS .\" NS override this in `mdoc.local', if necessary. . .nr doc-hyphen-flags 12 . . .\" NS doc-header macro .\" NS print page header .\" NS .\" NS local variables: .\" NS doc-reg-dh .\" NS doc-reg-dh1 . .de doc-header . ev doc-env-dh . doc-setup-page-layout . if !\n[cR] \ . sp \n[doc-header-space]u . nr doc-reg-dh \w'\*[doc-caption-font]\*[doc-header-string]\f[]' . nr doc-reg-dh1 \w'\*[doc-caption-font2]\*[doc-volume]\f[]' . if (\n[doc-reg-dh] + \n[doc-reg-dh1] + \n[doc-reg-dh] >= \n[.lt]) \{\ . while (\n[doc-reg-dh] + \n[doc-reg-dh1] + \n[doc-reg-dh] >= \n[.lt]) \{\ . substring doc-header-string 0 -2 . nr doc-reg-dh \w'\*[doc-caption-font]\*[doc-header-string]\|.\|.\|.\f[]' . \} . as doc-header-string "\|.\|.\|. . \} . tl \*[doc-caption-font]\*[doc-header-string]\f[]\*[doc-caption-font2]\*[doc-volume]\f[]\*[doc-caption-font]\*[doc-header-string]\f[] . ie !\n[cR] \ . sp \n[doc-header-space]u . el \ . sp 1v . ev . ns .. . . .\" NS doc-footer macro .\" NS print page footer . .de doc-footer . ie \n[cR] \ . br . el \{\ . ev doc-caption-enviroment . doc-setup-page-layout . sp \n[doc-footer-space]u . ie \n[D] \{\ . ie o \ . tl %\*[doc-caption-font2]\*[doc-date-string]\f[]\*[doc-caption-font]\*[doc-operating-system]\f[] . el \ . tl \*[doc-caption-font]\*[doc-operating-system]\f[]\*[doc-caption-font2]\*[doc-date-string]\f[]% . \} . el \ . tl \*[doc-caption-font]\*[doc-operating-system]\f[]\*[doc-caption-font2]\*[doc-date-string]\f[]% . bp . ev . \} .. . . .\" NS doc-check-depth macro .\" NS check paired macros . .de doc-check-depth . if \n[doc-list-depth] \{\ . tm mdoc warning: A .Bl directive has no matching .El (#\n[.c]) . nr doc-list-depth 0 . \} . if \n[doc-display-depth] \{\ . tm mdoc warning: A .Bd directive has no matching .Ed (#\n[.c]) . nr doc-display-depth 0 . \} . if \n[doc-fontmode-depth] \{\ . tm mdoc warning: A .Bf directive has no matching .Ef (#\n[.c]) . nr doc-fontmode-depth 0 . \} .. . . .\" NS doc-end-macro macro .\" NS finish output . .de doc-end-macro . \" We may still have a partial line in the environment. If this is the . \" case, and we happen to be on the last line of the page, the `.fl' . \" request will cause the page to be ejected and troff will immediately . \" exit. If we are in nroff mode, this would be unfortunate, since we . \" would never get a chance to output the footer. So we fudge the page . \" length to make sure that the last page is never ejected until we want . \" it to be. . . if \n[cR] \ . pl +3v . fl . . doc-check-depth . . if \n[cR] \{\ . sp . tl \*[doc-caption-font]\*[doc-operating-system]\f[]\*[doc-caption-font2]\*[doc-date-string]\f[]\*[doc-caption-font]\*[doc-operating-system]\f[] . \" suppress empty lines after the footer . pl \n[nl]u . \} .. . . .\" NS doc-paragraph macro .\" NS insert a paragraph . .de doc-paragraph . sp \n[doc-paragraph-space]u . if !\n[cR] \ . ne 2 . ns .. . . .\" NS Pp user macro (not parsed, not callable) .\" NS new paragraph .\" NS .\" NS width register `Pp' set above . .als Pp doc-paragraph . . .\" NS Lp user macro (not parsed, not callable) .\" NS same as .Pp .\" NS .\" NS width register `Lp' set above . .als Lp doc-paragraph . . .de LP . tm Not a \-mdoc command: .LP (#\n[.c]) .. . . .de PP . tm Not a \-mdoc command: .PP (#\n[.c]) .. . . .de pp . tm Not a \-mdoc command: .pp (#\n[.c]) .. . . .de SH . tm Not a \-mdoc command: .SH (#\n[.c]) .. . . .\" NS Nd user macro (not parsed, not callable) .\" NS print name description .\" NS .\" NS width register `Nd' set above . .de Nd . nop \[em] \$* .. . . .\" NS doc-in-synopsis-section global register (bool) .\" NS whether we are in the `synopsis' section . .nr doc-in-synopsis-section 0 . . .\" NS doc-in-library-section global register (bool) .\" NS whether we are in the `library' section . .nr doc-in-library-section 0 . . .\" NS doc-in-see-also-section global register (bool) .\" NS whether we are in the `see also' section . .nr doc-in-see-also-section 0 . . .\" NS doc-in-files-section global register (bool) .\" NS whether we are in the `files' section . .nr doc-in-files-section 0 . . .\" NS doc-in-authors-section global register (bool) .\" NS whether we are in the `authors' section . .nr doc-in-authors-section 0 . . .\" NS doc-first-parameter macro .\" NS return first parameter .\" NS .\" NS local variables: .\" NS doc-str-dfp . .de doc-first-parameter . ds doc-str-dfp "\$1 .. . . .\" NS Sh user macro (not callable) .\" NS section headers .\" NS .\" NS modifies: .\" NS doc-func-args-processed .\" NS doc-func-count .\" NS doc-in-authors-section .\" NS doc-in-files-section .\" NS doc-in-library-section .\" NS doc-in-see-also-section .\" NS doc-in-synopsis-section .\" NS doc-indent-synopsis .\" NS doc-indent-synopsis-active .\" NS doc-is-func .\" NS doc-num-func-args .\" NS .\" NS local variables: .\" NS doc-reg-Sh .\" NS doc-reg-Sh1 .\" NS doc-section-XXX .\" NS .\" NS width register `Sh' set in doc-common . .ds doc-section-name NAME .ds doc-section-synopsis SYNOPSIS .ds doc-section-library LIBRARY .ds doc-section-description DESCRIPTION .ds doc-section-see-also SEE .ds doc-section-files FILES .ds doc-section-authors AUTHORS . .de Sh . ie \n[doc-arg-limit] \{\ . \" we only allow `Sh' within `Sh'; it will change the font back to . \" `doc-Sh-font' . ie "\*[doc-macro-name]"Sh" \{\ . nr doc-arg-ptr +1 . ie (\n[doc-arg-limit] >= \n[doc-arg-ptr]) \{\ . nr doc-curr-font \n[.f] . nr doc-curr-size \n[.ps] . nop \*[doc-Sh-font]\c . doc-print-recursive . \} . el \{\ . tm Usage: .Sh section_name ... (#\n[.c]) . doc-reset-args . \}\} . el \{\ . tm Usage: .Sh not callable by other macros (#\n[.c]) . doc-reset-args . \}\} . el \{\ . if !\n[.$] \{\ . tm Usage: .Sh section_name ... (#\n[.c]) . return . \} . . ds doc-macro-name Sh . doc-parse-args \$@ . . if t \ . ad . . \" this resolves e.g. `.Sh "SEE ALSO"' . doc-first-parameter \$* . . ie "\*[doc-str-dfp]"\*[doc-section-name]" \{\ . doc-setup-header . in 0 . \} . el \{\ . nr doc-in-synopsis-section 0 . nr doc-in-library-section 0 . nr doc-in-see-also-section 0 . nr doc-in-files-section 0 . nr doc-in-authors-section 0 . . ie "\*[doc-str-dfp]"\*[doc-section-synopsis]" \{\ . if t \ . na . nr doc-in-synopsis-section 1 . nr doc-indent-synopsis 0 . nr doc-indent-synopsis-active 0 . \} . el \{ .ie "\*[doc-str-dfp]"\*[doc-section-library]" \{\ . nr doc-in-library-section 1 . \} . el \{ .ie "\*[doc-str-dfp]"\*[doc-section-description]" \{\ . nr doc-is-func 0 . nr doc-func-count 0 . nr doc-func-args-processed 0 . nr doc-num-func-args 0 . \} . el \{ .ie "\*[doc-str-dfp]"\*[doc-section-see-also]" \{\ . if t \ . na . nr doc-in-see-also-section 1 . \} . el \{ .ie "\*[doc-str-dfp]"\*[doc-section-files]" \ . nr doc-in-files-section 1 . el .if "\*[doc-str-dfp]"\*[doc-section-authors]" \ . nr doc-in-authors-section 1 . \}\}\}\} . . in 0 . nr doc-have-author 0 . \} . . doc-setup-page-layout . sp . ns . ta T .5i . if !\n[cR] \ . ne 3 . fi . . if t \{\ . nr doc-reg-Sh \n[.ss] . nr doc-reg-Sh1 \n[.sss] . ss (\n[.ss] * 5 / 3) (\n[.sss] * 5 / 3) . \} . . nr doc-arg-ptr +1 . nr doc-curr-font \n[.f] . nr doc-curr-size \n[.ps] . nop \*[doc-Sh-font]\c . doc-print-recursive . . if t \ . ss \n[doc-reg-Sh] \n[doc-reg-Sh1] . . in +\n[doc-subheader-indent]u . ns . . doc-check-depth . \} .. . . .\" NS Ss user macro (not callable) .\" NS subsection .\" NS .\" NS local variable: .\" NS doc-reg-Ss .\" NS doc-reg-Ss1 .\" NS .\" NS width register `Ss' set above . .de Ss . ie \n[doc-arg-limit] \{\ . \" we only allow `Ss' within `Ss'; it will change the font back to . \" `doc-Sh-font' . ie "\*[doc-macro-name]"Ss" \{\ . nr doc-arg-ptr +1 . ie (\n[doc-arg-limit] >= \n[doc-arg-ptr]) \{\ . nr doc-curr-font \n[.f] . nr doc-curr-size \n[.ps] . nop \*[doc-Sh-font]\c . doc-print-recursive . \} . el \{\ . tm Usage: .Ss subsection_name ... (#\n[.c]) . doc-reset-args . \}\} . el \{\ . tm Usage: .Ss not callable by other macros (#\n[.c]) . doc-reset-args . \}\} . el \{\ . if !\n[.$] \{\ . tm Usage: .Ss subsection_name ... (#\n[.c]) . return . \} . . ds doc-macro-name Ss . doc-parse-args \$@ . . sp . if !\n[cR] \ . ne 3 . ti -.25i . . nr doc-reg-Ss \n[.ss] . nr doc-reg-Ss1 \n[.sss] . ss (\n[.ss] * 5 / 4) (\n[.sss] * 5 / 4) . . nr doc-arg-ptr +1 . nr doc-curr-font \n[.f] . nr doc-curr-size \n[.ps] . nop \*[doc-Sh-font]\c . doc-print-recursive . . ss \n[doc-reg-Ss] \n[doc-reg-Ss1] . . ta T .5i . if !\n[cR] \ . ne 2 . br . ns . . doc-check-depth . \} .. . . .\" NS Rd macro (not parsed, not callable) .\" NS print global register dump to stderr .\" NS .\" NS local variables: .\" NS doc-reg-Rd . .de Rd . tm MDOC GLOBAL REGISTER DUMP . tm doc-macro-name == `\*[doc-macro-name]' . tm doc-arg-limit == \n[doc-arg-limit] . tm doc-num-args == \n[doc-num-args] . tm doc-arg-ptr == \n[doc-arg-ptr] . . nr doc-reg-Rd 1 . while (\n[doc-reg-Rd] <= \n[doc-arg-limit]) \{\ . tm doc-arg\n[doc-reg-Rd] == `\*[doc-arg\n[doc-reg-Rd]]' . tm doc-type\n[doc-reg-Rd] == \n[doc-type\n[doc-reg-Rd]] . tm doc-space\n[doc-reg-Rd] == `\*[doc-space\n[doc-reg-Rd]]' . nr doc-reg-Rd +1 . \} . . tm doc-curr-font == \n[doc-curr-font] . tm doc-curr-size == \n[doc-curr-size] . tm doc-indent-synopsis == \n[doc-indent-synopsis] . tm doc-indent-synopsis-active == \n[doc-indent-synopsis-active] . tm doc-have-decl == \n[doc-have-decl] . tm doc-have-var == \n[doc-have-var] . tm doc-command-name == `\*[doc-command-name]' . tm doc-quote-left == `\*[doc-quote-left]' . tm doc-quote-right == `\*[doc-quote-right]' . tm doc-nesting-level == \n[doc-nesting-level] . tm doc-in-list == \n[doc-in-list] . tm doc-space == `\*[doc-space]' . tm doc-saved-space == `\*[doc-saved-space]' . tm doc-space-mode == \n[doc-space-mode] . tm doc-have-space == \n[doc-have-space] . tm doc-have-slot == \n[doc-have-slot] . tm doc-keep-type == \n[doc-keep-type] . tm doc-display-depth == \n[doc-display-depth] . tm doc-is-compact == \n[doc-is-compact] . . nr doc-reg-Rd 0 . while (\n[doc-reg-Rd] <= \n[doc-display-depth]) \{\ . tm doc-display-type-stack\n[doc-reg-Rd] == `\*[doc-display-type-stack\n[doc-reg-Rd]]' . tm doc-display-indent-stack\n[doc-reg-Rd] == \n[doc-display-indent-stack\n[doc-reg-Rd]] . tm doc-display-ad-stack\n[doc-reg-Rd] == \n[doc-display-ad-stack\n[doc-reg-Rd]] . tm doc-display-fi-stack\n[doc-reg-Rd] == \n[doc-display-fi-stack\n[doc-reg-Rd]] . tm doc-display-ft-stack\n[doc-reg-Rd] == \n[doc-display-ft-stack\n[doc-reg-Rd]] . tm doc-display-ps-stack\n[doc-reg-Rd] == \n[doc-display-ps-stack\n[doc-reg-Rd]] . nr doc-reg-Rd +1 . \} . . tm doc-fontmode-depth == \n[doc-fontmode-depth] . . nr doc-reg-Rd 1 . while (\n[doc-reg-Rd] <= \n[doc-fontmode-depth]) \{\ . tm doc-fontmode-font-stack\n[doc-reg-Rd] == `\n[doc-fontmode-font-stack\n[doc-reg-Rd]]' . tm doc-fontmode-size-stack\n[doc-reg-Rd] == `\n[doc-fontmode-size-stack\n[doc-reg-Rd]]' . nr doc-reg-Rd +1 . \} . . tm doc-list-depth == \n[doc-list-depth] . . nr doc-reg-Rd 1 . while (\n[doc-reg-Rd] <= \n[doc-list-depth]) \{\ . tm doc-list-type-stack\n[doc-reg-Rd] == `\*[doc-list-type-stack\n[doc-reg-Rd]]' . tm doc-list-have-indent-stack\n[doc-reg-Rd] == \n[doc-list-have-indent-stack\n[doc-reg-Rd]] . tm doc-list-indent-stack\n[doc-reg-Rd] == \n[doc-list-indent-stack\n[doc-reg-Rd]] . tm doc-compact-list-stack\n[doc-reg-Rd] == \n[doc-compact-list-stack\n[doc-reg-Rd]] . tm doc-tag-prefix-stack\n[doc-reg-Rd] == `\*[doc-tag-prefix-stack\n[doc-reg-Rd]]' . tm doc-tag-width-stack\n[doc-reg-Rd] == `\*[doc-tag-width-stack\n[doc-reg-Rd]]' . tm doc-list-offset-stack\n[doc-reg-Rd] == \n[doc-list-offset-stack\n[doc-reg-Rd]] . tm doc-enum-list-count-stack\n[doc-reg-Rd] == \n[doc-enum-list-count-stack\n[doc-reg-Rd]] . nr doc-reg-Rd +1 . \} . . tm doc-saved-Pa-font == `\*[doc-saved-Pa-font]' . tm doc-curr-type == \n[doc-curr-type] . tm doc-curr-arg == `\*[doc-curr-arg]' . tm doc-diag-list-input-line-count == \n[doc-diag-list-input-line-count] . tm doc-num-columns == \n[doc-num-columns] . tm doc-column-indent-width == \n[doc-column-indent-width] . tm doc-is-func == \n[doc-is-func] . tm doc-have-old-func == \n[doc-have-old-func] . tm doc-func-arg-count == \n[doc-func-arg-count] . tm doc-func-arg == `\*[doc-func-arg]' . tm doc-num-func-args == \n[doc-num-func-args] . tm doc-func-args-processed == \n[doc-func-args-processed] . tm doc-have-func == \n[doc-have-func] . tm doc-is-reference == \n[doc-is-reference] . tm doc-reference-count == \n[doc-reference-count] . tm doc-author-count == \n[doc-author-count] . . nr doc-reg-Rd 0 . while (\n[doc-reg-Rd] <= \n[doc-author-count]) \{\ . tm doc-author-name\n[doc-reg-Rd] == `\*[doc-author-name\n[doc-reg-Rd]]' . nr doc-reg-Rd +1 . \} . . tm doc-book-count == \n[doc-book-count] . tm doc-book-name == `\*[doc-book-name]' . tm doc-date-count == \n[doc-date-count] . tm doc-date == `\*[doc-date]' . tm doc-publisher-count == \n[doc-publisher-count] . tm doc-publisher-name == `\*[doc-publisher-name]' . tm doc-journal-count == \n[doc-journal-count] . tm doc-journal-name == `\*[doc-journal-name]' . tm doc-issue-count == \n[doc-issue-count] . tm doc-issue-name == `\*[doc-issue-name]' . tm doc-optional-count == \n[doc-optional-count] . tm doc-optional-string == `\*[doc-optional-string]' . tm doc-page-number-count == \n[doc-page-number-count] . tm doc-page-number-string == `\*[doc-page-number-string]' . tm doc-corporate-count == \n[doc-corporate-count] . tm doc-corporate-name == `\*[doc-corporate-name]' . tm doc-report-count == \n[doc-report-count] . tm doc-report-name == `\*[doc-report-name]' . tm doc-reference-title-count == \n[doc-reference-title-count] . tm doc-reference-title-name == `\*[doc-reference-title-name]' . tm doc-reference-title-name-for-book == `\*[doc-reference-title-name-for-book]' . tm doc-volume-count == \n[doc-volume-count] . tm doc-volume-name == `\*[doc-volume-name]' . tm doc-have-author == \n[doc-have-author] . . tm doc-document-title == `\*[doc-document-title]' . tm doc-volume == `\*[doc-volume]' . tm doc-section == `\*[doc-section]' . tm doc-operating-system == `\*[doc-operating-system]' . tm doc-date-string == `\*[doc-date-string]' . tm doc-header-space == \n[doc-header-space] . tm doc-footer-space == \n[doc-footer-space] . tm doc-display-vertical == \n[doc-display-vertical] . tm doc-header-string == `\*[doc-header-string]' . tm doc-in-synopsis-section == \n[doc-in-synopsis-section] . tm doc-in-library-section == \n[doc-in-library-section] . tm doc-in-see-also-section == \n[doc-in-see-also-section] . tm doc-in-files-section == \n[doc-in-files-section] . tm doc-in-authors-section == \n[doc-in-authors-section] . . tm END OF GLOBAL REGISTER DUMP .. . . .ec . .\" EOF Index: head/contrib/groff/tmac/doc-ditroff =================================================================== --- head/contrib/groff/tmac/doc-ditroff (revision 151501) +++ head/contrib/groff/tmac/doc-ditroff (revision 151502) @@ -1,334 +1,332 @@ .\" Copyright (c) 1991, 1993 .\" The Regents of the University of California. All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. -.\" 3. All advertising materials mentioning features or use of this software -.\" must display the following acknowledgement: -.\" This product includes software developed by the University of -.\" California, Berkeley and its contributors. +.\" 3. [Deleted. See +.\" ftp://ftp.cs.berkeley.edu/pub/4bsd/README.Impt.License.Change] .\" 4. Neither the name of the University nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" @(#)doc-ditroff 8.1 (Berkeley) 06/08/93 .\" .\" %beginstrip% . . .eo . .\" use -rD=1 for double-sided printing . .if !r D .nr D 0 . .\" use -rcR=1 to force the creation of a single, very long page . .if !r cR .nr cR 0 . .\" use -rS={11,12} to change the font size from 10pt to 11pt or 12pt. . .if !r S .nr S 10 . . .ec . . .ie (\n[S] == 11) \{\ . ps 10.95z . vs 13.6p .\} .el \{ .ie (\n[S] == 12) \{\ . ps 12z . vs 14.5p .\} .el \{\ . ps 10z . vs 12p .\}\} . . .\" the `doc-xx-font' strings must not be empty! . .ds doc-caption-font \f[R]\s[\n[.ps]u] .ds doc-caption-font2 \f[R]\s[\n[.ps]u] .ds doc-Ad-font \f[I]\s[\n[.ps]u] .ds doc-Ar-font \f[CO]\s[\n[.ps]u] .ds doc-Cm-font \f[CB]\s[\n[.ps]u] .ds doc-Em-font \f[I]\s[\n[.ps]u] .ds doc-Er-font \f[C]\s[\n[.ps]u] .ds doc-Ev-font \f[C]\s[\n[.ps]u] .ds doc-Fa-font \f[CO]\s[\n[.ps]u] .ds doc-Fd-font \f[CB]\s[\n[.ps]u] .ds doc-Fl-font \f[CB]\s[\n[.ps]u] .ds doc-Fn-font \f[CB]\s[\n[.ps]u] .ds doc-Ft-font \f[CO]\s[\n[.ps]u] .ds doc-Ic-font \f[CB]\s[\n[.ps]u] .ds doc-Li-font \f[C] .ds doc-Me-font \f[B]\s[\n[.ps]u] .ds doc-Nm-font \f[CB]\s[\n[.ps]u] .ds doc-No-font \f[R]\s[\n[.ps]u] .ds doc-Pa-font \f[C]\s[\n[.ps]u] .ds doc-Sh-font \f[B]\s[\n[.ps]u] .ds doc-Sy-font \f[B]\s[\n[.ps]u] .ds doc-Sx-font \f[B]\s[\n[.ps]u] .ds doc-Tn-font-shape \f[R] \# XXX: adapt to discrete LaTeX font sizes .ds doc-Tn-font-size \s[(\n[.ps]u - 1z)] .ds doc-Va-font \f[I]\s[\n[.ps]u] .ds doc-Xr-font \f[C]\s[\n[.ps]u] . .ds doc-left-parenthesis \f[R]\|(\|\f[]\s[\n[.ps]u] .ds doc-right-parenthesis \f[R]\|)\|\f[]\s[\n[.ps]u] .ds lp \f[R](\f[]\s[\n[.ps]u] .ds rp \f[R])\f[]\s[\n[.ps]u] .ds doc-left-bracket \f[R]\^[\^\f[]\s[\n[.ps]u] .ds doc-right-bracket \f[R]\^]\f[]\s[\n[.ps]u] . .tr *\[**] . .\" miscellaneous .nr doc-subheader-indent (\w\f[C],u * 5u) .nr doc-paragraph-space .5v . .nr doc-digit-width \w'\0'u .nr doc-fixed-width \w\f[C]0 . .eo . . .\" NS doc-header-space global register .\" NS the space between header and body . .nr doc-header-space .5i . . .\" NS doc-footer-space global register .\" NS the space between body and footer . .nr doc-footer-space .5i . . .\" NS doc-display-vertical global register .\" NS vertical space between list elements etc. . .nr doc-display-vertical 0 . . .\" NS doc-setup-page-layout macro .\" NS set up page layout .\" NS .\" NS modifies: .\" NS doc-display-vertical . .de doc-setup-page-layout . ie r LL \ . ll \n[LL]u . el \ . ll 6.5i . . ie r LT \ . lt \n[LT]u . el \ . lt 6.5i . . po 1i . . nr doc-display-vertical .5v .. . . .ds doc-left-singlequote \[oq] .ds doc-right-singlequote \[cq] . .\" the following strings are `official' .ds <= \[<=] .ds >= \[>=] .ds Lq \[lq] .ds Rq \[rq] .ds ua \[ua] .ds aa \[aa] .ds ga \[ga] .ds q \[dq] .ds Pi \[*p] .ds Ne \[!=] .ds Le \[<=] .ds Ge \[>=] .ds Lt < .ds Gt > .ds Pm \[+-] .ds If \[if] .ds Na \f[I]NaN\f[] .ds Ba \f[R]|\f[] .ds Am & . . .\" NS doc-header-string global string .\" NS the final string used for the manual page header . .ds doc-header-string . . .\" NS doc-setup-header macro .\" NS install and initialize header and footer support .\" NS .\" NS modifies: .\" NS doc-header-string . .de doc-setup-header . ds doc-header-string "\*[doc-document-title] . if !"\*[doc-section]"Null" \ . as doc-header-string \|(\*[doc-section]) . . wh 0 doc-header . wh -1.25i doc-footer . . br . . e@ doc-end-macro .. . . .\" NS doc-get-width macro .\" NS computes the width of a string as a multiple of `doc-fixed-width': .\" NS `.doc-get-width string' .\" NS .\" NS modifies: .\" NS doc-width . .de doc-get-width . nr doc-width \w\f[C]\$1 . ie (\n[doc-width] >= \n[doc-fixed-width]) \{\ . ie (\n[doc-width] % \n[doc-fixed-width]) \ . nr doc-width ((\n[doc-width] / \n[doc-fixed-width]) + 1) . el \ . nr doc-width (\n[doc-width] / \n[doc-fixed-width]) . \} . el \{\ . ie \n[doc-width] \ . nr doc-width 1 . el \ . nr doc-width 0 . \} .. . . .\" NS doc-get-arg-width macro .\" NS computes the width of an argument as a multiple of .\" NS `doc-fixed-width': `.doc-get-arg-width arg-index' .\" NS .\" NS modifies: .\" NS doc-width . .de doc-get-arg-width . nr doc-width \w\f[C]\*[doc-arg\$1] . ie (\n[doc-width] >= \n[doc-fixed-width]) \{\ . ie (\n[doc-width] % \n[doc-fixed-width]) \ . nr doc-width ((\n[doc-width] / \n[doc-fixed-width]) + 1) . el \ . nr doc-width (\n[doc-width] / \n[doc-fixed-width]) . \} . el \{\ . ie \n[doc-width] \ . nr doc-width 1 . el \ . nr doc-width 0 . \} .. . . .\" NS Ql user macro .\" NS quoted literal define .\" NS .\" NS modifies: .\" NS doc-argXXX .\" NS doc-arg-limit .\" NS doc-arg-ptr .\" NS doc-macro-name .\" NS doc-spaceXXX .\" NS doc-typeXXX .\" NS doc-quote-left .\" NS doc-quote-right .\" NS .\" NS local variables: .\" NS doc-reg-Ql .\" NS doc-reg-Ql1 .\" NS doc-reg-Ql2 .\" NS .\" NS width register `Ql' set in doc-common . .de Ql . if !\n[doc-arg-limit] \{\ . ie \n[.$] \{\ . ds doc-macro-name Ql . doc-parse-args \$@ . \} . el \ . tm Usage: .Ql argument ... (#\n[.c]) . \} . . nr doc-reg-Ql (\n[doc-arg-ptr] + 1) . doc-get-arg-width \n[doc-reg-Ql] . . \" don't use quotes if we have more than two succeeding string arguments . nr doc-reg-Ql +1 . if (\n[doc-arg-limit] >= \n[doc-reg-Ql]) \ . if (\n[doc-type\n[doc-reg-Ql]] == 2) \ . nr doc-width 3 . . \" make a difference in quotation style for strings longer . \" than two characters . ie (\n[doc-width] > 2) \ . Li . el \{\ . ie \n[doc-arg-ptr] \{\ . \" we replace `Ql' with `Li' . ds doc-arg\n[doc-arg-ptr] Li . nr doc-arg-ptr -1 . \} . el \{\ . \" if .Ql has been called directly, we must shift all elements in . \" the argument vector to the right so that we can insert `Li' . nr doc-reg-Ql \n[doc-arg-limit] . nr doc-reg-Ql1 (\n[doc-arg-limit] + 1) . while \n[doc-reg-Ql] \{\ . rn doc-arg\n[doc-reg-Ql] doc-arg\n[doc-reg-Ql1] . rnn doc-type\n[doc-reg-Ql] doc-type\n[doc-reg-Ql1] . rn doc-space\n[doc-reg-Ql] doc-space\n[doc-reg-Ql1] . nr doc-reg-Ql -1 . nr doc-reg-Ql1 -1 . \} . ds doc-arg1 Li . nr doc-type1 1 . ds doc-space1 . nr doc-arg-limit +1 . \} . . ds doc-quote-left "\*[doc-left-singlequote] . ds doc-quote-right "\*[doc-right-singlequote] . doc-enclose-string . \} .. . . .ec . .\" EOF Index: head/contrib/groff/tmac/doc-nroff =================================================================== --- head/contrib/groff/tmac/doc-nroff (revision 151501) +++ head/contrib/groff/tmac/doc-nroff (revision 151502) @@ -1,277 +1,275 @@ .\" Copyright (c) 1991, 1993 .\" The Regents of the University of California. All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. -.\" 3. All advertising materials mentioning features or use of this software -.\" must display the following acknowledgement: -.\" This product includes software developed by the University of -.\" California, Berkeley and its contributors. +.\" 3. [Deleted. See +.\" ftp://ftp.cs.berkeley.edu/pub/4bsd/README.Impt.License.Change] .\" 4. Neither the name of the University nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" @(#)doc-nroff 8.1 (Berkeley) 06/08/93 .\" .\" %beginstrip% . . .eo . .\" use -rD=1 for double-sided printing . .if !r D .nr D 0 . .\" use -rcR=0 to have multiple pages instead of a single, very long page . .if !r cR .nr cR 1 . .\" the following switch is ignored in nroff mode . .nr S 10 . .\" the `doc-xx-font' strings must not be empty! . .ds doc-caption-font \f[R] .ds doc-caption-font2 \f[R] .ds doc-Ad-font \f[I] .ds doc-Ar-font \f[I] .ds doc-Cm-font \f[B] .ds doc-Em-font \f[I] .ds doc-Er-font \f[R] .ds doc-Ev-font \f[R] .ds doc-Fa-font \f[I] .ds doc-Fd-font \f[B] .ds doc-Fl-font \f[B] .ds doc-Fn-font \f[B] .ds doc-Ft-font \f[I] .ds doc-Ic-font \f[B] .ds doc-Li-font \f[R] .ds doc-Me-font \f[B] .ds doc-Nm-font \f[B] .ds doc-No-font \f[R] .ds doc-Pa-font \f[I] .ds doc-Sh-font \f[B] .ds doc-Sy-font \f[B] .ds doc-Sx-font \f[I] .ds doc-Tn-font-shape \f[R] .ds doc-Tn-font-size .ds doc-Va-font \f[I] .ds doc-Xr-font \f[R] . .ds doc-left-parenthesis \f[R](\f[] .ds doc-right-parenthesis \f[R])\f[] .ds lp \f[R](\f[] .ds rp \f[R])\f[] .ds doc-left-bracket \f[R][\f[] .ds doc-right-bracket \f[R]]\f[] . .\" miscellaneous .nr doc-subheader-indent .5i .nr doc-paragraph-space 1v . .ec .nr doc-digit-width \w'\0\0'u .nr doc-fixed-width \w'0' .eo . . .\" NS doc-header-space global register .\" NS the space between header and body . .nr doc-header-space 0.5i . . .\" NS doc-footer-space global register .\" NS the space between body and footer . .nr doc-footer-space 0.5i . . .\" NS doc-display-vertical global register .\" NS vertical space between list elements etc. . .nr doc-display-vertical 0 . . .\" NS doc-setup-page-layout macro .\" NS set up page layout .\" NS .\" NS modifies: .\" NS doc-display-vertical . .de doc-setup-page-layout . ie r LL \ . ll \n[LL]u . el \ . ll 78n . . ie r LT \ . lt \n[LT]u . el \ . lt 78n . . po 0i . . nr doc-display-vertical 1v . ad l . na .. . . .ec . .ds doc-left-singlequote \[oq] .ds doc-right-singlequote \[cq] . .\" the following strings are `official' .ds <= \[<=] .ds >= \[>=] .ds aa \[aa] .ds ga \[ga] .ds q \[dq] .ds Ne \[!=] .ds Le \[<=] .ds Ge \[>=] .ds Lt < .ds Gt > .ds Pm \[+-] .ds Na \f[I]NaN\f[] .ds Ba \f[R]|\f[] .ds Am & . .\" Unicode TTYs have all glyph forms; for other TTY character sets we need .\" character representations which are different from GNU troff's standard .\" forms. .ie '\*[.T]'utf8' \{\ . ds Rq \[rq] . ds Lq \[lq] . ds ua \[ua] . ds Pi \[*p] . ds If \[if] .\} .el \{\ . ds Rq '' . ds Lq `` . ds ua ^ . ds Pi pi . ds If infinity .\} . .eo . . .\" NS doc-header-string global string .\" NS the final string used for the manual page header . .ds doc-header-string . . .\" NS doc-setup-header macro .\" NS install and initialize header and footer support .\" NS .\" NS modifies: .\" NS doc-header-string . .de doc-setup-header . ds doc-header-string "\*[doc-document-title] . if !"\*[doc-section]"Null" \ . as doc-header-string (\*[doc-section]) . . ie \n[cR] \ . doc-header . el \{\ . wh 0 doc-header . wh -1.167i doc-footer . \} . . e@ doc-end-macro .. . . .\" NS doc-get-width macro .\" NS computes the width of a string as a multiple of `doc-fixed-width': .\" NS `.doc-get-width string' .\" NS .\" NS modifies: .\" NS doc-width . .de doc-get-width . nr doc-width \w\$1 . ie (\n[doc-width] >= \n[doc-fixed-width]) \{\ . ie (\n[doc-width] % \n[doc-fixed-width]) \ . nr doc-width ((\n[doc-width] / \n[doc-fixed-width]) + 1) . el \ . nr doc-width (\n[doc-width] / \n[doc-fixed-width]) . \} . el \ . nr doc-width 0 .. . . .\" NS doc-get-arg-width macro .\" NS computes the width of an argument as a multiple of .\" NS `doc-fixed-width': `.doc-get-arg-width arg-index' .\" NS .\" NS modifies: .\" NS doc-width . .de doc-get-arg-width . nr doc-width \w\*[doc-arg\$1] . ie (\n[doc-width] >= \n[doc-fixed-width]) \{\ . ie (\n[doc-width] % \n[doc-fixed-width]) \ . nr doc-width ((\n[doc-width] / \n[doc-fixed-width]) + 1) . el \ . nr doc-width (\n[doc-width] / \n[doc-fixed-width]) . \} . el \ . nr doc-width 0 .. . . .\" NS Ql user macro .\" NS quoted literal define .\" NS .\" NS modifies: .\" NS doc-macro-name .\" NS doc-quote-left .\" NS doc-quote-right .\" NS .\" NS width register `Ql' set in doc-common . .de Ql . if !\n[doc-arg-limit] \{\ . ie \n[.$] \ . ds doc-macro-name Ql . el \ . tm Usage: .Ql argument ... (#\n[.c]) . \} . . ds doc-quote-left "\*[doc-left-singlequote] . ds doc-quote-right "\*[doc-right-singlequote] . . doc-enclose-string \$@ .. . . .ec . .\" EOF Index: head/contrib/groff/tmac/doc-syms =================================================================== --- head/contrib/groff/tmac/doc-syms (revision 151501) +++ head/contrib/groff/tmac/doc-syms (revision 151502) @@ -1,759 +1,757 @@ .\" Copyright (c) 1991, 1993 .\" The Regents of the University of California. All rights reserved. .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: .\" 1. Redistributions of source code must retain the above copyright .\" notice, this list of conditions and the following disclaimer. .\" 2. Redistributions in binary form must reproduce the above copyright .\" notice, this list of conditions and the following disclaimer in the .\" documentation and/or other materials provided with the distribution. -.\" 3. All advertising materials mentioning features or use of this software -.\" must display the following acknowledgement: -.\" This product includes software developed by the University of -.\" California, Berkeley and its contributors. +.\" 3. [Deleted. See +.\" ftp://ftp.cs.berkeley.edu/pub/4bsd/README.Impt.License.Change] .\" 4. Neither the name of the University nor the names of its contributors .\" may be used to endorse or promote products derived from this software .\" without specific prior written permission. .\" .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" .\" @(#)doc-syms 8.1 (Berkeley) 06/08/93 .\" .\" %beginstrip% . . .eo . .\" NS Ux user macro .\" NS print UNIX .\" NS .\" NS modifies: .\" NS doc-arg-ptr .\" NS doc-curr-font .\" NS doc-curr-size .\" NS doc-macro-name .\" NS .\" NS local variable: .\" NS doc-str-Ux .\" NS .\" NS width register `Ux' defined in doc-common . .de Ux . nr doc-curr-font \n[.f] . nr doc-curr-size \n[.ps] . ds doc-str-Ux \f[\n[doc-curr-font]]\s[\n[doc-curr-size]u] . . if !\n[doc-arg-limit] \ . if \n[.$] \{\ . ds doc-macro-name Ux . doc-parse-args \$@ . \} . . \" replace current argument with result . ds doc-arg\n[doc-arg-ptr] \*[doc-Tn-font-size]UNIX\*[doc-str-Ux] . nr doc-type\n[doc-arg-ptr] 2 . ds doc-space\n[doc-arg-ptr] "\*[doc-space] . . \" recompute space vector for remaining arguments . nr doc-num-args (\n[doc-arg-limit] - \n[doc-arg-ptr]) . nr doc-arg-limit \n[doc-arg-ptr] . if \n[doc-num-args] \ . doc-parse-space-vector . . doc-print-recursive .. . . .\" NS Bx user macro .\" NS print BSD (fix smaller nroff version) .\" NS .\" NS modifies: .\" NS doc-arg-ptr .\" NS doc-curr-font .\" NS doc-curr-size .\" NS doc-macro-name .\" NS .\" NS local variable: .\" NS doc-str-Bx .\" NS doc-str-Bx1 .\" NS doc-str-Bx-XXX .\" NS .\" NS width register `Bx' defined in doc-common . .ds doc-str-Bx-Reno \-Reno .ds doc-str-Bx-reno \-Reno .ds doc-str-Bx-Tahoe \-Tahoe .ds doc-str-Bx-tahoe \-Tahoe .ds doc-str-Bx-Lite \-Lite .ds doc-str-Bx-lite \-Lite .ds doc-str-Bx-Lite2 \-Lite2 .ds doc-str-Bx-lite2 \-Lite2 . .de Bx . nr doc-curr-font \n[.f] . nr doc-curr-size \n[.ps] . ds doc-str-Bx \f[\n[doc-curr-font]]\s[\n[doc-curr-size]u] . . \" default value if no argument . ds doc-str-Bx1 \*[doc-Tn-font-size]BSD\*[doc-str-Bx] . . if !\n[doc-arg-limit] \ . if \n[.$] \{\ . ds doc-macro-name Bx . doc-parse-args \$@ . \} . . if (\n[doc-arg-limit] > \n[doc-arg-ptr]) \{\ . nr doc-arg-ptr +1 . ie (\n[doc-type\n[doc-arg-ptr]] == 2) \{\ . ie "\*[doc-arg\n[doc-arg-ptr]]"-alpha" \ . as doc-str-Bx1 " (currently in alpha test) . el \{ .ie "\*[doc-arg\n[doc-arg-ptr]]"-beta" \ . as doc-str-Bx1 " (currently in beta test) . el \{ .ie "\*[doc-arg\n[doc-arg-ptr]]"-devel" \ . as doc-str-Bx1 " (currently under development) . el \{\ . ds doc-str-Bx1 \&\*[doc-arg\n[doc-arg-ptr]]\^\*[doc-Tn-font-size] . as doc-str-Bx1 BSD\*[doc-str-Bx] . . if (\n[doc-arg-limit] > \n[doc-arg-ptr]) \{\ . nr doc-arg-ptr +1 . ie (\n[doc-type\n[doc-arg-ptr]] == 2) \{\ . ie (\n[doc-type\n[doc-arg-ptr]] == 2) \{\ . ie d doc-str-Bx-\*[doc-arg\n[doc-arg-ptr]] \ . as doc-str-Bx1 "\*[doc-str-Bx-\*[doc-arg\n[doc-arg-ptr]]] . el \ . nr doc-arg-ptr -1 . \} . el \ . nr doc-arg-ptr -1 . \} . el \ . nr doc-arg-ptr -1 . \}\}\}\}\} . el \ . nr doc-arg-ptr -1 . \} . . \" replace current argument with result . ds doc-arg\n[doc-arg-ptr] "\*[doc-str-Bx1] . nr doc-type\n[doc-arg-ptr] 2 . ds doc-space\n[doc-arg-ptr] "\*[doc-space] . . \" recompute space vector for remaining arguments . nr doc-num-args (\n[doc-arg-limit] - \n[doc-arg-ptr]) . nr doc-arg-limit \n[doc-arg-ptr] . if \n[doc-num-args] \ . doc-parse-space-vector . . doc-print-recursive .. . . .\" NS Ud user macro (not parsed, not callable) .\" NS print "currently under development" (HISTORY section) .\" NS .\" NS width register `Ud' defined in doc-common . .de Ud . nop \¤tly under development. .. . . .\" NS At user macro .\" NS print AT&T UNIX .\" NS .\" NS modifies: .\" NS doc-arg-ptr .\" NS doc-curr-font .\" NS doc-curr-size .\" NS doc-macro-name .\" NS .\" NS local variable: .\" NS doc-str-At .\" NS doc-str-At1 .\" NS doc-str-At-XXX .\" NS .\" NS width register `At' defined in doc-common . .ds doc-str-At-32v \&Version\~32V .as doc-str-At-32v " \*[doc-Tn-font-size]AT&T UNIX\*[doc-str-At] .ds doc-str-At-v1 \&Version\~1 .as doc-str-At-v1 " \*[doc-Tn-font-size]AT&T UNIX\*[doc-str-At] .ds doc-str-At-v2 \&Version\~2 .as doc-str-At-v2 " \*[doc-Tn-font-size]AT&T UNIX\*[doc-str-At] .ds doc-str-At-v3 \&Version\~3 .as doc-str-At-v3 " \*[doc-Tn-font-size]AT&T UNIX\*[doc-str-At] .ds doc-str-At-v4 \&Version\~4 .as doc-str-At-v4 " \*[doc-Tn-font-size]AT&T UNIX\*[doc-str-At] .ds doc-str-At-v5 \&Version\~5 .as doc-str-At-v5 " \*[doc-Tn-font-size]AT&T UNIX\*[doc-str-At] .ds doc-str-At-v6 \&Version\~6 .as doc-str-At-v6 " \*[doc-Tn-font-size]AT&T UNIX\*[doc-str-At] .ds doc-str-At-v7 \&Version\~7 .as doc-str-At-v7 " \*[doc-Tn-font-size]AT&T UNIX\*[doc-str-At] .ds doc-str-At-V \*[doc-Tn-font-size]AT&T\*[doc-str-At] System\~V .as doc-str-At-V " \*[doc-Tn-font-size]UNIX\*[doc-str-At] .ds doc-str-At-V.1 \*[doc-Tn-font-size]AT&T\*[doc-str-At] System\~V.1 .as doc-str-At-V.1 " \*[doc-Tn-font-size]UNIX\*[doc-str-At] .ds doc-str-At-V.2 \*[doc-Tn-font-size]AT&T\*[doc-str-At] System\~V.2 .as doc-str-At-V.2 " \*[doc-Tn-font-size]UNIX\*[doc-str-At] .ds doc-str-At-V.3 \*[doc-Tn-font-size]AT&T\*[doc-str-At] System\~V.3 .as doc-str-At-V.3 " \*[doc-Tn-font-size]UNIX\*[doc-str-At] .ds doc-str-At-V.4 \*[doc-Tn-font-size]AT&T\*[doc-str-At] System\~V.4 .as doc-str-At-V.4 " \*[doc-Tn-font-size]UNIX\*[doc-str-At] . .de At . nr doc-curr-font \n[.f] . nr doc-curr-size \n[.ps] . ds doc-str-At \f[\n[doc-curr-font]]\s[\n[doc-curr-size]u] . . \" default value if no argument . ds doc-str-At1 \*[doc-Tn-font-size]AT&T UNIX\*[doc-str-At] . . if !\n[doc-arg-limit] \ . if \n[.$] \{\ . ds doc-macro-name At . doc-parse-args \$@ . \} . . if (\n[doc-arg-limit] > \n[doc-arg-ptr]) \{\ . nr doc-arg-ptr +1 . ie (\n[doc-type\n[doc-arg-ptr]] == 2) \{\ . ie \A\*[doc-arg\n[doc-arg-ptr]] \{\ . ie d doc-str-At-\*[doc-arg\n[doc-arg-ptr]] \ . ds doc-str-At1 "\*[doc-str-At-\*[doc-arg\n[doc-arg-ptr]]] . el \{\ . tmc mdoc warning: .At: Unknown AT&T UNIX version . tm1 " `\*[doc-arg\n[doc-arg-ptr]]' (#\n[.c]) . nr doc-arg-ptr -1 . \}\} . el \ . nr doc-arg-ptr -1 . \} . el \ . nr doc-arg-ptr -1 . \} . . \" replace current argument with result . ds doc-arg\n[doc-arg-ptr] "\*[doc-str-At1] . nr doc-type\n[doc-arg-ptr] 2 . ds doc-space\n[doc-arg-ptr] "\*[doc-space] . . \" recompute space vector for remaining arguments . nr doc-num-args (\n[doc-arg-limit] - \n[doc-arg-ptr]) . nr doc-arg-limit \n[doc-arg-ptr] . if \n[doc-num-args] \ . doc-parse-space-vector . . doc-print-recursive .. . . .\" NS Fx user macro .\" NS print FreeBSD .\" NS .\" NS modifies: .\" NS doc-arg-ptr .\" NS doc-curr-font .\" NS doc-curr-size .\" NS doc-macro-name .\" NS .\" NS local variable: .\" NS doc-str-Fx .\" NS doc-str-Fx1 .\" NS .\" NS width register `Fx' defined in doc-common . .\" we use the doc-operating-system-FreeBSD-* strings defined in doc-common . .de Fx . nr doc-curr-font \n[.f] . nr doc-curr-size \n[.ps] . ds doc-str-Fx \f[\n[doc-curr-font]]\s[\n[doc-curr-size]u] . . \" default value if no argument . ds doc-str-Fx1 \*[doc-Tn-font-size]\%FreeBSD\*[doc-str-Fx] . . if !\n[doc-arg-limit] \ . if \n[.$] \{\ . ds doc-macro-name Fx . doc-parse-args \$@ . \} . . if (\n[doc-arg-limit] > \n[doc-arg-ptr]) \{\ . nr doc-arg-ptr +1 . ie (\n[doc-type\n[doc-arg-ptr]] == 2) \{\ . ie \A\*[doc-arg\n[doc-arg-ptr]] \{\ . ie d doc-operating-system-FreeBSD-\*[doc-arg\n[doc-arg-ptr]] \ . as doc-str-Fx1 \~\*[doc-operating-system-FreeBSD-\*[doc-arg\n[doc-arg-ptr]]] . el \{\ . tmc mdoc warning: .Fx: Unknown FreeBSD version . tm1 " `\*[doc-arg\n[doc-arg-ptr]]' (#\n[.c]) . as doc-str-Fx1 \~\*[doc-arg\n[doc-arg-ptr]] . \}\} . el \ . as doc-str-Fx1 \~\*[doc-arg\n[doc-arg-ptr]] . \} . el \ . nr doc-arg-ptr -1 . \} . . \" replace current argument with result . ds doc-arg\n[doc-arg-ptr] "\*[doc-str-Fx1] . nr doc-type\n[doc-arg-ptr] 2 . ds doc-space\n[doc-arg-ptr] "\*[doc-space] . . \" recompute space vector for remaining arguments . nr doc-num-args (\n[doc-arg-limit] - \n[doc-arg-ptr]) . nr doc-arg-limit \n[doc-arg-ptr] . if \n[doc-num-args] \ . doc-parse-space-vector . . doc-print-recursive .. . . .\" NS Nx user macro .\" NS print NetBSD .\" NS .\" NS modifies: .\" NS doc-arg-ptr .\" NS doc-curr-font .\" NS doc-curr-size .\" NS doc-macro-name .\" NS .\" NS local variable: .\" NS doc-str-Nx .\" NS doc-str-Nx1 .\" NS .\" NS width register `Nx' defined in doc-common . .\" we use the doc-operating-system-NetBSD-* strings defined in doc-common . .de Nx . nr doc-curr-font \n[.f] . nr doc-curr-size \n[.ps] . ds doc-str-Nx \f[\n[doc-curr-font]]\s[\n[doc-curr-size]u] . . \" default value if no argument . ds doc-str-Nx1 \*[doc-Tn-font-size]\%N\s[\n[doc-curr-size]u]et . as doc-str-Nx1 \*[doc-Tn-font-size]BSD\*[doc-str-Nx] . . if !\n[doc-arg-limit] \ . if \n[.$] \{\ . ds doc-macro-name Nx . doc-parse-args \$@ . \} . . if (\n[doc-arg-limit] > \n[doc-arg-ptr]) \{\ . nr doc-arg-ptr +1 . ie (\n[doc-type\n[doc-arg-ptr]] == 2) \{\ . ie \A\*[doc-arg\n[doc-arg-ptr]] \{\ . ie d doc-operating-system-NetBSD-\*[doc-arg\n[doc-arg-ptr]] \ . as doc-str-Nx1 \~\*[doc-operating-system-NetBSD-\*[doc-arg\n[doc-arg-ptr]]] . el \{\ . tmc mdoc warning: .Nx: Unknown NetBSD version . tm1 " `\*[doc-arg\n[doc-arg-ptr]]' (#\n[.c]) . as doc-str-Nx1 \~\*[doc-arg\n[doc-arg-ptr]] . \}\} . el \ . as doc-str-Nx1 \~\*[doc-arg\n[doc-arg-ptr]] . \} . el \ . nr doc-arg-ptr -1 . \} . . \" replace current argument with result . ds doc-arg\n[doc-arg-ptr] "\*[doc-str-Nx1] . nr doc-type\n[doc-arg-ptr] 2 . ds doc-space\n[doc-arg-ptr] "\*[doc-space] . . \" recompute space vector for remaining arguments . nr doc-num-args (\n[doc-arg-limit] - \n[doc-arg-ptr]) . nr doc-arg-limit \n[doc-arg-ptr] . if \n[doc-num-args] \ . doc-parse-space-vector . . doc-print-recursive .. . . .\" NS Ox user macro .\" NS print OpenBSD .\" NS .\" NS modifies: .\" NS doc-arg-ptr .\" NS doc-curr-font .\" NS doc-curr-size .\" NS doc-macro-name .\" NS .\" NS local variable: .\" NS doc-str-Ox .\" NS doc-str-Ox1 .\" NS .\" NS width register `Ox' defined in doc-common . .de Ox . nr doc-curr-font \n[.f] . nr doc-curr-size \n[.ps] . ds doc-str-Ox \f[\n[doc-curr-font]]\s[\n[doc-curr-size]u] . . \" default value if no argument . ds doc-str-Ox1 \*[doc-Tn-font-size]\%OpenBSD\*[doc-str-Ox] . . if !\n[doc-arg-limit] \ . if \n[.$] \{\ . ds doc-macro-name Ox . doc-parse-args \$@ . \} . . if (\n[doc-arg-limit] > \n[doc-arg-ptr]) \{\ . nr doc-arg-ptr +1 . ie (\n[doc-type\n[doc-arg-ptr]] == 2) \ . as doc-str-Ox1 \~\*[doc-arg\n[doc-arg-ptr]] . el \ . nr doc-arg-ptr -1 . \} . . \" replace current argument with result . ds doc-arg\n[doc-arg-ptr] "\*[doc-str-Ox1] . nr doc-type\n[doc-arg-ptr] 2 . ds doc-space\n[doc-arg-ptr] "\*[doc-space] . . \" recompute space vector for remaining arguments . nr doc-num-args (\n[doc-arg-limit] - \n[doc-arg-ptr]) . nr doc-arg-limit \n[doc-arg-ptr] . if \n[doc-num-args] \ . doc-parse-space-vector . . doc-print-recursive .. . . .\" NS Bsx user macro .\" NS print BSD/OS .\" NS .\" NS modifies: .\" NS doc-arg-ptr .\" NS doc-curr-font .\" NS doc-curr-size .\" NS doc-macro-name .\" NS .\" NS local variable: .\" NS doc-str-Bsx .\" NS doc-str-Bsx1 .\" NS .\" NS width register `Bsx' defined in doc-common . .de Bsx . nr doc-curr-font \n[.f] . nr doc-curr-size \n[.ps] . ds doc-str-Bsx \f[\n[doc-curr-font]]\s[\n[doc-curr-size]u] . . \" default value if no argument . ds doc-str-Bsx1 \*[doc-Tn-font-size]BSD/OS\*[doc-str-Bsx] . . if !\n[doc-arg-limit] \ . if \n[.$] \{\ . ds doc-macro-name Bsx . doc-parse-args \$@ . \} . . if (\n[doc-arg-limit] > \n[doc-arg-ptr]) \{\ . nr doc-arg-ptr +1 . ie (\n[doc-type\n[doc-arg-ptr]] == 2) \ . as doc-str-Bsx1 \~\*[doc-arg\n[doc-arg-ptr]] . el \ . nr doc-arg-ptr -1 . \} . . \" replace current argument with result . ds doc-arg\n[doc-arg-ptr] "\*[doc-str-Bsx1] . nr doc-type\n[doc-arg-ptr] 2 . ds doc-space\n[doc-arg-ptr] "\*[doc-space] . . \" recompute space vector for remaining arguments . nr doc-num-args (\n[doc-arg-limit] - \n[doc-arg-ptr]) . nr doc-arg-limit \n[doc-arg-ptr] . if \n[doc-num-args] \ . doc-parse-space-vector . . doc-print-recursive .. . . .\" The Bt macro should go away now . .\" NS Bt user macro (not parsed, not callable) .\" NS print "is currently in beta test." (HISTORY section) .\" NS .\" NS width register `Bt' defined in doc-common . .de Bt . nop \&is currently in beta test. .. . . .\" NS Px user macro .\" NS print POSIX . .ds Px \*[doc-Tn-font-size]\%POSIX . . .\" NS Ai user macro .\" NS print ANSI . .ds Ai \*[doc-Tn-font-size]\%ANSI . . .\" NS St user macro .\" NS standards (posix, ansi - formal standard names) .\" NS .\" NS modifies: .\" NS doc-arg-ptr .\" NS doc-curr-font .\" NS doc-curr-size .\" NS doc-macro-name .\" NS .\" NS local variable: .\" NS doc-reg-St .\" NS doc-str-St .\" NS doc-str-St1 .\" NS doc-str-St-XXX .\" NS .\" NS width register `St' defined in doc-common . .\" ANSI/ISO C .ds doc-str-St--ansiC-89 \*[Ai] \*[doc-str-St]X\^3.159-1989 .as doc-str-St--ansiC-89 " (\*[Lq]\)\*[Ai]\~C89\*[doc-str-St]\*[Rq]) .als doc-str-St--ansiC doc-str-St--ansiC-89 .ds doc-str-St--isoC \*[doc-Tn-font-size]ISO/IEC\*[doc-str-St] 9899:1990 .as doc-str-St--isoC " (\*[Lq]\*[doc-Tn-font-size]ISO\~C\^90\*[doc-str-St]\*[Rq]) .als doc-str-St--isoC-90 doc-str-St--isoC .ds doc-str-St--isoC-99 \*[doc-Tn-font-size]ISO/IEC\*[doc-str-St] 9899:1999 .as doc-str-St--isoC-99 " (\*[Lq]\*[doc-Tn-font-size]ISO\~C\^99\*[doc-str-St]\*[Rq]) . .\" POSIX Part 1: System API .ds doc-str-St--p1003.1 \*[doc-Tn-font-size]\%IEEE\*[doc-str-St] Std 1003.1 .as doc-str-St--p1003.1 " (\*[Lq]\)\*[Px]\*[doc-str-St].1\*[Rq]) .ds doc-str-St--p1003.1-88 \*[doc-Tn-font-size]\%IEEE\*[doc-str-St] Std 1003.1-1988 .as doc-str-St--p1003.1-88 " (\*[Lq]\)\*[Px]\*[doc-str-St].1\*[Rq]) .ds doc-str-St--p1003.1-90 \*[doc-Tn-font-size]ISO/IEC\*[doc-str-St] 9945-1:1990 .as doc-str-St--p1003.1-90 " (\*[Lq]\)\*[Px]\*[doc-str-St].1\*[Rq]) .als doc-str-St--iso9945-1-90 doc-str-St--p1003.1-90 .ds doc-str-St--p1003.1b-93 \*[doc-Tn-font-size]\%IEEE\*[doc-str-St] Std 1003.1b-1993 .as doc-str-St--p1003.1b-93 " (\*[Lq]\)\*[Px]\*[doc-str-St].1\*[Rq]) .ds doc-str-St--p1003.1c-95 \*[doc-Tn-font-size]\%IEEE\*[doc-str-St] Std 1003.1c-1995 .as doc-str-St--p1003.1c-95 " (\*[Lq]\)\*[Px]\*[doc-str-St].1\*[Rq]) .ds doc-str-St--p1003.1i-95 \*[doc-Tn-font-size]\%IEEE\*[doc-str-St] Std 1003.1i-1995 .as doc-str-St--p1003.1i-95 " (\*[Lq]\)\*[Px]\*[doc-str-St].1\*[Rq]) .ds doc-str-St--p1003.1-96 \*[doc-Tn-font-size]ISO/IEC\*[doc-str-St] 9945-1:1996 .as doc-str-St--p1003.1-96 " (\*[Lq]\)\*[Px]\*[doc-str-St].1\*[Rq]) .als doc-str-St--iso9945-1-96 doc-str-St--p1003.1-96 .ds doc-str-St--p1003.1g-2000 \*[doc-Tn-font-size]\%IEEE\*[doc-str-St] Std 1003.1g-2000 .as doc-str-St--p1003.1g-2000 " (\*[Lq]\)\*[Px]\*[doc-str-St].1\*[Rq]) .ds doc-str-St--p1003.1-2001 \*[doc-Tn-font-size]\%IEEE\*[doc-str-St] Std 1003.1-2001 .as doc-str-St--p1003.1-2001 " (\*[Lq]\)\*[Px]\*[doc-str-St].1\*[Rq]) .ds doc-str-St--p1003.1-2004 \*[doc-Tn-font-size]\%IEEE\*[doc-str-St] Std 1003.1-2004 .as doc-str-St--p1003.1-2004 " (\*[Lq]\)\*[Px]\*[doc-str-St].1\*[Rq]) . .\" POSIX Part 2: Shell and Utilities .ds doc-str-St--p1003.2 \*[doc-Tn-font-size]\%IEEE\*[doc-str-St] Std 1003.2 .as doc-str-St--p1003.2 " (\*[Lq]\)\*[Px]\*[doc-str-St].2\*[Rq]) .ds doc-str-St--p1003.2-92 \*[doc-Tn-font-size]\%IEEE\*[doc-str-St] Std 1003.2-1992 .as doc-str-St--p1003.2-92 " (\*[Lq]\)\*[Px]\*[doc-str-St].2\*[Rq]) .ds doc-str-St--p1003.2a-92 \*[doc-Tn-font-size]\%IEEE\*[doc-str-St] Std 1003.2a-1992 .as doc-str-St--p1003.2a-92 " (\*[Lq]\)\*[Px]\*[doc-str-St].2\*[Rq]) .ds doc-str-St--iso9945-2-93 \*[doc-Tn-font-size]ISO/IEC\*[doc-str-St] 9945-2:1993 .as doc-str-St--iso9945-2-93 " (\*[Lq]\)\*[Px]\*[doc-str-St].2\*[Rq]) . .\" X/Open .ds doc-str-St--susv2 Version\~2 of the Single \*[doc-Tn-font-size]UNIX\*[doc-str-St] Specification .as doc-str-St--susv2 " (\*[Lq]\*[doc-Tn-font-size]SUSv2\*[doc-str-St]\*[Rq]) .ds doc-str-St--svid4 System\~V Interface Definition, Fourth Edition .as doc-str-St--svid4 " (\*[Lq]\*[doc-Tn-font-size]SVID\*[doc-str-St]\^4\*[Rq]) .ds doc-str-St--xbd5 \*[doc-Tn-font-size]X/Open\*[doc-str-St] System Interface Definitions Issue\~5 .as doc-str-St--xbd5 " (\*[Lq]\*[doc-Tn-font-size]XBD\*[doc-str-St]\^5\*[Rq]) .ds doc-str-St--xcu5 \*[doc-Tn-font-size]X/Open\*[doc-str-St] Commands and Utilities Issue\~5 .as doc-str-St--xcu5 " (\*[Lq]\*[doc-Tn-font-size]XCU\*[doc-str-St]\^5\*[Rq]) .ds doc-str-St--xcurses4.2 \*[doc-Tn-font-size]X/Open\*[doc-str-St] Curses Issue\~4, Version\~2 .as doc-str-St--xcurses4.2 " (\*[Lq]\*[doc-Tn-font-size]XCURSES\*[doc-str-St]\^4.2\*[Rq]) .ds doc-str-St--xns5 \*[doc-Tn-font-size]X/Open\*[doc-str-St] Networking Services Issue\~5 .as doc-str-St--xns5 " (\*[Lq]\*[doc-Tn-font-size]XNS\*[doc-str-St]\^5\*[Rq]) .ds doc-str-St--xns5.2 \*[doc-Tn-font-size]X/Open\*[doc-str-St] Networking Services Issue\~5.2 .as doc-str-St--xns5.2 " (\*[Lq]\*[doc-Tn-font-size]XNS\*[doc-str-St]\^5.2\*[Rq]) .ds doc-str-St--xpg3 \*[doc-Tn-font-size]X/Open\*[doc-str-St] Portability Guide Issue\~3 .as doc-str-St--xpg3 " (\*[Lq]\*[doc-Tn-font-size]XPG\*[doc-str-St]\^3\*[Rq]) .ds doc-str-St--xpg4 \*[doc-Tn-font-size]X/Open\*[doc-str-St] Portability Guide Issue\~4 .as doc-str-St--xpg4 " (\*[Lq]\*[doc-Tn-font-size]XPG\*[doc-str-St]\^4\*[Rq]) .ds doc-str-St--xpg4.2 \*[doc-Tn-font-size]X/Open\*[doc-str-St] Portability Guide Issue\~4, Version\~2 .as doc-str-St--xpg4.2 " (\*[Lq]\*[doc-Tn-font-size]XPG\*[doc-str-St]\^4.2\*[Rq]) .ds doc-str-St--xsh5 \*[doc-Tn-font-size]X/Open\*[doc-str-St] System Interfaces and Headers Issue\~5 .as doc-str-St--xsh5 " (\*[Lq]\*[doc-Tn-font-size]XSH\*[doc-str-St]\^5\*[Rq]) . .\" Miscellaneous .ds doc-str-St--ieee754 \*[doc-Tn-font-size]\%IEEE\*[doc-str-St] Std 754-1985 .ds doc-str-St--iso8802-3 \*[doc-Tn-font-size]ISO/IEC\*[doc-str-St] 8802-3:1989 . .de St . if !\n[doc-arg-limit] \{\ . ie \n[.$] \{\ . ds doc-macro-name St . doc-parse-args \$@ . \} . el \ . doc-St-usage . \} . . if !\n[doc-arg-limit] \ . return . . nr doc-arg-ptr +1 . ie (\n[doc-arg-limit] >= \n[doc-arg-ptr]) \{\ . nr doc-curr-font \n[.f] . nr doc-curr-size \n[.ps] . ds doc-str-St \f[\n[doc-curr-font]]\s[\n[doc-curr-size]u] . . ds doc-str-St1 . ie \A\*[doc-arg\n[doc-arg-ptr]] \{\ . ie d doc-str-St-\*[doc-arg\n[doc-arg-ptr]] \ . ds doc-str-St1 "\*[doc-str-St-\*[doc-arg\n[doc-arg-ptr]]] . el \{\ . tmc "mdoc warning: .St: Unknown standard abbreviation . tm1 " `\*[doc-arg\n[doc-arg-ptr]]' (#\n[.c]) . tm1 " Please refer to the groff_mdoc(7) manpage for a . tm1 " list of available standard abbreviations. . \}\} . el \ . doc-St-usage . . \" replacing argument with result . ds doc-arg\n[doc-arg-ptr] "\*[doc-str-St1] . . doc-print-recursive . \} . el \{\ . doc-St-usage . doc-reset-args . \} .. . . .\" NS doc-St-usage macro . .de doc-St-usage . tm1 "Usage: .St standard (#\n[.c]) . tm1 " Please refer to the groff_mdoc(7) manpage for a list of . tm1 " available standard abbreviations. .. . . .\" NS Lb user macro .\" NS formal library names for LIBRARY sections .\" NS .\" NS modifies: .\" NS doc-arg-ptr .\" NS doc-curr-font .\" NS doc-curr-size .\" NS doc-macro-name .\" NS .\" NS local variable: .\" NS doc-reg-Lb .\" NS doc-str-Lb .\" NS doc-str-Lb1 .\" NS doc-str-Lb-XXX .\" NS .\" NS width register `Lb' defined in doc-common . .ds doc-str-Lb-libarm ARM Architecture Library (libarm, \-larm) .ds doc-str-Lb-libarm32 ARM32 Architecture Library (libarm32, \-larm32) .ds doc-str-Lb-libc Standard C\~Library (libc, \-lc) .ds doc-str-Lb-libcdk Curses Development Kit Library (libcdk, \-lcdk) .ds doc-str-Lb-libcompat Compatibility Library (libcompat, \-lcompat) .ds doc-str-Lb-libcrypt Crypt Library (libcrypt, \-lcrypt) .ds doc-str-Lb-libcurses Curses Library (libcurses, \-lcurses) .ds doc-str-Lb-libedit Command Line Editor Library (libedit, \-ledit) .ds doc-str-Lb-libevent Event Notification Library (libevent, \-levent) .ds doc-str-Lb-libform Curses Form Library (libform, \-lform) .ds doc-str-Lb-libi386 i386 Architecture Library (libi386, \-li386) .ds doc-str-Lb-libintl Internationalized Message Handling Library (libintl, \-lintl) .ds doc-str-Lb-libipsec IPsec Policy Control Library (libipsec, \-lipsec) .ds doc-str-Lb-libkvm Kernel Data Access Library (libkvm, \-lkvm) .ds doc-str-Lb-libm Math Library (libm, \-lm) .ds doc-str-Lb-libm68k m68k Architecture Library (libm68k, \-lm68k) .ds doc-str-Lb-libmagic Magic Number Recognition Library (libmagic, \-lmagic) .ds doc-str-Lb-libmenu Curses Menu Library (libmenu, \-lmenu) .ds doc-str-Lb-libossaudio OSS Audio Emulation Library (libossaudio, \-lossaudio) .ds doc-str-Lb-libpam Pluggable Authentication Module Library (libpam, \-lpam) .ds doc-str-Lb-libpcap Packet Capture Library (libpcap, \-lpcap) .ds doc-str-Lb-libpci PCI Bus Access Library (libpci, \-lpci) .ds doc-str-Lb-libpmc Performance Counters Library (libpmc, \-lpmc) .ds doc-str-Lb-libposix \*[Px] \*[doc-str-Lb]Compatibility Library (libposix, \-lposix) .ds doc-str-Lb-libpthread \*[Px] \*[doc-str-Lb]Threads Library (libpthread, \-lpthread) .ds doc-str-Lb-libresolv DNS Resolver Library (libresolv, \-lresolv) .ds doc-str-Lb-librt \*[Px] \*[doc-str-Lb]Real-time Library (librt, \-lrt) .ds doc-str-Lb-libtermcap Termcap Access Library (libtermcap, \-ltermcap) .ds doc-str-Lb-libusbhid USB Human Interface Devices Library (libusbhid, \-lusbhid) .ds doc-str-Lb-libutil System Utilities Library (libutil, \-lutil) .ds doc-str-Lb-libx86_64 x86_64 Architecture Library (libx86_64, \-lx86_64) .ds doc-str-Lb-libz Compression Library (libz, \-lz) . .de Lb . if !\n[doc-arg-limit] \{\ . ie \n[.$] \{\ . ds doc-macro-name Lb . doc-parse-args \$@ . \} . el \ . tm Usage: .Lb library_name ... (#\n[.c]) . \} . . if !\n[doc-arg-limit] \ . return . . nr doc-arg-ptr +1 . ie (\n[doc-arg-limit] >= \n[doc-arg-ptr]) \{\ . nr doc-curr-font \n[.f] . nr doc-curr-size \n[.ps] . ds doc-str-Lb \f[\n[doc-curr-font]]\s[\n[doc-curr-size]u] . . ie d doc-str-Lb-\*[doc-arg\n[doc-arg-ptr]] \ . ds doc-str-Lb1 "\*[doc-str-Lb-\*[doc-arg\n[doc-arg-ptr]]] . el \{\ . tmc "mdoc warning: .Lb: no description for library . tm1 " `\*[doc-arg\n[doc-arg-ptr]]' available (#\n[.c]) . ds doc-str-Lb1 library \*[Lq]\*[doc-arg\n[doc-arg-ptr]]\*[Rq] . \} . . \" replacing argument with result . ds doc-arg\n[doc-arg-ptr] "\*[doc-str-Lb1] . . if \n[doc-in-library-section] \ . br . doc-print-recursive . if \n[doc-in-library-section] \ . br . \} . el \{\ . tm Usage: .Lb library_name ... (#\n[.c]) . doc-reset-args . \} .. . . .ec . .\" EOF