contrib/mdocml/man.7

   1 .\"     $Id: man.7,v 1.135 2017/05/07 21:44:49 schwarze Exp $
   2 .\"
   3 .\" Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
   4 .\" Copyright (c) 2011-2015 Ingo Schwarze <schwarze@openbsd.org>
   5 .\" Copyright (c) 2010 Joerg Sonnenberger <joerg@netbsd.org>
   6 .\"
   7 .\" Permission to use, copy, modify, and distribute this software for any
   8 .\" purpose with or without fee is hereby granted, provided that the above
   9 .\" copyright notice and this permission notice appear in all copies.
  10 .\"
  11 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  12 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  13 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  14 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  15 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  16 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  17 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  18 .\"
  19 .Dd $Mdocdate: May 7 2017 $
  20 .Dt MAN 7
  21 .Os
  22 .Sh NAME
  23 .Nm man
  24 .Nd legacy formatting language for manual pages
  25 .Sh DESCRIPTION
  26 Traditionally, the
  27 .Nm man
  28 language has been used to write
  29 .Ux
  30 manuals for the
  31 .Xr man 1
  32 utility.
  33 It supports limited control of presentational details like fonts,
  34 indentation and spacing.
  35 This reference document describes the structure of manual pages
  36 and the syntax and usage of the man language.
  37 .Pp
  38 .Bf -emphasis
  39 Do not use
  40 .Nm
  41 to write your manuals:
  42 .Ef
  43 It lacks support for semantic markup.
  44 Use the
  45 .Xr mdoc 7
  46 language, instead.
  47 .Pp
  48 In a
  49 .Nm
  50 document, lines beginning with the control character
  51 .Sq \&.
  52 are called
  53 .Dq macro lines .
  54 The first word is the macro name.
  55 It usually consists of two capital letters.
  56 For a list of available macros, see
  57 .Sx MACRO OVERVIEW .
  58 The words following the macro name are arguments to the macro.
  59 .Pp
  60 Lines not beginning with the control character are called
  61 .Dq text lines .
  62 They provide free-form text to be printed; the formatting of the text
  63 depends on the respective processing context:
  64 .Bd -literal -offset indent
  65 \&.SH Macro lines change control state.
  66 Text lines are interpreted within the current state.
  67 .Ed
  68 .Pp
  69 Many aspects of the basic syntax of the
  70 .Nm
  71 language are based on the
  72 .Xr roff 7
  73 language; see the
  74 .Em LANGUAGE SYNTAX
  75 and
  76 .Em MACRO SYNTAX
  77 sections in the
  78 .Xr roff 7
  79 manual for details, in particular regarding
  80 comments, escape sequences, whitespace, and quoting.
  81 .Sh MANUAL STRUCTURE
  82 Each
  83 .Nm
  84 document must contain the
  85 .Sx \&TH
  86 macro describing the document's section and title.
  87 It may occur anywhere in the document, although conventionally it
  88 appears as the first macro.
  89 .Pp
  90 Beyond
  91 .Sx \&TH ,
  92 at least one macro or text line must appear in the document.
  93 .Pp
  94 The following is a well-formed skeleton
  95 .Nm
  96 file for a utility
  97 .Qq progname :
  98 .Bd -literal -offset indent
  99 \&.TH PROGNAME 1 2009-10-10
 100 \&.SH NAME
 101 \efBprogname\efR \e(en one line about what it does
 102 \&.\e\(dq .SH LIBRARY
 103 \&.\e\(dq For sections 2, 3, and 9 only.
 104 \&.\e\(dq Not used in OpenBSD.
 105 \&.SH SYNOPSIS
 106 \efBprogname\efR [\efB\e-options\efR] \efIfile ...\efR
 107 \&.SH DESCRIPTION
 108 The \efBfoo\efR utility processes files ...
 109 \&.\e\(dq .Sh CONTEXT
 110 \&.\e\(dq For section 9 functions only.
 111 \&.\e\(dq .SH IMPLEMENTATION NOTES
 112 \&.\e\(dq Not used in OpenBSD.
 113 \&.\e\(dq .SH RETURN VALUES
 114 \&.\e\(dq For sections 2, 3, and 9 function return values only.
 115 \&.\e\(dq .SH ENVIRONMENT
 116 \&.\e\(dq For sections 1, 6, 7, and 8 only.
 117 \&.\e\(dq .SH FILES
 118 \&.\e\(dq .SH EXIT STATUS
 119 \&.\e\(dq For sections 1, 6, and 8 only.
 120 \&.\e\(dq .SH EXAMPLES
 121 \&.\e\(dq .SH DIAGNOSTICS
 122 \&.\e\(dq For sections 1, 4, 6, 7, 8, and 9 printf/stderr messages only.
 123 \&.\e\(dq .SH ERRORS
 124 \&.\e\(dq For sections 2, 3, 4, and 9 errno settings only.
 125 \&.\e\(dq .SH SEE ALSO
 126 \&.\e\(dq .BR foobar ( 1 )
 127 \&.\e\(dq .SH STANDARDS
 128 \&.\e\(dq .SH HISTORY
 129 \&.\e\(dq .SH AUTHORS
 130 \&.\e\(dq .SH CAVEATS
 131 \&.\e\(dq .SH BUGS
 132 \&.\e\(dq .SH SECURITY CONSIDERATIONS
 133 \&.\e\(dq Not used in OpenBSD.
 134 .Ed
 135 .Pp
 136 The sections in a
 137 .Nm
 138 document are conventionally ordered as they appear above.
 139 Sections should be composed as follows:
 140 .Bl -ohang -offset indent
 141 .It Em NAME
 142 The name(s) and a short description of the documented material.
 143 The syntax for this is generally as follows:
 144 .Pp
 145 .D1 \efBname\efR \e(en description
 146 .It Em LIBRARY
 147 The name of the library containing the documented material, which is
 148 assumed to be a function in a section 2 or 3 manual.
 149 For functions in the C library, this may be as follows:
 150 .Pp
 151 .D1 Standard C Library (libc, -lc)
 152 .It Em SYNOPSIS
 153 Documents the utility invocation syntax, function call syntax, or device
 154 configuration.
 155 .Pp
 156 For the first, utilities (sections 1, 6, and 8), this is
 157 generally structured as follows:
 158 .Pp
 159 .D1 \efBname\efR [-\efBab\efR] [-\efBc\efR\efIarg\efR] \efBpath\efR...
 160 .Pp
 161 For the second, function calls (sections 2, 3, 9):
 162 .Pp
 163 .D1 \&.B char *name(char *\efIarg\efR);
 164 .Pp
 165 And for the third, configurations (section 4):
 166 .Pp
 167 .D1 \&.B name* at cardbus ? function ?
 168 .Pp
 169 Manuals not in these sections generally don't need a
 170 .Em SYNOPSIS .
 171 .It Em DESCRIPTION
 172 This expands upon the brief, one-line description in
 173 .Em NAME .
 174 It usually contains a break-down of the options (if documenting a
 175 command).
 176 .It Em CONTEXT
 177 This section lists the contexts in which functions can be called in section 9.
 178 The contexts are autoconf, process, or interrupt.
 179 .It Em IMPLEMENTATION NOTES
 180 Implementation-specific notes should be kept here.
 181 This is useful when implementing standard functions that may have side
 182 effects or notable algorithmic implications.
 183 .It Em RETURN VALUES
 184 This section documents the return values of functions in sections 2, 3, and 9.
 185 .It Em ENVIRONMENT
 186 Documents any usages of environment variables, e.g.,
 187 .Xr environ 7 .
 188 .It Em FILES
 189 Documents files used.
 190 It's helpful to document both the file name and a short description of how
 191 the file is used (created, modified, etc.).
 192 .It Em EXIT STATUS
 193 This section documents the command exit status for
 194 section 1, 6, and 8 utilities.
 195 Historically, this information was described in
 196 .Em DIAGNOSTICS ,
 197 a practise that is now discouraged.
 198 .It Em EXAMPLES
 199 Example usages.
 200 This often contains snippets of well-formed,
 201 well-tested invocations.
 202 Make sure that examples work properly!
 203 .It Em DIAGNOSTICS
 204 Documents error conditions.
 205 In section 4 and 9 manuals, these are usually messages
 206 printed by the kernel to the console and to the kernel log.
 207 In section 1, 6, 7, and 8, these are usually messages
 208 printed by userland programs to the standard error output.
 209 .Pp
 210 Historically, this section was used in place of
 211 .Em EXIT STATUS
 212 for manuals in sections 1, 6, and 8; however, this practise is
 213 discouraged.
 214 .It Em ERRORS
 215 Documents
 216 .Xr errno 2
 217 settings in sections 2, 3, 4, and 9.
 218 .It Em SEE ALSO
 219 References other manuals with related topics.
 220 This section should exist for most manuals.
 221 .Pp
 222 .D1 \&.BR bar \&( 1 \&),
 223 .Pp
 224 Cross-references should conventionally be ordered
 225 first by section, then alphabetically.
 226 .It Em STANDARDS
 227 References any standards implemented or used, such as
 228 .Pp
 229 .D1 IEEE Std 1003.2 (\e(lqPOSIX.2\e(rq)
 230 .Pp
 231 If not adhering to any standards, the
 232 .Em HISTORY
 233 section should be used.
 234 .It Em HISTORY
 235 A brief history of the subject, including where support first appeared.
 236 .It Em AUTHORS
 237 Credits to the person or persons who wrote the code and/or documentation.
 238 Authors should generally be noted by both name and email address.
 239 .It Em CAVEATS
 240 Common misuses and misunderstandings should be explained
 241 in this section.
 242 .It Em BUGS
 243 Known bugs, limitations, and work-arounds should be described
 244 in this section.
 245 .It Em SECURITY CONSIDERATIONS
 246 Documents any security precautions that operators should consider.
 247 .El
 248 .Sh MACRO OVERVIEW
 249 This overview is sorted such that macros of similar purpose are listed
 250 together, to help find the best macro for any given purpose.
 251 Deprecated macros are not included in the overview, but can be found
 252 in the alphabetical reference below.
 253 .Ss Page header and footer meta-data
 254 .Bl -column "PP, LP, P" description
 255 .It Sx TH Ta set the title: Ar title section date Op Ar source Op Ar volume
 256 .It Sx AT Ta display AT&T UNIX version in the page footer (<= 1 argument)
 257 .It Sx UC Ta display BSD version in the page footer (<= 1 argument)
 258 .El
 259 .Ss Sections and paragraphs
 260 .Bl -column "PP, LP, P" description
 261 .It Sx SH Ta section header (one line)
 262 .It Sx SS Ta subsection header (one line)
 263 .It Sx PP , LP , P Ta start an undecorated paragraph (no arguments)
 264 .It Sx RS , RE Ta reset the left margin: Op Ar width
 265 .It Sx IP Ta indented paragraph: Op Ar head Op Ar width
 266 .It Sx TP Ta tagged paragraph: Op Ar width
 267 .It Sx HP Ta hanged paragraph: Op Ar width
 268 .It Sx PD Ta set vertical paragraph distance: Op Ar height
 269 .It Sx fi , nf Ta fill mode and no-fill mode (no arguments)
 270 .It Sx in Ta additional indent: Op Ar width
 271 .El
 272 .Ss Physical markup
 273 .Bl -column "PP, LP, P" description
 274 .It Sx B Ta boldface font
 275 .It Sx I Ta italic font
 276 .It Sx R Ta roman (default) font
 277 .It Sx SB Ta small boldface font
 278 .It Sx SM Ta small roman font
 279 .It Sx BI Ta alternate between boldface and italic fonts
 280 .It Sx BR Ta alternate between boldface and roman fonts
 281 .It Sx IB Ta alternate between italic and boldface fonts
 282 .It Sx IR Ta alternate between italic and roman fonts
 283 .It Sx RB Ta alternate between roman and boldface fonts
 284 .It Sx RI Ta alternate between roman and italic fonts
 285 .El
 286 .Sh MACRO REFERENCE
 287 This section is a canonical reference to all macros, arranged
 288 alphabetically.
 289 For the scoping of individual macros, see
 290 .Sx MACRO SYNTAX .
 291 .Ss \&AT
 292 Sets the volume for the footer for compatibility with man pages from
 293 .At
 294 releases.
 295 The optional arguments specify which release it is from.
 296 .Ss \&B
 297 Text is rendered in bold face.
 298 .Pp
 299 See also
 300 .Sx \&I
 301 and
 302 .Sx \&R .
 303 .Ss \&BI
 304 Text is rendered alternately in bold face and italic.
 305 Thus,
 306 .Sq .BI this word and that
 307 causes
 308 .Sq this
 309 and
 310 .Sq and
 311 to render in bold face, while
 312 .Sq word
 313 and
 314 .Sq that
 315 render in italics.
 316 Whitespace between arguments is omitted in output.
 317 .Pp
 318 Examples:
 319 .Pp
 320 .Dl \&.BI bold italic bold italic
 321 .Pp
 322 The output of this example will be emboldened
 323 .Dq bold
 324 and italicised
 325 .Dq italic ,
 326 with spaces stripped between arguments.
 327 .Pp
 328 See also
 329 .Sx \&IB ,
 330 .Sx \&BR ,
 331 .Sx \&RB ,
 332 .Sx \&RI ,
 333 and
 334 .Sx \&IR .
 335 .Ss \&BR
 336 Text is rendered alternately in bold face and roman (the default font).
 337 Whitespace between arguments is omitted in output.
 338 .Pp
 339 See
 340 .Sx \&BI
 341 for an equivalent example.
 342 .Pp
 343 See also
 344 .Sx \&BI ,
 345 .Sx \&IB ,
 346 .Sx \&RB ,
 347 .Sx \&RI ,
 348 and
 349 .Sx \&IR .
 350 .Ss \&DT
 351 Restore the default tabulator positions.
 352 They are at intervals of 0.5 inches.
 353 This has no effect unless the tabulator positions were changed with the
 354 .Xr roff 7
 355 .Ic \&ta
 356 request.
 357 .Ss \&EE
 358 This is a non-standard GNU extension, included only for compatibility.
 359 In
 360 .Xr mandoc 1 ,
 361 it does the same as
 362 .Sx \&fi .
 363 .Ss \&EX
 364 This is a non-standard GNU extension, included only for compatibility.
 365 In
 366 .Xr mandoc 1 ,
 367 it does the same as
 368 .Sx \&nf .
 369 .Ss \&HP
 370 Begin a paragraph whose initial output line is left-justified, but
 371 subsequent output lines are indented, with the following syntax:
 372 .Bd -filled -offset indent
 373 .Pf \. Sx \&HP
 374 .Op Ar width
 375 .Ed
 376 .Pp
 377 The
 378 .Ar width
 379 argument is a
 380 .Xr roff 7
 381 scaling width.
 382 If specified, it's saved for later paragraph left-margins; if unspecified, the
 383 saved or default width is used.
 384 .Pp
 385 See also
 386 .Sx \&IP ,
 387 .Sx \&LP ,
 388 .Sx \&P ,
 389 .Sx \&PP ,
 390 and
 391 .Sx \&TP .
 392 .Ss \&I
 393 Text is rendered in italics.
 394 .Pp
 395 See also
 396 .Sx \&B
 397 and
 398 .Sx \&R .
 399 .Ss \&IB
 400 Text is rendered alternately in italics and bold face.
 401 Whitespace between arguments is omitted in output.
 402 .Pp
 403 See
 404 .Sx \&BI
 405 for an equivalent example.
 406 .Pp
 407 See also
 408 .Sx \&BI ,
 409 .Sx \&BR ,
 410 .Sx \&RB ,
 411 .Sx \&RI ,
 412 and
 413 .Sx \&IR .
 414 .Ss \&IP
 415 Begin an indented paragraph with the following syntax:
 416 .Bd -filled -offset indent
 417 .Pf \. Sx \&IP
 418 .Op Ar head Op Ar width
 419 .Ed
 420 .Pp
 421 The
 422 .Ar width
 423 argument is a
 424 .Xr roff 7
 425 scaling width defining the left margin.
 426 It's saved for later paragraph left-margins; if unspecified, the saved or
 427 default width is used.
 428 .Pp
 429 The
 430 .Ar head
 431 argument is used as a leading term, flushed to the left margin.
 432 This is useful for bulleted paragraphs and so on.
 433 .Pp
 434 See also
 435 .Sx \&HP ,
 436 .Sx \&LP ,
 437 .Sx \&P ,
 438 .Sx \&PP ,
 439 and
 440 .Sx \&TP .
 441 .Ss \&IR
 442 Text is rendered alternately in italics and roman (the default font).
 443 Whitespace between arguments is omitted in output.
 444 .Pp
 445 See
 446 .Sx \&BI
 447 for an equivalent example.
 448 .Pp
 449 See also
 450 .Sx \&BI ,
 451 .Sx \&IB ,
 452 .Sx \&BR ,
 453 .Sx \&RB ,
 454 and
 455 .Sx \&RI .
 456 .Ss \&LP
 457 Begin an undecorated paragraph.
 458 The scope of a paragraph is closed by a subsequent paragraph,
 459 sub-section, section, or end of file.
 460 The saved paragraph left-margin width is reset to the default.
 461 .Pp
 462 See also
 463 .Sx \&HP ,
 464 .Sx \&IP ,
 465 .Sx \&P ,
 466 .Sx \&PP ,
 467 and
 468 .Sx \&TP .
 469 .Ss \&OP
 470 Optional command-line argument.
 471 This is a non-standard GNU extension, included only for compatibility.
 472 It has the following syntax:
 473 .Bd -filled -offset indent
 474 .Pf \. Sx \&OP
 475 .Ar key Op Ar value
 476 .Ed
 477 .Pp
 478 The
 479 .Ar key
 480 is usually a command-line flag and
 481 .Ar value
 482 its argument.
 483 .Ss \&P
 484 Synonym for
 485 .Sx \&LP .
 486 .Pp
 487 See also
 488 .Sx \&HP ,
 489 .Sx \&IP ,
 490 .Sx \&LP ,
 491 .Sx \&PP ,
 492 and
 493 .Sx \&TP .
 494 .Ss \&PD
 495 Specify the vertical space to be inserted before each new paragraph.
 496 .br
 497 The syntax is as follows:
 498 .Bd -filled -offset indent
 499 .Pf \. Sx \&PD
 500 .Op Ar height
 501 .Ed
 502 .Pp
 503 The
 504 .Ar height
 505 argument is a
 506 .Xr roff 7
 507 scaling width.
 508 It defaults to
 509 .Cm 1v .
 510 If the unit is omitted,
 511 .Cm v
 512 is assumed.
 513 .Pp
 514 This macro affects the spacing before any subsequent instances of
 515 .Sx \&HP ,
 516 .Sx \&IP ,
 517 .Sx \&LP ,
 518 .Sx \&P ,
 519 .Sx \&PP ,
 520 .Sx \&SH ,
 521 .Sx \&SS ,
 522 and
 523 .Sx \&TP .
 524 .Ss \&PP
 525 Synonym for
 526 .Sx \&LP .
 527 .Pp
 528 See also
 529 .Sx \&HP ,
 530 .Sx \&IP ,
 531 .Sx \&LP ,
 532 .Sx \&P ,
 533 and
 534 .Sx \&TP .
 535 .Ss \&R
 536 Text is rendered in roman (the default font).
 537 .Pp
 538 See also
 539 .Sx \&I
 540 and
 541 .Sx \&B .
 542 .Ss \&RB
 543 Text is rendered alternately in roman (the default font) and bold face.
 544 Whitespace between arguments is omitted in output.
 545 .Pp
 546 See
 547 .Sx \&BI
 548 for an equivalent example.
 549 .Pp
 550 See also
 551 .Sx \&BI ,
 552 .Sx \&IB ,
 553 .Sx \&BR ,
 554 .Sx \&RI ,
 555 and
 556 .Sx \&IR .
 557 .Ss \&RE
 558 Explicitly close out the scope of a prior
 559 .Sx \&RS .
 560 The default left margin is restored to the state before that
 561 .Sx \&RS
 562 invocation.
 563 .Pp
 564 The syntax is as follows:
 565 .Bd -filled -offset indent
 566 .Pf \. Sx \&RE
 567 .Op Ar level
 568 .Ed
 569 .Pp
 570 Without an argument, the most recent
 571 .Sx \&RS
 572 block is closed out.
 573 If
 574 .Ar level
 575 is 1, all open
 576 .Sx \&RS
 577 blocks are closed out.
 578 Otherwise,
 579 .Ar level No \(mi 1
 580 nested
 581 .Sx \&RS
 582 blocks remain open.
 583 .Ss \&RI
 584 Text is rendered alternately in roman (the default font) and italics.
 585 Whitespace between arguments is omitted in output.
 586 .Pp
 587 See
 588 .Sx \&BI
 589 for an equivalent example.
 590 .Pp
 591 See also
 592 .Sx \&BI ,
 593 .Sx \&IB ,
 594 .Sx \&BR ,
 595 .Sx \&RB ,
 596 and
 597 .Sx \&IR .
 598 .Ss \&RS
 599 Temporarily reset the default left margin.
 600 This has the following syntax:
 601 .Bd -filled -offset indent
 602 .Pf \. Sx \&RS
 603 .Op Ar width
 604 .Ed
 605 .Pp
 606 The
 607 .Ar width
 608 argument is a
 609 .Xr roff 7
 610 scaling width.
 611 If not specified, the saved or default width is used.
 612 .Pp
 613 See also
 614 .Sx \&RE .
 615 .Ss \&SB
 616 Text is rendered in small size (one point smaller than the default font)
 617 bold face.
 618 .Ss \&SH
 619 Begin a section.
 620 The scope of a section is only closed by another section or the end of
 621 file.
 622 The paragraph left-margin width is reset to the default.
 623 .Ss \&SM
 624 Text is rendered in small size (one point smaller than the default
 625 font).
 626 .Ss \&SS
 627 Begin a sub-section.
 628 The scope of a sub-section is closed by a subsequent sub-section,
 629 section, or end of file.
 630 The paragraph left-margin width is reset to the default.
 631 .Ss \&TH
 632 Sets the title of the manual page for use in the page header
 633 and footer with the following syntax:
 634 .Bd -filled -offset indent
 635 .Pf \. Sx \&TH
 636 .Ar title section date
 637 .Op Ar source Op Ar volume
 638 .Ed
 639 .Pp
 640 Conventionally, the document
 641 .Ar title
 642 is given in all caps.
 643 The recommended
 644 .Ar date
 645 format is
 646 .Sy YYYY-MM-DD
 647 as specified in the ISO-8601 standard;
 648 if the argument does not conform, it is printed verbatim.
 649 If the
 650 .Ar date
 651 is empty or not specified, the current date is used.
 652 The optional
 653 .Ar source
 654 string specifies the organisation providing the utility.
 655 When unspecified,
 656 .Xr mandoc 1
 657 uses its
 658 .Fl Ios
 659 argument.
 660 The
 661 .Ar volume
 662 string replaces the default rendered volume, which is dictated by the
 663 manual section.
 664 .Pp
 665 Examples:
 666 .Pp
 667 .Dl \&.TH CVS 5 "1992-02-12" GNU
 668 .Ss \&TP
 669 Begin a paragraph where the head, if exceeding the indentation width, is
 670 followed by a newline; if not, the body follows on the same line after a
 671 buffer to the indentation width.
 672 Subsequent output lines are indented.
 673 The syntax is as follows:
 674 .Bd -filled -offset indent
 675 .Pf \. Sx \&TP
 676 .Op Ar width
 677 .Ed
 678 .Pp
 679 The
 680 .Ar width
 681 argument is a
 682 .Xr roff 7
 683 scaling width.
 684 If specified, it's saved for later paragraph left-margins; if
 685 unspecified, the saved or default width is used.
 686 .Pp
 687 See also
 688 .Sx \&HP ,
 689 .Sx \&IP ,
 690 .Sx \&LP ,
 691 .Sx \&P ,
 692 and
 693 .Sx \&PP .
 694 .Ss \&UC
 695 Sets the volume for the footer for compatibility with man pages from
 696 .Bx
 697 releases.
 698 The optional first argument specifies which release it is from.
 699 .Ss \&UE
 700 End a uniform resource identifier block.
 701 This is a non-standard GNU extension, included only for compatibility.
 702 See
 703 .Sx \&UE .
 704 .Ss \&UR
 705 Begin a uniform resource identifier block.
 706 This is a non-standard GNU extension, included only for compatibility.
 707 It has the following syntax:
 708 .Bd -literal -offset indent
 709 .Pf \. Sx \&UR Ar uri
 710 link description to be shown
 711 .Pf \. Sx UE
 712 .Ed
 713 .Ss \&fi
 714 End literal mode begun by
 715 .Sx \&nf .
 716 .Ss \&in
 717 Indent relative to the current indentation:
 718 .Pp
 719 .D1 Pf \. Sx \&in Op Ar width
 720 .Pp
 721 If
 722 .Ar width
 723 is signed, the new offset is relative.
 724 Otherwise, it is absolute.
 725 This value is reset upon the next paragraph, section, or sub-section.
 726 .Ss \&nf
 727 Begin literal mode: all subsequent free-form lines have their end of
 728 line boundaries preserved.
 729 May be ended by
 730 .Sx \&fi .
 731 Literal mode is implicitly ended by
 732 .Sx \&SH
 733 or
 734 .Sx \&SS .
 735 .Sh MACRO SYNTAX
 736 The
 737 .Nm
 738 macros are classified by scope: line scope or block scope.
 739 Line macros are only scoped to the current line (and, in some
 740 situations, the subsequent line).
 741 Block macros are scoped to the current line and subsequent lines until
 742 closed by another block macro.
 743 .Ss Line Macros
 744 Line macros are generally scoped to the current line, with the body
 745 consisting of zero or more arguments.
 746 If a macro is scoped to the next line and the line arguments are empty,
 747 the next line, which must be text, is used instead.
 748 Thus:
 749 .Bd -literal -offset indent
 750 \&.I
 751 foo
 752 .Ed
 753 .Pp
 754 is equivalent to
 755 .Sq \&.I foo .
 756 If next-line macros are invoked consecutively, only the last is used.
 757 If a next-line macro is followed by a non-next-line macro, an error is
 758 raised.
 759 .Pp
 760 The syntax is as follows:
 761 .Bd -literal -offset indent
 762 \&.YO \(lBbody...\(rB
 763 \(lBbody...\(rB
 764 .Ed
 765 .Bl -column "MacroX" "ArgumentsX" "ScopeXXXXX" "CompatX" -offset indent
 766 .It Em Macro Ta Em Arguments Ta Em Scope     Ta Em Notes
 767 .It Sx \&AT  Ta    <=1       Ta    current   Ta    \&
 768 .It Sx \&B   Ta    n         Ta    next-line Ta    \&
 769 .It Sx \&BI  Ta    n         Ta    current   Ta    \&
 770 .It Sx \&BR  Ta    n         Ta    current   Ta    \&
 771 .It Sx \&DT  Ta    0         Ta    current   Ta    \&
 772 .It Sx \&EE  Ta    0         Ta    current   Ta    compat
 773 .It Sx \&EX  Ta    0         Ta    current   Ta    compat
 774 .It Sx \&I   Ta    n         Ta    next-line Ta    \&
 775 .It Sx \&IB  Ta    n         Ta    current   Ta    \&
 776 .It Sx \&IR  Ta    n         Ta    current   Ta    \&
 777 .It Sx \&OP  Ta    0, 1      Ta    current   Ta    compat
 778 .It Sx \&PD  Ta    1         Ta    current   Ta    \&
 779 .It Sx \&R   Ta    n         Ta    next-line Ta    \&
 780 .It Sx \&RB  Ta    n         Ta    current   Ta    \&
 781 .It Sx \&RI  Ta    n         Ta    current   Ta    \&
 782 .It Sx \&SB  Ta    n         Ta    next-line Ta    \&
 783 .It Sx \&SM  Ta    n         Ta    next-line Ta    \&
 784 .It Sx \&TH  Ta    >1, <6    Ta    current   Ta    \&
 785 .It Sx \&UC  Ta    <=1       Ta    current   Ta    \&
 786 .It Sx \&fi  Ta    0         Ta    current   Ta    compat
 787 .It Sx \&in  Ta    1         Ta    current   Ta    compat
 788 .It Sx \&nf  Ta    0         Ta    current   Ta    compat
 789 .El
 790 .Pp
 791 Macros marked as
 792 .Qq compat
 793 are included for compatibility with the significant corpus of existing
 794 manuals that mix dialects of roff.
 795 These macros should not be used for portable
 796 .Nm
 797 manuals.
 798 .Ss Block Macros
 799 Block macros comprise a head and body.
 800 As with in-line macros, the head is scoped to the current line and, in
 801 one circumstance, the next line (the next-line stipulations as in
 802 .Sx Line Macros
 803 apply here as well).
 804 .Pp
 805 The syntax is as follows:
 806 .Bd -literal -offset indent
 807 \&.YO \(lBhead...\(rB
 808 \(lBhead...\(rB
 809 \(lBbody...\(rB
 810 .Ed
 811 .Pp
 812 The closure of body scope may be to the section, where a macro is closed
 813 by
 814 .Sx \&SH ;
 815 sub-section, closed by a section or
 816 .Sx \&SS ;
 817 part, closed by a section, sub-section, or
 818 .Sx \&RE ;
 819 or paragraph, closed by a section, sub-section, part,
 820 .Sx \&HP ,
 821 .Sx \&IP ,
 822 .Sx \&LP ,
 823 .Sx \&P ,
 824 .Sx \&PP ,
 825 or
 826 .Sx \&TP .
 827 No closure refers to an explicit block closing macro.
 828 .Pp
 829 As a rule, block macros may not be nested; thus, calling a block macro
 830 while another block macro scope is open, and the open scope is not
 831 implicitly closed, is syntactically incorrect.
 832 .Bl -column "MacroX" "ArgumentsX" "Head ScopeX" "sub-sectionX" "compatX" -offset indent
 833 .It Em Macro Ta Em Arguments Ta Em Head Scope Ta Em Body Scope  Ta Em Notes
 834 .It Sx \&HP  Ta    <2        Ta    current    Ta    paragraph   Ta    \&
 835 .It Sx \&IP  Ta    <3        Ta    current    Ta    paragraph   Ta    \&
 836 .It Sx \&LP  Ta    0         Ta    current    Ta    paragraph   Ta    \&
 837 .It Sx \&P   Ta    0         Ta    current    Ta    paragraph   Ta    \&
 838 .It Sx \&PP  Ta    0         Ta    current    Ta    paragraph   Ta    \&
 839 .It Sx \&RE  Ta    0         Ta    current    Ta    none        Ta    compat
 840 .It Sx \&RS  Ta    1         Ta    current    Ta    part        Ta    compat
 841 .It Sx \&SH  Ta    >0        Ta    next-line  Ta    section     Ta    \&
 842 .It Sx \&SS  Ta    >0        Ta    next-line  Ta    sub-section Ta    \&
 843 .It Sx \&TP  Ta    n         Ta    next-line  Ta    paragraph   Ta    \&
 844 .It Sx \&UE  Ta    0         Ta    current    Ta    none        Ta    compat
 845 .It Sx \&UR  Ta    1         Ta    current    Ta    part        Ta    compat
 846 .El
 847 .Pp
 848 Macros marked
 849 .Qq compat
 850 are as mentioned in
 851 .Sx Line Macros .
 852 .Pp
 853 If a block macro is next-line scoped, it may only be followed by in-line
 854 macros for decorating text.
 855 .Ss Font handling
 856 In
 857 .Nm
 858 documents, both
 859 .Sx Physical markup
 860 macros and
 861 .Xr roff 7
 862 .Ql \ef
 863 font escape sequences can be used to choose fonts.
 864 In text lines, the effect of manual font selection by escape sequences
 865 only lasts until the next macro invocation; in macro lines, it only lasts
 866 until the end of the macro scope.
 867 Note that macros like
 868 .Sx \&BR
 869 open and close a font scope for each argument.
 870 .Sh SEE ALSO
 871 .Xr man 1 ,
 872 .Xr mandoc 1 ,
 873 .Xr eqn 7 ,
 874 .Xr mandoc_char 7 ,
 875 .Xr mdoc 7 ,
 876 .Xr roff 7 ,
 877 .Xr tbl 7
 878 .Sh HISTORY
 879 The
 880 .Nm
 881 language first appeared as a macro package for the roff typesetting
 882 system in
 883 .At v7 .
 884 It was later rewritten by James Clark as a macro package for groff.
 885 Eric S. Raymond wrote the extended
 886 .Nm
 887 macros for groff in 2007.
 888 The stand-alone implementation that is part of the
 889 .Xr mandoc 1
 890 utility written by Kristaps Dzonsons appeared in
 891 .Ox 4.6 .
 892 .Sh AUTHORS
 893 This
 894 .Nm
 895 reference was written by
 896 .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv .
 897 .Sh CAVEATS
 898 Do not use this language.
 899 Use
 900 .Xr mdoc 7 ,
 901 instead.