summaryrefslogtreecommitdiffstats
path: root/mdoc.7
diff options
context:
space:
mode:
authorKristaps Dzonsons <kristaps@bsd.lv>2010-06-04 20:57:26 +0000
committerKristaps Dzonsons <kristaps@bsd.lv>2010-06-04 20:57:26 +0000
commitbf61435dc0abfd7e6ec28cc908580306d14676f3 (patch)
tree69d07ce7c25d57ad079dee323c4eaaa4a562ebf1 /mdoc.7
parent9a1ca3441d9d2ab749c31a82dd52ebda4f5160f7 (diff)
downloadmandoc-bf61435dc0abfd7e6ec28cc908580306d14676f3.tar.gz
Documented `Db', `El', `Fa', and `Fd'.
Diffstat (limited to 'mdoc.7')
-rw-r--r--mdoc.737
1 files changed, 37 insertions, 0 deletions
diff --git a/mdoc.7 b/mdoc.7
index a4501505..b8b787ca 100644
--- a/mdoc.7
+++ b/mdoc.7
@@ -1332,6 +1332,11 @@ See also
and
.Sx \&Dl .
.Ss \&Db
+Start a debugging context.
+This macro is parsed, but generally ignored.
+Its calling syntax is as follows:
+.Pp
+.D1 \. Ns Sx \&Db Cm on | off
.Ss \&Dc
Closes a
.Sx \&Do
@@ -1559,6 +1564,13 @@ and
.Ss \&Ef
.Ss \&Ek
.Ss \&El
+Ends a list context started by
+.Sx \&Bl .
+.Pp
+See also
+.Sx \&Bl
+and
+.Sx \&It .
.Ss \&Em
Denotes text that should be emphasised.
Note that this is a presentation term and should not be used for
@@ -1598,8 +1610,33 @@ is not provided, the document's name as stipulated in
.Sx \&Nm
is provided.
.Ss \&Fa
+Function argument.
+This may be invoked for names with or without the corresponding type.
+It is also used to specify the field name of a structure.
+Most often, the
+.Sx \&Fa
+macro is used in the
+.Em SYNOPSIS
+section when documenting multi-line function prototypes.
+If invoked with multiple arguments, the arguments are separated by a
+comma.
+Furthermore, if the following macro is another
+.Sx \&Fa ,
+the last argument will also have a trailing comma.
+.Pp
+Examples:
+.D1 \&.Fa \(dqconst char *p\(dq
+.D1 \&.Fa \(dqint a\(dq \(dqint b\(dq \(dqint c\(dq
+.D1 \&.Fa foo
.Ss \&Fc
.Ss \&Fd
+Historically used to document include files.
+This usage has been deprecated in favour of
+.Sx \&In .
+Do not use this macro.
+.Pp
+See also
+.Sx \&In .
.Ss \&Fl
Command-line flag.
Used when listing arguments to command-line utilities.