586 Author name. Can be used both for the authors of the program, function,
587 or driver documented in the manual, or for the authors of the manual
588 itself. Requires either the name of an author or one of the following
589 arguments:
590
591 -split Start a new output line before each subsequent
592 invocation of An.
593 -nosplit The opposite of -split.
594
595 The default is -nosplit. The effect of selecting either of the -split
596 modes ends at the beginning of the AUTHORS section. In the AUTHORS
597 section, the default is -nosplit for the first author listing and -split
598 for all other author listings.
599
600 Examples:
601 .An -nosplit
602 .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv
603
604 Ao
605 Begin a block enclosed by angle brackets. Does not have any head
606 arguments.
607
608 Examples:
609 .Fl -key= Ns Ao Ar val Ac
610
611 See also Aq.
612
613 Ap
614 Inserts an apostrophe without any surrounding whitespace. This is
615 generally used as a grammatical device when referring to the verb form of
616 a function.
617
618 Examples:
619 .Fn execve Ap d
620
621 Aq
622 Encloses its arguments in angle brackets.
623
624 Examples:
625 .Fl -key= Ns Aq Ar val
626
627 Remarks: this macro is often abused for rendering URIs, which should
628 instead use Lk or Mt, or to note pre-processor "#include" statements,
629 which should use In.
630
631 See also Ao.
632
633 Ar
634 Command arguments. If an argument is not provided, the string "file ..."
635 is used as a default.
636
637 Examples:
638 .Fl o Ar file
639 .Ar
640 .Ar arg1 , arg2 .
641
642 The arguments to the Ar macro are names and placeholders for command
643 arguments; for fixed strings to be passed verbatim as arguments, use Fl
644 or Cm.
645
646 At
647 Formats an AT&T UNIX version. Accepts one optional argument:
648
649 v[1-7] | 32v A version of AT&T UNIX.
650 III AT&T System III UNIX.
929
930 Examples:
931 .D1 Fl abcdefgh
932
933 See also Bd and Dl.
934
935 Db
936 This macro is obsolete. No replacement is needed. It is ignored by
937 mandoc(1) and groff including its arguments. It was formerly used to
938 toggle a debugging mode.
939
940 Dc
941 Close a Do block. Does not have any tail arguments.
942
943 Dd
944 Document date for display in the page footer. This is the mandatory
945 first macro of any mdoc manual. Its syntax is as follows:
946
947 .Dd month day, year
948
949 The month is the full English month name, the day is an optionally zero-
950 padded numeral, and the year is the full four-digit year.
951
952 Other arguments are not portable; the mandoc(1) utility handles them as
953 follows:
954 - To have the date automatically filled in by the OpenBSD version of
955 cvs(1), the special string "$Mdocdate$" can be given as an
956 argument.
957 - The traditional, purely numeric man(5) format year-month-day is
958 accepted, too.
959 - If a date string cannot be parsed, it is used verbatim.
960 - If no date string is given, the current date is used.
961
962 Examples:
963 .Dd $Mdocdate$
964 .Dd $Mdocdate: July 21 2007$
965 .Dd July 21, 2007
966
967 See also Dt and Os.
968
969 Dl
970 One-line indented display. This is formatted as literal text and is
971 useful for commands and invocations. It is followed by a newline.
972
973 Examples:
974 .Dl % mandoc mdoc.5 \(ba less
975
976 See also Ql, Bd -literal, and D1.
977
978 Do
979 Begin a block enclosed by double quotes. Does not have any head
980 arguments.
981
982 Examples:
983 .Do
984 April is the cruellest month
985 .Dc
2236 large indentations.
2237
2238 SEE ALSO
2239 man(1), mandoc(1), eqn(5), man(5), mandoc_char(5), mandoc_roff(5), tbl(5)
2240
2241 The web page extended documentation for the mdoc language:
2242 http://mandoc.bsd.lv/mdoc/ provides a few tutorial-style pages for
2243 beginners, an extensive style guide for advanced authors, and an
2244 alphabetic index helping to choose the best macros for various kinds of
2245 content.
2246
2247 HISTORY
2248 The mdoc language first appeared as a troff macro package in 4.4BSD. It
2249 was later significantly updated by Werner Lemberg and Ruslan Ermilov in
2250 groff-1.17. The standalone implementation that is part of the mandoc(1)
2251 utility written by Kristaps Dzonsons appeared in OpenBSD 4.6.
2252
2253 AUTHORS
2254 The mdoc reference was written by Kristaps Dzonsons <kristaps@bsd.lv>.
2255
2256 illumos July 20, 2017 illumos
|
586 Author name. Can be used both for the authors of the program, function,
587 or driver documented in the manual, or for the authors of the manual
588 itself. Requires either the name of an author or one of the following
589 arguments:
590
591 -split Start a new output line before each subsequent
592 invocation of An.
593 -nosplit The opposite of -split.
594
595 The default is -nosplit. The effect of selecting either of the -split
596 modes ends at the beginning of the AUTHORS section. In the AUTHORS
597 section, the default is -nosplit for the first author listing and -split
598 for all other author listings.
599
600 Examples:
601 .An -nosplit
602 .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv
603
604 Ao
605 Begin a block enclosed by angle brackets. Does not have any head
606 arguments. This macro is almost never useful. See Aq for more details.
607
608 Ap
609 Inserts an apostrophe without any surrounding whitespace. This is
610 generally used as a grammatical device when referring to the verb form of
611 a function.
612
613 Examples:
614 .Fn execve Ap d
615
616 Aq
617 Encloses its arguments in angle brackets. The only important use case is
618 for email addresses. See Mt for an example.
619
620 Occasionally, it is used for names of characters and keys, for example:
621
622 Press the
623 .Aq escape
624 key to ...
625
626 For URIs, use Lk instead, and In for "#include" directives. Never wrap
627 Ar in Aq.
628
629 Since Aq usually renders with non-ASCII characters in non-ASCII output
630 modes, do not use it where the ASCII characters `<' and `>' are required
631 as syntax elements. Instead, use these characters directly in such
632 cases, combining them with the macros Pf, Ns, or Eo as needed.
633
634 See also Ao.
635
636 Ar
637 Command arguments. If an argument is not provided, the string "file ..."
638 is used as a default.
639
640 Examples:
641 .Fl o Ar file
642 .Ar
643 .Ar arg1 , arg2 .
644
645 The arguments to the Ar macro are names and placeholders for command
646 arguments; for fixed strings to be passed verbatim as arguments, use Fl
647 or Cm.
648
649 At
650 Formats an AT&T UNIX version. Accepts one optional argument:
651
652 v[1-7] | 32v A version of AT&T UNIX.
653 III AT&T System III UNIX.
932
933 Examples:
934 .D1 Fl abcdefgh
935
936 See also Bd and Dl.
937
938 Db
939 This macro is obsolete. No replacement is needed. It is ignored by
940 mandoc(1) and groff including its arguments. It was formerly used to
941 toggle a debugging mode.
942
943 Dc
944 Close a Do block. Does not have any tail arguments.
945
946 Dd
947 Document date for display in the page footer. This is the mandatory
948 first macro of any mdoc manual. Its syntax is as follows:
949
950 .Dd month day, year
951
952 The month is the full English month name, the day is an integer number,
953 and the year is the full four-digit year.
954
955 Other arguments are not portable; the mandoc(1) utility handles them as
956 follows:
957 - To have the date automatically filled in by the OpenBSD version of
958 cvs(1), the special string "$Mdocdate$" can be given as an
959 argument.
960 - The traditional, purely numeric man(5) format year-month-day is
961 accepted, too.
962 - If a date string cannot be parsed, it is used verbatim.
963 - If no date string is given, the current date is used.
964
965 Examples:
966 .Dd $Mdocdate$
967 .Dd $Mdocdate: July 2 2018$
968 .Dd July 2, 2018
969
970 See also Dt and Os.
971
972 Dl
973 One-line indented display. This is formatted as literal text and is
974 useful for commands and invocations. It is followed by a newline.
975
976 Examples:
977 .Dl % mandoc mdoc.5 \(ba less
978
979 See also Ql, Bd -literal, and D1.
980
981 Do
982 Begin a block enclosed by double quotes. Does not have any head
983 arguments.
984
985 Examples:
986 .Do
987 April is the cruellest month
988 .Dc
2239 large indentations.
2240
2241 SEE ALSO
2242 man(1), mandoc(1), eqn(5), man(5), mandoc_char(5), mandoc_roff(5), tbl(5)
2243
2244 The web page extended documentation for the mdoc language:
2245 http://mandoc.bsd.lv/mdoc/ provides a few tutorial-style pages for
2246 beginners, an extensive style guide for advanced authors, and an
2247 alphabetic index helping to choose the best macros for various kinds of
2248 content.
2249
2250 HISTORY
2251 The mdoc language first appeared as a troff macro package in 4.4BSD. It
2252 was later significantly updated by Werner Lemberg and Ruslan Ermilov in
2253 groff-1.17. The standalone implementation that is part of the mandoc(1)
2254 utility written by Kristaps Dzonsons appeared in OpenBSD 4.6.
2255
2256 AUTHORS
2257 The mdoc reference was written by Kristaps Dzonsons <kristaps@bsd.lv>.
2258
2259 illumos July 28, 2018 illumos
|