Differences between current version and previous revision of mdoc.samples(7).
Other diffs: Previous Major Revision, Previous Author, or view the Annotated Edit History
| Newer page: | version 2 | Last edited on Saturday, August 23, 2003 4:25:07 pm | by StuartYeates | |
| Older page: | version 1 | Last edited on Monday, June 3, 2002 11:58:29 pm | by perry | Revert |
@@ -13,9 +13,9 @@
A tutorial sampler for writing BSD manual
pages with the -mdoc macro package, a ''content''-based
and ''domain''-based for- matting package for
-troff(1). Its predecessor, the -
man(7)
+troff(1). Its predecessor, the man(7)
package, addressed page layout leaving the manipulation of
fonts and other typesetting details to the individual
author. In -mdoc, page layout macros make up the ''page
structure domain'' which consists of macros for titles,
@@ -48,9 +48,9 @@
outlined as follows:
1.TROFF IDIOSYNCRASIES
-
Macro Usage. Passing Space Characters in an Argument. Trailing Blank Space Characters (awarning). Escaping Special Characters.2.THE ANATOMY OF A MAN PAGE A manual page template.3.TITLE MACROS.4.INTRODUCTION OF MANUAL AND GENERAL TEXT DOMAINS. What's in a name.... General Syntax.5.MANUAL DOMAIN Addresses. Author name. Arguments. Configuration Declarations (section fouronly). Command Modifier. Defined Variables. Errno's (Section two only). Environment Variables. Function Argument. Function Declaration. Flags. Functions (library routines). Function Types. Interactive Commands. Names. Options. Pathnames. Variables. Cross References.6.GENERAL TEXT DOMAIN ATPAGE STRUCTURE DOMAIN Section Headers. Paragraphs and Line Spacing. Keeps. Displays. Font Modes (Emphasis, Literal, andSymbolic). Lists and Columns.8.PREDEFINED STRINGS9.DIAGNOSTICS10.FORMATTING WITH GROFF, TROFF AND NROFF11.BUGS__TROFF IDIOSYNCRASIES__
+Macro Usage. Passing Space Characters in an Argument. Trailing Blank Space Characters (awarning). Escaping Special Characters.2.THE ANATOMY OF A MAN PAGE A manual page template.3.TITLE MACROS.4.INTRODUCTION OF MANUAL AND GENERAL TEXT DOMAINS. What's in a name.... General Syntax.5.MANUAL DOMAIN Addresses. Author name. Arguments. Configuration Declarations (section fouronly). Command Modifier. Defined Variables. Errno's (Section two only). Environment Variables. Function Argument. Function Declaration. Flags. Functions (library routines). Function Types. Interactive Commands. Names. Options. Pathnames. Variables. Cross References.6.GENERAL TEXT DOMAIN ATPAGE STRUCTURE DOMAIN Section Headers. Paragraphs and Line Spacing. Keeps. Displays. Font Modes (Emphasis, Literal, andSymbolic). Lists and Columns.8.PREDEFINED STRINGS9.DIAGNOSTICS10.FORMATTING WITH GROFF, TROFF AND NROFF11.BUGS__TROFF IDIOSYNCRASIES__
The -mdoc package attempts to simplify the process of writ-
ing a man page. Theoretically, one should not have to learn
@@ -79,9 +79,9 @@
In general, troff(1) macros accept up to nine
arguments, any extra arguments are ignored. Most macros in
-mdoc accept nine arguments and, in limited cases, arguments
-may be con- tinued
or extended on the next line (See
+may be continued
or extended on the next line (See
__Extensions__). A few macros handle quoted arguments
(see __Passing Space Characters in an Argument__
below).
@@ -93,12 +93,12 @@
or manual domain macro name and is determined to be callable
will be executed or called when it is processed. In this
case the argument, although the name of a macro, is not
preceded by a . (dot). It is in this manner that
-many macros are nested; for exam- ple
the option macro,
+many macros are nested; for example
the option macro,
.Op, may ''call'' the flag and argument macros,
Fl and Ar, to specify an optional flag
-with an argu- ment
:
+with an argument
:
[[-s bytes] is produced by .Op Fl s Ar bytes
To prevent a two character string from being interpreted as a macro name, precede the string with the escape sequence :
