Appendix: Macros

This table consists of brief descriptions of mdoc macros referenced in this book (meaning: this is not a complete list!), then links to full descriptions according to the mdoc reference on http://mdocml.bsd.lv. Disclaimer: I'm the principle author of this system.

Ap
Insert an apostrophe. Reference: Ap.
Ar
Argument to a command or flag. Reference: Ar.
Bd
Begin a display. Reference: Bd.
Bl
Begin a list. Reference: Bl.
Bq
Square-bracket arguments. Reference: Bq.
Bx
BSD UNIX text. Reference: Bx.
Dd
Date of manual's last edit. Reference: Dd.
Dl
Display a line of literal text. Reference: Dl.
Dt
Title and category of a manual. Reference: Dt.
Dv
Constant-value variables. Reference: Dv.
Ed
End a display. Reference: Ed.
El
End a list. Reference: El.
Em
Text to be emphasised (presentational). Reference: Em.
Er
Error constant. Reference: Er.
Ev
Environment variable. Reference: Ev.
Ex
Exit code of a command. Reference: Ex.
Fa
Function argument. Reference: Fa.
Fc
Close multi-line function prototype. Reference: Fc.
Fd
A preprocessor macro definition. Reference: Fd.
Fl
Command flag (switch). Reference: Fl.
Fn
Function name. Reference: Fn.
Fo
Open multi-line function prototype. Reference: Fo.
Ft
Function type. Reference: Ft.
In
Include file (header file). Reference: In.
Lb
Library name. Reference: Lb.
Li
Literal text (presentational). Reference: Li.
Nd
A one-line description of the material. Reference: Nd.
Nm
Set or get name of documented component. Reference: Nm.
Ns
Suppress the following space and reset formatting. Reference: Ns.
Os
Operating system applying to manual. Reference: Os.
It
List item. Reference: It.
Oc
Close an optional part block. Reference: Oc.
Oo
Open an optional part block. Reference: Oo.
Op
Optional part of a command invocation. Reference: Op.
Ox
Format the OpenBSD operating system name. Reference: Ox.
Pp
Separate paragraphs with vertical space. Reference: Pp.
Pq
Parenthesise arguments. Reference: Pq.
Ql
Enclose literal argument in single quotes. Reference: Ql.
Qq
Enclose arguments in regular double quotes. Reference: Qq.
Rs
Begin a reference (bibliographic) block. Reference: Rs.
Rv
Function return value. Reference: Rv.
Sh
Begin a manual section. Reference: Sh.
Sq
Single-quote arguments. Reference: Sq.
Ss
Begin a manual subsection. Reference: Ss.
St
Print a standard name. Reference: St.
Va
Variable name. Reference: Va.
Vt
Variable type. Reference: Vt.
Xr
Manual cross-reference. Reference: Xr.

Last edited by $Author: kristaps $ on $Date: 2011/11/04 01:06:28 $. Copyright © 2011, Kristaps Dzonsons. CC BY-SA.