summaryrefslogtreecommitdiffstats
path: root/mdoc.7
diff options
context:
space:
mode:
authorKristaps Dzonsons <kristaps@bsd.lv>2011-07-18 10:23:02 +0000
committerKristaps Dzonsons <kristaps@bsd.lv>2011-07-18 10:23:02 +0000
commit45631964bff6bf11513de08ba29baef754890d00 (patch)
tree898250a66ca1e6ee116043a14b7150eba3d3547a /mdoc.7
parent2173e28fcf7b145a4c262891755ce23df43319b7 (diff)
downloadmandoc-45631964bff6bf11513de08ba29baef754890d00.tar.gz
Clarify up `Rv' and `Ex' documentation.
Diffstat (limited to 'mdoc.7')
-rw-r--r--mdoc.730
1 files changed, 20 insertions, 10 deletions
diff --git a/mdoc.7 b/mdoc.7
index 6f211e47..784a7be0 100644
--- a/mdoc.7
+++ b/mdoc.7
@@ -1821,16 +1821,20 @@ See also
.Sx \&Dv
for general constants.
.Ss \&Ex
-Insert a standard sentence regarding exit values.
+Insert a standard sentence regarding command exit values of 0 on success
+and >0 on failure.
Its syntax is as follows:
.Pp
-.D1 Pf \. Sx \&Ex Fl std Op Ar utility
+.D1 Pf \. Sx \&Ex Fl std Op Ar utility...
.Pp
-When
+If
.Ar utility
is not specified, the document's name set by
.Sx \&Nm
is used.
+Multiple
+.Ar utility
+arguments are treated as separate utilities.
.Pp
See also
.Sx \&Rv .
@@ -2462,16 +2466,22 @@ block is used within a SEE ALSO section, a vertical space is asserted
before the rendered output, else the block continues on the current
line.
.Ss \&Rv
-Inserts text regarding a function call's return value.
-This macro must consist of the
-.Fl std
-argument followed by an optional
-.Ar function .
+Insert a standard sentence regarding a system call's return value of 0
+on success and \-1 on error, with the
+.Va errno
+libc global variable set on error.
+Its syntax is as follows:
+.Pp
+.D1 Pf \. Sx \&Rv Fl std Op Ar function...
+.Pp
If
.Ar function
-is not provided, the document's name as stipulated by the first
+is not specified, the document's name set by
.Sx \&Nm
-is provided.
+is used.
+Multiple
+.Ar function
+arguments are treated as separate functions.
.Pp
See also
.Sx \&Ex .