diff options
| author |   Kristaps Dzonsons <kristaps@bsd.lv> | 2010-06-04 20:57:26 +0000 |
|---|---|---|
| committer | Kristaps Dzonsons <kristaps@bsd.lv> | 2010-06-04 20:57:26 +0000 |
| commit | cdd2b3c33fbd3e98ec382b355b933fe87e0bd605 (patch) | |
| tree | 764c78270b4ceb48b1155251e6de9351d8c062ab /mdoc.7 | |
| parent | 93846a3c2a1fbfc00717e873aa0de54b8dc4702d (diff) | |
| download | mandoc-cdd2b3c33fbd3e98ec382b355b933fe87e0bd605.tar.gz mandoc-cdd2b3c33fbd3e98ec382b355b933fe87e0bd605.tar.zst mandoc-cdd2b3c33fbd3e98ec382b355b933fe87e0bd605.zip | |
Documented `Db', `El', `Fa', and `Fd'.
Diffstat (limited to 'mdoc.7')
| -rw-r--r-- | mdoc.7 | 41 |
1 files changed, 39 insertions, 2 deletions
@@ -1,4 +1,4 @@ -.\" $Id: mdoc.7,v 1.116 2010/06/03 15:54:27 kristaps Exp $ +.\" $Id: mdoc.7,v 1.117 2010/06/04 20:57:26 kristaps Exp $ .\" .\" Copyright (c) 2009 Kristaps Dzonsons <kristaps@bsd.lv> .\" @@ -14,7 +14,7 @@ .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: June 3 2010 $ +.Dd $Mdocdate: June 4 2010 $ .Dt MDOC 7 .Os .Sh NAME @@ -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. |