diff options
author | ru <ru@FreeBSD.org> | 2001-08-14 15:19:35 +0000 |
---|---|---|
committer | ru <ru@FreeBSD.org> | 2001-08-14 15:19:35 +0000 |
commit | 9348de26a244cae2e450a601c2d1cca29b1a3406 (patch) | |
tree | 1ed42fbcea9839216f9e10758f549a41392e1990 /contrib | |
parent | 213982a5006238355200339d141ae7bd6ae57cd1 (diff) | |
download | FreeBSD-src-9348de26a244cae2e450a601c2d1cca29b1a3406.zip FreeBSD-src-9348de26a244cae2e450a601c2d1cca29b1a3406.tar.gz |
From ChangeLog:
: 2001-08-13 Ruslan Ermilov <ru@FreeBSD.org>
:
: * tmac/doc.tmac (Rv): Implement support for 0 or more than 1
: argument.
: * tmac/groff_tmac.man: Updated.
All of the following are now valid:
.Rv -std f1
.Rv -std f1 f2
.Rv -std f1 f2 f3
.Rv -std
The last form is useful where the standard return behavior is applicable
to all of the functions described in this particular manpage. Look, for
example, at the stat(2), setresuid(2), and utimes(2) manpages.
The form with >1 functions is useful in a mixed environment. See the
fhopen(2) manpage for an example.
Prodded by: yar
Diffstat (limited to 'contrib')
-rw-r--r-- | contrib/groff/tmac/doc.tmac | 61 | ||||
-rw-r--r-- | contrib/groff/tmac/groff_mdoc.man | 4 |
2 files changed, 50 insertions, 15 deletions
diff --git a/contrib/groff/tmac/doc.tmac b/contrib/groff/tmac/doc.tmac index 5b8ec41..db8029f 100644 --- a/contrib/groff/tmac/doc.tmac +++ b/contrib/groff/tmac/doc.tmac @@ -6124,14 +6124,30 @@ .\" NS width register `Rv' set in doc-common .\" NS .\" NS local variables: -.\" NS doc-str-Rv-prefix -.\" NS doc-str-Rv-suffix -. -.ds doc-str-Rv-prefix "The -.ds doc-str-Rv-suffix "function returns the value\~0 if successful; -.as doc-str-Rv-suffix " otherwise the value\~-1 is returned and -.as doc-str-Rv-suffix " the global variable \*[doc-Va-font]errno\f[P] -.as doc-str-Rv-suffix " is set to indicate the error. +.\" NS doc-str-Rv-std-prefix +.\" NS doc-str-Rv-std-suffix +.\" NS doc-str-Rv-stds-prefix +.\" NS doc-str-Rv-stds-and +.\" NS doc-str-Rv-stds-suffix +.\" NS doc-str-Rv-std0 +. +.ds doc-str-Rv-std-prefix "The +.ds doc-str-Rv-std-suffix "function returns the value\~0 if successful; +.as doc-str-Rv-std-suffix " otherwise the value\~-1 is returned and +.as doc-str-Rv-std-suffix " the global variable \*[doc-Va-font]errno\f[P] +.as doc-str-Rv-std-suffix " is set to indicate the error. +. +.ds doc-str-Rv-stds-prefix "The +.ds doc-str-Rv-stds-and "and +.ds doc-str-Rv-stds-suffix "functions return the value\~0 if successful; +.as doc-str-Rv-stds-suffix " otherwise the value\~-1 is returned and +.as doc-str-Rv-stds-suffix " the global variable \*[doc-Va-font]errno\f[P] +.as doc-str-Rv-stds-suffix " is set to indicate the error. +. +.ds doc-str-Rv-std0 "Upon successful completion, the value\~0 is returned; +.as doc-str-Rv-std0 " otherwise the value\~-1 is returned and +.as doc-str-Rv-std0 " the global variable \*[doc-Va-font]errno\f[P] +.as doc-str-Rv-std0 " is set to indicate the error. . .de Rv . @@ -6144,7 +6160,7 @@ . \} . . if !\n[.$] \{\ -. tm Usage: .Rv [-std] <function> (#\n[.c]) +. tm Usage: .Rv [-std] [<function> ...] (#\n[.c]) . return . \} . @@ -6153,10 +6169,29 @@ . if ((\n[doc-reg-Rv] < 2) : (\n[doc-reg-Rv] > 3)) \ . tm Usage: .Rv -std in sections 2 and 3 only (#\n[.c]) . br -. nop \)\*[doc-str-Rv-prefix] -. Fn \$2 -. nop \)\*[doc-str-Rv-suffix] -. \} +. shift +. ie (\n[.$] > 1) \{\ +. nop \)\*[doc-str-Rv-stds-prefix] +. nr doc-reg-Rv 1 +. while (\n[doc-reg-Rv] < \n[.$]) \{\ +. ie (\n[.$] > 2) \ +. Fn \$\n[doc-reg-Rv] , +. el \ +. Fn \$\n[doc-reg-Rv] +. nr doc-reg-Rv +1 +. \} +. nop \)\*[doc-str-Rv-stds-and] +. Fn \$\n[.$] +. nop \)\*[doc-str-Rv-stds-suffix] +. \} +. el \{ .ie (\n[.$] == 1) \{\ +. nop \)\*[doc-str-Rv-std-prefix] +. Fn \$1 +. nop \)\*[doc-str-Rv-std-suffix] +. \} +. el \{\ +. nop \)\*[doc-str-Rv-std0] +. \}\}\} .. . . diff --git a/contrib/groff/tmac/groff_mdoc.man b/contrib/groff/tmac/groff_mdoc.man index dec0655..17ef3d6 100644 --- a/contrib/groff/tmac/groff_mdoc.man +++ b/contrib/groff/tmac/groff_mdoc.man @@ -46,7 +46,7 @@ .\" for an already extremely slow package. .\" . -.Dd April 10, 2001 +.Dd July 20, 2001 .Os .Dt GROFF_MDOC 7 . @@ -1515,7 +1515,7 @@ macro generates text for use in the .Sx RETURN VALUES section. .Pp -.Dl Usage: .Rv Oo -std Oc Ao function Ac +.Dl Usage: .Rv Oo -std Oc Op Ao function Ac ... .Pp For example, .Ql ".Rv -std atexit" |