Annotation of mandoc/roff.7, Revision 1.60
1.60 ! schwarze 1: .\" $Id: roff.7,v 1.59 2014/11/19 01:20:25 schwarze Exp $
1.1 kristaps 2: .\"
1.46 schwarze 3: .\" Copyright (c) 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
1.47 schwarze 4: .\" Copyright (c) 2010, 2011, 2013, 2014 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.60 ! schwarze 18: .Dd $Mdocdate: November 19 2014 $
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.17 schwarze 398: Note that the
1.15 kristaps 399: .Nm
1.17 schwarze 400: language defines many more requests not implemented in
1.15 kristaps 401: .Xr mandoc 1 .
402: .Ss \&ad
403: Set line adjustment mode.
404: This line-scoped request is intended to have one argument to select
1.32 kristaps 405: normal, left, right, or centre adjustment for subsequent text.
1.15 kristaps 406: Currently, it is ignored including its arguments,
407: and the number of arguments is not checked.
1.3 kristaps 408: .Ss \&am
1.15 kristaps 409: Append to a macro definition.
410: The syntax of this request is the same as that of
411: .Sx \&de .
1.3 kristaps 412: .Ss \&ami
1.15 kristaps 413: Append to a macro definition, specifying the macro name indirectly.
414: The syntax of this request is the same as that of
415: .Sx \&dei .
1.3 kristaps 416: .Ss \&am1
1.15 kristaps 417: Append to a macro definition, switching roff compatibility mode off
418: during macro execution.
419: The syntax of this request is the same as that of
420: .Sx \&de1 .
1.55 schwarze 421: Since
422: .Xr mandoc 1
423: does not implement
424: .Nm
425: compatibility mode at all, it handles this request as an alias for
426: .Sx \&am .
1.47 schwarze 427: .Ss \&as
428: Append to a user-defined string.
429: The syntax of this request is the same as that of
430: .Sx \&ds .
431: If a user-defined string with the specified name does not yet exist,
432: it is set to the empty string before appending.
1.39 kristaps 433: .Ss \&cc
434: Changes the control character.
435: Its syntax is as follows:
436: .Bd -literal -offset indent
437: .Pf . Cm \&cc Op Ar c
438: .Ed
439: .Pp
440: If
441: .Ar c
442: is not specified, the control character is reset to
443: .Sq \&. .
444: Trailing characters are ignored.
1.47 schwarze 445: .Ss \&ce
446: Center some lines.
447: This line-scoped request is intended to take one integer argument,
448: specifying how many lines to center.
449: Currently, it is ignored including its arguments, and the number
450: of arguments is not checked.
1.3 kristaps 451: .Ss \&de
1.17 schwarze 452: Define a
1.15 kristaps 453: .Nm
454: macro.
455: Its syntax can be either
456: .Bd -literal -offset indent
457: .Pf . Cm \&de Ar name
458: .Ar macro definition
459: \&..
460: .Ed
461: .Pp
462: or
463: .Bd -literal -offset indent
464: .Pf . Cm \&de Ar name Ar end
465: .Ar macro definition
466: .Pf . Ar end
467: .Ed
468: .Pp
469: Both forms define or redefine the macro
470: .Ar name
471: to represent the
472: .Ar macro definition ,
473: which may consist of one or more input lines, including the newline
474: characters terminating each line, optionally containing calls to
475: .Nm
476: requests,
477: .Nm
478: macros or high-level macros like
479: .Xr man 7
480: or
481: .Xr mdoc 7
482: macros, whichever applies to the document in question.
483: .Pp
484: Specifying a custom
485: .Ar end
486: macro works in the same way as for
487: .Sx \&ig ;
488: namely, the call to
489: .Sq Pf . Ar end
490: first ends the
491: .Ar macro definition ,
492: and after that, it is also evaluated as a
493: .Nm
494: request or
495: .Nm
496: macro, but not as a high-level macro.
497: .Pp
1.17 schwarze 498: The macro can be invoked later using the syntax
1.15 kristaps 499: .Pp
500: .D1 Pf . Ar name Op Ar argument Op Ar argument ...
501: .Pp
1.24 schwarze 502: Regarding argument parsing, see
503: .Sx MACRO SYNTAX
504: above.
1.15 kristaps 505: .Pp
1.17 schwarze 506: The line invoking the macro will be replaced
1.15 kristaps 507: in the input stream by the
508: .Ar macro definition ,
509: replacing all occurrences of
510: .No \e\e$ Ns Ar N ,
1.17 schwarze 511: where
1.15 kristaps 512: .Ar N
513: is a digit, by the
514: .Ar N Ns th Ar argument .
515: For example,
516: .Bd -literal -offset indent
517: \&.de ZN
518: \efI\e^\e\e$1\e^\efP\e\e$2
519: \&..
520: \&.ZN XtFree .
521: .Ed
522: .Pp
523: produces
524: .Pp
525: .D1 \efI\e^XtFree\e^\efP.
526: .Pp
527: in the input stream, and thus in the output: \fI\^XtFree\^\fP.
528: .Pp
1.17 schwarze 529: Since macros and user-defined strings share a common string table,
1.15 kristaps 530: defining a macro
531: .Ar name
532: clobbers the user-defined string
533: .Ar name ,
534: and the
535: .Ar macro definition
536: can also be printed using the
537: .Sq \e*
538: string interpolation syntax described below
539: .Sx ds ,
540: but this is rarely useful because every macro definition contains at least
541: one explicit newline character.
1.16 schwarze 542: .Pp
543: In order to prevent endless recursion, both groff and
544: .Xr mandoc 1
545: limit the stack depth for expanding macros and strings
546: to a large, but finite number.
547: Do not rely on the exact value of this limit.
1.3 kristaps 548: .Ss \&dei
1.17 schwarze 549: Define a
1.15 kristaps 550: .Nm
551: macro, specifying the macro name indirectly.
1.17 schwarze 552: The syntax of this request is the same as that of
1.15 kristaps 553: .Sx \&de .
1.55 schwarze 554: The request
555: .Pp
556: .D1 Pf . Cm \&dei Ar name Op Ar end
557: .Pp
558: has the same effect as:
559: .Pp
560: .D1 Pf . Cm \&de No \e* Ns Bo Ar name Bc Op \e* Ns Bq Ar end
1.15 kristaps 561: .Ss \&de1
1.17 schwarze 562: Define a
1.15 kristaps 563: .Nm
564: macro that will be executed with
565: .Nm
566: compatibility mode switched off during macro execution.
567: This is a GNU extension not available in traditional
568: .Nm
569: implementations and not even in older versions of groff.
570: Since
571: .Xr mandoc 1
572: does not implement
573: .Nm
1.17 schwarze 574: compatibility mode at all, it handles this request as an alias for
1.15 kristaps 575: .Sx \&de .
1.6 schwarze 576: .Ss \&ds
1.15 kristaps 577: Define a user-defined string.
1.13 kristaps 578: Its syntax is as follows:
579: .Pp
1.15 kristaps 580: .D1 Pf . Cm \&ds Ar name Oo \(dq Oc Ns Ar string
1.13 kristaps 581: .Pp
582: The
1.15 kristaps 583: .Ar name
1.13 kristaps 584: and
1.15 kristaps 585: .Ar string
586: arguments are space-separated.
587: If the
588: .Ar string
589: begins with a double-quote character, that character will not be part
590: of the string.
591: All remaining characters on the input line form the
592: .Ar string ,
593: including whitespace and double-quote characters, even trailing ones.
594: .Pp
1.13 kristaps 595: The
1.15 kristaps 596: .Ar string
597: can be interpolated into subsequent text by using
598: .No \e* Ns Bq Ar name
599: for a
600: .Ar name
601: of arbitrary length, or \e*(NN or \e*N if the length of
602: .Ar name
603: is two or one characters, respectively.
1.17 schwarze 604: Interpolation can be prevented by escaping the leading backslash;
605: that is, an asterisk preceded by an even number of backslashes
606: does not trigger string interpolation.
1.15 kristaps 607: .Pp
608: Since user-defined strings and macros share a common string table,
609: defining a string
610: .Ar name
1.17 schwarze 611: clobbers the macro
1.15 kristaps 612: .Ar name ,
613: and the
614: .Ar name
615: used for defining a string can also be invoked as a macro,
616: in which case the following input line will be appended to the
617: .Ar string ,
618: forming a new input line passed to the
619: .Nm
620: parser.
621: For example,
622: .Bd -literal -offset indent
623: \&.ds badidea .S
624: \&.badidea
625: H SYNOPSIS
626: .Ed
627: .Pp
628: invokes the
629: .Cm SH
630: macro when used in a
631: .Xr man 7
632: document.
633: Such abuse is of course strongly discouraged.
1.5 kristaps 634: .Ss \&el
635: The
636: .Qq else
637: half of an if/else conditional.
638: Pops a result off the stack of conditional evaluations pushed by
639: .Sx \&ie
640: and uses it as its conditional.
641: If no stack entries are present (e.g., due to no prior
642: .Sx \&ie
643: calls)
644: then false is assumed.
1.17 schwarze 645: The syntax of this request is similar to
1.5 kristaps 646: .Sx \&if
647: except that the conditional is missing.
1.27 kristaps 648: .Ss \&EN
649: End an equation block.
650: See
651: .Sx \&EQ .
652: .Ss \&EQ
653: Begin an equation block.
654: See
655: .Xr eqn 7
656: for a description of the equation language.
1.43 schwarze 657: .Ss \&fam
658: Change the font family.
659: This line-scoped request is intended to have one argument specifying
660: the font family to be selected.
661: It is a groff extension, and currently, it is ignored including its
662: arguments, and the number of arguments is not checked.
1.49 schwarze 663: .Ss \&ft
664: Change the font.
665: Its syntax is as follows:
666: .Pp
667: .D1 Pf . Cm \&ft Op Ar font
668: .Pp
669: The following
670: .Ar font
671: arguments are supported:
672: .Bl -tag -width 4n -offset indent
673: .It Cm B , BI , 3 , 4
674: switches to
675: .Sy bold
676: font
677: .It Cm I , 2
678: switches to
679: .Em underlined
680: font
681: .It Cm R , CW , 1
682: switches to normal font
683: .It Cm P No "or no argument"
684: switches back to the previous font
685: .El
686: .Pp
687: This request takes effect only locally, may be overridden by macros
688: and escape sequences, and is only supported in
689: .Xr man 7
690: for now.
1.44 schwarze 691: .Ss \&hw
692: Specify hyphenation points in words.
693: This line-scoped request is currently ignored.
1.15 kristaps 694: .Ss \&hy
695: Set automatic hyphenation mode.
696: This line-scoped request is currently ignored.
1.5 kristaps 697: .Ss \&ie
698: The
699: .Qq if
700: half of an if/else conditional.
701: The result of the conditional is pushed into a stack used by subsequent
702: invocations of
703: .Sx \&el ,
704: which may be separated by any intervening input (or not exist at all).
705: Its syntax is equivalent to
706: .Sx \&if .
1.1 kristaps 707: .Ss \&if
1.7 schwarze 708: Begins a conditional.
1.48 schwarze 709: This request has the following syntax:
710: .Bd -literal -offset indent
711: \&.if COND BODY
712: .Ed
713: .Bd -literal -offset indent
714: \&.if COND \e{BODY
715: BODY...\e}
716: .Ed
717: .Bd -literal -offset indent
718: \&.if COND \e{\e
719: BODY...
720: \&.\e}
721: .Ed
722: .Pp
723: COND is a conditional statement.
724: Currently,
725: .Xr mandoc 1
726: supports the following subset of roff conditionals:
727: .Bl -bullet
728: .It
729: If
730: .Sq \&!
731: is prefixed to COND, the condition is logically inverted.
732: .It
733: If the first character of COND is
734: .Sq n
735: .Pq nroff mode
736: or
737: .Sq o
738: .Pq odd page ,
739: COND evaluates to true.
740: .It
741: If the first character of COND is
742: .Sq c
743: .Pq character available ,
744: .Sq d
745: .Pq string defined ,
746: .Sq e
747: .Pq even page ,
748: .Sq r
749: .Pq register accessed ,
750: .Sq t
751: .Pq troff mode ,
1.59 schwarze 752: or
753: .Sq v
754: .Pq vroff mode ,
1.48 schwarze 755: COND evaluates to false.
756: .It
1.53 schwarze 757: If COND starts with a parenthesis or with an optionally signed
758: integer number, it is evaluated according to the rules of
759: .Sx Numerical expressions
760: explained below.
1.57 schwarze 761: It evaluates to true if the result is positive,
1.53 schwarze 762: or to false if the result is zero or negative.
1.48 schwarze 763: .It
764: Otherwise, the first character of COND is regarded as a delimiter
765: and COND evaluates to true if the string extending from its first
766: to its second occurrence is equal to the string extending from its
767: second to its third occurrence.
768: .It
769: If COND cannot be parsed, it evaluates to false.
770: .El
771: .Pp
1.3 kristaps 772: If a conditional is false, its children are not processed, but are
773: syntactically interpreted to preserve the integrity of the input
774: document.
775: Thus,
776: .Pp
1.17 schwarze 777: .D1 \&.if t .ig
1.3 kristaps 778: .Pp
779: will discard the
780: .Sq \&.ig ,
781: which may lead to interesting results, but
782: .Pp
1.17 schwarze 783: .D1 \&.if t .if t \e{\e
1.3 kristaps 784: .Pp
785: will continue to syntactically interpret to the block close of the final
786: conditional.
787: Sub-conditionals, in this case, obviously inherit the truth value of
788: the parent.
1.1 kristaps 789: .Pp
790: If the BODY section is begun by an escaped brace
791: .Sq \e{ ,
1.48 schwarze 792: scope continues until the end of the input line containing the
793: matching closing-brace escape sequence
794: .Sq \e} .
1.17 schwarze 795: If the BODY is not enclosed in braces, scope continues until
796: the end of the line.
1.1 kristaps 797: If the COND is followed by a BODY on the same line, whether after a
1.17 schwarze 798: brace or not, then requests and macros
1.1 kristaps 799: .Em must
800: begin with a control character.
801: It is generally more intuitive, in this case, to write
802: .Bd -literal -offset indent
803: \&.if COND \e{\e
804: \&.foo
805: bar
806: \&.\e}
807: .Ed
808: .Pp
1.17 schwarze 809: than having the request or macro follow as
1.1 kristaps 810: .Pp
811: .D1 \&.if COND \e{ .foo
812: .Pp
813: The scope of a conditional is always parsed, but only executed if the
814: conditional evaluates to true.
815: .Pp
1.29 kristaps 816: Note that the
1.1 kristaps 817: .Sq \e}
1.29 kristaps 818: is converted into a zero-width escape sequence if not passed as a
819: standalone macro
820: .Sq \&.\e} .
821: For example,
822: .Pp
823: .D1 \&.Fl a \e} b
824: .Pp
825: will result in
1.8 kristaps 826: .Sq \e}
1.29 kristaps 827: being considered an argument of the
828: .Sq \&Fl
829: macro.
1.1 kristaps 830: .Ss \&ig
1.2 kristaps 831: Ignore input.
1.15 kristaps 832: Its syntax can be either
833: .Bd -literal -offset indent
834: .Pf . Cm \&ig
835: .Ar ignored text
1.2 kristaps 836: \&..
837: .Ed
1.15 kristaps 838: .Pp
839: or
840: .Bd -literal -offset indent
841: .Pf . Cm \&ig Ar end
842: .Ar ignored text
843: .Pf . Ar end
1.2 kristaps 844: .Ed
845: .Pp
846: In the first case, input is ignored until a
847: .Sq \&..
1.17 schwarze 848: request is encountered on its own line.
1.15 kristaps 849: In the second case, input is ignored until the specified
850: .Sq Pf . Ar end
851: macro is encountered.
852: Do not use the escape character
1.2 kristaps 853: .Sq \e
1.15 kristaps 854: anywhere in the definition of
855: .Ar end ;
856: it would cause very strange behaviour.
857: .Pp
858: When the
859: .Ar end
860: macro is a roff request or a roff macro, like in
1.2 kristaps 861: .Pp
862: .D1 \&.ig if
863: .Pp
864: the subsequent invocation of
865: .Sx \&if
1.15 kristaps 866: will first terminate the
867: .Ar ignored text ,
868: then be invoked as usual.
869: Otherwise, it only terminates the
870: .Ar ignored text ,
871: and arguments following it or the
872: .Sq \&..
1.17 schwarze 873: request are discarded.
1.50 schwarze 874: .Ss \&ll
875: Change the output line length.
876: Its syntax is as follows:
877: .Pp
1.51 schwarze 878: .D1 Pf . Cm \&ll Op Oo +|- Oc Ns Ar width
1.50 schwarze 879: .Pp
880: If the
881: .Ar width
882: argument is omitted, the line length is reset to its previous value.
883: The default setting for terminal output is 78n.
1.51 schwarze 884: If a sign is given, the line length is added to or subtracted from;
885: otherwise, it is set to the provided value.
1.50 schwarze 886: Using this request in new manuals is discouraged for several reasons,
887: among others because it overrides the
888: .Xr mandoc 1
889: .Fl O Cm width
890: command line option.
1.15 kristaps 891: .Ss \&ne
892: Declare the need for the specified minimum vertical space
893: before the next trap or the bottom of the page.
894: This line-scoped request is currently ignored.
895: .Ss \&nh
896: Turn off automatic hyphenation mode.
897: This line-scoped request is currently ignored.
1.10 kristaps 898: .Ss \&nr
1.45 schwarze 899: Define or change a register.
1.10 kristaps 900: A register is an arbitrary string value that defines some sort of state,
901: which influences parsing and/or formatting.
902: Its syntax is as follows:
903: .Pp
1.53 schwarze 904: .D1 Pf \. Cm \&nr Ar name Oo +|- Oc Ns Ar expression
1.10 kristaps 905: .Pp
1.53 schwarze 906: For the syntax of
907: .Ar expression ,
908: see
909: .Sx Numerical expressions
910: below.
1.46 schwarze 911: If it is prefixed by a sign, the register will be
1.45 schwarze 912: incremented or decremented instead of assigned to.
913: .Pp
914: The following register
1.15 kristaps 915: .Ar name
1.45 schwarze 916: is handled specially:
1.10 kristaps 917: .Bl -tag -width Ds
918: .It Cm nS
919: If set to a positive integer value, certain
920: .Xr mdoc 7
1.17 schwarze 921: macros will behave in the same way as in the
1.10 kristaps 922: .Em SYNOPSIS
1.11 kristaps 923: section.
1.17 schwarze 924: If set to 0, these macros will behave in the same way as outside the
925: .Em SYNOPSIS
926: section, even when called within the
1.10 kristaps 927: .Em SYNOPSIS
1.17 schwarze 928: section itself.
929: Note that starting a new
1.11 kristaps 930: .Xr mdoc 7
1.17 schwarze 931: section with the
932: .Cm \&Sh
933: macro will reset this register.
1.10 kristaps 934: .El
1.26 schwarze 935: .Ss \&ns
936: Turn on no-space mode.
937: This line-scoped request is intended to take no arguments.
1.58 schwarze 938: Currently, it is ignored including its arguments,
939: and the number of arguments is not checked.
940: .Ss \&pl
941: Change page length.
942: This line-scoped request is intended to take one height argument.
1.26 schwarze 943: Currently, it is ignored including its arguments,
944: and the number of arguments is not checked.
945: .Ss \&ps
946: Change point size.
947: This line-scoped request is intended to take one numerical argument.
948: Currently, it is ignored including its arguments,
949: and the number of arguments is not checked.
1.52 schwarze 950: .Ss \&rm
951: Remove a request, macro or string.
952: Its syntax is as follows:
953: .Pp
954: .D1 Pf \. Cm \&rm Ar name
955: .Ss \&rr
956: Remove a register.
957: Its syntax is as follows:
958: .Pp
959: .D1 Pf \. Cm \&rr Ar name
1.15 kristaps 960: .Ss \&so
961: Include a source file.
962: Its syntax is as follows:
963: .Pp
964: .D1 Pf \. Cm \&so Ar file
965: .Pp
966: The
967: .Ar file
968: will be read and its contents processed as input in place of the
969: .Sq \&.so
970: request line.
1.28 kristaps 971: To avoid inadvertent inclusion of unrelated files,
1.15 kristaps 972: .Xr mandoc 1
973: only accepts relative paths not containing the strings
974: .Qq ../
975: and
976: .Qq /.. .
1.37 schwarze 977: .Pp
978: This request requires
979: .Xr man 1
980: to change to the right directory before calling
981: .Xr mandoc 1 ,
982: per convention to the root of the manual tree.
983: Typical usage looks like:
984: .Pp
985: .Dl \&.so man3/Xcursor.3
986: .Pp
987: As the whole concept is rather fragile, the use of
988: .Sx \&so
989: is discouraged.
990: Use
991: .Xr ln 1
992: instead.
1.26 schwarze 993: .Ss \&ta
994: Set tab stops.
995: This line-scoped request can take an arbitrary number of arguments.
996: Currently, it is ignored including its arguments.
1.6 schwarze 997: .Ss \&tr
998: Output character translation.
1.30 kristaps 999: Its syntax is as follows:
1000: .Pp
1001: .D1 Pf \. Cm \&tr Ar [ab]+
1002: .Pp
1003: Pairs of
1004: .Ar ab
1005: characters are replaced
1006: .Ar ( a
1007: for
1008: .Ar b ) .
1009: Replacement (or origin) characters may also be character escapes; thus,
1010: .Pp
1011: .Dl tr \e(xx\e(yy
1012: .Pp
1013: replaces all invocations of \e(xx with \e(yy.
1.20 kristaps 1014: .Ss \&T&
1015: Re-start a table layout, retaining the options of the prior table
1016: invocation.
1017: See
1018: .Sx \&TS .
1019: .Ss \&TE
1020: End a table context.
1021: See
1022: .Sx \&TS .
1023: .Ss \&TS
1024: Begin a table, which formats input in aligned rows and columns.
1.23 kristaps 1025: See
1026: .Xr tbl 7
1027: for a description of the tbl language.
1.53 schwarze 1028: .Ss Numerical expressions
1029: The
1030: .Sx \&nr ,
1031: .Sx \&if ,
1032: and
1033: .Sx \&ie
1034: requests accept integer numerical expressions as arguments.
1035: These are always evaluated using the C
1036: .Vt int
1037: type; integer overflow works the same way as in the C language.
1038: Numbers consist of an arbitrary number of digits
1039: .Sq 0
1040: to
1041: .Sq 9
1042: prefixed by an optional sign
1043: .Sq +
1044: or
1045: .Sq - .
1046: .Pp
1047: The following binary operators are implemented.
1048: Unless otherwise stated, they behave as in the C language:
1049: .Pp
1050: .Bl -tag -width 2n -compact
1051: .It Ic +
1052: addition
1053: .It Ic -
1054: subtraction
1055: .It Ic *
1056: multiplication
1057: .It Ic /
1058: division
1059: .It Ic %
1060: remainder of division
1061: .It Ic <
1062: less than
1063: .It Ic >
1064: greater than
1065: .It Ic ==
1066: equal to
1067: .It Ic =
1068: equal to, same effect as
1069: .Ic ==
1070: (this differs from C)
1071: .It Ic <=
1072: less than or equal to
1073: .It Ic >=
1074: greater than or equal to
1075: .It Ic <>
1076: not equal to (corresponds to C
1077: .Ic != ;
1078: this one is of limited portability, it is supported by Heirloom roff,
1079: but not by groff)
1080: .It Ic &
1081: logical and (corresponds to C
1082: .Ic && )
1083: .It Ic \&:
1084: logical or (corresponds to C
1085: .Ic \&|| )
1086: .It Ic <?
1087: minimum (not available in C)
1088: .It Ic >?
1089: maximum (not available in C)
1090: .El
1091: .Pp
1092: There is no concept of precendence; evaluation proceeds from left to right,
1093: except when subexpressions are enclosed in parantheses.
1094: Inside parentheses, whitespace is ignored.
1.46 schwarze 1095: .Sh ESCAPE SEQUENCE REFERENCE
1096: The
1097: .Xr mandoc 1
1098: .Nm
1099: parser recognises the following escape sequences.
1100: Note that the
1101: .Nm
1102: language defines more escape sequences not implemented in
1103: .Xr mandoc 1 .
1104: In
1105: .Xr mdoc 7
1106: and
1107: .Xr man 7
1108: documents, using escape sequences is discouraged except for those
1109: described in the
1110: .Sx LANGUAGE SYNTAX
1111: section above.
1112: .Pp
1113: A backslash followed by any character not listed here
1114: simply prints that character itself.
1115: .Ss \e<newline>
1116: A backslash at the end of an input line can be used to continue the
1117: logical input line on the next physical input line, joining the text
1118: on both lines together as if it were on a single input line.
1119: .Ss \e<space>
1120: The escape sequence backslash-space
1121: .Pq Sq \e\ \&
1122: is an unpaddable space-sized non-breaking space character; see
1123: .Sx Whitespace .
1124: .Ss \e\(dq
1125: The rest of the input line is treated as
1126: .Sx Comments .
1127: .Ss \e%
1128: Hyphenation allowed at this point of the word; ignored by
1129: .Xr mandoc 1 .
1130: .Ss \e&
1131: Non-printing zero-width character; see
1132: .Sx Whitespace .
1133: .Ss \e\(aq
1134: Acute accent special character; use
1135: .Sq \e(aa
1136: instead.
1137: .Ss \e( Ns Ar cc
1138: .Sx Special Characters
1139: with two-letter names, see
1140: .Xr mandoc_char 7 .
1141: .Ss \e*[ Ns Ar name ]
1142: Interpolate the string with the
1143: .Ar name ;
1144: see
1145: .Sx Predefined Strings
1146: and
1147: .Sx ds .
1148: For short names, there are variants
1149: .No \e* Ns Ar c
1150: and
1151: .No \e*( Ns Ar cc .
1152: .Ss \e-
1153: Special character
1154: .Dq mathematical minus sign .
1155: .Ss \e[ Ns Ar name ]
1156: .Sx Special Characters
1157: with names of arbitrary length, see
1158: .Xr mandoc_char 7 .
1159: .Ss \e^
1160: One-twelfth em half-narrow space character, effectively zero-width in
1161: .Xr mandoc 1 .
1162: .Ss \e`
1163: Grave accent special character; use
1164: .Sq \e(ga
1165: instead.
1166: .Ss \e{
1167: Begin conditional input; see
1168: .Sx if .
1169: .Ss \e\(ba
1170: One-sixth em narrow space character, effectively zero-width in
1171: .Xr mandoc 1 .
1172: .Ss \e}
1173: End conditional input; see
1174: .Sx if .
1175: .Ss \e~
1176: Paddable non-breaking space character.
1177: .Ss \e0
1178: Digit width space character.
1179: .Ss \eA\(aq Ns Ar string Ns \(aq
1180: Anchor definition; ignored by
1181: .Xr mandoc 1 .
1182: .Ss \eB\(aq Ns Ar string Ns \(aq
1.54 schwarze 1183: Interpolate
1184: .Sq 1
1185: if
1.46 schwarze 1186: .Ar string
1.54 schwarze 1187: conforms to the syntax of
1188: .Sx Numerical expressions
1189: explained above and
1190: .Sq 0
1191: otherwise.
1.46 schwarze 1192: .Ss \eb\(aq Ns Ar string Ns \(aq
1193: Bracket building function; ignored by
1194: .Xr mandoc 1 .
1195: .Ss \eC\(aq Ns Ar name Ns \(aq
1196: .Sx Special Characters
1197: with names of arbitrary length.
1198: .Ss \ec
1.60 ! schwarze 1199: When encountered at the end of an input text line,
! 1200: the next input text line is considered to continue that line,
! 1201: even if there are request or macro lines in between.
! 1202: No whitespace is inserted.
1.46 schwarze 1203: .Ss \eD\(aq Ns Ar string Ns \(aq
1204: Draw graphics function; ignored by
1205: .Xr mandoc 1 .
1206: .Ss \ed
1207: Move down by half a line; ignored by
1208: .Xr mandoc 1 .
1209: .Ss \ee
1210: Backslash special character.
1211: .Ss \eF[ Ns Ar name ]
1212: Switch font family (groff extension); ignored by
1213: .Xr mandoc 1 .
1214: For short names, there are variants
1215: .No \eF Ns Ar c
1216: and
1217: .No \eF( Ns Ar cc .
1218: .Ss \ef[ Ns Ar name ]
1219: Switch to the font
1220: .Ar name ,
1221: see
1222: .Sx Text Decoration .
1223: For short names, there are variants
1224: .No \ef Ns Ar c
1225: and
1226: .No \ef( Ns Ar cc .
1227: .Ss \eg[ Ns Ar name ]
1228: Interpolate the format of a number register; ignored by
1229: .Xr mandoc 1 .
1230: For short names, there are variants
1231: .No \eg Ns Ar c
1232: and
1233: .No \eg( Ns Ar cc .
1234: .Ss \eH\(aq Ns Oo +|- Oc Ns Ar number Ns \(aq
1235: Set the height of the current font; ignored by
1236: .Xr mandoc 1 .
1237: .Ss \eh\(aq Ns Ar number Ns \(aq
1238: Horizontal motion; ignored by
1239: .Xr mandoc 1 .
1240: .Ss \ek[ Ns Ar name ]
1241: Mark horizontal input place in register; ignored by
1242: .Xr mandoc 1 .
1243: For short names, there are variants
1244: .No \ek Ns Ar c
1245: and
1246: .No \ek( Ns Ar cc .
1247: .Ss \eL\(aq Ns Ar number Ns Oo Ar c Oc Ns \(aq
1248: Vertical line drawing function; ignored by
1249: .Xr mandoc 1 .
1250: .Ss \el\(aq Ns Ar number Ns Oo Ar c Oc Ns \(aq
1251: Horizontal line drawing function; ignored by
1252: .Xr mandoc 1 .
1253: .Ss \eM[ Ns Ar name ]
1254: Set fill (background) color (groff extension); ignored by
1255: .Xr mandoc 1 .
1256: For short names, there are variants
1257: .No \eM Ns Ar c
1258: and
1259: .No \eM( Ns Ar cc .
1260: .Ss \em[ Ns Ar name ]
1261: Set glyph drawing color (groff extension); ignored by
1262: .Xr mandoc 1 .
1263: For short names, there are variants
1264: .No \em Ns Ar c
1265: and
1266: .No \em( Ns Ar cc .
1267: .Ss \eN\(aq Ns Ar number Ns \(aq
1268: Character
1269: .Ar number
1270: on the current font.
1271: .Ss \en[ Ns Ar name ]
1272: Interpolate the number register
1273: .Ar name .
1274: For short names, there are variants
1275: .No \en Ns Ar c
1276: and
1277: .No \en( Ns Ar cc .
1278: .Ss \eo\(aq Ns Ar string Ns \(aq
1279: Overstrike
1280: .Ar string ;
1281: ignored by
1282: .Xr mandoc 1 .
1283: .Ss \eR\(aq Ns Ar name Oo +|- Oc Ns Ar number Ns \(aq
1284: Set number register; ignored by
1285: .Xr mandoc 1 .
1286: .Ss \eS\(aq Ns Ar number Ns \(aq
1287: Slant output; ignored by
1288: .Xr mandoc 1 .
1289: .Ss \es\(aq Ns Oo +|- Oc Ns Ar number Ns \(aq
1290: Change point size; ignored by
1291: .Xr mandoc 1 .
1292: Alternative forms
1293: .No \es Ns Oo +|- Oc Ns Ar n ,
1294: .No \es Ns Oo +|- Oc Ns \(aq Ns Ar number Ns \(aq ,
1295: .No \es Ns [ Oo +|- Oc Ns Ar number ] ,
1296: and
1297: .No \es Ns Oo +|- Oc Ns [ Ar number Ns ]
1298: are also parsed and ignored.
1299: .Ss \et
1300: Horizontal tab; ignored by
1301: .Xr mandoc 1 .
1302: .Ss \eu
1303: Move up by half a line; ignored by
1304: .Xr mandoc 1 .
1305: .Ss \eV[ Ns Ar name ]
1306: Interpolate an environment variable; ignored by
1307: .Xr mandoc 1 .
1308: For short names, there are variants
1309: .No \eV Ns Ar c
1310: and
1311: .No \eV( Ns Ar cc .
1312: .Ss \ev\(aq Ns Ar number Ns \(aq
1313: Vertical motion; ignored by
1314: .Xr mandoc 1 .
1315: .Ss \ew\(aq Ns Ar string Ns \(aq
1316: Interpolate the width of the
1.54 schwarze 1317: .Ar string .
1318: The
1319: .Xr mandoc 1
1320: implementation assumes that after expansion of user-defined strings, the
1321: .Ar string
1322: only contains normal characters, no escape sequences, and that each
1323: character has a width of 24 basic units.
1.46 schwarze 1324: .Ss \eX\(aq Ns Ar string Ns \(aq
1325: Output
1326: .Ar string
1327: as device control function; ignored in nroff mode and by
1328: .Xr mandoc 1 .
1329: .Ss \ex\(aq Ns Ar number Ns \(aq
1330: Extra line space function; ignored by
1331: .Xr mandoc 1 .
1332: .Ss \eY[ Ns Ar name ]
1333: Output a string as a device control function; ignored in nroff mode and by
1334: .Xr mandoc 1 .
1335: For short names, there are variants
1336: .No \eY Ns Ar c
1337: and
1338: .No \eY( Ns Ar cc .
1339: .Ss \eZ\(aq Ns Ar string Ns \(aq
1340: Print
1341: .Ar string
1342: with zero width and height; ignored by
1343: .Xr mandoc 1 .
1344: .Ss \ez
1345: Output the next character without advancing the cursor position;
1346: approximated in
1347: .Xr mandoc 1
1348: by simply skipping the next character.
1.2 kristaps 1349: .Sh COMPATIBILITY
1.40 schwarze 1350: This section documents compatibility between mandoc and other
1.17 schwarze 1351: .Nm
1352: implementations, at this time limited to GNU troff
1.2 kristaps 1353: .Pq Qq groff .
1354: The term
1355: .Qq historic groff
1.17 schwarze 1356: refers to groff version 1.15.
1.2 kristaps 1357: .Pp
1358: .Bl -dash -compact
1.56 kristaps 1359: .It
1360: The
1361: .Sq u
1362: scaling unit is the default terminal unit.
1363: In traditional troff systems, this unit would change depending on the
1364: output media.
1.10 kristaps 1365: .It
1.27 kristaps 1366: In mandoc, the
1367: .Sx \&EQ ,
1368: .Sx \&TE ,
1369: .Sx \&TS ,
1370: and
1371: .Sx \&T& ,
1372: macros are considered regular macros.
1373: In all other
1374: .Nm
1375: implementations, these are special macros that must be specified without
1376: spacing between the control character (which must be a period) and the
1377: macro name.
1378: .It
1.10 kristaps 1379: The
1380: .Cm nS
1.17 schwarze 1381: register is only compatible with OpenBSD's groff-1.15.
1.2 kristaps 1382: .It
1.17 schwarze 1383: Historic groff did not accept white-space before a custom
1384: .Ar end
1385: macro for the
1.2 kristaps 1386: .Sx \&ig
1.17 schwarze 1387: request.
1.4 kristaps 1388: .It
1389: The
1390: .Sx \&if
1391: and family would print funny white-spaces with historic groff when
1.17 schwarze 1392: using the next-line syntax.
1.2 kristaps 1393: .El
1.17 schwarze 1394: .Sh SEE ALSO
1395: .Xr mandoc 1 ,
1.27 kristaps 1396: .Xr eqn 7 ,
1.17 schwarze 1397: .Xr man 7 ,
1398: .Xr mandoc_char 7 ,
1.23 kristaps 1399: .Xr mdoc 7 ,
1400: .Xr tbl 7
1.17 schwarze 1401: .Rs
1402: .%A Joseph F. Ossanna
1403: .%A Brian W. Kernighan
1404: .%I AT&T Bell Laboratories
1405: .%T Troff User's Manual
1406: .%R Computing Science Technical Report
1407: .%N 54
1408: .%C Murray Hill, New Jersey
1409: .%D 1976 and 1992
1410: .%U http://www.kohala.com/start/troff/cstr54.ps
1411: .Re
1412: .Rs
1413: .%A Joseph F. Ossanna
1414: .%A Brian W. Kernighan
1415: .%A Gunnar Ritter
1416: .%T Heirloom Documentation Tools Nroff/Troff User's Manual
1417: .%D September 17, 2007
1418: .%U http://heirloom.sourceforge.net/doctools/troff.pdf
1419: .Re
1420: .Sh HISTORY
1.35 kristaps 1421: The RUNOFF typesetting system, whose input forms the basis for
1.17 schwarze 1422: .Nm ,
1.35 kristaps 1423: was written in MAD and FAP for the CTSS operating system by Jerome E.
1424: Saltzer in 1964.
1425: Doug McIlroy rewrote it in BCPL in 1969, renaming it
1426: .Nm .
1427: Dennis M. Ritchie rewrote McIlroy's
1.36 schwarze 1428: .Nm
1429: in PDP-11 assembly for
1.35 kristaps 1430: .At v1 ,
1431: Joseph F. Ossanna improved roff and renamed it nroff
1432: for
1433: .At v2 ,
1434: then ported nroff to C as troff, which Brian W. Kernighan released with
1435: .At v7 .
1436: In 1989, James Clarke re-implemented troff in C++, naming it groff.
1.1 kristaps 1437: .Sh AUTHORS
1.15 kristaps 1438: .An -nosplit
1.31 kristaps 1439: This
1.1 kristaps 1440: .Nm
1441: reference was written by
1.41 schwarze 1442: .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv
1.15 kristaps 1443: and
1.41 schwarze 1444: .An Ingo Schwarze Aq Mt schwarze@openbsd.org .
CVSweb