diff options
| author |   Kristaps Dzonsons <kristaps@bsd.lv> | 2011-07-18 10:23:02 +0000 |
|---|---|---|
| committer | Kristaps Dzonsons <kristaps@bsd.lv> | 2011-07-18 10:23:02 +0000 |
| commit | 7ed796f084952eeeec4f96d00aaf0e994f071047 (patch) | |
| tree | 5381e0a2b2dd1f257cb1a7b4e22d732b3e02d164 /mdoc.7 | |
| parent | c1f71c38bac4a2fee48c8e05855f5ac59a25ae4b (diff) | |
| download | mandoc-7ed796f084952eeeec4f96d00aaf0e994f071047.tar.gz mandoc-7ed796f084952eeeec4f96d00aaf0e994f071047.tar.zst mandoc-7ed796f084952eeeec4f96d00aaf0e994f071047.zip | |
Clarify up `Rv' and `Ex' documentation.
Diffstat (limited to 'mdoc.7')
| -rw-r--r-- | mdoc.7 | 34 |
1 files changed, 22 insertions, 12 deletions
@@ -1,4 +1,4 @@ -.\" $Id: mdoc.7,v 1.190 2011/07/15 20:40:32 schwarze Exp $ +.\" $Id: mdoc.7,v 1.191 2011/07/18 10:23:02 kristaps Exp $ .\" .\" Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> .\" Copyright (c) 2010 Ingo Schwarze <schwarze@openbsd.org> @@ -15,7 +15,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: July 15 2011 $ +.Dd $Mdocdate: July 18 2011 $ .Dt MDOC 7 .Os .Sh NAME @@ -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 . |