Annotation of mandoc/roff.7, Revision 1.83
1.83 ! schwarze 1: .\" $Id: roff.7,v 1.82 2017/06/02 19:21:23 schwarze Exp $
1.1 kristaps 2: .\"
1.46 schwarze 3: .\" Copyright (c) 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
1.80 schwarze 4: .\" Copyright (c) 2010,2011,2013-2015,2017 Ingo Schwarze <schwarze@openbsd.org>
1.1 kristaps 5: .\"
6: .\" Permission to use, copy, modify, and distribute this software for any
7: .\" purpose with or without fee is hereby granted, provided that the above
8: .\" copyright notice and this permission notice appear in all copies.
9: .\"
10: .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11: .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12: .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13: .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14: .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15: .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16: .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17: .\"
1.83 ! schwarze 18: .Dd $Mdocdate: June 2 2017 $
1.1 kristaps 19: .Dt ROFF 7
20: .Os
21: .Sh NAME
22: .Nm roff
1.17 schwarze 23: .Nd roff language reference for mandoc
1.1 kristaps 24: .Sh DESCRIPTION
25: The
26: .Nm roff
1.17 schwarze 27: language is a general purpose text formatting language.
1.33 schwarze 28: Since traditional implementations of the
1.17 schwarze 29: .Xr mdoc 7
30: and
31: .Xr man 7
1.33 schwarze 32: manual formatting languages are based on it,
33: many real-world manuals use small numbers of
1.17 schwarze 34: .Nm
1.46 schwarze 35: requests and escape sequences intermixed with their
1.33 schwarze 36: .Xr mdoc 7
37: or
38: .Xr man 7
39: code.
40: To properly format such manuals, the
1.1 kristaps 41: .Xr mandoc 1
1.33 schwarze 42: utility supports a tiny subset of
43: .Nm
1.46 schwarze 44: requests and escapes.
45: Only these requests and escapes supported by
1.33 schwarze 46: .Xr mandoc 1
47: are documented in the present manual,
48: together with the basic language syntax shared by
49: .Nm ,
50: .Xr mdoc 7 ,
51: and
52: .Xr man 7 .
53: For complete
54: .Nm
55: manuals, consult the
56: .Sx SEE ALSO
57: section.
1.1 kristaps 58: .Pp
1.33 schwarze 59: Input lines beginning with the control character
1.17 schwarze 60: .Sq \&.
1.33 schwarze 61: are parsed for requests and macros.
62: Such lines are called
63: .Dq request lines
1.1 kristaps 64: or
1.33 schwarze 65: .Dq macro lines ,
66: respectively.
67: Requests change the processing state and manipulate the formatting;
68: some macros also define the document structure and produce formatted
69: output.
70: The single quote
71: .Pq Qq \(aq
72: is accepted as an alternative control character,
73: treated by
74: .Xr mandoc 1
75: just like
76: .Ql \&.
77: .Pp
78: Lines not beginning with control characters are called
79: .Dq text lines .
80: They provide free-form text to be printed; the formatting of the text
81: depends on the respective processing context.
1.1 kristaps 82: .Sh LANGUAGE SYNTAX
83: .Nm
84: documents may contain only graphable 7-bit ASCII characters, the space
1.17 schwarze 85: character, and, in certain circumstances, the tab character.
1.38 kristaps 86: The backslash character
1.33 schwarze 87: .Sq \e
1.46 schwarze 88: indicates the start of an escape sequence, used for example for
1.33 schwarze 89: .Sx Comments ,
90: .Sx Special Characters ,
91: .Sx Predefined Strings ,
92: and
93: user-defined strings defined using the
94: .Sx ds
95: request.
1.46 schwarze 96: For a listing of escape sequences, consult the
97: .Sx ESCAPE SEQUENCE REFERENCE
98: below.
1.33 schwarze 99: .Ss Comments
100: Text following an escaped double-quote
101: .Sq \e\(dq ,
102: whether in a request, macro, or text line, is ignored to the end of the line.
103: A request line beginning with a control character and comment escape
104: .Sq \&.\e\(dq
105: is also ignored.
106: Furthermore, request lines with only a control character and optional
107: trailing whitespace are stripped from input.
108: .Pp
109: Examples:
110: .Bd -literal -offset indent -compact
111: \&.\e\(dq This is a comment line.
112: \&.\e\(dq The next line is ignored:
113: \&.
114: \&.Sh EXAMPLES \e\(dq This is a comment, too.
115: \&example text \e\(dq And so is this.
116: .Ed
117: .Ss Special Characters
118: Special characters are used to encode special glyphs and are rendered
119: differently across output media.
120: They may occur in request, macro, and text lines.
121: Sequences begin with the escape character
122: .Sq \e
123: followed by either an open-parenthesis
124: .Sq \&(
125: for two-character sequences; an open-bracket
126: .Sq \&[
127: for n-character sequences (terminated at a close-bracket
128: .Sq \&] ) ;
129: or a single one character sequence.
130: .Pp
131: Examples:
132: .Bl -tag -width Ds -offset indent -compact
133: .It Li \e(em
134: Two-letter em dash escape.
135: .It Li \ee
136: One-letter backslash escape.
137: .El
138: .Pp
139: See
1.17 schwarze 140: .Xr mandoc_char 7
1.33 schwarze 141: for a complete list.
142: .Ss Text Decoration
143: Terms may be text-decorated using the
144: .Sq \ef
145: escape followed by an indicator: B (bold), I (italic), R (regular), or P
146: (revert to previous mode).
147: A numerical representation 3, 2, or 1 (bold, italic, and regular,
148: respectively) may be used instead.
1.34 kristaps 149: The indicator or numerical representative may be preceded by C
150: (constant-width), which is ignored.
1.33 schwarze 151: .Pp
1.42 schwarze 152: The two-character indicator
153: .Sq BI
154: requests a font that is both bold and italic.
155: It may not be portable to old roff implementations.
156: .Pp
1.33 schwarze 157: Examples:
158: .Bl -tag -width Ds -offset indent -compact
159: .It Li \efBbold\efR
1.42 schwarze 160: Write in \fBbold\fP, then switch to regular font mode.
1.33 schwarze 161: .It Li \efIitalic\efP
1.42 schwarze 162: Write in \fIitalic\fP, then return to previous font mode.
163: .It Li \ef(BIbold italic\efP
164: Write in \f(BIbold italic\fP, then return to previous font mode.
1.33 schwarze 165: .El
166: .Pp
167: Text decoration is
168: .Em not
169: recommended for
170: .Xr mdoc 7 ,
171: which encourages semantic annotation.
172: .Ss Predefined Strings
173: Predefined strings, like
174: .Sx Special Characters ,
175: mark special output glyphs.
176: Predefined strings are escaped with the slash-asterisk,
177: .Sq \e* :
178: single-character
179: .Sq \e*X ,
180: two-character
181: .Sq \e*(XX ,
182: and N-character
183: .Sq \e*[N] .
184: .Pp
185: Examples:
186: .Bl -tag -width Ds -offset indent -compact
187: .It Li \e*(Am
188: Two-letter ampersand predefined string.
189: .It Li \e*q
190: One-letter double-quote predefined string.
191: .El
192: .Pp
193: Predefined strings are not recommended for use,
194: as they differ across implementations.
195: Those supported by
196: .Xr mandoc 1
197: are listed in
198: .Xr mandoc_char 7 .
199: Manuals using these predefined strings are almost certainly not portable.
200: .Ss Whitespace
201: Whitespace consists of the space character.
202: In text lines, whitespace is preserved within a line.
203: In request and macro lines, whitespace delimits arguments and is discarded.
204: .Pp
205: Unescaped trailing spaces are stripped from text line input unless in a
206: literal context.
207: In general, trailing whitespace on any input line is discouraged for
208: reasons of portability.
209: In the rare case that a blank character is needed at the end of an
210: input line, it may be forced by
211: .Sq \e\ \e& .
212: .Pp
213: Literal space characters can be produced in the output
214: using escape sequences.
215: In macro lines, they can also be included in arguments using quotation; see
216: .Sx MACRO SYNTAX
217: for details.
218: .Pp
219: Blank text lines, which may include whitespace, are only permitted
220: within literal contexts.
221: If the first character of a text line is a space, that line is printed
222: with a leading newline.
223: .Ss Scaling Widths
224: Many requests and macros support scaled widths for their arguments.
225: The syntax for a scaled width is
226: .Sq Li [+-]?[0-9]*.[0-9]*[:unit:] ,
227: where a decimal must be preceded or followed by at least one digit.
228: Negative numbers, while accepted, are truncated to zero.
229: .Pp
230: The following scaling units are accepted:
231: .Pp
232: .Bl -tag -width Ds -offset indent -compact
233: .It c
234: centimetre
235: .It i
236: inch
237: .It P
238: pica (~1/6 inch)
239: .It p
240: point (~1/72 inch)
241: .It f
1.56 kristaps 242: scale
1.33 schwarze 243: .Sq u
1.56 kristaps 244: by 65536
1.33 schwarze 245: .It v
246: default vertical span
247: .It m
248: width of rendered
249: .Sq m
250: .Pq em
251: character
252: .It n
253: width of rendered
254: .Sq n
255: .Pq en
256: character
257: .It u
1.56 kristaps 258: default horizontal span for the terminal
1.33 schwarze 259: .It M
260: mini-em (~1/100 em)
261: .El
262: .Pp
263: Using anything other than
264: .Sq m ,
265: .Sq n ,
266: or
267: .Sq v
268: is necessarily non-portable across output media.
269: See
270: .Sx COMPATIBILITY .
271: .Pp
272: If a scaling unit is not provided, the numerical value is interpreted
273: under the default rules of
274: .Sq v
275: for vertical spaces and
276: .Sq u
277: for horizontal ones.
278: .Pp
279: Examples:
280: .Bl -tag -width ".Bl -tag -width 2i" -offset indent -compact
281: .It Li \&.Bl -tag -width 2i
282: two-inch tagged list indentation in
283: .Xr mdoc 7
284: .It Li \&.HP 2i
285: two-inch tagged list indentation in
286: .Xr man 7
287: .It Li \&.sp 2v
288: two vertical spaces
289: .El
290: .Ss Sentence Spacing
291: Each sentence should terminate at the end of an input line.
292: By doing this, a formatter will be able to apply the proper amount of
293: spacing after the end of sentence (unescaped) period, exclamation mark,
294: or question mark followed by zero or more non-sentence closing
295: delimiters
296: .Po
297: .Sq \&) ,
298: .Sq \&] ,
299: .Sq \&' ,
300: .Sq \&"
301: .Pc .
302: .Pp
303: The proper spacing is also intelligently preserved if a sentence ends at
304: the boundary of a macro line.
305: .Pp
306: Examples:
307: .Bd -literal -offset indent -compact
308: Do not end sentences mid-line like this. Instead,
309: end a sentence like this.
310: A macro would end like this:
311: \&.Xr mandoc 1 \&.
312: .Ed
1.17 schwarze 313: .Sh REQUEST SYNTAX
314: A request or macro line consists of:
315: .Pp
316: .Bl -enum -compact
317: .It
318: the control character
319: .Sq \&.
1.1 kristaps 320: or
1.17 schwarze 321: .Sq \(aq
322: at the beginning of the line,
323: .It
324: optionally an arbitrary amount of whitespace,
325: .It
326: the name of the request or the macro, which is one word of arbitrary
327: length, terminated by whitespace,
328: .It
329: and zero or more arguments delimited by whitespace.
330: .El
331: .Pp
332: Thus, the following request lines are all equivalent:
1.1 kristaps 333: .Bd -literal -offset indent
1.17 schwarze 334: \&.ig end
335: \&.ig end
336: \&. ig end
1.1 kristaps 337: .Ed
1.24 schwarze 338: .Sh MACRO SYNTAX
1.33 schwarze 339: Macros are provided by the
340: .Xr mdoc 7
341: and
342: .Xr man 7
343: languages and can be defined by the
1.24 schwarze 344: .Sx \&de
345: request.
346: When called, they follow the same syntax as requests, except that
347: macro arguments may optionally be quoted by enclosing them
348: in double quote characters
349: .Pq Sq \(dq .
1.33 schwarze 350: Quoted text, even if it contains whitespace or would cause
351: a macro invocation when unquoted, is always considered literal text.
352: Inside quoted text, pairs of double quote characters
353: .Pq Sq Qq
354: resolve to single double quote characters.
355: .Pp
1.32 kristaps 356: To be recognised as the beginning of a quoted argument, the opening
1.24 schwarze 357: quote character must be preceded by a space character.
358: A quoted argument extends to the next double quote character that is not
359: part of a pair, or to the end of the input line, whichever comes earlier.
360: Leaving out the terminating double quote character at the end of the line
361: is discouraged.
362: For clarity, if more arguments follow on the same input line,
363: it is recommended to follow the terminating double quote character
364: by a space character; in case the next character after the terminating
365: double quote character is anything else, it is regarded as the beginning
366: of the next, unquoted argument.
367: .Pp
368: Both in quoted and unquoted arguments, pairs of backslashes
369: .Pq Sq \e\e
370: resolve to single backslashes.
371: In unquoted arguments, space characters can alternatively be included
372: by preceding them with a backslash
373: .Pq Sq \e\~ ,
374: but quoting is usually better for clarity.
1.33 schwarze 375: .Pp
376: Examples:
377: .Bl -tag -width Ds -offset indent -compact
378: .It Li .Fn strlen \(dqconst char *s\(dq
379: Group arguments
380: .Qq const char *s
381: into one function argument.
382: If unspecified,
383: .Qq const ,
384: .Qq char ,
385: and
386: .Qq *s
387: would be considered separate arguments.
388: .It Li .Op \(dqFl a\(dq
389: Consider
390: .Qq \&Fl a
391: as literal text instead of a flag macro.
392: .El
1.15 kristaps 393: .Sh REQUEST REFERENCE
1.17 schwarze 394: The
1.15 kristaps 395: .Xr mandoc 1
396: .Nm
1.32 kristaps 397: parser recognises the following requests.
1.63 schwarze 398: For requests marked as "ignored" or "unsupported", any arguments are
399: ignored, and the number of arguments is not checked.
1.79 schwarze 400: .Bl -tag -width Ds
401: .It Ic \&ab Op Ar message
1.63 schwarze 402: Abort processing.
403: Currently unsupported.
1.79 schwarze 404: .It Ic \&ad Op Cm b | c | l | n | r
405: Set line adjustment mode for subsequent text.
1.63 schwarze 406: Currently ignored.
1.79 schwarze 407: .It Ic \&af Ar registername format
1.63 schwarze 408: Assign an output format to a number register.
409: Currently ignored.
1.79 schwarze 410: .It Ic \&aln Ar newname oldname
1.63 schwarze 411: Create an alias for a number register.
412: Currently unsupported.
1.79 schwarze 413: .It Ic \&als Ar newname oldname
1.63 schwarze 414: Create an alias for a request, string, macro, or diversion.
415: Currently unsupported.
1.79 schwarze 416: .It Ic \&am Ar macroname Op Ar endmacro
1.15 kristaps 417: Append to a macro definition.
418: The syntax of this request is the same as that of
1.79 schwarze 419: .Ic \&de .
420: .It Ic \&am1 Ar macroname Op Ar endmacro
1.15 kristaps 421: Append to a macro definition, switching roff compatibility mode off
1.63 schwarze 422: during macro execution (groff extension).
1.15 kristaps 423: The syntax of this request is the same as that of
1.79 schwarze 424: .Ic \&de1 .
1.55 schwarze 425: Since
426: .Xr mandoc 1
427: does not implement
428: .Nm
429: compatibility mode at all, it handles this request as an alias for
1.79 schwarze 430: .Ic \&am .
431: .It Ic \&ami Ar macrostring Op Ar endstring
1.63 schwarze 432: Append to a macro definition, specifying the macro name indirectly
433: (groff extension).
434: The syntax of this request is the same as that of
1.79 schwarze 435: .Ic \&dei .
436: .It Ic \&ami1 Ar macrostring Op Ar endstring
1.63 schwarze 437: Append to a macro definition, specifying the macro name indirectly
438: and switching roff compatibility mode off during macro execution
439: (groff extension).
440: The syntax of this request is the same as that of
1.79 schwarze 441: .Ic \&dei1 .
1.63 schwarze 442: Since
443: .Xr mandoc 1
444: does not implement
445: .Nm
446: compatibility mode at all, it handles this request as an alias for
1.79 schwarze 447: .Ic \&ami .
448: .It Ic \&as Ar stringname Op Ar string
1.47 schwarze 449: Append to a user-defined string.
450: The syntax of this request is the same as that of
451: .Sx \&ds .
452: If a user-defined string with the specified name does not yet exist,
453: it is set to the empty string before appending.
1.79 schwarze 454: .It Ic \&as1 Ar stringname Op Ar string
1.63 schwarze 455: Append to a user-defined string, switching roff compatibility mode off
456: during macro execution (groff extension).
457: The syntax of this request is the same as that of
1.79 schwarze 458: .Ic \&ds1 .
1.63 schwarze 459: Since
460: .Xr mandoc 1
461: does not implement
462: .Nm
463: compatibility mode at all, it handles this request as an alias for
1.79 schwarze 464: .Ic \&as .
465: .It Ic \&asciify Ar divname
1.63 schwarze 466: Fully unformat a diversion.
467: Currently unsupported.
1.79 schwarze 468: .It Ic \&backtrace
1.63 schwarze 469: Print a backtrace of the input stack.
470: This is a groff extension and currently ignored.
1.79 schwarze 471: .It Ic \&bd Ar font Oo Ar curfont Oc Op Ar offset
1.63 schwarze 472: Artificially embolden by repeated printing with small shifts.
473: Currently ignored.
1.79 schwarze 474: .It Ic \&bleedat Ar left top width height
1.63 schwarze 475: Set the BleedBox page parameter for PDF generation.
476: This is a Heirloom extension and currently ignored.
1.79 schwarze 477: .It Ic \&blm Ar macroname
1.63 schwarze 478: Set a blank line trap.
479: Currently unsupported.
1.79 schwarze 480: .It Ic \&box Ar divname
1.63 schwarze 481: Begin a diversion without including a partially filled line.
482: Currently unsupported.
1.79 schwarze 483: .It Ic \&boxa Ar divname
1.63 schwarze 484: Add to a diversion without including a partially filled line.
485: Currently unsupported.
1.79 schwarze 486: .It Ic \&bp Oo Cm + Ns | Ns Cm - Oc Ns Ar pagenumber
487: Begin a new page.
1.63 schwarze 488: Currently ignored.
1.79 schwarze 489: .It Ic \&BP Ar source height width position offset flags label
1.63 schwarze 490: Define a frame and place a picture in it.
491: This is a Heirloom extension and currently unsupported.
1.79 schwarze 492: .It Ic \&br
1.63 schwarze 493: Break the output line.
1.79 schwarze 494: .It Ic \&break
1.63 schwarze 495: Break out of a
1.79 schwarze 496: .Ic \&while
1.63 schwarze 497: loop.
498: Currently unsupported.
1.79 schwarze 499: .It Ic \&breakchar Ar char ...
1.63 schwarze 500: Optional line break characters.
501: This is a Heirloom extension and currently ignored.
1.79 schwarze 502: .It Ic \&brnl Ar N
503: Break output line after the next
504: .Ar N
505: input lines.
1.63 schwarze 506: This is a Heirloom extension and currently ignored.
1.79 schwarze 507: .It Ic \&brp
1.63 schwarze 508: Break and spread output line.
509: Currently, this is implemented as an alias for
1.79 schwarze 510: .Ic \&br .
511: .It Ic \&brpnl Ar N
512: Break and spread output line after the next
513: .Ar N
514: input lines.
1.63 schwarze 515: This is a Heirloom extension and currently ignored.
1.79 schwarze 516: .It Ic \&c2 Op Ar char
1.63 schwarze 517: Change the no-break control character.
518: Currently unsupported.
1.79 schwarze 519: .It Ic \&cc Op Ar char
1.63 schwarze 520: Change the control character.
1.39 kristaps 521: If
1.79 schwarze 522: .Ar char
1.39 kristaps 523: is not specified, the control character is reset to
524: .Sq \&. .
525: Trailing characters are ignored.
1.79 schwarze 526: .It Ic \&ce Op Ar N
527: Center the next
528: .Ar N
529: input lines without filling.
1.63 schwarze 530: Currently ignored.
1.79 schwarze 531: .It Ic \&cf Ar filename
1.63 schwarze 532: Output the contents of a file.
533: Ignored because insecure.
1.79 schwarze 534: .It Ic \&cflags Ar flags char ...
1.63 schwarze 535: Set character flags.
536: This is a groff extension and currently ignored.
1.79 schwarze 537: .It Ic \&ch Ar macroname Op Ar dist
1.63 schwarze 538: Change a trap location.
539: Currently ignored.
1.79 schwarze 540: .It Ic \&char Ar glyphname Op Ar string
1.63 schwarze 541: Define a new glyph.
542: Currently unsupported.
1.79 schwarze 543: .It Ic \&chop Ar stringname
1.63 schwarze 544: Remove the last character from a macro, string, or diversion.
545: Currently unsupported.
1.79 schwarze 546: .It Ic \&class Ar classname char ...
1.63 schwarze 547: Define a character class.
548: This is a groff extension and currently ignored.
1.79 schwarze 549: .It Ic \&close Ar streamname
1.63 schwarze 550: Close an open file.
551: Ignored because insecure.
1.79 schwarze 552: .It Ic \&CL Ar color text
1.63 schwarze 553: Print text in color.
554: This is a Heirloom extension and currently unsupported.
1.79 schwarze 555: .It Ic \&color Op Cm 1 | 0
1.63 schwarze 556: Activate or deactivate colors.
557: This is a groff extension and currently ignored.
1.79 schwarze 558: .It Ic \&composite Ar from to
1.63 schwarze 559: Define a name component for composite glyph names.
560: This is a groff extension and currently unsupported.
1.79 schwarze 561: .It Ic \&continue
1.63 schwarze 562: Immediately start the next iteration of a
1.79 schwarze 563: .Ic \&while
1.63 schwarze 564: loop.
565: Currently unsupported.
1.79 schwarze 566: .It Ic \&cp Op Cm 1 | 0
1.63 schwarze 567: Switch
568: .Nm
569: compatibility mode on or off.
570: Currently ignored.
1.79 schwarze 571: .It Ic \&cropat Ar left top width height
1.63 schwarze 572: Set the CropBox page parameter for PDF generation.
573: This is a Heirloom extension and currently ignored.
1.79 schwarze 574: .It Ic \&cs Ar font Op Ar width Op Ar emsize
1.63 schwarze 575: Constant character spacing mode.
576: Currently ignored.
1.79 schwarze 577: .It Ic \&cu Op Ar N
578: Underline next
579: .Ar N
580: input lines including whitespace.
1.63 schwarze 581: Currently ignored.
1.79 schwarze 582: .It Ic \&da Ar divname
1.63 schwarze 583: Append to a diversion.
584: Currently unsupported.
1.79 schwarze 585: .It Ic \&dch Ar macroname Op Ar dist
1.63 schwarze 586: Change a trap location in the current diversion.
587: This is a Heirloom extension and currently unsupported.
1.79 schwarze 588: .It Ic \&de Ar macroname Op Ar endmacro
1.17 schwarze 589: Define a
1.15 kristaps 590: .Nm
591: macro.
592: Its syntax can be either
593: .Bd -literal -offset indent
1.79 schwarze 594: .Pf . Ic \&de Ar macroname
595: .Ar definition
1.15 kristaps 596: \&..
597: .Ed
598: .Pp
599: or
600: .Bd -literal -offset indent
1.79 schwarze 601: .Pf . Ic \&de Ar macroname Ar endmacro
602: .Ar definition
603: .Pf . Ar endmacro
1.15 kristaps 604: .Ed
605: .Pp
606: Both forms define or redefine the macro
1.79 schwarze 607: .Ar macroname
1.15 kristaps 608: to represent the
1.79 schwarze 609: .Ar definition ,
1.15 kristaps 610: which may consist of one or more input lines, including the newline
611: characters terminating each line, optionally containing calls to
612: .Nm
613: requests,
614: .Nm
615: macros or high-level macros like
616: .Xr man 7
617: or
618: .Xr mdoc 7
619: macros, whichever applies to the document in question.
620: .Pp
621: Specifying a custom
1.79 schwarze 622: .Ar endmacro
1.15 kristaps 623: macro works in the same way as for
1.79 schwarze 624: .Ic \&ig ;
1.15 kristaps 625: namely, the call to
1.79 schwarze 626: .Sq Pf . Ar endmacro
1.15 kristaps 627: first ends the
1.79 schwarze 628: .Ar definition ,
1.15 kristaps 629: and after that, it is also evaluated as a
630: .Nm
631: request or
632: .Nm
633: macro, but not as a high-level macro.
634: .Pp
1.17 schwarze 635: The macro can be invoked later using the syntax
1.15 kristaps 636: .Pp
1.79 schwarze 637: .D1 Pf . Ar macroname Op Ar argument Op Ar argument ...
1.15 kristaps 638: .Pp
1.24 schwarze 639: Regarding argument parsing, see
640: .Sx MACRO SYNTAX
641: above.
1.15 kristaps 642: .Pp
1.17 schwarze 643: The line invoking the macro will be replaced
1.15 kristaps 644: in the input stream by the
1.79 schwarze 645: .Ar definition ,
1.15 kristaps 646: replacing all occurrences of
647: .No \e\e$ Ns Ar N ,
1.17 schwarze 648: where
1.15 kristaps 649: .Ar N
650: is a digit, by the
651: .Ar N Ns th Ar argument .
652: For example,
653: .Bd -literal -offset indent
654: \&.de ZN
655: \efI\e^\e\e$1\e^\efP\e\e$2
656: \&..
657: \&.ZN XtFree .
658: .Ed
659: .Pp
660: produces
661: .Pp
662: .D1 \efI\e^XtFree\e^\efP.
663: .Pp
664: in the input stream, and thus in the output: \fI\^XtFree\^\fP.
1.73 schwarze 665: Each occurrence of \e\e$* is replaced with all the arguments,
666: joined together with single blank characters.
1.15 kristaps 667: .Pp
1.17 schwarze 668: Since macros and user-defined strings share a common string table,
1.15 kristaps 669: defining a macro
1.79 schwarze 670: .Ar macroname
1.15 kristaps 671: clobbers the user-defined string
1.79 schwarze 672: .Ar macroname ,
1.15 kristaps 673: and the
1.79 schwarze 674: .Ar definition
1.15 kristaps 675: can also be printed using the
676: .Sq \e*
677: string interpolation syntax described below
1.79 schwarze 678: .Ic ds ,
1.15 kristaps 679: but this is rarely useful because every macro definition contains at least
680: one explicit newline character.
1.16 schwarze 681: .Pp
682: In order to prevent endless recursion, both groff and
683: .Xr mandoc 1
684: limit the stack depth for expanding macros and strings
1.61 schwarze 685: to a large, but finite number, and
686: .Xr mandoc 1
687: also limits the length of the expanded input line.
688: Do not rely on the exact values of these limits.
1.79 schwarze 689: .It Ic \&de1 Ar macroname Op Ar endmacro
1.63 schwarze 690: Define a
691: .Nm
692: macro that will be executed with
693: .Nm
694: compatibility mode switched off during macro execution.
695: This is a groff extension.
696: Since
697: .Xr mandoc 1
698: does not implement
699: .Nm
700: compatibility mode at all, it handles this request as an alias for
1.79 schwarze 701: .Ic \&de .
702: .It Ic \&defcolor Ar newname scheme component ...
1.63 schwarze 703: Define a color name.
704: This is a groff extension and currently ignored.
1.79 schwarze 705: .It Ic \&dei Ar macrostring Op Ar endstring
1.17 schwarze 706: Define a
1.15 kristaps 707: .Nm
1.63 schwarze 708: macro, specifying the macro name indirectly (groff extension).
1.17 schwarze 709: The syntax of this request is the same as that of
1.79 schwarze 710: .Ic \&de .
711: The effect is the same as:
1.55 schwarze 712: .Pp
1.79 schwarze 713: .D1 Pf . Cm \&de No \e* Ns Bo Ar macrostring Bc Op \e* Ns Bq Ar endstring
714: .It Ic \&dei1 Ar macrostring Op Ar endstring
1.17 schwarze 715: Define a
1.15 kristaps 716: .Nm
717: macro that will be executed with
718: .Nm
1.63 schwarze 719: compatibility mode switched off during macro execution,
720: specifying the macro name indirectly (groff extension).
1.15 kristaps 721: Since
722: .Xr mandoc 1
723: does not implement
724: .Nm
1.17 schwarze 725: compatibility mode at all, it handles this request as an alias for
1.79 schwarze 726: .Ic \&dei .
727: .It Ic \&device Ar string ...
728: .It Ic \&devicem Ar stringname
729: These two requests only make sense with the groff-specific intermediate
730: output format and are unsupported.
731: .It Ic \&di Ar divname
1.63 schwarze 732: Begin a diversion.
733: Currently unsupported.
1.79 schwarze 734: .It Ic \&do Ar command Op Ar argument ...
1.63 schwarze 735: Execute
736: .Nm
737: request or macro line with compatibility mode disabled.
738: Currently unsupported.
1.79 schwarze 739: .It Ic \&ds Ar stringname Op Oo \(dq Oc Ns Ar string
1.15 kristaps 740: Define a user-defined string.
1.13 kristaps 741: The
1.79 schwarze 742: .Ar stringname
1.13 kristaps 743: and
1.15 kristaps 744: .Ar string
745: arguments are space-separated.
746: If the
747: .Ar string
748: begins with a double-quote character, that character will not be part
749: of the string.
750: All remaining characters on the input line form the
751: .Ar string ,
752: including whitespace and double-quote characters, even trailing ones.
753: .Pp
1.13 kristaps 754: The
1.15 kristaps 755: .Ar string
756: can be interpolated into subsequent text by using
1.79 schwarze 757: .No \e* Ns Bq Ar stringname
1.15 kristaps 758: for a
1.79 schwarze 759: .Ar stringname
1.15 kristaps 760: of arbitrary length, or \e*(NN or \e*N if the length of
1.79 schwarze 761: .Ar stringname
1.15 kristaps 762: is two or one characters, respectively.
1.17 schwarze 763: Interpolation can be prevented by escaping the leading backslash;
764: that is, an asterisk preceded by an even number of backslashes
765: does not trigger string interpolation.
1.15 kristaps 766: .Pp
767: Since user-defined strings and macros share a common string table,
768: defining a string
1.79 schwarze 769: .Ar stringname
1.17 schwarze 770: clobbers the macro
1.79 schwarze 771: .Ar stringname ,
1.15 kristaps 772: and the
1.79 schwarze 773: .Ar stringname
1.15 kristaps 774: used for defining a string can also be invoked as a macro,
775: in which case the following input line will be appended to the
776: .Ar string ,
777: forming a new input line passed to the
778: .Nm
779: parser.
780: For example,
781: .Bd -literal -offset indent
782: \&.ds badidea .S
783: \&.badidea
784: H SYNOPSIS
785: .Ed
786: .Pp
787: invokes the
1.79 schwarze 788: .Ic SH
1.15 kristaps 789: macro when used in a
790: .Xr man 7
791: document.
792: Such abuse is of course strongly discouraged.
1.79 schwarze 793: .It Ic \&ds1 Ar stringname Op Oo \(dq Oc Ns Ar string
1.63 schwarze 794: Define a user-defined string that will be expanded with
795: .Nm
796: compatibility mode switched off during string expansion.
797: This is a groff extension.
798: Since
799: .Xr mandoc 1
800: does not implement
801: .Nm
802: compatibility mode at all, it handles this request as an alias for
1.79 schwarze 803: .Ic \&ds .
804: .It Ic \&dwh Ar dist macroname
1.63 schwarze 805: Set a location trap in the current diversion.
806: This is a Heirloom extension and currently unsupported.
1.79 schwarze 807: .It Ic \&dt Op Ar dist macroname
1.63 schwarze 808: Set a trap within a diversion.
809: Currently unsupported.
1.79 schwarze 810: .It Ic \&ec Op Ar char
1.83 ! schwarze 811: Enable the escape mechanism and change the escape character.
! 812: The
! 813: .Ar char
! 814: argument defaults to the backslash
! 815: .Pq Sq \e .
1.79 schwarze 816: .It Ic \&ecr
1.63 schwarze 817: Restore the escape character.
818: Currently unsupported.
1.79 schwarze 819: .It Ic \&ecs
1.63 schwarze 820: Save the escape character.
821: Currently unsupported.
1.79 schwarze 822: .It Ic \&el Ar body
1.5 kristaps 823: The
1.79 schwarze 824: .Dq else
1.5 kristaps 825: half of an if/else conditional.
826: Pops a result off the stack of conditional evaluations pushed by
1.79 schwarze 827: .Ic \&ie
1.5 kristaps 828: and uses it as its conditional.
829: If no stack entries are present (e.g., due to no prior
1.79 schwarze 830: .Ic \&ie
1.5 kristaps 831: calls)
832: then false is assumed.
1.17 schwarze 833: The syntax of this request is similar to
1.79 schwarze 834: .Ic \&if
1.5 kristaps 835: except that the conditional is missing.
1.79 schwarze 836: .It Ic \&em Ar macroname
1.63 schwarze 837: Set a trap at the end of input.
838: Currently unsupported.
1.79 schwarze 839: .It Ic \&EN
1.27 kristaps 840: End an equation block.
841: See
1.79 schwarze 842: .Ic \&EQ .
843: .It Ic \&eo
1.63 schwarze 844: Disable the escape mechanism completely.
1.79 schwarze 845: .It Ic \&EP
1.63 schwarze 846: End a picture started by
1.79 schwarze 847: .Ic \&BP .
1.63 schwarze 848: This is a Heirloom extension and currently unsupported.
1.79 schwarze 849: .It Ic \&EQ
1.27 kristaps 850: Begin an equation block.
851: See
852: .Xr eqn 7
853: for a description of the equation language.
1.79 schwarze 854: .It Ic \&errprint Ar message
1.63 schwarze 855: Print a string like an error message.
856: This is a Heirloom extension and currently ignored.
1.79 schwarze 857: .It Ic \&ev Op Ar envname
1.63 schwarze 858: Switch to another environment.
859: Currently unsupported.
1.79 schwarze 860: .It Ic \&evc Op Ar envname
1.63 schwarze 861: Copy an environment into the current environment.
862: Currently unsupported.
1.79 schwarze 863: .It Ic \&ex
1.63 schwarze 864: Abort processing and exit.
865: Currently unsupported.
1.79 schwarze 866: .It Ic \&fallback Ar curfont font ...
1.63 schwarze 867: Select the fallback sequence for a font.
868: This is a Heirloom extension and currently ignored.
1.79 schwarze 869: .It Ic \&fam Op Ar familyname
1.43 schwarze 870: Change the font family.
1.79 schwarze 871: This is a groff extension and currently ignored.
872: .It Ic \&fc Op Ar delimchar Op Ar padchar
1.63 schwarze 873: Define a delimiting and a padding character for fields.
874: Currently unsupported.
1.79 schwarze 875: .It Ic \&fchar Ar glyphname Op Ar string
1.63 schwarze 876: Define a fallback glyph.
877: Currently unsupported.
1.79 schwarze 878: .It Ic \&fcolor Ar colorname
1.63 schwarze 879: Set the fill color for \eD objects.
880: This is a groff extension and currently ignored.
1.79 schwarze 881: .It Ic \&fdeferlig Ar font string ...
1.63 schwarze 882: Defer ligature building.
883: This is a Heirloom extension and currently ignored.
1.79 schwarze 884: .It Ic \&feature Cm + Ns | Ns Cm - Ns Ar name
1.63 schwarze 885: Enable or disable an OpenType feature.
886: This is a Heirloom extension and currently ignored.
1.79 schwarze 887: .It Ic \&fi
1.63 schwarze 888: Switch to fill mode.
889: See
890: .Xr man 7 .
891: Ignored in
892: .Xr mdoc 7 .
1.79 schwarze 893: .It Ic \&fkern Ar font minkern
1.63 schwarze 894: Control the use of kerning tables for a font.
895: This is a Heirloom extension and currently ignored.
1.79 schwarze 896: .It Ic \&fl
1.63 schwarze 897: Flush output.
898: Currently ignored.
1.79 schwarze 899: .It Ic \&flig Ar font string char ...
1.63 schwarze 900: Define ligatures.
901: This is a Heirloom extension and currently ignored.
1.79 schwarze 902: .It Ic \&fp Ar position font Op Ar filename
1.63 schwarze 903: Assign font position.
904: Currently ignored.
1.79 schwarze 905: .It Ic \&fps Ar mapname ...
1.63 schwarze 906: Mount a font with a special character map.
907: This is a Heirloom extension and currently ignored.
1.79 schwarze 908: .It Ic \&fschar Ar font glyphname Op Ar string
1.63 schwarze 909: Define a font-specific fallback glyph.
910: This is a groff extension and currently unsupported.
1.79 schwarze 911: .It Ic \&fspacewidth Ar font Op Ar afmunits
1.63 schwarze 912: Set a font-specific width for the space character.
913: This is a Heirloom extension and currently ignored.
1.79 schwarze 914: .It Ic \&fspecial Ar curfont Op Ar font ...
1.63 schwarze 915: Conditionally define a special font.
916: This is a groff extension and currently ignored.
1.79 schwarze 917: .It Ic \&ft Op Ar font
1.49 schwarze 918: Change the font.
919: The following
920: .Ar font
921: arguments are supported:
922: .Bl -tag -width 4n -offset indent
923: .It Cm B , BI , 3 , 4
924: switches to
925: .Sy bold
926: font
927: .It Cm I , 2
928: switches to
929: .Em underlined
930: font
931: .It Cm R , CW , 1
932: switches to normal font
933: .It Cm P No "or no argument"
934: switches back to the previous font
935: .El
936: .Pp
1.77 schwarze 937: This request takes effect only locally and may be overridden
938: by macros and escape sequences.
1.79 schwarze 939: .It Ic \&ftr Ar newname Op Ar oldname
1.63 schwarze 940: Translate font name.
941: This is a groff extension and currently ignored.
1.79 schwarze 942: .It Ic \&fzoom Ar font Op Ar permille
1.63 schwarze 943: Zoom font size.
944: Currently ignored.
1.79 schwarze 945: .It Ic \&gcolor Op Ar colorname
1.63 schwarze 946: Set glyph color.
947: This is a groff extension and currently ignored.
1.79 schwarze 948: .It Ic \&hc Op Ar char
1.63 schwarze 949: Set the hyphenation character.
950: Currently ignored.
1.79 schwarze 951: .It Ic \&hcode Ar char code ...
1.63 schwarze 952: Set hyphenation codes of characters.
953: Currently ignored.
1.79 schwarze 954: .It Ic \&hidechar Ar font char ...
1.63 schwarze 955: Hide characters in a font.
956: This is a Heirloom extension and currently ignored.
1.79 schwarze 957: .It Ic \&hla Ar language
1.63 schwarze 958: Set hyphenation language.
959: This is a groff extension and currently ignored.
1.79 schwarze 960: .It Ic \&hlm Op Ar number
1.63 schwarze 961: Set maximum number of consecutive hyphenated lines.
962: Currently ignored.
1.79 schwarze 963: .It Ic \&hpf Ar filename
1.63 schwarze 964: Load hyphenation pattern file.
965: This is a groff extension and currently ignored.
1.79 schwarze 966: .It Ic \&hpfa Ar filename
1.63 schwarze 967: Load hyphenation pattern file, appending to the current patterns.
968: This is a groff extension and currently ignored.
1.79 schwarze 969: .It Ic \&hpfcode Ar code code ...
1.63 schwarze 970: Define mapping values for character codes in hyphenation patterns.
971: This is a groff extension and currently ignored.
1.79 schwarze 972: .It Ic \&hw Ar word ...
1.44 schwarze 973: Specify hyphenation points in words.
1.63 schwarze 974: Currently ignored.
1.79 schwarze 975: .It Ic \&hy Op Ar mode
1.15 kristaps 976: Set automatic hyphenation mode.
1.63 schwarze 977: Currently ignored.
1.79 schwarze 978: .It Ic \&hylang Ar language
1.63 schwarze 979: Set hyphenation language.
980: This is a Heirloom extension and currently ignored.
1.79 schwarze 981: .It Ic \&hylen Ar nchar
1.63 schwarze 982: Minimum word length for hyphenation.
983: This is a Heirloom extension and currently ignored.
1.79 schwarze 984: .It Ic \&hym Op Ar length
1.63 schwarze 985: Set hyphenation margin.
986: This is a groff extension and currently ignored.
1.79 schwarze 987: .It Ic \&hypp Ar penalty ...
1.63 schwarze 988: Define hyphenation penalties.
989: This is a Heirloom extension and currently ignored.
1.79 schwarze 990: .It Ic \&hys Op Ar length
1.63 schwarze 991: Set hyphenation space.
992: This is a groff extension and currently ignored.
1.79 schwarze 993: .It Ic \&ie Ar condition body
1.5 kristaps 994: The
1.79 schwarze 995: .Dq if
1.5 kristaps 996: half of an if/else conditional.
997: The result of the conditional is pushed into a stack used by subsequent
998: invocations of
1.79 schwarze 999: .Ic \&el ,
1.5 kristaps 1000: which may be separated by any intervening input (or not exist at all).
1001: Its syntax is equivalent to
1.79 schwarze 1002: .Ic \&if .
1003: .It Ic \&if Ar condition body
1004: Begin a conditional.
1005: This request can also be written as follows:
1006: .Bd -unfilled -offset indent
1007: .Pf . Ic \&if Ar condition No \e{ Ns Ar body
1008: .Ar body ... Ns \e}
1.48 schwarze 1009: .Ed
1.79 schwarze 1010: .Bd -unfilled -offset indent
1011: .Pf . Ic \&if Ar condition No \e{\e
1012: .Ar body ...
1013: .Pf . No \e}
1.48 schwarze 1014: .Ed
1015: .Pp
1.79 schwarze 1016: The
1017: .Ar condition
1018: is a boolean expression.
1.48 schwarze 1019: Currently,
1020: .Xr mandoc 1
1021: supports the following subset of roff conditionals:
1022: .Bl -bullet
1023: .It
1024: If
1025: .Sq \&!
1.79 schwarze 1026: is prefixed to
1027: .Ar condition ,
1028: it is logically inverted.
1.48 schwarze 1029: .It
1.79 schwarze 1030: If the first character of
1031: .Ar condition
1032: is
1.48 schwarze 1033: .Sq n
1034: .Pq nroff mode
1035: or
1036: .Sq o
1037: .Pq odd page ,
1.79 schwarze 1038: it evaluates to true.
1.48 schwarze 1039: .It
1.79 schwarze 1040: If the first character of
1041: .Ar condition
1042: is
1.48 schwarze 1043: .Sq c
1044: .Pq character available ,
1045: .Sq d
1046: .Pq string defined ,
1047: .Sq e
1048: .Pq even page ,
1049: .Sq t
1050: .Pq troff mode ,
1.59 schwarze 1051: or
1052: .Sq v
1053: .Pq vroff mode ,
1.79 schwarze 1054: it evaluates to false.
1.72 schwarze 1055: .It
1.79 schwarze 1056: If the first character of
1057: .Ar condition
1058: is
1.72 schwarze 1059: .Sq r ,
1.79 schwarze 1060: it evaluates to true if the rest of
1061: .Ar condition
1062: is the name of an existing number register;
1063: otherwise, it evaluates to false.
1.48 schwarze 1064: .It
1.79 schwarze 1065: If the
1066: .Ar condition
1067: starts with a parenthesis or with an optionally signed
1.53 schwarze 1068: integer number, it is evaluated according to the rules of
1069: .Sx Numerical expressions
1070: explained below.
1.57 schwarze 1071: It evaluates to true if the result is positive,
1.53 schwarze 1072: or to false if the result is zero or negative.
1.48 schwarze 1073: .It
1.79 schwarze 1074: Otherwise, the first character of
1075: .Ar condition
1076: is regarded as a delimiter and it evaluates to true if the string
1077: extending from its first to its second occurrence is equal to the
1078: string extending from its second to its third occurrence.
1.48 schwarze 1079: .It
1.79 schwarze 1080: If
1081: .Ar condition
1082: cannot be parsed, it evaluates to false.
1.48 schwarze 1083: .El
1084: .Pp
1.3 kristaps 1085: If a conditional is false, its children are not processed, but are
1086: syntactically interpreted to preserve the integrity of the input
1087: document.
1088: Thus,
1089: .Pp
1.17 schwarze 1090: .D1 \&.if t .ig
1.3 kristaps 1091: .Pp
1092: will discard the
1093: .Sq \&.ig ,
1094: which may lead to interesting results, but
1095: .Pp
1.17 schwarze 1096: .D1 \&.if t .if t \e{\e
1.3 kristaps 1097: .Pp
1098: will continue to syntactically interpret to the block close of the final
1099: conditional.
1100: Sub-conditionals, in this case, obviously inherit the truth value of
1101: the parent.
1.1 kristaps 1102: .Pp
1.79 schwarze 1103: If the
1104: .Ar body
1105: section is begun by an escaped brace
1.1 kristaps 1106: .Sq \e{ ,
1.48 schwarze 1107: scope continues until the end of the input line containing the
1108: matching closing-brace escape sequence
1109: .Sq \e} .
1.79 schwarze 1110: If the
1111: .Ar body
1112: is not enclosed in braces, scope continues until the end of the line.
1113: If the
1114: .Ar condition
1115: is followed by a
1116: .Ar body
1117: on the same line, whether after a brace or not, then requests and macros
1.1 kristaps 1118: .Em must
1119: begin with a control character.
1120: It is generally more intuitive, in this case, to write
1.79 schwarze 1121: .Bd -unfilled -offset indent
1122: .Pf . Ic \&if Ar condition No \e{\e
1123: .Pf . Ar request
1124: .Pf . No \e}
1.1 kristaps 1125: .Ed
1126: .Pp
1.17 schwarze 1127: than having the request or macro follow as
1.1 kristaps 1128: .Pp
1.79 schwarze 1129: .D1 Pf . Ic \&if Ar condition Pf \e{. Ar request
1.1 kristaps 1130: .Pp
1131: The scope of a conditional is always parsed, but only executed if the
1132: conditional evaluates to true.
1133: .Pp
1.29 kristaps 1134: Note that the
1.1 kristaps 1135: .Sq \e}
1.29 kristaps 1136: is converted into a zero-width escape sequence if not passed as a
1137: standalone macro
1138: .Sq \&.\e} .
1139: For example,
1140: .Pp
1141: .D1 \&.Fl a \e} b
1142: .Pp
1143: will result in
1.8 kristaps 1144: .Sq \e}
1.29 kristaps 1145: being considered an argument of the
1146: .Sq \&Fl
1147: macro.
1.79 schwarze 1148: .It Ic \&ig Op Ar endmacro
1.2 kristaps 1149: Ignore input.
1.15 kristaps 1150: Its syntax can be either
1151: .Bd -literal -offset indent
1152: .Pf . Cm \&ig
1153: .Ar ignored text
1.2 kristaps 1154: \&..
1155: .Ed
1.15 kristaps 1156: .Pp
1157: or
1158: .Bd -literal -offset indent
1.79 schwarze 1159: .Pf . Cm \&ig Ar endmacro
1.15 kristaps 1160: .Ar ignored text
1.79 schwarze 1161: .Pf . Ar endmacro
1.2 kristaps 1162: .Ed
1163: .Pp
1164: In the first case, input is ignored until a
1165: .Sq \&..
1.17 schwarze 1166: request is encountered on its own line.
1.15 kristaps 1167: In the second case, input is ignored until the specified
1.79 schwarze 1168: .Sq Pf . Ar endmacro
1169: is encountered.
1.15 kristaps 1170: Do not use the escape character
1.2 kristaps 1171: .Sq \e
1.15 kristaps 1172: anywhere in the definition of
1.79 schwarze 1173: .Ar endmacro ;
1.15 kristaps 1174: it would cause very strange behaviour.
1175: .Pp
1176: When the
1.79 schwarze 1177: .Ar endmacro
1178: is a roff request or a roff macro, like in
1.2 kristaps 1179: .Pp
1180: .D1 \&.ig if
1181: .Pp
1182: the subsequent invocation of
1.79 schwarze 1183: .Ic \&if
1.15 kristaps 1184: will first terminate the
1185: .Ar ignored text ,
1186: then be invoked as usual.
1187: Otherwise, it only terminates the
1188: .Ar ignored text ,
1189: and arguments following it or the
1190: .Sq \&..
1.17 schwarze 1191: request are discarded.
1.79 schwarze 1192: .It Ic \&in Op Oo Cm + Ns | Ns Cm - Oc Ns Ar width
1.63 schwarze 1193: Change indentation.
1194: See
1195: .Xr man 7 .
1196: Ignored in
1197: .Xr mdoc 7 .
1.79 schwarze 1198: .It Ic \&index Ar register stringname substring
1.63 schwarze 1199: Find a substring in a string.
1200: This is a Heirloom extension and currently unsupported.
1.79 schwarze 1201: .It Ic \&it Ar expression macro
1.63 schwarze 1202: Set an input line trap.
1203: The named
1204: .Ar macro
1.70 schwarze 1205: will be invoked after processing the number of input text lines
1206: specified by the numerical
1207: .Ar expression .
1208: While evaluating the
1209: .Ar expression ,
1210: the unit suffixes described below
1211: .Sx Scaling Widths
1212: are ignored.
1.79 schwarze 1213: .It Ic \&it Ar expression macro
1.63 schwarze 1214: Set an input line trap, not counting lines ending with \ec.
1215: Currently unsupported.
1.79 schwarze 1216: .It Ic \&IX Ar class keystring
1.63 schwarze 1217: To support the generation of a table of contents,
1218: .Xr pod2man 1
1219: emits this user-defined macro, usually without defining it.
1220: To avoid reporting large numbers of spurious errors,
1221: .Xr mandoc 1
1222: ignores it.
1.79 schwarze 1223: .It Ic \&kern Op Cm 1 | 0
1.63 schwarze 1224: Switch kerning on or off.
1225: Currently ignored.
1.79 schwarze 1226: .It Ic \&kernafter Ar font char ... afmunits ...
1.63 schwarze 1227: Increase kerning after some characters.
1228: This is a Heirloom extension and currently ignored.
1.79 schwarze 1229: .It Ic \&kernbefore Ar font char ... afmunits ...
1.63 schwarze 1230: Increase kerning before some characters.
1231: This is a Heirloom extension and currently ignored.
1.79 schwarze 1232: .It Ic \&kernpair Ar font char ... font char ... afmunits
1.63 schwarze 1233: Add a kerning pair to the kerning table.
1234: This is a Heirloom extension and currently ignored.
1.79 schwarze 1235: .It Ic \&lc Op Ar glyph
1.63 schwarze 1236: Define a leader repetition character.
1237: Currently unsupported.
1.79 schwarze 1238: .It Ic \&lc_ctype Ar localename
1.63 schwarze 1239: Set the
1240: .Dv LC_CTYPE
1241: locale.
1242: This is a Heirloom extension and currently unsupported.
1.79 schwarze 1243: .It Ic \&lds Ar macroname string
1.63 schwarze 1244: Define a local string.
1245: This is a Heirloom extension and currently unsupported.
1.79 schwarze 1246: .It Ic \&length Ar register string
1247: Count the number of input characters in a string.
1.63 schwarze 1248: Currently unsupported.
1.79 schwarze 1249: .It Ic \&letadj Ar lspmin lshmin letss lspmax lshmax
1.63 schwarze 1250: Dynamic letter spacing and reshaping.
1251: This is a Heirloom extension and currently ignored.
1.79 schwarze 1252: .It Ic \&lf Ar lineno Op Ar filename
1.63 schwarze 1253: Change the line number for error messages.
1254: Ignored because insecure.
1.79 schwarze 1255: .It Ic \&lg Op Cm 1 | 0
1.63 schwarze 1256: Switch the ligature mechanism on or off.
1257: Currently ignored.
1.79 schwarze 1258: .It Ic \&lhang Ar font char ... afmunits
1.63 schwarze 1259: Hang characters at left margin.
1260: This is a Heirloom extension and currently ignored.
1.79 schwarze 1261: .It Ic \&linetabs Op Cm 1 | 0
1.63 schwarze 1262: Enable or disable line-tabs mode.
1263: This is a groff extension and currently unsupported.
1.79 schwarze 1264: .It Ic \&ll Op Oo Cm + Ns | Ns Cm - Oc Ns Ar width
1.50 schwarze 1265: Change the output line length.
1266: If the
1267: .Ar width
1268: argument is omitted, the line length is reset to its previous value.
1269: The default setting for terminal output is 78n.
1.51 schwarze 1270: If a sign is given, the line length is added to or subtracted from;
1271: otherwise, it is set to the provided value.
1.50 schwarze 1272: Using this request in new manuals is discouraged for several reasons,
1273: among others because it overrides the
1274: .Xr mandoc 1
1275: .Fl O Cm width
1276: command line option.
1.79 schwarze 1277: .It Ic \&lnr Ar register Oo Cm + Ns | Ns Cm - Oc Ns Ar value Op Ar increment
1.63 schwarze 1278: Set local number register.
1279: This is a Heirloom extension and currently unsupported.
1.79 schwarze 1280: .It Ic \&lnrf Ar register Oo Cm + Ns | Ns Cm - Oc Ns Ar value Op Ar increment
1.63 schwarze 1281: Set local floating-point register.
1282: This is a Heirloom extension and currently unsupported.
1.79 schwarze 1283: .It Ic \&lpfx Ar string
1.63 schwarze 1284: Set a line prefix.
1285: This is a Heirloom extension and currently unsupported.
1.79 schwarze 1286: .It Ic \&ls Op Ar factor
1.63 schwarze 1287: Set line spacing.
1288: It takes one integer argument specifying the vertical distance of
1289: subsequent output text lines measured in v units.
1290: Currently ignored.
1.79 schwarze 1291: .It Ic \&lsm Ar macroname
1.63 schwarze 1292: Set a leading spaces trap.
1293: This is a groff extension and currently unsupported.
1.79 schwarze 1294: .It Ic \< Op Oo Cm + Ns | Ns Cm - Oc Ns Ar width
1.63 schwarze 1295: Set title line length.
1296: Currently ignored.
1.79 schwarze 1297: .It Ic \&mc Ar glyph Op Ar dist
1.63 schwarze 1298: Print margin character in the right margin.
1299: Currently ignored.
1.79 schwarze 1300: .It Ic \&mediasize Ar media
1.63 schwarze 1301: Set the device media size.
1302: This is a Heirloom extension and currently ignored.
1.79 schwarze 1303: .It Ic \&minss Ar width
1.63 schwarze 1304: Set minimum word space.
1305: This is a Heirloom extension and currently ignored.
1.79 schwarze 1306: .It Ic \&mk Op Ar register
1.63 schwarze 1307: Mark vertical position.
1308: Currently ignored.
1.79 schwarze 1309: .It Ic \&mso Ar filename
1310: Load a macro file using the search path.
1.63 schwarze 1311: Ignored because insecure.
1.79 schwarze 1312: .It Ic \&na
1.63 schwarze 1313: Disable adjusting without changing the adjustment mode.
1314: Currently ignored.
1.79 schwarze 1315: .It Ic \&ne Op Ar height
1.15 kristaps 1316: Declare the need for the specified minimum vertical space
1317: before the next trap or the bottom of the page.
1.63 schwarze 1318: Currently ignored.
1.79 schwarze 1319: .It Ic \&nf
1.63 schwarze 1320: Switch to no-fill mode.
1321: See
1322: .Xr man 7 .
1323: Ignored by
1.64 schwarze 1324: .Xr mdoc 7 .
1.79 schwarze 1325: .It Ic \&nh
1.15 kristaps 1326: Turn off automatic hyphenation mode.
1.63 schwarze 1327: Currently ignored.
1.79 schwarze 1328: .It Ic \&nhychar Ar char ...
1.63 schwarze 1329: Define hyphenation-inhibiting characters.
1330: This is a Heirloom extension and currently ignored.
1.79 schwarze 1331: .It Ic \&nm Op Ar start Op Ar inc Op Ar space Op Ar indent
1.63 schwarze 1332: Print line numbers.
1333: Currently unsupported.
1.79 schwarze 1334: .It Ic \&nn Op Ar number
1.63 schwarze 1335: Temporarily turn off line numbering.
1336: Currently unsupported.
1.79 schwarze 1337: .It Ic \&nop Ar body
1.75 schwarze 1338: Execute the rest of the input line as a request or macro line.
1.63 schwarze 1339: Currently unsupported.
1.79 schwarze 1340: .It Ic \&nr Ar register Oo Cm + Ns | Ns Cm - Oc Ns Ar expression
1.45 schwarze 1341: Define or change a register.
1.10 kristaps 1342: A register is an arbitrary string value that defines some sort of state,
1343: which influences parsing and/or formatting.
1.53 schwarze 1344: For the syntax of
1345: .Ar expression ,
1346: see
1347: .Sx Numerical expressions
1348: below.
1.46 schwarze 1349: If it is prefixed by a sign, the register will be
1.45 schwarze 1350: incremented or decremented instead of assigned to.
1351: .Pp
1.79 schwarze 1352: The following
1353: .Ar register
1.45 schwarze 1354: is handled specially:
1.10 kristaps 1355: .Bl -tag -width Ds
1356: .It Cm nS
1357: If set to a positive integer value, certain
1358: .Xr mdoc 7
1.17 schwarze 1359: macros will behave in the same way as in the
1.10 kristaps 1360: .Em SYNOPSIS
1.11 kristaps 1361: section.
1.17 schwarze 1362: If set to 0, these macros will behave in the same way as outside the
1363: .Em SYNOPSIS
1364: section, even when called within the
1.10 kristaps 1365: .Em SYNOPSIS
1.17 schwarze 1366: section itself.
1367: Note that starting a new
1.11 kristaps 1368: .Xr mdoc 7
1.17 schwarze 1369: section with the
1.79 schwarze 1370: .Ic \&Sh
1.17 schwarze 1371: macro will reset this register.
1.10 kristaps 1372: .El
1.79 schwarze 1373: .It Xo
1374: .Ic \&nrf Ar register Oo Cm + Ns | Ns Cm - Oc Ns Ar expression
1375: .Op Ar increment
1376: .Xc
1.63 schwarze 1377: Define or change a floating-point register.
1378: This is a Heirloom extension and currently unsupported.
1.79 schwarze 1379: .It Ic \&nroff
1.63 schwarze 1380: Force nroff mode.
1381: This is a groff extension and currently ignored.
1.79 schwarze 1382: .It Ic \&ns
1.26 schwarze 1383: Turn on no-space mode.
1.63 schwarze 1384: Currently ignored.
1.79 schwarze 1385: .It Ic \&nx Op Ar filename
1.63 schwarze 1386: Abort processing of the current input file and process another one.
1387: Ignored because insecure.
1.79 schwarze 1388: .It Ic \&open Ar stream file
1.63 schwarze 1389: Open a file for writing.
1390: Ignored because insecure.
1.79 schwarze 1391: .It Ic \&opena Ar stream file
1.63 schwarze 1392: Open a file for appending.
1393: Ignored because insecure.
1.79 schwarze 1394: .It Ic \&os
1.63 schwarze 1395: Output saved vertical space.
1396: Currently ignored.
1.79 schwarze 1397: .It Ic \&output Ar string
1.63 schwarze 1398: Output directly to intermediate output.
1399: Not supported.
1.79 schwarze 1400: .It Ic \&padj Op Cm 1 | 0
1.63 schwarze 1401: Globally control paragraph-at-once adjustment.
1402: This is a Heirloom extension and currently ignored.
1.79 schwarze 1403: .It Ic \&papersize Ar media
1.63 schwarze 1404: Set the paper size.
1405: This is a Heirloom extension and currently ignored.
1.79 schwarze 1406: .It Ic \&pc Op Ar char
1.63 schwarze 1407: Change the page number character.
1408: Currently ignored.
1.79 schwarze 1409: .It Ic \&pev
1.63 schwarze 1410: Print environments.
1411: This is a groff extension and currently ignored.
1.79 schwarze 1412: .It Ic \&pi Ar command
1.63 schwarze 1413: Pipe output to a shell command.
1414: Ignored because insecure.
1.79 schwarze 1415: .It Ic \&PI
1.63 schwarze 1416: Low-level request used by
1.79 schwarze 1417: .Ic \&BP .
1.63 schwarze 1418: This is a Heirloom extension and currently unsupported.
1.79 schwarze 1419: .It Ic \&pl Op Oo Cm + Ns | Ns Cm - Oc Ns Ar height
1.58 schwarze 1420: Change page length.
1.63 schwarze 1421: Currently ignored.
1.79 schwarze 1422: .It Ic \&pm
1423: Print names and sizes of macros, strings, and diversions
1424: to standard error output.
1.63 schwarze 1425: Currently ignored.
1.79 schwarze 1426: .It Ic \&pn Oo Cm + Ns | Ns Cm - Oc Ns Ar number
1427: Change the page number of the next page.
1.63 schwarze 1428: Currently ignored.
1.79 schwarze 1429: .It Ic \&pnr
1430: Print all number registers on standard error output.
1.63 schwarze 1431: Currently ignored.
1.79 schwarze 1432: .It Ic \&po Op Oo Cm + Ns | Ns Cm - Oc Ns Ar offset
1.63 schwarze 1433: Set horizontal page offset.
1434: Currently ignored.
1.79 schwarze 1435: .It Ic \&ps Op Oo Cm + Ns | Ns Cm - Oc Ns size
1.26 schwarze 1436: Change point size.
1.63 schwarze 1437: Currently ignored.
1.79 schwarze 1438: .It Ic \&psbb Ar filename
1.63 schwarze 1439: Retrieve the bounding box of a PostScript file.
1440: Currently unsupported.
1.79 schwarze 1441: .It Ic \&pshape Ar indent length ...
1.63 schwarze 1442: Set a special shape for the current paragraph.
1.68 schwarze 1443: This is a Heirloom extension and currently unsupported.
1.79 schwarze 1444: .It Ic \&pso Ar command
1.63 schwarze 1445: Include output of a shell command.
1446: Ignored because insecure.
1.79 schwarze 1447: .It Ic \&ptr
1448: Print the names and positions of all traps on standard error output.
1.63 schwarze 1449: This is a groff extension and currently ignored.
1.79 schwarze 1450: .It Ic \&pvs Op Oo Cm + Ns | Ns Cm - Oc Ns Ar height
1.63 schwarze 1451: Change post-vertical spacing.
1452: This is a groff extension and currently ignored.
1.79 schwarze 1453: .It Ic \&rchar Ar glyph ...
1.63 schwarze 1454: Remove glyph definitions.
1455: Currently unsupported.
1.79 schwarze 1456: .It Ic \&rd Op Ar prompt Op Ar agument ...
1.63 schwarze 1457: Read from standard input.
1458: Currently ignored.
1.79 schwarze 1459: .It Ic \&recursionlimit Ar maxrec maxtail
1.63 schwarze 1460: Set the maximum stack depth for recursive macros.
1461: This is a Heirloom extension and currently ignored.
1.79 schwarze 1462: .It Ic \&return Op Ar twice
1.63 schwarze 1463: Exit a macro and return to the caller.
1464: Currently unsupported.
1.79 schwarze 1465: .It Ic \&rfschar Ar font glyph ...
1.63 schwarze 1466: Remove font-specific fallback glyph definitions.
1467: Currently unsupported.
1.79 schwarze 1468: .It Ic \&rhang Ar font char ... afmunits
1.63 schwarze 1469: Hang characters at right margin.
1470: This is a Heirloom extension and currently ignored.
1.79 schwarze 1471: .It Ic \&rj Op Ar N
1472: Justify the next
1473: .Ar N
1474: input lines to the right margin without filling.
1.63 schwarze 1475: Currently ignored.
1.79 schwarze 1476: .It Ic \&rm Ar macroname
1.52 schwarze 1477: Remove a request, macro or string.
1.79 schwarze 1478: .It Ic \&rn Ar oldname newname
1.63 schwarze 1479: Rename a request, macro, diversion, or string.
1480: Currently unsupported.
1.79 schwarze 1481: .It Ic \&rnn Ar oldname newname
1.63 schwarze 1482: Rename a number register.
1483: Currently unsupported.
1.79 schwarze 1484: .It Ic \&rr Ar register
1.52 schwarze 1485: Remove a register.
1.79 schwarze 1486: .It Ic \&rs
1.63 schwarze 1487: End no-space mode.
1488: Currently ignored.
1.79 schwarze 1489: .It Ic \&rt Op Ar dist
1.63 schwarze 1490: Return to marked vertical position.
1491: Currently ignored.
1.79 schwarze 1492: .It Ic \&schar Ar glyph Op Ar string
1.63 schwarze 1493: Define global fallback glyph.
1494: This is a groff extension and currently unsupported.
1.79 schwarze 1495: .It Ic \&sentchar Ar char ...
1.63 schwarze 1496: Define sentence-ending characters.
1497: This is a Heirloom extension and currently ignored.
1.79 schwarze 1498: .It Ic \&shc Op Ar glyph
1.63 schwarze 1499: Change the soft hyphen character.
1500: Currently ignored.
1.79 schwarze 1501: .It Ic \&shift Op Ar number
1.63 schwarze 1502: Shift macro arguments.
1503: Currently unsupported.
1.79 schwarze 1504: .It Ic \&sizes Ar size ...
1.63 schwarze 1505: Define permissible point sizes.
1506: This is a groff extension and currently ignored.
1.79 schwarze 1507: .It Ic \&so Ar filename
1.15 kristaps 1508: Include a source file.
1.79 schwarze 1509: The file is read and its contents processed as input in place of the
1510: .Ic \&so
1.15 kristaps 1511: request line.
1.28 kristaps 1512: To avoid inadvertent inclusion of unrelated files,
1.15 kristaps 1513: .Xr mandoc 1
1514: only accepts relative paths not containing the strings
1515: .Qq ../
1516: and
1517: .Qq /.. .
1.37 schwarze 1518: .Pp
1519: This request requires
1520: .Xr man 1
1521: to change to the right directory before calling
1522: .Xr mandoc 1 ,
1523: per convention to the root of the manual tree.
1524: Typical usage looks like:
1525: .Pp
1526: .Dl \&.so man3/Xcursor.3
1527: .Pp
1528: As the whole concept is rather fragile, the use of
1.79 schwarze 1529: .Ic \&so
1.37 schwarze 1530: is discouraged.
1531: Use
1532: .Xr ln 1
1533: instead.
1.79 schwarze 1534: .It Ic \&sp Op Ar height
1.78 schwarze 1535: Break the output line and emit vertical space.
1536: The argument follows the syntax of
1537: .Sx Scaling Widths
1538: and defaults to one blank line
1539: .Pq Li 1v .
1.79 schwarze 1540: .It Ic \&spacewidth Op Cm 1 | 0
1.63 schwarze 1541: Set the space width from the font metrics file.
1542: This is a Heirloom extension and currently ignored.
1.79 schwarze 1543: .It Ic \&special Op Ar font ...
1.63 schwarze 1544: Define a special font.
1545: This is a groff extension and currently ignored.
1.79 schwarze 1546: .It Ic \&spreadwarn Op Ar width
1.63 schwarze 1547: Warn about wide spacing between words.
1548: Currently ignored.
1.79 schwarze 1549: .It Ic \&ss Ar wordspace Op Ar sentencespace
1.63 schwarze 1550: Set space character size.
1551: Currently ignored.
1.79 schwarze 1552: .It Ic \&sty Ar position style
1.63 schwarze 1553: Associate style with a font position.
1554: This is a groff extension and currently ignored.
1.79 schwarze 1555: .It Ic \&substring Ar stringname startpos Op Ar endpos
1.63 schwarze 1556: Replace a user-defined string with a substring.
1557: Currently unsupported.
1.79 schwarze 1558: .It Ic \&sv Op Ar height
1.63 schwarze 1559: Save vertical space.
1560: Currently ignored.
1.79 schwarze 1561: .It Ic \&sy Ar command
1.63 schwarze 1562: Execute shell command.
1563: Ignored because insecure.
1.79 schwarze 1564: .It Ic \&T&
1.63 schwarze 1565: Re-start a table layout, retaining the options of the prior table
1566: invocation.
1567: See
1568: .Sx \&TS .
1.79 schwarze 1569: .It Ic \&ta Op Ar width ... Op Cm T Ar width ...
1.26 schwarze 1570: Set tab stops.
1.79 schwarze 1571: Each
1572: .Ar width
1573: argument follows the syntax of
1574: .Sx Scaling Widths .
1575: If prefixed by a plus sign, it is relative to the previous tab stop.
1576: The arguments after the
1577: .Cm T
1578: marker are used repeatedly as often as needed; for each reuse,
1579: they are taken relative to the last previously established tab stop.
1580: When
1581: .Ic \&ta
1582: is called without arguments, all tab stops are cleared.
1583: .It Ic \&tc Op Ar glyph
1.75 schwarze 1584: Change tab repetition character.
1.63 schwarze 1585: Currently unsupported.
1.79 schwarze 1586: .It Ic \&TE
1.63 schwarze 1587: End a table context.
1588: See
1589: .Sx \&TS .
1.80 schwarze 1590: .It Ic \&ti Oo Cm + Ns | Ns Cm - Oc Ns Ar width
1591: Break the output line and indent the next output line by
1592: .Ar width .
1593: If a sign is specified, the temporary indentation is calculated
1594: relative to the current indentation; otherwise, it is absolute.
1595: The argument follows the syntax of
1596: .Sx Scaling Widths
1597: and the default scaling unit is
1598: .Cm m .
1.79 schwarze 1599: .It Ic \&tkf Ar font minps width1 maxps width2
1.63 schwarze 1600: Enable track kerning for a font.
1601: Currently ignored.
1.79 schwarze 1602: .It Ic \&tl No \& Ap Ar left Ap Ar center Ap Ar right Ap
1.63 schwarze 1603: Print a title line.
1604: Currently unsupported.
1.79 schwarze 1605: .It Ic \&tm Ar string
1.63 schwarze 1606: Print to standard error output.
1607: Currently ignored.
1.79 schwarze 1608: .It Ic \&tm1 Ar string
1.63 schwarze 1609: Print to standard error output, allowing leading blanks.
1610: This is a groff extension and currently ignored.
1.79 schwarze 1611: .It Ic \&tmc Ar string
1.63 schwarze 1612: Print to standard error output without a trailing newline.
1613: This is a groff extension and currently ignored.
1.79 schwarze 1614: .It Ic \&tr Ar glyph glyph ...
1.6 schwarze 1615: Output character translation.
1.79 schwarze 1616: The first glyph in each pair is replaced by the second one.
1617: Character escapes can be used; for example,
1.30 kristaps 1618: .Pp
1619: .Dl tr \e(xx\e(yy
1620: .Pp
1621: replaces all invocations of \e(xx with \e(yy.
1.79 schwarze 1622: .It Ic \&track Ar font minps width1 maxps width2
1.63 schwarze 1623: Static letter space tracking.
1624: This is a Heirloom extension and currently ignored.
1.79 schwarze 1625: .It Ic \&transchar Ar char ...
1.63 schwarze 1626: Define transparent characters for sentence-ending.
1627: This is a Heirloom extension and currently ignored.
1.79 schwarze 1628: .It Ic \&trf Ar filename
1.63 schwarze 1629: Output the contents of a file, disallowing invalid characters.
1630: This is a groff extension and ignored because insecure.
1.79 schwarze 1631: .It Ic \&trimat Ar left top width height
1.63 schwarze 1632: Set the TrimBox page parameter for PDF generation.
1633: This is a Heirloom extension and currently ignored.
1.79 schwarze 1634: .It Ic \&trin Ar glyph glyph ...
1.63 schwarze 1635: Output character translation, ignored by
1.79 schwarze 1636: .Ic \&asciify .
1.63 schwarze 1637: Currently unsupported.
1.79 schwarze 1638: .It Ic \&trnt Ar glyph glyph ...
1.63 schwarze 1639: Output character translation, ignored by \e!.
1640: Currently unsupported.
1.79 schwarze 1641: .It Ic \&troff
1.63 schwarze 1642: Force troff mode.
1643: This is a groff extension and currently ignored.
1.79 schwarze 1644: .It Ic \&TS
1.20 kristaps 1645: Begin a table, which formats input in aligned rows and columns.
1.23 kristaps 1646: See
1647: .Xr tbl 7
1648: for a description of the tbl language.
1.79 schwarze 1649: .It Ic \&uf Ar font
1.63 schwarze 1650: Globally set the underline font.
1651: Currently ignored.
1.79 schwarze 1652: .It Ic \&ul Op Ar N
1653: Underline next
1654: .Ar N
1655: input lines.
1.63 schwarze 1656: Currently ignored.
1.79 schwarze 1657: .It Ic \&unformat Ar divname
1.63 schwarze 1658: Unformat spaces and tabs in a diversion.
1659: Currently unsupported.
1.79 schwarze 1660: .It Ic \&unwatch Ar macroname
1.63 schwarze 1661: Disable notification for string or macro.
1662: This is a Heirloom extension and currently ignored.
1.79 schwarze 1663: .It Ic \&unwatchn Ar register
1.63 schwarze 1664: Disable notification for register.
1665: This is a Heirloom extension and currently ignored.
1.79 schwarze 1666: .It Ic \&vpt Op Cm 1 | 0
1.63 schwarze 1667: Enable or disable vertical position traps.
1668: This is a groff extension and currently ignored.
1.79 schwarze 1669: .It Ic \&vs Op Oo Cm + Ns | Ns Cm - Oc Ns Ar height
1.63 schwarze 1670: Change vertical spacing.
1671: Currently ignored.
1.79 schwarze 1672: .It Ic \&warn Ar flags
1.63 schwarze 1673: Set warning level.
1674: Currently ignored.
1.79 schwarze 1675: .It Ic \&warnscale Ar si
1.63 schwarze 1676: Set the scaling indicator used in warnings.
1677: This is a groff extension and currently ignored.
1.79 schwarze 1678: .It Ic \&watch Ar macroname
1.63 schwarze 1679: Notify on change of string or macro.
1680: This is a Heirloom extension and currently ignored.
1.79 schwarze 1681: .It Ic \&watchlength Ar maxlength
1.63 schwarze 1682: On change, report the contents of macros and strings
1.75 schwarze 1683: up to the specified length.
1.63 schwarze 1684: This is a Heirloom extension and currently ignored.
1.79 schwarze 1685: .It Ic \&watchn Ar register
1.63 schwarze 1686: Notify on change of register.
1687: This is a Heirloom extension and currently ignored.
1.79 schwarze 1688: .It Ic \&wh Ar dist Op Ar macroname
1.63 schwarze 1689: Set a page location trap.
1690: Currently unsupported.
1.79 schwarze 1691: .It Ic \&while Ar condition body
1.63 schwarze 1692: Repeated execution while a condition is true.
1693: Currently unsupported.
1.79 schwarze 1694: .It Ic \&write Oo \(dq Oc Ns Ar string
1.63 schwarze 1695: Write to an open file.
1696: Ignored because insecure.
1.79 schwarze 1697: .It Ic \&writec Oo \(dq Oc Ns Ar string
1.63 schwarze 1698: Write to an open file without appending a newline.
1699: Ignored because insecure.
1.79 schwarze 1700: .It Ic \&writem Ar macroname
1.63 schwarze 1701: Write macro or string to an open file.
1702: Ignored because insecure.
1.79 schwarze 1703: .It Ic \&xflag Ar level
1.63 schwarze 1704: Set the extension level.
1705: This is a Heirloom extension and currently ignored.
1.79 schwarze 1706: .El
1.53 schwarze 1707: .Ss Numerical expressions
1708: The
1709: .Sx \&nr ,
1710: .Sx \&if ,
1711: and
1712: .Sx \&ie
1713: requests accept integer numerical expressions as arguments.
1714: These are always evaluated using the C
1715: .Vt int
1716: type; integer overflow works the same way as in the C language.
1717: Numbers consist of an arbitrary number of digits
1718: .Sq 0
1719: to
1720: .Sq 9
1721: prefixed by an optional sign
1722: .Sq +
1723: or
1724: .Sq - .
1.67 schwarze 1725: Each number may be followed by one optional scaling unit described below
1726: .Sx Scaling Widths .
1727: The following equations hold:
1728: .Bd -literal -offset indent
1729: 1i = 6v = 6P = 10m = 10n = 72p = 1000M = 240u = 240
1.68 schwarze 1730: 254c = 100i = 24000u = 24000
1.67 schwarze 1731: 1f = 65536u = 65536
1732: .Ed
1.53 schwarze 1733: .Pp
1734: The following binary operators are implemented.
1735: Unless otherwise stated, they behave as in the C language:
1736: .Pp
1737: .Bl -tag -width 2n -compact
1738: .It Ic +
1739: addition
1740: .It Ic -
1741: subtraction
1742: .It Ic *
1743: multiplication
1744: .It Ic /
1745: division
1746: .It Ic %
1747: remainder of division
1748: .It Ic <
1749: less than
1750: .It Ic >
1751: greater than
1752: .It Ic ==
1753: equal to
1754: .It Ic =
1755: equal to, same effect as
1756: .Ic ==
1757: (this differs from C)
1758: .It Ic <=
1759: less than or equal to
1760: .It Ic >=
1761: greater than or equal to
1762: .It Ic <>
1763: not equal to (corresponds to C
1764: .Ic != ;
1765: this one is of limited portability, it is supported by Heirloom roff,
1766: but not by groff)
1767: .It Ic &
1768: logical and (corresponds to C
1769: .Ic && )
1770: .It Ic \&:
1771: logical or (corresponds to C
1772: .Ic \&|| )
1773: .It Ic <?
1774: minimum (not available in C)
1775: .It Ic >?
1776: maximum (not available in C)
1777: .El
1778: .Pp
1.75 schwarze 1779: There is no concept of precedence; evaluation proceeds from left to right,
1.76 schwarze 1780: except when subexpressions are enclosed in parentheses.
1.53 schwarze 1781: Inside parentheses, whitespace is ignored.
1.46 schwarze 1782: .Sh ESCAPE SEQUENCE REFERENCE
1783: The
1784: .Xr mandoc 1
1785: .Nm
1786: parser recognises the following escape sequences.
1787: Note that the
1788: .Nm
1789: language defines more escape sequences not implemented in
1790: .Xr mandoc 1 .
1791: In
1792: .Xr mdoc 7
1793: and
1794: .Xr man 7
1795: documents, using escape sequences is discouraged except for those
1796: described in the
1797: .Sx LANGUAGE SYNTAX
1798: section above.
1799: .Pp
1800: A backslash followed by any character not listed here
1801: simply prints that character itself.
1802: .Ss \e<newline>
1803: A backslash at the end of an input line can be used to continue the
1804: logical input line on the next physical input line, joining the text
1805: on both lines together as if it were on a single input line.
1806: .Ss \e<space>
1807: The escape sequence backslash-space
1808: .Pq Sq \e\ \&
1809: is an unpaddable space-sized non-breaking space character; see
1810: .Sx Whitespace .
1811: .Ss \e\(dq
1812: The rest of the input line is treated as
1813: .Sx Comments .
1814: .Ss \e%
1815: Hyphenation allowed at this point of the word; ignored by
1816: .Xr mandoc 1 .
1817: .Ss \e&
1818: Non-printing zero-width character; see
1819: .Sx Whitespace .
1820: .Ss \e\(aq
1821: Acute accent special character; use
1822: .Sq \e(aa
1823: instead.
1824: .Ss \e( Ns Ar cc
1825: .Sx Special Characters
1826: with two-letter names, see
1827: .Xr mandoc_char 7 .
1828: .Ss \e*[ Ns Ar name ]
1829: Interpolate the string with the
1830: .Ar name ;
1831: see
1832: .Sx Predefined Strings
1833: and
1834: .Sx ds .
1835: For short names, there are variants
1836: .No \e* Ns Ar c
1837: and
1838: .No \e*( Ns Ar cc .
1.74 schwarze 1839: .Ss \e,
1840: Left italic correction (groff extension); ignored by
1841: .Xr mandoc 1 .
1.46 schwarze 1842: .Ss \e-
1843: Special character
1844: .Dq mathematical minus sign .
1.74 schwarze 1845: .Ss \e/
1846: Right italic correction (groff extension); ignored by
1847: .Xr mandoc 1 .
1.46 schwarze 1848: .Ss \e[ Ns Ar name ]
1849: .Sx Special Characters
1850: with names of arbitrary length, see
1851: .Xr mandoc_char 7 .
1852: .Ss \e^
1853: One-twelfth em half-narrow space character, effectively zero-width in
1854: .Xr mandoc 1 .
1855: .Ss \e`
1856: Grave accent special character; use
1857: .Sq \e(ga
1858: instead.
1859: .Ss \e{
1860: Begin conditional input; see
1861: .Sx if .
1862: .Ss \e\(ba
1863: One-sixth em narrow space character, effectively zero-width in
1864: .Xr mandoc 1 .
1865: .Ss \e}
1866: End conditional input; see
1867: .Sx if .
1868: .Ss \e~
1869: Paddable non-breaking space character.
1870: .Ss \e0
1871: Digit width space character.
1872: .Ss \eA\(aq Ns Ar string Ns \(aq
1873: Anchor definition; ignored by
1874: .Xr mandoc 1 .
1875: .Ss \eB\(aq Ns Ar string Ns \(aq
1.54 schwarze 1876: Interpolate
1877: .Sq 1
1878: if
1.46 schwarze 1879: .Ar string
1.54 schwarze 1880: conforms to the syntax of
1881: .Sx Numerical expressions
1882: explained above and
1883: .Sq 0
1884: otherwise.
1.46 schwarze 1885: .Ss \eb\(aq Ns Ar string Ns \(aq
1886: Bracket building function; ignored by
1887: .Xr mandoc 1 .
1888: .Ss \eC\(aq Ns Ar name Ns \(aq
1889: .Sx Special Characters
1890: with names of arbitrary length.
1891: .Ss \ec
1.60 schwarze 1892: When encountered at the end of an input text line,
1893: the next input text line is considered to continue that line,
1894: even if there are request or macro lines in between.
1895: No whitespace is inserted.
1.46 schwarze 1896: .Ss \eD\(aq Ns Ar string Ns \(aq
1897: Draw graphics function; ignored by
1898: .Xr mandoc 1 .
1899: .Ss \ed
1900: Move down by half a line; ignored by
1901: .Xr mandoc 1 .
1902: .Ss \ee
1903: Backslash special character.
1904: .Ss \eF[ Ns Ar name ]
1905: Switch font family (groff extension); ignored by
1906: .Xr mandoc 1 .
1907: For short names, there are variants
1908: .No \eF Ns Ar c
1909: and
1910: .No \eF( Ns Ar cc .
1911: .Ss \ef[ Ns Ar name ]
1912: Switch to the font
1913: .Ar name ,
1914: see
1915: .Sx Text Decoration .
1916: For short names, there are variants
1917: .No \ef Ns Ar c
1918: and
1919: .No \ef( Ns Ar cc .
1920: .Ss \eg[ Ns Ar name ]
1921: Interpolate the format of a number register; ignored by
1922: .Xr mandoc 1 .
1923: For short names, there are variants
1924: .No \eg Ns Ar c
1925: and
1926: .No \eg( Ns Ar cc .
1927: .Ss \eH\(aq Ns Oo +|- Oc Ns Ar number Ns \(aq
1928: Set the height of the current font; ignored by
1929: .Xr mandoc 1 .
1.81 schwarze 1930: .Ss \eh\(aq Ns Ar width Ns \(aq
1931: Horizontal motion relative to the current position.
1932: The default scaling unit is
1933: .Cm m .
1.46 schwarze 1934: .Ss \ek[ Ns Ar name ]
1935: Mark horizontal input place in register; ignored by
1936: .Xr mandoc 1 .
1937: For short names, there are variants
1938: .No \ek Ns Ar c
1939: and
1940: .No \ek( Ns Ar cc .
1941: .Ss \eL\(aq Ns Ar number Ns Oo Ar c Oc Ns \(aq
1942: Vertical line drawing function; ignored by
1943: .Xr mandoc 1 .
1.82 schwarze 1944: .Ss \el\(aq Ns Ar width Ns Oo Ar c Oc Ns \(aq
1945: Draw a horizontal line of
1946: .Ar width
1947: using the glyph
1948: .Ar c .
1.46 schwarze 1949: .Ss \eM[ Ns Ar name ]
1950: Set fill (background) color (groff extension); ignored by
1951: .Xr mandoc 1 .
1952: For short names, there are variants
1953: .No \eM Ns Ar c
1954: and
1955: .No \eM( Ns Ar cc .
1956: .Ss \em[ Ns Ar name ]
1957: Set glyph drawing color (groff extension); ignored by
1958: .Xr mandoc 1 .
1959: For short names, there are variants
1960: .No \em Ns Ar c
1961: and
1962: .No \em( Ns Ar cc .
1963: .Ss \eN\(aq Ns Ar number Ns \(aq
1964: Character
1965: .Ar number
1966: on the current font.
1967: .Ss \en[ Ns Ar name ]
1968: Interpolate the number register
1969: .Ar name .
1970: For short names, there are variants
1971: .No \en Ns Ar c
1972: and
1973: .No \en( Ns Ar cc .
1974: .Ss \eo\(aq Ns Ar string Ns \(aq
1.66 schwarze 1975: Overstrike, writing all the characters contained in the
1.65 schwarze 1976: .Ar string
1977: to the same output position.
1978: In terminal and HTML output modes,
1979: only the last one of the characters is visible.
1.46 schwarze 1980: .Ss \eR\(aq Ns Ar name Oo +|- Oc Ns Ar number Ns \(aq
1981: Set number register; ignored by
1982: .Xr mandoc 1 .
1983: .Ss \eS\(aq Ns Ar number Ns \(aq
1984: Slant output; ignored by
1985: .Xr mandoc 1 .
1986: .Ss \es\(aq Ns Oo +|- Oc Ns Ar number Ns \(aq
1987: Change point size; ignored by
1988: .Xr mandoc 1 .
1989: Alternative forms
1990: .No \es Ns Oo +|- Oc Ns Ar n ,
1991: .No \es Ns Oo +|- Oc Ns \(aq Ns Ar number Ns \(aq ,
1992: .No \es Ns [ Oo +|- Oc Ns Ar number ] ,
1993: and
1994: .No \es Ns Oo +|- Oc Ns [ Ar number Ns ]
1995: are also parsed and ignored.
1996: .Ss \et
1997: Horizontal tab; ignored by
1998: .Xr mandoc 1 .
1999: .Ss \eu
2000: Move up by half a line; ignored by
2001: .Xr mandoc 1 .
2002: .Ss \eV[ Ns Ar name ]
2003: Interpolate an environment variable; ignored by
2004: .Xr mandoc 1 .
2005: For short names, there are variants
2006: .No \eV Ns Ar c
2007: and
2008: .No \eV( Ns Ar cc .
2009: .Ss \ev\(aq Ns Ar number Ns \(aq
2010: Vertical motion; ignored by
2011: .Xr mandoc 1 .
2012: .Ss \ew\(aq Ns Ar string Ns \(aq
2013: Interpolate the width of the
1.54 schwarze 2014: .Ar string .
2015: The
2016: .Xr mandoc 1
2017: implementation assumes that after expansion of user-defined strings, the
2018: .Ar string
2019: only contains normal characters, no escape sequences, and that each
2020: character has a width of 24 basic units.
1.46 schwarze 2021: .Ss \eX\(aq Ns Ar string Ns \(aq
2022: Output
2023: .Ar string
2024: as device control function; ignored in nroff mode and by
2025: .Xr mandoc 1 .
2026: .Ss \ex\(aq Ns Ar number Ns \(aq
2027: Extra line space function; ignored by
2028: .Xr mandoc 1 .
2029: .Ss \eY[ Ns Ar name ]
2030: Output a string as a device control function; ignored in nroff mode and by
2031: .Xr mandoc 1 .
2032: For short names, there are variants
2033: .No \eY Ns Ar c
2034: and
2035: .No \eY( Ns Ar cc .
2036: .Ss \eZ\(aq Ns Ar string Ns \(aq
2037: Print
2038: .Ar string
2039: with zero width and height; ignored by
2040: .Xr mandoc 1 .
2041: .Ss \ez
1.71 schwarze 2042: Output the next character without advancing the cursor position.
1.2 kristaps 2043: .Sh COMPATIBILITY
1.69 schwarze 2044: The
2045: .Xr mandoc 1
2046: implementation of the
1.17 schwarze 2047: .Nm
1.69 schwarze 2048: language is intentionally incomplete.
2049: Unimplemented features include:
1.2 kristaps 2050: .Pp
2051: .Bl -dash -compact
1.56 kristaps 2052: .It
1.69 schwarze 2053: For security reasons,
2054: .Xr mandoc 1
2055: never reads or writes external files except via
2056: .Sx \&so
2057: requests with safe relative paths.
2058: .It
2059: There is no automatic hyphenation, no adjustment to the right margin,
2060: and no centering; the output is always set flush-left.
2061: .It
2062: Support for setting tabulator positions
2063: and tabulator and leader characters is missing,
2064: and support for manually changing indentation is limited.
2065: .It
1.56 kristaps 2066: The
2067: .Sq u
2068: scaling unit is the default terminal unit.
1.69 schwarze 2069: In traditional troff systems, this unit changes depending on the
1.56 kristaps 2070: output media.
1.10 kristaps 2071: .It
1.69 schwarze 2072: Width measurements are implemented in a crude way
2073: and often yield wrong results.
2074: Explicit movement requests and escapes are ignored.
2075: .It
2076: There is no concept of output pages, no support for floats,
2077: graphics drawing, and picture inclusion;
2078: terminal output is always continuous.
2079: .It
2080: Requests regarding color, font families, and glyph manipulation
2081: are ignored.
2082: Font support is very limited.
2083: Kerning is not implemented, and no ligatures are produced.
1.27 kristaps 2084: .It
1.10 kristaps 2085: The
1.69 schwarze 2086: .Qq \(aq
2087: macro control character does not suppress output line breaks.
1.2 kristaps 2088: .It
1.69 schwarze 2089: Diversions are not implemented,
2090: and support for traps is very incomplete.
1.4 kristaps 2091: .It
1.69 schwarze 2092: While recursion is supported,
2093: .Sx \&while
2094: loops are not.
1.2 kristaps 2095: .El
1.69 schwarze 2096: .Pp
2097: The special semantics of the
2098: .Cm nS
2099: number register is an idiosyncracy of
2100: .Ox
2101: manuals and not supported by other
2102: .Xr mdoc 7
2103: implementations.
1.17 schwarze 2104: .Sh SEE ALSO
2105: .Xr mandoc 1 ,
1.27 kristaps 2106: .Xr eqn 7 ,
1.17 schwarze 2107: .Xr man 7 ,
2108: .Xr mandoc_char 7 ,
1.23 kristaps 2109: .Xr mdoc 7 ,
2110: .Xr tbl 7
1.17 schwarze 2111: .Rs
2112: .%A Joseph F. Ossanna
2113: .%A Brian W. Kernighan
2114: .%I AT&T Bell Laboratories
2115: .%T Troff User's Manual
2116: .%R Computing Science Technical Report
2117: .%N 54
2118: .%C Murray Hill, New Jersey
2119: .%D 1976 and 1992
2120: .%U http://www.kohala.com/start/troff/cstr54.ps
2121: .Re
2122: .Rs
2123: .%A Joseph F. Ossanna
2124: .%A Brian W. Kernighan
2125: .%A Gunnar Ritter
2126: .%T Heirloom Documentation Tools Nroff/Troff User's Manual
2127: .%D September 17, 2007
2128: .%U http://heirloom.sourceforge.net/doctools/troff.pdf
2129: .Re
2130: .Sh HISTORY
1.35 kristaps 2131: The RUNOFF typesetting system, whose input forms the basis for
1.17 schwarze 2132: .Nm ,
1.35 kristaps 2133: was written in MAD and FAP for the CTSS operating system by Jerome E.
2134: Saltzer in 1964.
2135: Doug McIlroy rewrote it in BCPL in 1969, renaming it
2136: .Nm .
2137: Dennis M. Ritchie rewrote McIlroy's
1.36 schwarze 2138: .Nm
2139: in PDP-11 assembly for
1.35 kristaps 2140: .At v1 ,
2141: Joseph F. Ossanna improved roff and renamed it nroff
2142: for
2143: .At v2 ,
2144: then ported nroff to C as troff, which Brian W. Kernighan released with
2145: .At v7 .
2146: In 1989, James Clarke re-implemented troff in C++, naming it groff.
1.1 kristaps 2147: .Sh AUTHORS
1.15 kristaps 2148: .An -nosplit
1.31 kristaps 2149: This
1.1 kristaps 2150: .Nm
2151: reference was written by
1.41 schwarze 2152: .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv
1.15 kristaps 2153: and
1.41 schwarze 2154: .An Ingo Schwarze Aq Mt schwarze@openbsd.org .
CVSweb
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to roff.7 CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc