[BACK]Return to roff.7 CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/roff.7 between version 1.56 and 1.84

version 1.56, 2014/08/13 20:34:29 version 1.84, 2017/06/04 22:44:15
Line 1 
Line 1 
 .\"     $Id$  .\"     $Id$
 .\"  .\"
 .\" Copyright (c) 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>  .\" Copyright (c) 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
 .\" Copyright (c) 2010, 2011, 2013, 2014 Ingo Schwarze <schwarze@openbsd.org>  .\" Copyright (c) 2010,2011,2013-2015,2017 Ingo Schwarze <schwarze@openbsd.org>
 .\"  .\"
 .\" Permission to use, copy, modify, and distribute this software for any  .\" Permission to use, copy, modify, and distribute this software for any
 .\" purpose with or without fee is hereby granted, provided that the above  .\" purpose with or without fee is hereby granted, provided that the above
Line 395  The
Line 395  The
 .Xr mandoc 1  .Xr mandoc 1
 .Nm  .Nm
 parser recognises the following requests.  parser recognises the following requests.
 Note that the  For requests marked as "ignored" or "unsupported", any arguments are
 .Nm  ignored, and the number of arguments is not checked.
 language defines many more requests not implemented in  .Bl -tag -width Ds
 .Xr mandoc 1 .  .It Ic \&ab Op Ar message
 .Ss \&ad  Abort processing.
 Set line adjustment mode.  Currently unsupported.
 This line-scoped request is intended to have one argument to select  .It Ic \&ad Op Cm b | c | l | n | r
 normal, left, right, or centre adjustment for subsequent text.  Set line adjustment mode for subsequent text.
 Currently, it is ignored including its arguments,  Currently ignored.
 and the number of arguments is not checked.  .It Ic \&af Ar registername format
 .Ss \&am  Assign an output format to a number register.
   Currently ignored.
   .It Ic \&aln Ar newname oldname
   Create an alias for a number register.
   Currently unsupported.
   .It Ic \&als Ar newname oldname
   Create an alias for a request, string, macro, or diversion.
   Currently unsupported.
   .It Ic \&am Ar macroname Op Ar endmacro
 Append to a macro definition.  Append to a macro definition.
 The syntax of this request is the same as that of  The syntax of this request is the same as that of
 .Sx \&de .  .Ic \&de .
 .Ss \&ami  .It Ic \&am1 Ar macroname Op Ar endmacro
 Append to a macro definition, specifying the macro name indirectly.  
 The syntax of this request is the same as that of  
 .Sx \&dei .  
 .Ss \&am1  
 Append to a macro definition, switching roff compatibility mode off  Append to a macro definition, switching roff compatibility mode off
 during macro execution.  during macro execution (groff extension).
 The syntax of this request is the same as that of  The syntax of this request is the same as that of
 .Sx \&de1 .  .Ic \&de1 .
 Since  Since
 .Xr mandoc 1  .Xr mandoc 1
 does not implement  does not implement
 .Nm  .Nm
 compatibility mode at all, it handles this request as an alias for  compatibility mode at all, it handles this request as an alias for
 .Sx \&am .  .Ic \&am .
 .Ss \&as  .It Ic \&ami Ar macrostring Op Ar endstring
   Append to a macro definition, specifying the macro name indirectly
   (groff extension).
   The syntax of this request is the same as that of
   .Ic \&dei .
   .It Ic \&ami1 Ar macrostring Op Ar endstring
   Append to a macro definition, specifying the macro name indirectly
   and switching roff compatibility mode off during macro execution
   (groff extension).
   The syntax of this request is the same as that of
   .Ic \&dei1 .
   Since
   .Xr mandoc 1
   does not implement
   .Nm
   compatibility mode at all, it handles this request as an alias for
   .Ic \&ami .
   .It Ic \&as Ar stringname Op Ar string
 Append to a user-defined string.  Append to a user-defined string.
 The syntax of this request is the same as that of  The syntax of this request is the same as that of
 .Sx \&ds .  .Sx \&ds .
 If a user-defined string with the specified name does not yet exist,  If a user-defined string with the specified name does not yet exist,
 it is set to the empty string before appending.  it is set to the empty string before appending.
 .Ss \&cc  .It Ic \&as1 Ar stringname Op Ar string
 Changes the control character.  Append to a user-defined string, switching roff compatibility mode off
 Its syntax is as follows:  during macro execution (groff extension).
 .Bd -literal -offset indent  The syntax of this request is the same as that of
 .Pf . Cm \&cc Op Ar c  .Ic \&ds1 .
 .Ed  Since
 .Pp  .Xr mandoc 1
   does not implement
   .Nm
   compatibility mode at all, it handles this request as an alias for
   .Ic \&as .
   .It Ic \&asciify Ar divname
   Fully unformat a diversion.
   Currently unsupported.
   .It Ic \&backtrace
   Print a backtrace of the input stack.
   This is a groff extension and currently ignored.
   .It Ic \&bd Ar font Oo Ar curfont Oc Op Ar offset
   Artificially embolden by repeated printing with small shifts.
   Currently ignored.
   .It Ic \&bleedat Ar left top width height
   Set the BleedBox page parameter for PDF generation.
   This is a Heirloom extension and currently ignored.
   .It Ic \&blm Ar macroname
   Set a blank line trap.
   Currently unsupported.
   .It Ic \&box Ar divname
   Begin a diversion without including a partially filled line.
   Currently unsupported.
   .It Ic \&boxa Ar divname
   Add to a diversion without including a partially filled line.
   Currently unsupported.
   .It Ic \&bp Oo Cm + Ns | Ns Cm - Oc Ns Ar pagenumber
   Begin a new page.
   Currently ignored.
   .It Ic \&BP Ar source height width position offset flags label
   Define a frame and place a picture in it.
   This is a Heirloom extension and currently unsupported.
   .It Ic \&br
   Break the output line.
   .It Ic \&break
   Break out of a
   .Ic \&while
   loop.
   Currently unsupported.
   .It Ic \&breakchar Ar char ...
   Optional line break characters.
   This is a Heirloom extension and currently ignored.
   .It Ic \&brnl Ar N
   Break output line after the next
   .Ar N
   input lines.
   This is a Heirloom extension and currently ignored.
   .It Ic \&brp
   Break and spread output line.
   Currently, this is implemented as an alias for
   .Ic \&br .
   .It Ic \&brpnl Ar N
   Break and spread output line after the next
   .Ar N
   input lines.
   This is a Heirloom extension and currently ignored.
   .It Ic \&c2 Op Ar char
   Change the no-break control character.
   Currently unsupported.
   .It Ic \&cc Op Ar char
   Change the control character.
 If  If
 .Ar c  .Ar char
 is not specified, the control character is reset to  is not specified, the control character is reset to
 .Sq \&. .  .Sq \&. .
 Trailing characters are ignored.  Trailing characters are ignored.
 .Ss \&ce  .It Ic \&ce Op Ar N
 Center some lines.  Center the next
 This line-scoped request is intended to take one integer argument,  .Ar N
 specifying how many lines to center.  input lines without filling.
 Currently, it is ignored including its arguments, and the number  Currently ignored.
 of arguments is not checked.  .It Ic \&cf Ar filename
 .Ss \&de  Output the contents of a file.
   Ignored because insecure.
   .It Ic \&cflags Ar flags char ...
   Set character flags.
   This is a groff extension and currently ignored.
   .It Ic \&ch Ar macroname Op Ar dist
   Change a trap location.
   Currently ignored.
   .It Ic \&char Ar glyphname Op Ar string
   Define a new glyph.
   Currently unsupported.
   .It Ic \&chop Ar stringname
   Remove the last character from a macro, string, or diversion.
   Currently unsupported.
   .It Ic \&class Ar classname char ...
   Define a character class.
   This is a groff extension and currently ignored.
   .It Ic \&close Ar streamname
   Close an open file.
   Ignored because insecure.
   .It Ic \&CL Ar color text
   Print text in color.
   This is a Heirloom extension and currently unsupported.
   .It Ic \&color Op Cm 1 | 0
   Activate or deactivate colors.
   This is a groff extension and currently ignored.
   .It Ic \&composite Ar from to
   Define a name component for composite glyph names.
   This is a groff extension and currently unsupported.
   .It Ic \&continue
   Immediately start the next iteration of a
   .Ic \&while
   loop.
   Currently unsupported.
   .It Ic \&cp Op Cm 1 | 0
   Switch
   .Nm
   compatibility mode on or off.
   Currently ignored.
   .It Ic \&cropat Ar left top width height
   Set the CropBox page parameter for PDF generation.
   This is a Heirloom extension and currently ignored.
   .It Ic \&cs Ar font Op Ar width Op Ar emsize
   Constant character spacing mode.
   Currently ignored.
   .It Ic \&cu Op Ar N
   Underline next
   .Ar N
   input lines including whitespace.
   Currently ignored.
   .It Ic \&da Ar divname
   Append to a diversion.
   Currently unsupported.
   .It Ic \&dch Ar macroname Op Ar dist
   Change a trap location in the current diversion.
   This is a Heirloom extension and currently unsupported.
   .It Ic \&de Ar macroname Op Ar endmacro
 Define a  Define a
 .Nm  .Nm
 macro.  macro.
 Its syntax can be either  Its syntax can be either
 .Bd -literal -offset indent  .Bd -literal -offset indent
 .Pf . Cm \&de Ar name  .Pf . Ic \&de Ar macroname
 .Ar macro definition  .Ar definition
 \&..  \&..
 .Ed  .Ed
 .Pp  .Pp
 or  or
 .Bd -literal -offset indent  .Bd -literal -offset indent
 .Pf . Cm \&de Ar name Ar end  .Pf . Ic \&de Ar macroname Ar endmacro
 .Ar macro definition  .Ar definition
 .Pf . Ar end  .Pf . Ar endmacro
 .Ed  .Ed
 .Pp  .Pp
 Both forms define or redefine the macro  Both forms define or redefine the macro
 .Ar name  .Ar macroname
 to represent the  to represent the
 .Ar macro definition ,  .Ar definition ,
 which may consist of one or more input lines, including the newline  which may consist of one or more input lines, including the newline
 characters terminating each line, optionally containing calls to  characters terminating each line, optionally containing calls to
 .Nm  .Nm
Line 482  or
Line 619  or
 macros, whichever applies to the document in question.  macros, whichever applies to the document in question.
 .Pp  .Pp
 Specifying a custom  Specifying a custom
 .Ar end  .Ar endmacro
 macro works in the same way as for  macro works in the same way as for
 .Sx \&ig ;  .Ic \&ig ;
 namely, the call to  namely, the call to
 .Sq Pf . Ar end  .Sq Pf . Ar endmacro
 first ends the  first ends the
 .Ar macro definition ,  .Ar definition ,
 and after that, it is also evaluated as a  and after that, it is also evaluated as a
 .Nm  .Nm
 request or  request or
Line 497  macro, but not as a high-level macro.
Line 634  macro, but not as a high-level macro.
 .Pp  .Pp
 The macro can be invoked later using the syntax  The macro can be invoked later using the syntax
 .Pp  .Pp
 .D1 Pf . Ar name Op Ar argument Op Ar argument ...  .D1 Pf . Ar macroname Op Ar argument Op Ar argument ...
 .Pp  .Pp
 Regarding argument parsing, see  Regarding argument parsing, see
 .Sx MACRO SYNTAX  .Sx MACRO SYNTAX
Line 505  above.
Line 642  above.
 .Pp  .Pp
 The line invoking the macro will be replaced  The line invoking the macro will be replaced
 in the input stream by the  in the input stream by the
 .Ar macro definition ,  .Ar definition ,
 replacing all occurrences of  replacing all occurrences of
 .No \e\e$ Ns Ar N ,  .No \e\e$ Ns Ar N ,
 where  where
Line 525  produces
Line 662  produces
 .D1 \efI\e^XtFree\e^\efP.  .D1 \efI\e^XtFree\e^\efP.
 .Pp  .Pp
 in the input stream, and thus in the output: \fI\^XtFree\^\fP.  in the input stream, and thus in the output: \fI\^XtFree\^\fP.
   Each occurrence of \e\e$* is replaced with all the arguments,
   joined together with single blank characters.
 .Pp  .Pp
 Since macros and user-defined strings share a common string table,  Since macros and user-defined strings share a common string table,
 defining a macro  defining a macro
 .Ar name  .Ar macroname
 clobbers the user-defined string  clobbers the user-defined string
 .Ar name ,  .Ar macroname ,
 and the  and the
 .Ar macro definition  .Ar definition
 can also be printed using the  can also be printed using the
 .Sq \e*  .Sq \e*
 string interpolation syntax described below  string interpolation syntax described below
 .Sx ds ,  .Ic ds ,
 but this is rarely useful because every macro definition contains at least  but this is rarely useful because every macro definition contains at least
 one explicit newline character.  one explicit newline character.
 .Pp  .Pp
 In order to prevent endless recursion, both groff and  In order to prevent endless recursion, both groff and
 .Xr mandoc 1  .Xr mandoc 1
 limit the stack depth for expanding macros and strings  limit the stack depth for expanding macros and strings
 to a large, but finite number.  to a large, but finite number, and
 Do not rely on the exact value of this limit.  .Xr mandoc 1
 .Ss \&dei  also limits the length of the expanded input line.
   Do not rely on the exact values of these limits.
   .It Ic \&de1 Ar macroname Op Ar endmacro
 Define a  Define a
 .Nm  .Nm
 macro, specifying the macro name indirectly.  macro that will be executed with
   .Nm
   compatibility mode switched off during macro execution.
   This is a groff extension.
   Since
   .Xr mandoc 1
   does not implement
   .Nm
   compatibility mode at all, it handles this request as an alias for
   .Ic \&de .
   .It Ic \&defcolor Ar newname scheme component ...
   Define a color name.
   This is a groff extension and currently ignored.
   .It Ic \&dei Ar macrostring Op Ar endstring
   Define a
   .Nm
   macro, specifying the macro name indirectly (groff extension).
 The syntax of this request is the same as that of  The syntax of this request is the same as that of
 .Sx \&de .  .Ic \&de .
 The request  The effect is the same as:
 .Pp  .Pp
 .D1 Pf . Cm \&dei Ar name Op Ar end  .D1 Pf . Cm \&de No \e* Ns Bo Ar macrostring Bc Op \e* Ns Bq Ar endstring
 .Pp  .It Ic \&dei1 Ar macrostring Op Ar endstring
 has the same effect as:  
 .Pp  
 .D1 Pf . Cm \&de No \e* Ns Bo Ar name Bc Op \e* Ns Bq Ar end  
 .Ss \&de1  
 Define a  Define a
 .Nm  .Nm
 macro that will be executed with  macro that will be executed with
 .Nm  .Nm
 compatibility mode switched off during macro execution.  compatibility mode switched off during macro execution,
 This is a GNU extension not available in traditional  specifying the macro name indirectly (groff extension).
 .Nm  
 implementations and not even in older versions of groff.  
 Since  Since
 .Xr mandoc 1  .Xr mandoc 1
 does not implement  does not implement
 .Nm  .Nm
 compatibility mode at all, it handles this request as an alias for  compatibility mode at all, it handles this request as an alias for
 .Sx \&de .  .Ic \&dei .
 .Ss \&ds  .It Ic \&device Ar string ...
   .It Ic \&devicem Ar stringname
   These two requests only make sense with the groff-specific intermediate
   output format and are unsupported.
   .It Ic \&di Ar divname
   Begin a diversion.
   Currently unsupported.
   .It Ic \&do Ar command Op Ar argument ...
   Execute
   .Nm
   request or macro line with compatibility mode disabled.
   Currently unsupported.
   .It Ic \&ds Ar stringname Op Oo \(dq Oc Ns Ar string
 Define a user-defined string.  Define a user-defined string.
 Its syntax is as follows:  
 .Pp  
 .D1 Pf . Cm \&ds Ar name Oo \(dq Oc Ns Ar string  
 .Pp  
 The  The
 .Ar name  .Ar stringname
 and  and
 .Ar string  .Ar string
 arguments are space-separated.  arguments are space-separated.
Line 595  including whitespace and double-quote characters, even
Line 754  including whitespace and double-quote characters, even
 The  The
 .Ar string  .Ar string
 can be interpolated into subsequent text by using  can be interpolated into subsequent text by using
 .No \e* Ns Bq Ar name  .No \e* Ns Bq Ar stringname
 for a  for a
 .Ar name  .Ar stringname
 of arbitrary length, or \e*(NN or \e*N if the length of  of arbitrary length, or \e*(NN or \e*N if the length of
 .Ar name  .Ar stringname
 is two or one characters, respectively.  is two or one characters, respectively.
 Interpolation can be prevented by escaping the leading backslash;  Interpolation can be prevented by escaping the leading backslash;
 that is, an asterisk preceded by an even number of backslashes  that is, an asterisk preceded by an even number of backslashes
Line 607  does not trigger string interpolation.
Line 766  does not trigger string interpolation.
 .Pp  .Pp
 Since user-defined strings and macros share a common string table,  Since user-defined strings and macros share a common string table,
 defining a string  defining a string
 .Ar name  .Ar stringname
 clobbers the macro  clobbers the macro
 .Ar name ,  .Ar stringname ,
 and the  and the
 .Ar name  .Ar stringname
 used for defining a string can also be invoked as a macro,  used for defining a string can also be invoked as a macro,
 in which case the following input line will be appended to the  in which case the following input line will be appended to the
 .Ar string ,  .Ar string ,
Line 626  H SYNOPSIS
Line 785  H SYNOPSIS
 .Ed  .Ed
 .Pp  .Pp
 invokes the  invokes the
 .Cm SH  .Ic SH
 macro when used in a  macro when used in a
 .Xr man 7  .Xr man 7
 document.  document.
 Such abuse is of course strongly discouraged.  Such abuse is of course strongly discouraged.
 .Ss \&el  .It Ic \&ds1 Ar stringname Op Oo \(dq Oc Ns Ar string
   Define a user-defined string that will be expanded with
   .Nm
   compatibility mode switched off during string expansion.
   This is a groff extension.
   Since
   .Xr mandoc 1
   does not implement
   .Nm
   compatibility mode at all, it handles this request as an alias for
   .Ic \&ds .
   .It Ic \&dwh Ar dist macroname
   Set a location trap in the current diversion.
   This is a Heirloom extension and currently unsupported.
   .It Ic \&dt Op Ar dist macroname
   Set a trap within a diversion.
   Currently unsupported.
   .It Ic \&ec Op Ar char
   Enable the escape mechanism and change the escape character.
 The  The
 .Qq else  .Ar char
   argument defaults to the backslash
   .Pq Sq \e .
   .It Ic \&ecr
   Restore the escape character.
   Currently unsupported.
   .It Ic \&ecs
   Save the escape character.
   Currently unsupported.
   .It Ic \&el Ar body
   The
   .Dq else
 half of an if/else conditional.  half of an if/else conditional.
 Pops a result off the stack of conditional evaluations pushed by  Pops a result off the stack of conditional evaluations pushed by
 .Sx \&ie  .Ic \&ie
 and uses it as its conditional.  and uses it as its conditional.
 If no stack entries are present (e.g., due to no prior  If no stack entries are present (e.g., due to no prior
 .Sx \&ie  .Ic \&ie
 calls)  calls)
 then false is assumed.  then false is assumed.
 The syntax of this request is similar to  The syntax of this request is similar to
 .Sx \&if  .Ic \&if
 except that the conditional is missing.  except that the conditional is missing.
 .Ss \&EN  .It Ic \&em Ar macroname
   Set a trap at the end of input.
   Currently unsupported.
   .It Ic \&EN
 End an equation block.  End an equation block.
 See  See
 .Sx \&EQ .  .Ic \&EQ .
 .Ss \&EQ  .It Ic \&eo
   Disable the escape mechanism completely.
   .It Ic \&EP
   End a picture started by
   .Ic \&BP .
   This is a Heirloom extension and currently unsupported.
   .It Ic \&EQ
 Begin an equation block.  Begin an equation block.
 See  See
 .Xr eqn 7  .Xr eqn 7
 for a description of the equation language.  for a description of the equation language.
 .Ss \&fam  .It Ic \&errprint Ar message
   Print a string like an error message.
   This is a Heirloom extension and currently ignored.
   .It Ic \&ev Op Ar envname
   Switch to another environment.
   Currently unsupported.
   .It Ic \&evc Op Ar envname
   Copy an environment into the current environment.
   Currently unsupported.
   .It Ic \&ex
   Abort processing and exit.
   Currently unsupported.
   .It Ic \&fallback Ar curfont font ...
   Select the fallback sequence for a font.
   This is a Heirloom extension and currently ignored.
   .It Ic \&fam Op Ar familyname
 Change the font family.  Change the font family.
 This line-scoped request is intended to have one argument specifying  This is a groff extension and currently ignored.
 the font family to be selected.  .It Ic \&fc Op Ar delimchar Op Ar padchar
 It is a groff extension, and currently, it is ignored including its  Define a delimiting and a padding character for fields.
 arguments, and the number of arguments is not checked.  Currently unsupported.
 .Ss \&ft  .It Ic \&fchar Ar glyphname Op Ar string
   Define a fallback glyph.
   Currently unsupported.
   .It Ic \&fcolor Ar colorname
   Set the fill color for \eD objects.
   This is a groff extension and currently ignored.
   .It Ic \&fdeferlig Ar font string ...
   Defer ligature building.
   This is a Heirloom extension and currently ignored.
   .It Ic \&feature Cm + Ns | Ns Cm - Ns Ar name
   Enable or disable an OpenType feature.
   This is a Heirloom extension and currently ignored.
   .It Ic \&fi
   Switch to fill mode.
   See
   .Xr man 7 .
   Ignored in
   .Xr mdoc 7 .
   .It Ic \&fkern Ar font minkern
   Control the use of kerning tables for a font.
   This is a Heirloom extension and currently ignored.
   .It Ic \&fl
   Flush output.
   Currently ignored.
   .It Ic \&flig Ar font string char ...
   Define ligatures.
   This is a Heirloom extension and currently ignored.
   .It Ic \&fp Ar position font Op Ar filename
   Assign font position.
   Currently ignored.
   .It Ic \&fps Ar mapname ...
   Mount a font with a special character map.
   This is a Heirloom extension and currently ignored.
   .It Ic \&fschar Ar font glyphname Op Ar string
   Define a font-specific fallback glyph.
   This is a groff extension and currently unsupported.
   .It Ic \&fspacewidth Ar font Op Ar afmunits
   Set a font-specific width for the space character.
   This is a Heirloom extension and currently ignored.
   .It Ic \&fspecial Ar curfont Op Ar font ...
   Conditionally define a special font.
   This is a groff extension and currently ignored.
   .It Ic \&ft Op Ar font
 Change the font.  Change the font.
 Its syntax is as follows:  
 .Pp  
 .D1 Pf . Cm \&ft Op Ar font  
 .Pp  
 The following  The following
 .Ar font  .Ar font
 arguments are supported:  arguments are supported:
Line 684  switches to normal font
Line 934  switches to normal font
 switches back to the previous font  switches back to the previous font
 .El  .El
 .Pp  .Pp
 This request takes effect only locally, may be overridden by macros  This request takes effect only locally and may be overridden
 and escape sequences, and is only supported in  by macros and escape sequences.
 .Xr man 7  .It Ic \&ftr Ar newname Op Ar oldname
 for now.  Translate font name.
 .Ss \&hw  This is a groff extension and currently ignored.
   .It Ic \&fzoom Ar font Op Ar permille
   Zoom font size.
   Currently ignored.
   .It Ic \&gcolor Op Ar colorname
   Set glyph color.
   This is a groff extension and currently ignored.
   .It Ic \&hc Op Ar char
   Set the hyphenation character.
   Currently ignored.
   .It Ic \&hcode Ar char code ...
   Set hyphenation codes of characters.
   Currently ignored.
   .It Ic \&hidechar Ar font char ...
   Hide characters in a font.
   This is a Heirloom extension and currently ignored.
   .It Ic \&hla Ar language
   Set hyphenation language.
   This is a groff extension and currently ignored.
   .It Ic \&hlm Op Ar number
   Set maximum number of consecutive hyphenated lines.
   Currently ignored.
   .It Ic \&hpf Ar filename
   Load hyphenation pattern file.
   This is a groff extension and currently ignored.
   .It Ic \&hpfa Ar filename
   Load hyphenation pattern file, appending to the current patterns.
   This is a groff extension and currently ignored.
   .It Ic \&hpfcode Ar code code ...
   Define mapping values for character codes in hyphenation patterns.
   This is a groff extension and currently ignored.
   .It Ic \&hw Ar word ...
 Specify hyphenation points in words.  Specify hyphenation points in words.
 This line-scoped request is currently ignored.  Currently ignored.
 .Ss \&hy  .It Ic \&hy Op Ar mode
 Set automatic hyphenation mode.  Set automatic hyphenation mode.
 This line-scoped request is currently ignored.  Currently ignored.
 .Ss \&ie  .It Ic \&hylang Ar language
   Set hyphenation language.
   This is a Heirloom extension and currently ignored.
   .It Ic \&hylen Ar nchar
   Minimum word length for hyphenation.
   This is a Heirloom extension and currently ignored.
   .It Ic \&hym Op Ar length
   Set hyphenation margin.
   This is a groff extension and currently ignored.
   .It Ic \&hypp Ar penalty ...
   Define hyphenation penalties.
   This is a Heirloom extension and currently ignored.
   .It Ic \&hys Op Ar length
   Set hyphenation space.
   This is a groff extension and currently ignored.
   .It Ic \&ie Ar condition body
 The  The
 .Qq if  .Dq if
 half of an if/else conditional.  half of an if/else conditional.
 The result of the conditional is pushed into a stack used by subsequent  The result of the conditional is pushed into a stack used by subsequent
 invocations of  invocations of
 .Sx \&el ,  .Ic \&el ,
 which may be separated by any intervening input (or not exist at all).  which may be separated by any intervening input (or not exist at all).
 Its syntax is equivalent to  Its syntax is equivalent to
 .Sx \&if .  .Ic \&if .
 .Ss \&if  .It Ic \&if Ar condition body
 Begins a conditional.  Begin a conditional.
 This request has the following syntax:  This request can also be written as follows:
 .Bd -literal -offset indent  .Bd -unfilled -offset indent
 \&.if COND BODY  .Pf . Ic \&if Ar condition No \e{ Ns Ar body
   .Ar body ... Ns \e}
 .Ed  .Ed
 .Bd -literal -offset indent  .Bd -unfilled -offset indent
 \&.if COND \e{BODY  .Pf . Ic \&if Ar condition No \e{\e
 BODY...\e}  .Ar body ...
   .Pf . No \e}
 .Ed  .Ed
 .Bd -literal -offset indent  
 \&.if COND \e{\e  
 BODY...  
 \&.\e}  
 .Ed  
 .Pp  .Pp
 COND is a conditional statement.  The
   .Ar condition
   is a boolean expression.
 Currently,  Currently,
 .Xr mandoc 1  .Xr mandoc 1
 supports the following subset of roff conditionals:  supports the following subset of roff conditionals:
Line 728  supports the following subset of roff conditionals:
Line 1023  supports the following subset of roff conditionals:
 .It  .It
 If  If
 .Sq \&!  .Sq \&!
 is prefixed to COND, the condition is logically inverted.  is prefixed to
   .Ar condition ,
   it is logically inverted.
 .It  .It
 If the first character of COND is  If the first character of
   .Ar condition
   is
 .Sq n  .Sq n
 .Pq nroff mode  .Pq nroff mode
 or  or
 .Sq o  .Sq o
 .Pq odd page ,  .Pq odd page ,
 COND evaluates to true.  it evaluates to true.
 .It  .It
 If the first character of COND is  If the first character of
   .Ar condition
   is
 .Sq c  .Sq c
 .Pq character available ,  .Pq character available ,
 .Sq d  .Sq d
 .Pq string defined ,  .Pq string defined ,
 .Sq e  .Sq e
 .Pq even page ,  .Pq even page ,
 .Sq r  
 .Pq register accessed ,  
 or  
 .Sq t  .Sq t
 .Pq troff mode ,  .Pq troff mode ,
 COND evaluates to false.  or
   .Sq v
   .Pq vroff mode ,
   it evaluates to false.
 .It  .It
 If COND starts with a parenthesis or with an optionally signed  If the first character of
   .Ar condition
   is
   .Sq r ,
   it evaluates to true if the rest of
   .Ar condition
   is the name of an existing number register;
   otherwise, it evaluates to false.
   .It
   If the
   .Ar condition
   starts with a parenthesis or with an optionally signed
 integer number, it is evaluated according to the rules of  integer number, it is evaluated according to the rules of
 .Sx Numerical expressions  .Sx Numerical expressions
 explained below.  explained below.
 It evaluates to true if the the result is positive,  It evaluates to true if the result is positive,
 or to false if the result is zero or negative.  or to false if the result is zero or negative.
 .It  .It
 Otherwise, the first character of COND is regarded as a delimiter  Otherwise, the first character of
 and COND evaluates to true if the string extending from its first  .Ar condition
 to its second occurrence is equal to the string extending from its  is regarded as a delimiter and it evaluates to true if the string
 second to its third occurrence.  extending from its first to its second occurrence is equal to the
   string extending from its second to its third occurrence.
 .It  .It
 If COND cannot be parsed, it evaluates to false.  If
   .Ar condition
   cannot be parsed, it evaluates to false.
 .El  .El
 .Pp  .Pp
 If a conditional is false, its children are not processed, but are  If a conditional is false, its children are not processed, but are
Line 785  conditional.
Line 1100  conditional.
 Sub-conditionals, in this case, obviously inherit the truth value of  Sub-conditionals, in this case, obviously inherit the truth value of
 the parent.  the parent.
 .Pp  .Pp
 If the BODY section is begun by an escaped brace  If the
   .Ar body
   section is begun by an escaped brace
 .Sq \e{ ,  .Sq \e{ ,
 scope continues until the end of the input line containing the  scope continues until the end of the input line containing the
 matching closing-brace escape sequence  matching closing-brace escape sequence
 .Sq \e} .  .Sq \e} .
 If the BODY is not enclosed in braces, scope continues until  If the
 the end of the line.  .Ar body
 If the COND is followed by a BODY on the same line, whether after a  is not enclosed in braces, scope continues until the end of the line.
 brace or not, then requests and macros  If the
   .Ar condition
   is followed by a
   .Ar body
   on the same line, whether after a brace or not, then requests and macros
 .Em must  .Em must
 begin with a control character.  begin with a control character.
 It is generally more intuitive, in this case, to write  It is generally more intuitive, in this case, to write
 .Bd -literal -offset indent  .Bd -unfilled -offset indent
 \&.if COND \e{\e  .Pf . Ic \&if Ar condition No \e{\e
 \&.foo  .Pf . Ar request
 bar  .Pf . No \e}
 \&.\e}  
 .Ed  .Ed
 .Pp  .Pp
 than having the request or macro follow as  than having the request or macro follow as
 .Pp  .Pp
 .D1 \&.if COND \e{ .foo  .D1 Pf . Ic \&if Ar condition Pf \e{. Ar request
 .Pp  .Pp
 The scope of a conditional is always parsed, but only executed if the  The scope of a conditional is always parsed, but only executed if the
 conditional evaluates to true.  conditional evaluates to true.
Line 825  will result in
Line 1145  will result in
 being considered an argument of the  being considered an argument of the
 .Sq \&Fl  .Sq \&Fl
 macro.  macro.
 .Ss \&ig  .It Ic \&ig Op Ar endmacro
 Ignore input.  Ignore input.
 Its syntax can be either  Its syntax can be either
 .Bd -literal -offset indent  .Bd -literal -offset indent
Line 836  Its syntax can be either
Line 1156  Its syntax can be either
 .Pp  .Pp
 or  or
 .Bd -literal -offset indent  .Bd -literal -offset indent
 .Pf . Cm \&ig Ar end  .Pf . Cm \&ig Ar endmacro
 .Ar ignored text  .Ar ignored text
 .Pf . Ar end  .Pf . Ar endmacro
 .Ed  .Ed
 .Pp  .Pp
 In the first case, input is ignored until a  In the first case, input is ignored until a
 .Sq \&..  .Sq \&..
 request is encountered on its own line.  request is encountered on its own line.
 In the second case, input is ignored until the specified  In the second case, input is ignored until the specified
 .Sq Pf . Ar end  .Sq Pf . Ar endmacro
 macro is encountered.  is encountered.
 Do not use the escape character  Do not use the escape character
 .Sq \e  .Sq \e
 anywhere in the definition of  anywhere in the definition of
 .Ar end ;  .Ar endmacro ;
 it would cause very strange behaviour.  it would cause very strange behaviour.
 .Pp  .Pp
 When the  When the
 .Ar end  .Ar endmacro
 macro is a roff request or a roff macro, like in  is a roff request or a roff macro, like in
 .Pp  .Pp
 .D1 \&.ig if  .D1 \&.ig if
 .Pp  .Pp
 the subsequent invocation of  the subsequent invocation of
 .Sx \&if  .Ic \&if
 will first terminate the  will first terminate the
 .Ar ignored text ,  .Ar ignored text ,
 then be invoked as usual.  then be invoked as usual.
Line 869  Otherwise, it only terminates the
Line 1189  Otherwise, it only terminates the
 and arguments following it or the  and arguments following it or the
 .Sq \&..  .Sq \&..
 request are discarded.  request are discarded.
 .Ss \&ll  .It Ic \&in Op Oo Cm + Ns | Ns Cm - Oc Ns Ar width
   Change indentation.
   See
   .Xr man 7 .
   Ignored in
   .Xr mdoc 7 .
   .It Ic \&index Ar register stringname substring
   Find a substring in a string.
   This is a Heirloom extension and currently unsupported.
   .It Ic \&it Ar expression macro
   Set an input line trap.
   The named
   .Ar macro
   will be invoked after processing the number of input text lines
   specified by the numerical
   .Ar expression .
   While evaluating the
   .Ar expression ,
   the unit suffixes described below
   .Sx Scaling Widths
   are ignored.
   .It Ic \&it Ar expression macro
   Set an input line trap, not counting lines ending with \ec.
   Currently unsupported.
   .It Ic \&IX Ar class keystring
   To support the generation of a table of contents,
   .Xr pod2man 1
   emits this user-defined macro, usually without defining it.
   To avoid reporting large numbers of spurious errors,
   .Xr mandoc 1
   ignores it.
   .It Ic \&kern Op Cm 1 | 0
   Switch kerning on or off.
   Currently ignored.
   .It Ic \&kernafter Ar font char ... afmunits ...
   Increase kerning after some characters.
   This is a Heirloom extension and currently ignored.
   .It Ic \&kernbefore Ar font char ... afmunits ...
   Increase kerning before some characters.
   This is a Heirloom extension and currently ignored.
   .It Ic \&kernpair Ar font char ... font char ... afmunits
   Add a kerning pair to the kerning table.
   This is a Heirloom extension and currently ignored.
   .It Ic \&lc Op Ar glyph
   Define a leader repetition character.
   Currently unsupported.
   .It Ic \&lc_ctype Ar localename
   Set the
   .Dv LC_CTYPE
   locale.
   This is a Heirloom extension and currently unsupported.
   .It Ic \&lds Ar macroname string
   Define a local string.
   This is a Heirloom extension and currently unsupported.
   .It Ic \&length Ar register string
   Count the number of input characters in a string.
   Currently unsupported.
   .It Ic \&letadj Ar lspmin lshmin letss lspmax lshmax
   Dynamic letter spacing and reshaping.
   This is a Heirloom extension and currently ignored.
   .It Ic \&lf Ar lineno Op Ar filename
   Change the line number for error messages.
   Ignored because insecure.
   .It Ic \&lg Op Cm 1 | 0
   Switch the ligature mechanism on or off.
   Currently ignored.
   .It Ic \&lhang Ar font char ... afmunits
   Hang characters at left margin.
   This is a Heirloom extension and currently ignored.
   .It Ic \&linetabs Op Cm 1 | 0
   Enable or disable line-tabs mode.
   This is a groff extension and currently unsupported.
   .It Ic \&ll Op Oo Cm + Ns | Ns Cm - Oc Ns Ar width
 Change the output line length.  Change the output line length.
 Its syntax is as follows:  
 .Pp  
 .D1 Pf . Cm \&ll Op Oo +|- Oc Ns Ar width  
 .Pp  
 If the  If the
 .Ar width  .Ar width
 argument is omitted, the line length is reset to its previous value.  argument is omitted, the line length is reset to its previous value.
Line 886  among others because it overrides the
Line 1274  among others because it overrides the
 .Xr mandoc 1  .Xr mandoc 1
 .Fl O Cm width  .Fl O Cm width
 command line option.  command line option.
 .Ss \&ne  .It Ic \&lnr Ar register Oo Cm + Ns | Ns Cm - Oc Ns Ar value Op Ar increment
   Set local number register.
   This is a Heirloom extension and currently unsupported.
   .It Ic \&lnrf Ar register Oo Cm + Ns | Ns Cm - Oc Ns Ar value Op Ar increment
   Set local floating-point register.
   This is a Heirloom extension and currently unsupported.
   .It Ic \&lpfx Ar string
   Set a line prefix.
   This is a Heirloom extension and currently unsupported.
   .It Ic \&ls Op Ar factor
   Set line spacing.
   It takes one integer argument specifying the vertical distance of
   subsequent output text lines measured in v units.
   Currently ignored.
   .It Ic \&lsm Ar macroname
   Set a leading spaces trap.
   This is a groff extension and currently unsupported.
   .It Ic \&lt Op Oo Cm + Ns | Ns Cm - Oc Ns Ar width
   Set title line length.
   Currently ignored.
   .It Ic \&mc Ar glyph Op Ar dist
   Print margin character in the right margin.
   The
   .Ar dist
   is currently ignored; instead, 1n is used.
   .It Ic \&mediasize Ar media
   Set the device media size.
   This is a Heirloom extension and currently ignored.
   .It Ic \&minss Ar width
   Set minimum word space.
   This is a Heirloom extension and currently ignored.
   .It Ic \&mk Op Ar register
   Mark vertical position.
   Currently ignored.
   .It Ic \&mso Ar filename
   Load a macro file using the search path.
   Ignored because insecure.
   .It Ic \&na
   Disable adjusting without changing the adjustment mode.
   Currently ignored.
   .It Ic \&ne Op Ar height
 Declare the need for the specified minimum vertical space  Declare the need for the specified minimum vertical space
 before the next trap or the bottom of the page.  before the next trap or the bottom of the page.
 This line-scoped request is currently ignored.  Currently ignored.
 .Ss \&nh  .It Ic \&nf
   Switch to no-fill mode.
   See
   .Xr man 7 .
   Ignored by
   .Xr mdoc 7 .
   .It Ic \&nh
 Turn off automatic hyphenation mode.  Turn off automatic hyphenation mode.
 This line-scoped request is currently ignored.  Currently ignored.
 .Ss \&nr  .It Ic \&nhychar Ar char ...
   Define hyphenation-inhibiting characters.
   This is a Heirloom extension and currently ignored.
   .It Ic \&nm Op Ar start Op Ar inc Op Ar space Op Ar indent
   Print line numbers.
   Currently unsupported.
   .It Ic \&nn Op Ar number
   Temporarily turn off line numbering.
   Currently unsupported.
   .It Ic \&nop Ar body
   Execute the rest of the input line as a request or macro line.
   Currently unsupported.
   .It Ic \&nr Ar register Oo Cm + Ns | Ns Cm - Oc Ns Ar expression
 Define or change a register.  Define or change a register.
 A register is an arbitrary string value that defines some sort of state,  A register is an arbitrary string value that defines some sort of state,
 which influences parsing and/or formatting.  which influences parsing and/or formatting.
 Its syntax is as follows:  
 .Pp  
 .D1 Pf \. Cm \&nr Ar name Oo +|- Oc Ns Ar expression  
 .Pp  
 For the syntax of  For the syntax of
 .Ar expression ,  .Ar expression ,
 see  see
Line 909  below.
Line 1351  below.
 If it is prefixed by a sign, the register will be  If it is prefixed by a sign, the register will be
 incremented or decremented instead of assigned to.  incremented or decremented instead of assigned to.
 .Pp  .Pp
 The following register  The following
 .Ar name  .Ar register
 is handled specially:  is handled specially:
 .Bl -tag -width Ds  .Bl -tag -width Ds
 .It Cm nS  .It Cm nS
Line 927  section itself.
Line 1369  section itself.
 Note that starting a new  Note that starting a new
 .Xr mdoc 7  .Xr mdoc 7
 section with the  section with the
 .Cm \&Sh  .Ic \&Sh
 macro will reset this register.  macro will reset this register.
 .El  .El
 .Ss \&ns  .It Xo
   .Ic \&nrf Ar register Oo Cm + Ns | Ns Cm - Oc Ns Ar expression
   .Op Ar increment
   .Xc
   Define or change a floating-point register.
   This is a Heirloom extension and currently unsupported.
   .It Ic \&nroff
   Force nroff mode.
   This is a groff extension and currently ignored.
   .It Ic \&ns
 Turn on no-space mode.  Turn on no-space mode.
 This line-scoped request is intended to take no arguments.  Currently ignored.
 Currently, it is ignored including its arguments,  .It Ic \&nx Op Ar filename
 and the number of arguments is not checked.  Abort processing of the current input file and process another one.
 .Ss \&ps  Ignored because insecure.
   .It Ic \&open Ar stream file
   Open a file for writing.
   Ignored because insecure.
   .It Ic \&opena Ar stream file
   Open a file for appending.
   Ignored because insecure.
   .It Ic \&os
   Output saved vertical space.
   Currently ignored.
   .It Ic \&output Ar string
   Output directly to intermediate output.
   Not supported.
   .It Ic \&padj Op Cm 1 | 0
   Globally control paragraph-at-once adjustment.
   This is a Heirloom extension and currently ignored.
   .It Ic \&papersize Ar media
   Set the paper size.
   This is a Heirloom extension and currently ignored.
   .It Ic \&pc Op Ar char
   Change the page number character.
   Currently ignored.
   .It Ic \&pev
   Print environments.
   This is a groff extension and currently ignored.
   .It Ic \&pi Ar command
   Pipe output to a shell command.
   Ignored because insecure.
   .It Ic \&PI
   Low-level request used by
   .Ic \&BP .
   This is a Heirloom extension and currently unsupported.
   .It Ic \&pl Op Oo Cm + Ns | Ns Cm - Oc Ns Ar height
   Change page length.
   Currently ignored.
   .It Ic \&pm
   Print names and sizes of macros, strings, and diversions
   to standard error output.
   Currently ignored.
   .It Ic \&pn Oo Cm + Ns | Ns Cm - Oc Ns Ar number
   Change the page number of the next page.
   Currently ignored.
   .It Ic \&pnr
   Print all number registers on standard error output.
   Currently ignored.
   .It Ic \&po Op Oo Cm + Ns | Ns Cm - Oc Ns Ar offset
   Set horizontal page offset.
   Currently ignored.
   .It Ic \&ps Op Oo Cm + Ns | Ns Cm - Oc Ns size
 Change point size.  Change point size.
 This line-scoped request is intended to take one numerical argument.  Currently ignored.
 Currently, it is ignored including its arguments,  .It Ic \&psbb Ar filename
 and the number of arguments is not checked.  Retrieve the bounding box of a PostScript file.
 .Ss \&rm  Currently unsupported.
   .It Ic \&pshape Ar indent length ...
   Set a special shape for the current paragraph.
   This is a Heirloom extension and currently unsupported.
   .It Ic \&pso Ar command
   Include output of a shell command.
   Ignored because insecure.
   .It Ic \&ptr
   Print the names and positions of all traps on standard error output.
   This is a groff extension and currently ignored.
   .It Ic \&pvs Op Oo Cm + Ns | Ns Cm - Oc Ns Ar height
   Change post-vertical spacing.
   This is a groff extension and currently ignored.
   .It Ic \&rchar Ar glyph ...
   Remove glyph definitions.
   Currently unsupported.
   .It Ic \&rd Op Ar prompt Op Ar agument ...
   Read from standard input.
   Currently ignored.
   .It Ic \&recursionlimit Ar maxrec maxtail
   Set the maximum stack depth for recursive macros.
   This is a Heirloom extension and currently ignored.
   .It Ic \&return Op Ar twice
   Exit a macro and return to the caller.
   Currently unsupported.
   .It Ic \&rfschar Ar font glyph ...
   Remove font-specific fallback glyph definitions.
   Currently unsupported.
   .It Ic \&rhang Ar font char ... afmunits
   Hang characters at right margin.
   This is a Heirloom extension and currently ignored.
   .It Ic \&rj Op Ar N
   Justify the next
   .Ar N
   input lines to the right margin without filling.
   Currently ignored.
   .It Ic \&rm Ar macroname
 Remove a request, macro or string.  Remove a request, macro or string.
 Its syntax is as follows:  .It Ic \&rn Ar oldname newname
 .Pp  Rename a request, macro, diversion, or string.
 .D1 Pf \. Cm \&rm Ar name  Currently unsupported.
 .Ss \&rr  .It Ic \&rnn Ar oldname newname
   Rename a number register.
   Currently unsupported.
   .It Ic \&rr Ar register
 Remove a register.  Remove a register.
 Its syntax is as follows:  .It Ic \&rs
 .Pp  End no-space mode.
 .D1 Pf \. Cm \&rr Ar name  Currently ignored.
 .Ss \&so  .It Ic \&rt Op Ar dist
   Return to marked vertical position.
   Currently ignored.
   .It Ic \&schar Ar glyph Op Ar string
   Define global fallback glyph.
   This is a groff extension and currently unsupported.
   .It Ic \&sentchar Ar char ...
   Define sentence-ending characters.
   This is a Heirloom extension and currently ignored.
   .It Ic \&shc Op Ar glyph
   Change the soft hyphen character.
   Currently ignored.
   .It Ic \&shift Op Ar number
   Shift macro arguments.
   Currently unsupported.
   .It Ic \&sizes Ar size ...
   Define permissible point sizes.
   This is a groff extension and currently ignored.
   .It Ic \&so Ar filename
 Include a source file.  Include a source file.
 Its syntax is as follows:  The file is read and its contents processed as input in place of the
 .Pp  .Ic \&so
 .D1 Pf \. Cm \&so Ar file  
 .Pp  
 The  
 .Ar file  
 will be read and its contents processed as input in place of the  
 .Sq \&.so  
 request line.  request line.
 To avoid inadvertent inclusion of unrelated files,  To avoid inadvertent inclusion of unrelated files,
 .Xr mandoc 1  .Xr mandoc 1
Line 978  Typical usage looks like:
Line 1528  Typical usage looks like:
 .Dl \&.so man3/Xcursor.3  .Dl \&.so man3/Xcursor.3
 .Pp  .Pp
 As the whole concept is rather fragile, the use of  As the whole concept is rather fragile, the use of
 .Sx \&so  .Ic \&so
 is discouraged.  is discouraged.
 Use  Use
 .Xr ln 1  .Xr ln 1
 instead.  instead.
 .Ss \&ta  .It Ic \&sp Op Ar height
 Set tab stops.  Break the output line and emit vertical space.
 This line-scoped request can take an arbitrary number of arguments.  The argument follows the syntax of
 Currently, it is ignored including its arguments.  .Sx Scaling Widths
 .Ss \&tr  and defaults to one blank line
 Output character translation.  .Pq Li 1v .
 Its syntax is as follows:  .It Ic \&spacewidth Op Cm 1 | 0
 .Pp  Set the space width from the font metrics file.
 .D1 Pf \. Cm \&tr Ar [ab]+  This is a Heirloom extension and currently ignored.
 .Pp  .It Ic \&special Op Ar font ...
 Pairs of  Define a special font.
 .Ar ab  This is a groff extension and currently ignored.
 characters are replaced  .It Ic \&spreadwarn Op Ar width
 .Ar ( a  Warn about wide spacing between words.
 for  Currently ignored.
 .Ar b ) .  .It Ic \&ss Ar wordspace Op Ar sentencespace
 Replacement (or origin) characters may also be character escapes; thus,  Set space character size.
 .Pp  Currently ignored.
 .Dl tr \e(xx\e(yy  .It Ic \&sty Ar position style
 .Pp  Associate style with a font position.
 replaces all invocations of \e(xx with \e(yy.  This is a groff extension and currently ignored.
 .Ss \&T&  .It Ic \&substring Ar stringname startpos Op Ar endpos
   Replace a user-defined string with a substring.
   Currently unsupported.
   .It Ic \&sv Op Ar height
   Save vertical space.
   Currently ignored.
   .It Ic \&sy Ar command
   Execute shell command.
   Ignored because insecure.
   .It Ic \&T&
 Re-start a table layout, retaining the options of the prior table  Re-start a table layout, retaining the options of the prior table
 invocation.  invocation.
 See  See
 .Sx \&TS .  .Sx \&TS .
 .Ss \&TE  .It Ic \&ta Op Ar width ... Op Cm T Ar width ...
   Set tab stops.
   Each
   .Ar width
   argument follows the syntax of
   .Sx Scaling Widths .
   If prefixed by a plus sign, it is relative to the previous tab stop.
   The arguments after the
   .Cm T
   marker are used repeatedly as often as needed; for each reuse,
   they are taken relative to the last previously established tab stop.
   When
   .Ic \&ta
   is called without arguments, all tab stops are cleared.
   .It Ic \&tc Op Ar glyph
   Change tab repetition character.
   Currently unsupported.
   .It Ic \&TE
 End a table context.  End a table context.
 See  See
 .Sx \&TS .  .Sx \&TS .
 .Ss \&TS  .It Ic \&ti Oo Cm + Ns | Ns Cm - Oc Ns Ar width
   Break the output line and indent the next output line by
   .Ar width .
   If a sign is specified, the temporary indentation is calculated
   relative to the current indentation; otherwise, it is absolute.
   The argument follows the syntax of
   .Sx Scaling Widths
   and the default scaling unit is
   .Cm m .
   .It Ic \&tkf Ar font minps width1 maxps width2
   Enable track kerning for a font.
   Currently ignored.
   .It Ic \&tl No \& Ap Ar left Ap Ar center Ap Ar right Ap
   Print a title line.
   Currently unsupported.
   .It Ic \&tm Ar string
   Print to standard error output.
   Currently ignored.
   .It Ic \&tm1 Ar string
   Print to standard error output, allowing leading blanks.
   This is a groff extension and currently ignored.
   .It Ic \&tmc Ar string
   Print to standard error output without a trailing newline.
   This is a groff extension and currently ignored.
   .It Ic \&tr Ar glyph glyph ...
   Output character translation.
   The first glyph in each pair is replaced by the second one.
   Character escapes can be used; for example,
   .Pp
   .Dl tr \e(xx\e(yy
   .Pp
   replaces all invocations of \e(xx with \e(yy.
   .It Ic \&track Ar font minps width1 maxps width2
   Static letter space tracking.
   This is a Heirloom extension and currently ignored.
   .It Ic \&transchar Ar char ...
   Define transparent characters for sentence-ending.
   This is a Heirloom extension and currently ignored.
   .It Ic \&trf Ar filename
   Output the contents of a file, disallowing invalid characters.
   This is a groff extension and ignored because insecure.
   .It Ic \&trimat Ar left top width height
   Set the TrimBox page parameter for PDF generation.
   This is a Heirloom extension and currently ignored.
   .It Ic \&trin Ar glyph glyph ...
   Output character translation, ignored by
   .Ic \&asciify .
   Currently unsupported.
   .It Ic \&trnt Ar glyph glyph ...
   Output character translation, ignored by \e!.
   Currently unsupported.
   .It Ic \&troff
   Force troff mode.
   This is a groff extension and currently ignored.
   .It Ic \&TS
 Begin a table, which formats input in aligned rows and columns.  Begin a table, which formats input in aligned rows and columns.
 See  See
 .Xr tbl 7  .Xr tbl 7
 for a description of the tbl language.  for a description of the tbl language.
   .It Ic \&uf Ar font
   Globally set the underline font.
   Currently ignored.
   .It Ic \&ul Op Ar N
   Underline next
   .Ar N
   input lines.
   Currently ignored.
   .It Ic \&unformat Ar divname
   Unformat spaces and tabs in a diversion.
   Currently unsupported.
   .It Ic \&unwatch Ar macroname
   Disable notification for string or macro.
   This is a Heirloom extension and currently ignored.
   .It Ic \&unwatchn Ar register
   Disable notification for register.
   This is a Heirloom extension and currently ignored.
   .It Ic \&vpt Op Cm 1 | 0
   Enable or disable vertical position traps.
   This is a groff extension and currently ignored.
   .It Ic \&vs Op Oo Cm + Ns | Ns Cm - Oc Ns Ar height
   Change vertical spacing.
   Currently ignored.
   .It Ic \&warn Ar flags
   Set warning level.
   Currently ignored.
   .It Ic \&warnscale Ar si
   Set the scaling indicator used in warnings.
   This is a groff extension and currently ignored.
   .It Ic \&watch Ar macroname
   Notify on change of string or macro.
   This is a Heirloom extension and currently ignored.
   .It Ic \&watchlength Ar maxlength
   On change, report the contents of macros and strings
   up to the specified length.
   This is a Heirloom extension and currently ignored.
   .It Ic \&watchn Ar register
   Notify on change of register.
   This is a Heirloom extension and currently ignored.
   .It Ic \&wh Ar dist Op Ar macroname
   Set a page location trap.
   Currently unsupported.
   .It Ic \&while Ar condition body
   Repeated execution while a condition is true.
   Currently unsupported.
   .It Ic \&write Oo \(dq Oc Ns Ar string
   Write to an open file.
   Ignored because insecure.
   .It Ic \&writec Oo \(dq Oc Ns Ar string
   Write to an open file without appending a newline.
   Ignored because insecure.
   .It Ic \&writem Ar macroname
   Write macro or string to an open file.
   Ignored because insecure.
   .It Ic \&xflag Ar level
   Set the extension level.
   This is a Heirloom extension and currently ignored.
   .El
 .Ss Numerical expressions  .Ss Numerical expressions
 The  The
 .Sx \&nr ,  .Sx \&nr ,
Line 1036  prefixed by an optional sign
Line 1724  prefixed by an optional sign
 .Sq +  .Sq +
 or  or
 .Sq - .  .Sq - .
   Each number may be followed by one optional scaling unit described below
   .Sx Scaling Widths .
   The following equations hold:
   .Bd -literal -offset indent
   1i = 6v = 6P = 10m = 10n = 72p = 1000M = 240u = 240
   254c = 100i = 24000u = 24000
   1f = 65536u = 65536
   .Ed
 .Pp  .Pp
 The following binary operators are implemented.  The following binary operators are implemented.
 Unless otherwise stated, they behave as in the C language:  Unless otherwise stated, they behave as in the C language:
Line 1082  minimum (not available in C)
Line 1778  minimum (not available in C)
 maximum (not available in C)  maximum (not available in C)
 .El  .El
 .Pp  .Pp
 There is no concept of precendence; evaluation proceeds from left to right,  There is no concept of precedence; evaluation proceeds from left to right,
 except when subexpressions are enclosed in parantheses.  except when subexpressions are enclosed in parentheses.
 Inside parentheses, whitespace is ignored.  Inside parentheses, whitespace is ignored.
 .Sh ESCAPE SEQUENCE REFERENCE  .Sh ESCAPE SEQUENCE REFERENCE
 The  The
Line 1142  For short names, there are variants
Line 1838  For short names, there are variants
 .No \e* Ns Ar c  .No \e* Ns Ar c
 and  and
 .No \e*( Ns Ar cc .  .No \e*( Ns Ar cc .
   .Ss \e,
   Left italic correction (groff extension); ignored by
   .Xr mandoc 1 .
 .Ss \e-  .Ss \e-
 Special character  Special character
 .Dq mathematical minus sign .  .Dq mathematical minus sign .
   .Ss \e/
   Right italic correction (groff extension); ignored by
   .Xr mandoc 1 .
 .Ss \e[ Ns Ar name ]  .Ss \e[ Ns Ar name ]
 .Sx Special Characters  .Sx Special Characters
 with names of arbitrary length, see  with names of arbitrary length, see
Line 1189  Bracket building function; ignored by
Line 1891  Bracket building function; ignored by
 .Sx Special Characters  .Sx Special Characters
 with names of arbitrary length.  with names of arbitrary length.
 .Ss \ec  .Ss \ec
 Interrupt text processing to insert requests or macros; ignored by  When encountered at the end of an input text line,
 .Xr mandoc 1 .  the next input text line is considered to continue that line,
   even if there are request or macro lines in between.
   No whitespace is inserted.
 .Ss \eD\(aq Ns Ar string Ns \(aq  .Ss \eD\(aq Ns Ar string Ns \(aq
 Draw graphics function; ignored by  Draw graphics function; ignored by
 .Xr mandoc 1 .  .Xr mandoc 1 .
Line 1225  and
Line 1929  and
 .Ss \eH\(aq Ns Oo +|- Oc Ns Ar number Ns \(aq  .Ss \eH\(aq Ns Oo +|- Oc Ns Ar number Ns \(aq
 Set the height of the current font; ignored by  Set the height of the current font; ignored by
 .Xr mandoc 1 .  .Xr mandoc 1 .
 .Ss \eh\(aq Ns Ar number Ns \(aq  .Ss \eh\(aq Ns Ar width Ns \(aq
 Horizontal motion; ignored by  Horizontal motion relative to the current position.
 .Xr mandoc 1 .  The default scaling unit is
   .Cm m .
 .Ss \ek[ Ns Ar name ]  .Ss \ek[ Ns Ar name ]
 Mark horizontal input place in register; ignored by  Mark horizontal input place in register; ignored by
 .Xr mandoc 1 .  .Xr mandoc 1 .
Line 1238  and
Line 1943  and
 .Ss \eL\(aq Ns Ar number Ns Oo Ar c Oc Ns \(aq  .Ss \eL\(aq Ns Ar number Ns Oo Ar c Oc Ns \(aq
 Vertical line drawing function; ignored by  Vertical line drawing function; ignored by
 .Xr mandoc 1 .  .Xr mandoc 1 .
 .Ss \el\(aq Ns Ar number Ns Oo Ar c Oc Ns \(aq  .Ss \el\(aq Ns Ar width Ns Oo Ar c Oc Ns \(aq
 Horizontal line drawing function; ignored by  Draw a horizontal line of
 .Xr mandoc 1 .  .Ar width
   using the glyph
   .Ar c .
 .Ss \eM[ Ns Ar name ]  .Ss \eM[ Ns Ar name ]
 Set fill (background) color (groff extension); ignored by  Set fill (background) color (groff extension); ignored by
 .Xr mandoc 1 .  .Xr mandoc 1 .
Line 1267  For short names, there are variants
Line 1974  For short names, there are variants
 and  and
 .No \en( Ns Ar cc .  .No \en( Ns Ar cc .
 .Ss \eo\(aq Ns Ar string Ns \(aq  .Ss \eo\(aq Ns Ar string Ns \(aq
 Overstrike  Overstrike, writing all the characters contained in the
 .Ar string ;  .Ar string
 ignored by  to the same output position.
 .Xr mandoc 1 .  In terminal and HTML output modes,
   only the last one of the characters is visible.
 .Ss \eR\(aq Ns Ar name Oo +|- Oc Ns Ar number Ns \(aq  .Ss \eR\(aq Ns Ar name Oo +|- Oc Ns Ar number Ns \(aq
 Set number register; ignored by  Set number register; ignored by
 .Xr mandoc 1 .  .Xr mandoc 1 .
Line 1333  Print
Line 2041  Print
 with zero width and height; ignored by  with zero width and height; ignored by
 .Xr mandoc 1 .  .Xr mandoc 1 .
 .Ss \ez  .Ss \ez
 Output the next character without advancing the cursor position;  Output the next character without advancing the cursor position.
 approximated in  
 .Xr mandoc 1  
 by simply skipping the next character.  
 .Sh COMPATIBILITY  .Sh COMPATIBILITY
 This section documents compatibility between mandoc and other  The
   .Xr mandoc 1
   implementation of the
 .Nm  .Nm
 implementations, at this time limited to GNU troff  language is intentionally incomplete.
 .Pq Qq groff .  Unimplemented features include:
 The term  
 .Qq historic groff  
 refers to groff version 1.15.  
 .Pp  .Pp
 .Bl -dash -compact  .Bl -dash -compact
 .It  .It
   For security reasons,
   .Xr mandoc 1
   never reads or writes external files except via
   .Sx \&so
   requests with safe relative paths.
   .It
   There is no automatic hyphenation, no adjustment to the right margin,
   and no centering; the output is always set flush-left.
   .It
   Support for setting tabulator positions
   and tabulator and leader characters is missing,
   and support for manually changing indentation is limited.
   .It
 The  The
 .Sq u  .Sq u
 scaling unit is the default terminal unit.  scaling unit is the default terminal unit.
 In traditional troff systems, this unit would change depending on the  In traditional troff systems, this unit changes depending on the
 output media.  output media.
 .It  .It
 In mandoc, the  Width measurements are implemented in a crude way
 .Sx \&EQ ,  and often yield wrong results.
 .Sx \&TE ,  Explicit movement requests and escapes are ignored.
 .Sx \&TS ,  
 and  
 .Sx \&T& ,  
 macros are considered regular macros.  
 In all other  
 .Nm  
 implementations, these are special macros that must be specified without  
 spacing between the control character (which must be a period) and the  
 macro name.  
 .It  .It
 The  There is no concept of output pages, no support for floats,
 .Cm nS  graphics drawing, and picture inclusion;
 register is only compatible with OpenBSD's groff-1.15.  terminal output is always continuous.
 .It  .It
 Historic groff did not accept white-space before a custom  Requests regarding color, font families, and glyph manipulation
 .Ar end  are ignored.
 macro for the  Font support is very limited.
 .Sx \&ig  Kerning is not implemented, and no ligatures are produced.
 request.  
 .It  .It
 The  The
 .Sx \&if  .Qq \(aq
 and family would print funny white-spaces with historic groff when  macro control character does not suppress output line breaks.
 using the next-line syntax.  .It
   Diversions are not implemented,
   and support for traps is very incomplete.
   .It
   While recursion is supported,
   .Sx \&while
   loops are not.
 .El  .El
   .Pp
   The special semantics of the
   .Cm nS
   number register is an idiosyncracy of
   .Ox
   manuals and not supported by other
   .Xr mdoc 7
   implementations.
 .Sh SEE ALSO  .Sh SEE ALSO
 .Xr mandoc 1 ,  .Xr mandoc 1 ,
 .Xr eqn 7 ,  .Xr eqn 7 ,
Legend:
Removed from v.1.56  
changed lines
  Added in v.1.84
CVSweb