summaryrefslogtreecommitdiff
path: root/tmac/groff_mdoc.man
diff options
context:
space:
mode:
authorwlemb <wlemb>2001-08-14 22:28:18 +0000
committerwlemb <wlemb>2001-08-14 22:28:18 +0000
commit04fe52a4bad67608e23d03abfaf950d9fb95d4ac (patch)
tree72f91149acce59016f063cd803812007428f99ad /tmac/groff_mdoc.man
parent280c04dc2fbc77f607bbd8a30e7ce066105e8238 (diff)
downloadgroff-04fe52a4bad67608e23d03abfaf950d9fb95d4ac.tar.gz
* tmac/doc.tmac (Ex): New implementation.
* tmac/doc-common, tmac/groff_tmac.man: Updated.
Diffstat (limited to 'tmac/groff_mdoc.man')
-rw-r--r--tmac/groff_mdoc.man38
1 files changed, 38 insertions, 0 deletions
diff --git a/tmac/groff_mdoc.man b/tmac/groff_mdoc.man
index 17ef3d61..534c5168 100644
--- a/tmac/groff_mdoc.man
+++ b/tmac/groff_mdoc.man
@@ -163,6 +163,7 @@ as follows:
. It "Functions (Library Routines)"
. It "Function Arguments"
. It "Return Values"
+. It "Exit Status"
. \" .It "Header File (including source code)"
. It "Interactive Commands"
. It "Library Names"
@@ -1537,6 +1538,36 @@ Currently, this macro does nothing if used without the
.Fl std
flag.
.
+.Ss "Exit Status"
+.
+The
+.Ql .Ex
+macro generates text for use in the
+.Sx DIAGNOSTICS
+section.
+.Pp
+.Dl Usage: .Ex Oo -std Oc Op Ao utility Ac ...
+.Pp
+For example,
+.Ql ".Ex -std cat"
+produces:
+.
+.Bd -ragged -offset -indent
+\# a small hack to suppress a warning message
+.ds section-old "\*[section]
+.ds section 1
+.Ex -std cat
+.ds section "\*[section-old]
+.Ed
+.Pp
+.
+The
+.Fl std
+option is valid only for manual page sections 1, 6 and\~8.
+Currently, this macro does nothing if used without the
+.Fl std
+flag.
+.
.Ss "Interactive Commands"
.
The
@@ -2709,6 +2740,13 @@ section below for details.
.
.It Li ".Sh DIAGNOSTICS"
Diagnostic messages from a command should be placed in this section.
+The
+.Ql .Ex
+macro may be used to generate text for use in the
+.Sx DIAGNOSTICS
+section for most section 1, 6 and\~8 commands;
+see
+.Sx "Exit Status" .
.
.It Li ".Sh COMPATIBILITY"
Known compatibility issues (e.g. deprecated options or parameters)