4.4BSD/usr/share/man/cat7/mdoc.0
MDOC(7) BSD Reference Manual MDOC(7)
NNAAMMEE
mmddoocc - quick reference guide for the --mmddoocc macro package
SSYYNNOOPPSSIISS
ggrrooffff --mm_d_o_c _f_i_l_e_s _._._.
DDEESSCCRRIIPPTTIIOONN
The --mmddoocc package is a set of content-based and domain-based macros used
to format the BSD man pages. The macro names and their meanings are
listed below for quick reference; for a detailed explanation on using the
package, see the tutorial sampler mdoc.samples(7).
The macros are described in two groups, the first includes the structural
and physical page layout macros. The second contains the manual and gen-
eral text domain macros which differentiate the --mmddoocc package from other
troff formatting packages.
PPAAGGEE SSTTRRUUCCTTUURREE DDOOMMAAIINN
TTiittllee MMaaccrrooss
To create a valid manual page, these three macros, in this order, are re-
quired:
.Dd _M_o_n_t_h _d_a_y_, _y_e_a_r Document date.
.Dt _D_O_C_U_M_E_N_T___T_I_T_L_E _[_s_e_c_t_i_o_n_] _[_v_o_l_u_m_e_] Title, in upper case.
.Os _O_P_E_R_A_T_I_N_G___S_Y_S_T_E_M _[_v_e_r_s_i_o_n_/_r_e_l_e_a_s_e_] Operating system (BSD).
PPaaggee LLaayyoouutt MMaaccrrooss
Section headers, paragraph breaks, lists and displays.
.Sh Section Headers. Valid headers, in the order of presentation:
_N_A_M_E Name section, should include the `.Nm' or `.Fn' and
the `.Nd' macros.
_S_Y_N_O_P_S_I_S Usage.
_D_E_S_C_R_I_P_T_I_O_N General description, should include options and pa-
rameters.
_R_E_T_U_R_N _V_A_L_U_E_S Sections two and three function calls.
_E_N_V_I_R_O_N_M_E_N_T Describe environment variables.
_F_I_L_E_S Files associated with the subject.
_E_X_A_M_P_L_E_S Examples and suggestions.
_D_I_A_G_N_O_S_T_I_C_S Normally used for section four device interface di-
agnostics.
_E_R_R_O_R_S Sections two and three error and signal handling.
_S_E_E _A_L_S_O Cross references and citations.
_S_T_A_N_D_A_R_D_S Conformance to standards if applicable.
_H_I_S_T_O_R_Y If a standard is not applicable, the history of the
subject should be given.
_B_U_G_S Gotchas and caveats.
_o_t_h_e_r Customized headers may be added at the authors dis-
cretion.
.Ss Subsection Headers.
.Pp Paragraph Break. Vertical space (one line).
.D1 (D-one) Display-one Indent and display one text line.
.Dl (D-ell) Display-one literal. Indent and display one line of liter-
al text.
.Bd Begin-display block. Display options:
--rraaggggeedd Unjustified (ragged edges).
--ffiilllleedd Justified.
--lliitteerraall Literal text or code.
--ffiillee _n_a_m_e Read in named _f_i_l_e and display.
--ooffffsseett _s_t_r_i_n_g Offset display. Acceptable _s_t_r_i_n_g values:
_l_e_f_t Align block on left (default).
_c_e_n_t_e_r Approximate center margin.
_i_n_d_e_n_t Six constant width spaces (a tab).
_i_n_d_e_n_t_-_t_w_o Two tabs.
_r_i_g_h_t Left aligns block 2 inches from right.
_x_xnn Where _x_x is a number from 4nn to 99nn.
_A_a Where _A_a is a callable macro name.
_s_t_r_i_n_g The width of _s_t_r_i_n_g is used.
.Ed End-display (matches .Bd).
.Bl Begin-list. Create lists or columns. Options:
_L_i_s_t_-_t_y_p_e_s
--bbuulllleett Bullet Item List
--iitteemm Unlabeled List
--eennuumm Enumerated List
--ttaagg Tag Labeled List
--ddiiaagg Diagnostic List
--hhaanngg Hanging Labeled List
--oohhaanngg Overhanging Labeled List
--iinnsseett Inset or Run-on Labeled List
List-parameters
--ooffffsseett (All lists.) See `.Bd' begin-display above.
--wwiiddtthh (--ttaagg and --hhaanngg lists only.) See `.Bd'.
--ccoommppaacctt (All lists.) Suppresses blank lines.
.El End-list.
.It List item.
MMAANNUUAALL AANNDD GGEENNEERRAALL TTEEXXTT DDOOMMAAIINN MMAACCRROOSS
The manual and general text domain macros are special in that most of
them are parsed for callable macros for example:
.Op Fl s Ar file Produces [--ss _f_i_l_e]
In this example, the option enclosure macro `.Op' is parsed, and calls
the callable content macro `Fl' which operates on the argument `s' and
then calls the callable content macro `Ar' which operates on the argument
`file'. Some macros may be callable, but are not parsed and vice versa.
These macros are indicated in the _p_a_r_s_e_d and _c_a_l_l_a_b_l_e columns below.
Unless stated, manual domain macros share a common syntax:
.Va argument [ . , ; : ( ) [ ] argument ... ]
NNoottee: Opening and closing punctuation characters are only recognized as
such if they are presented one at a time. The string `),' is not recog-
nized as punctuation and will be output with a leading white space and in
what ever font the calling macro uses. The the argument list `] ) ,' is
recognized as three sequential closing punctuation characters and a lead-
ing white space is not output between the characters and the previous ar-
gument (if any). The special meaning of a punctuation character may be
escaped with the string `\&'. For example the following string,
.Ar file1 , file2 , file3 ) . Produces _f_i_l_e_1, _f_i_l_e_2, _f_i_l_e_3).
MMaannuuaall DDoommaaiinn MMaaccrrooss
_N_a_m_e _P_a_r_s_e_d _C_a_l_l_a_b_l_e _D_e_s_c_r_i_p_t_i_o_n
Ad Yes Yes Address. (This macro may be deprecated.)
Ar Yes Yes Command line argument.
Cd No No Configuration declaration (section four
only).
Cm Yes Yes Command line argument modifier.
Dv Yes Yes Defined variable (source code).
Er Yes Yes Error number (source code).
Ev Yes Yes Environment variable.
Fa Yes Yes Function argument.
Fd Yes Yes Function declaration.
Fn Yes Yes Function call (also .Fo and .Fc).
Ic Yes Yes Interactive command.
Li Yes Yes Literal text.
Nm Yes Yes Command name.
Op Yes Yes Option (also .Oo and .Oc).
Ot Yes Yes Old style function type (Fortran only).
Pa Yes Yes Pathname or file name.
St Yes Yes Standards (-p1003.2, -p1003.1 or -ansiC)
Va Yes Yes Variable name.
Vt Yes Yes Variable type (Fortran only).
Xr Yes Yes Manual Page Cross Reference.
GGeenneerraall TTeexxtt DDoommaaiinn MMaaccrrooss
_N_a_m_e _P_a_r_s_e_d _C_a_l_l_a_b_l_e _D_e_s_c_r_i_p_t_i_o_n
%A Yes No Reference author.
%B Yes Yes Reference book title.
%C No No Reference place of publishing (city).
%D No No Reference date.
%J Yes Yes Reference journal title.
%N No No Reference issue number.
%O No No Reference optional information.
%P No No Reference page number(s).
%R No No Reference report Name.
%T Yes Yes Reference article title.
%V No No Reference volume.
Ac Yes Yes Angle close quote.
Ao Yes Yes Angle open quote.
Aq Yes Yes Angle quote.
At No No AT&T UNIX
Bc Yes Yes Bracket close quote.
Bf No No Begin font mode.
Bo Yes Yes Bracket open quote.
Bq Yes Yes Bracket quote.
Bx Yes Yes Bx.
Db No No Debug (default is "off")
Dc Yes Yes Double close quote.
Do Yes Yes Double open quote.
Dq Yes Yes Double quote.
Ec Yes Yes Enclose string close quote.
Ef No No End font mode.
Em Yes Yes Emphasis (traditional English).
Eo Yes Yes Enclose string open quote.
No Yes Yes Normal text (no-op).
Ns Yes Yes No space.
Pc Yes Yes Parenthesis close quote.
Pf Yes No Prefix string.
Po Yes Yes Parenthesis open quote.
Pq Yes Yes Parentheses quote.
Qc Yes Yes Strait Double close quote.
Ql Yes Yes Quoted literal.
Qo Yes Yes Strait Double open quote.
Qq Yes Yes Strait Double quote.
Re No No Reference start.
Rs No No Reference start.
Sc Yes Yes Single close quote.
So Yes Yes Single open quote.
Sq Yes Yes Single quote.
Sm No No Space mode (default is "on")
Sx Yes Yes Section Cross Reference.
Sy Yes Yes Symbolic (traditional English).
Tn Yes Yes Trade or type name (small Caps).
Ux Yes Yes Ux
Xc Yes Yes Extend argument list close.
Xo Yes Yes Extend argument list close.
Macro names ending in `q' quote remaining items on the argument list.
Macro names ending in `o' begin a quote which may span more than one line
of input and are close quoted with the matching macro name ending in `c'.
Enclosure macros may be nested and are limited to eight arguments.
Note: the extended argument list macros (`.Xo', `.Xc') and the function
enclosure macros (`.Fo', `.Fc') are irregular. The extended list macros
are used when the number of macro arguments would exceed the troff limi-
tation of nine arguments.
CCOONNFFIIGGUURRAATTIIOONN
For site specific configuration of the macro package, see the file
_/_u_s_r_/_s_r_c_/_s_h_a_r_e_/_t_m_a_c_/_R_E_A_D_M_E.
FFIILLEESS
tmac.doc Manual and general text domain macros.
tmac.doc-common Common structural macros and definitions.
tmac.doc-nroff Site dependent nroff style file.
tmac.doc-ditroff Site dependent troff style file.
tmac.doc-syms Special defines (such as the standards macro).
SSEEEE AALLSSOO
mdoc.samples(7)
4.4BSD June 9, 1993 4