summaryrefslogtreecommitdiffstats
path: root/contrib/groff/tmac/groff_mdoc.man
diff options
context:
space:
mode:
authorru <ru@FreeBSD.org>2001-08-15 08:17:33 +0000
committerru <ru@FreeBSD.org>2001-08-15 08:17:33 +0000
commitd5b7bd9ab4f1081919fe4675b4688491c53effde (patch)
treef91b4a3cd3b48c1f1e2d79a9726ac639681af8a5 /contrib/groff/tmac/groff_mdoc.man
parent9348de26a244cae2e450a601c2d1cca29b1a3406 (diff)
downloadFreeBSD-src-d5b7bd9ab4f1081919fe4675b4688491c53effde.zip
FreeBSD-src-d5b7bd9ab4f1081919fe4675b4688491c53effde.tar.gz
From ChangeLog:
: 2001-08-14 Ruslan Ermilov <ru@FreeBSD.org> : : * tmac/doc.tmac (Ex): New implementation. : * tmac/doc-common, tmac/groff_tmac.man: Updated. This adds a new macro, .Ex (Exit Status), for use in the DIAGNOSTICS section of section 1, 6 and 8 manpages. Prodded by: dd
Diffstat (limited to 'contrib/groff/tmac/groff_mdoc.man')
-rw-r--r--contrib/groff/tmac/groff_mdoc.man38
1 files changed, 38 insertions, 0 deletions
diff --git a/contrib/groff/tmac/groff_mdoc.man b/contrib/groff/tmac/groff_mdoc.man
index 17ef3d6..534c516 100644
--- a/contrib/groff/tmac/groff_mdoc.man
+++ b/contrib/groff/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)
OpenPOWER on IntegriCloud