Use the ``.Rv -std'' mdoc(7) macro in appropriate cases.

Reviewed by:	ru
This commit is contained in:
Yaroslav Tykhiy 2001-08-09 13:32:13 +00:00
parent 91ce3c5b85
commit b1250632c5
Notes: svn2git 2020-12-20 02:59:44 +00:00
svn path=/head/; revision=81352
66 changed files with 66 additions and 291 deletions

View File

@ -66,10 +66,7 @@ the sender must be the super-user.
As a single special case the continue signal SIGCONT may be sent
to any process that is a descendant of the current process.
.Sh RETURN VALUES
Upon successful completion, a value of 0 is returned. Otherwise,
a value of -1 is returned and the global variable
.Va errno
is set to indicate the error.
.Rv -std killpg
.Sh ERRORS
.Fn Killpg
will fail and no signal will be sent if:

View File

@ -256,10 +256,7 @@ flag is not available in
.Bx 4.2 ,
hence it should not be used if backward compatibility is needed.
.Sh RETURN VALUES
A 0 value indicated that the call succeeded. A \-1 return value
indicates an error occurred and
.Va errno
is set to indicated the reason.
.Rv -std sigvec
.Sh ERRORS
.Fn Sigvec
will fail and no new signal handler will be installed if one

View File

@ -166,11 +166,7 @@ effective gid can match either
or
.Va msg_perm.gid .
.Sh RETURN VALUES
Upon successful completion, a value of 0 is returned.
Otherwise, -1 is
returned and the global variable
.Va errno
is set to indicate the error.
.Rv -std msgctl
.Sh ERRORS
.Fn msgctl
will fail if:

View File

@ -121,10 +121,7 @@ is set to the pid of the calling process.
is set to the current time.
.El
.Sh RETURN VALUES
Upon successful completion, 0 is returned.
Otherwise, -1 is returned and
.Va errno
is set to indicate the error.
.Rv -std msgsnd
.Sh ERRORS
.Fn msgsnd
will fail if:

View File

@ -55,10 +55,7 @@ function sends the signal
.Fa sig
to the current process.
.Sh RETURN VALUES
Upon successful completion, a value of 0 is returned.
Otherwise, a value of \-1 is returned and the global variable
.Va errno
is set to indicate the error.
.Rv -std raise
.Sh ERRORS
The
.Fn raise

View File

@ -49,12 +49,7 @@ After a successful call to
is unuseable until re-initialized by another call to
.Fn sem_init .
.Sh RETURN VALUES
If successful,
.Fn sem_destroy
returns 0. Otherwise, -1 is returned and
.Va errno
is set to indicate the type of
error.
.Rv -std sem_destroy
.Sh ERRORS
.Fn sem_destroy
will fail if:

View File

@ -49,12 +49,7 @@ as of the time that the call to
.Fn sem_getvalue
is actually run.
.Sh RETURN VALUES
If successful,
.Fn sem_getvalue
returns 0. Otherwise, -1 is returned and
.Va errno
is set to indicate the type of
error.
.Rv -std sem_getvalue
.Sh ERRORS
.Fn sem_getvalue
will fail if:

View File

@ -63,12 +63,7 @@ and
is no longer valid after a successful call to
.Fa sem_destroy .
.Sh RETURN VALUES
If successful,
.Fn sem_init
returns 0. Otherwise, -1 is returned and
.Va errno
is set to indicate the type of
error.
.Rv -std sem_init
.Sh ERRORS
.Fn sem_init
will fail if:

View File

@ -52,12 +52,7 @@ the semaphore will be allowed to return from
.Fn sem_post
is signal-reentrant and may be called within signal handlers.
.Sh RETURN VALUES
If successful,
.Fn sem_post
returns 0. Otherwise, -1 is returned and
.Va errno
is set to indicate the type of
error.
.Rv -std sem_post
.Sh ERRORS
.Fn sem_post
will fail if:

View File

@ -69,11 +69,7 @@ Version level of the operating system.
Machine hardware platform.
.El
.Sh RETURN VALUES
If
.Fn uname
is successful, 0 is returned, otherwise, -1 is returned and
.Va errno
is set appropriately.
.Rv -std uname
.Sh ERRORS
The
.Fn uname

View File

@ -78,13 +78,7 @@ with the correct machine context for vm86, and with the
.Em PSL_VM
bit set. Control returns to the process upon delivery of a signal.
.Sh RETURN VALUES
Upon successful completion,
.Fn i386_vm86
will return the value of 0.
Otherwise, a value of -1 is returned and the global
variable
.Va errno
is set to indicate the error.
.Rv -std i386_vm86
.Sh ERRORS
.Fn i386_vm86
will fail if:

View File

@ -50,10 +50,7 @@ or
support for POSIX.1e interfaces and features is still under
development at this time.
.Sh RETURN VALUES
In the event of success, 0 is returned. In the event of failure, -1 is
returned, and
.Va errno
is set to indicate the error.
.Rv -std acl_free
.Sh ERRORS
If any of the following conditions occur, the
.Fn acl_free

View File

@ -52,10 +52,7 @@ implementation shall be cleared.
support for POSIX.1e interfaces and features is still under
development at this time.
.Sh RETURN VALUES
Upon successful completion, the function shall return a value of zero.
Otherwise, a value of -1 shall be returned and
.Va errno
shall be set to indicate the error.
.Rv -std cap_clear
.Sh ERRORS
If any of the following conditions occur, the
.Fn cap_clear

View File

@ -57,10 +57,7 @@ function.
support for POSIX.1e interfaces and features is still under
development at this time.
.Sh RETURN VALUES
Upon successful completion, the function shall return a value of zero.
Otherwise, a value of -1 shall be returned and
.Va errno
set to indicate the error.
.Rv -std cap_free
.Sh ERRORS
If any of the following conditions occur, the
.Fn cap_free

View File

@ -56,10 +56,7 @@ and place it into the location pointed to by
support for POSIX.1e interfaces and features is still under
development at this time.
.Sh RETURN VALUES
Upon successful completion, the function shall return a value of zero.
Otherwise, a value of -1 shall be returned and
.Va errno
set to indicate the error.
.Rv -std cap_get_flag
.Sh ERRORS
If any of the following conditions occur, the
.Fn cap_get_flag

View File

@ -63,12 +63,7 @@ is the equivalent of
Otherwise, it is the equivalent of
.Fn unlink "path" .
.Sh RETURN VALUES
Upon successful completion,
.Fn remove
returns 0.
Otherwise, \-1 is returned and the global variable
.Va errno
is set to indicate the error.
.Rv -std remove
.Sh ERRORS
The
.Fn remove

View File

@ -108,10 +108,7 @@ These functions are variants of most-significant-byte radix sorting; in
particular, see D.E. Knuth's Algorithm R and section 5.2.5, exercise 10.
They take linear time relative to the number of bytes in the strings.
.Sh RETURN VALUES
Upon successful completion 0 is returned.
Otherwise, \-1 is returned and the global variable
.Va errno
is set to indicate the error.
.Rv -std radixsort
.Sh ERRORS
.Bl -tag -width Er
.It Bq Er EINVAL

View File

@ -84,10 +84,7 @@ The call
.Fn adjtime
is restricted to the super-user.
.Sh RETURN VALUES
A return value of 0 indicates that the call succeeded.
A return value of -1 indicates that an error occurred, and in this
case an error code is stored in the global variable
.Va errno .
.Rv -std adjtime
.Sh ERRORS
.Fn Adjtime
will fail if:

View File

@ -86,10 +86,7 @@ Before returning,
unlocks
.Fa s .
.Sh RETURN VALUES
If the bind is successful, a 0 value is returned.
A return value of -1 indicates an error, which is
further specified in the global
.Va errno .
.Rv -std bind
.Sh ERRORS
The
.Fn bind

View File

@ -123,10 +123,7 @@ Before returning,
unlocks
.Fa d .
.Sh RETURN VALUES
Upon successful completion, a value of 0 is returned.
Otherwise, a value of -1 is returned and the global integer variable
.Va errno
is set to indicate the error.
.Rv -std close
.Sh ERRORS
.Fn Close
will fail if:

View File

@ -96,10 +96,7 @@ Before returning,
unlocks
.Va s .
.Sh RETURN VALUES
If the connection or binding succeeds, 0 is returned.
Otherwise a -1 is returned, and a more specific error
code is stored in
.Va errno .
.Rv -std connect
.Sh ERRORS
The
.Fn connect

View File

@ -134,10 +134,7 @@ Before returning,
unlocks
.Fa fd .
.Sh RETURN VALUES
Zero is returned if the operation was successful;
on an error a -1 is returned and an error code is left in
the global location
.Va errno .
.Rv -std flock
.Sh ERRORS
The
.Fn flock

View File

@ -78,8 +78,7 @@ Before returning,
unlocks
.Fa fd .
.Sh RETURN VALUES
A 0 value is returned on success. A -1 value indicates
an error.
.Rv -std fsync
.Sh ERRORS
The
.Fn fsync

View File

@ -52,10 +52,7 @@ in the file handle pointed to by
.Fa fhp .
This system call is restricted to the superuser.
.Sh RETURN VALUES
Upon successful completion, a value of 0 is returned.
Otherwise, -1 is returned and the global variable
.Va errno
is set to indicate the error.
.Rv -std getfh
.Sh ERRORS
.Fn Getfh
fails if one or more of the following are true:

View File

@ -80,7 +80,7 @@ Before returning,
unlocks
.Fa s .
.Sh RETURN VALUES
A 0 is returned if the call succeeds, -1 if it fails.
.Rv -std getpeername
.Sh ERRORS
The call succeeds unless:
.Bl -tag -width Er

View File

@ -152,11 +152,7 @@ account only for real
I/O; data supplied by the caching mechanism is charged only
to the first process to read or write the data.
.Sh RETURN VALUES
Upon successful completion,
.Fn getrusage
returns 0. Otherwise, a value of -1 is returned and
.Va errno
is set to indicate the error.
.Rv -std getrusage
.Sh ERRORS
The
.Fn getrusage

View File

@ -78,7 +78,7 @@ Before returning,
unlocks
.Fa fd .
.Sh RETURN VALUES
A 0 is returned if the call succeeds, -1 if it fails.
.Rv -std getsockname
.Sh ERRORS
The call succeeds unless:
.Bl -tag -width Er

View File

@ -106,10 +106,7 @@ is equal to the absolute value of the process number.
This is a variant of
.Xr killpg 2 .
.Sh RETURN VALUES
Upon successful completion, a value of 0 is returned.
Otherwise, a value of -1 is returned and
.Va errno
is set to indicate the error.
.Rv -std kill
.Sh ERRORS
.Fn Kill
will fail and no signal will be sent if:

View File

@ -135,10 +135,7 @@ The type specific records are defined in the
.Aq Pa sys/ktrace.h
include file.
.Sh RETURN VALUES
On successful completion a value of 0 is returned.
Otherwise, a value of -1 is returned and
.Va errno
is set to show the error.
.Rv -std ktrace
.Sh ERRORS
.Fn Ktrace
will fail if:

View File

@ -80,10 +80,7 @@ must be in the same file system.
.Fa name1
may not be a directory.
.Sh RETURN VALUES
Upon successful completion, a value of 0 is returned. Otherwise,
a value of -1 is returned and
.Va errno
is set to indicate the error.
.Rv -std link
.Sh ERRORS
.Fn Link
will fail and no link will be created if:

View File

@ -107,7 +107,7 @@ Before returning,
unlocks
.Fa s .
.Sh RETURN VALUES
A 0 return value indicates success; -1 indicates an error.
.Rv -std listen
.Sh ERRORS
.Fn Listen
will fail if:

View File

@ -133,11 +133,7 @@ Region is not included in a core file.
Include region in a core file.
.El
.Sh RETURN VALUES
Upon successful completion,
.Fn madvise
returns 0. Otherwise a value of -1 is returned and
.Va errno
is set to indicate the error.
.Rv -std madvise
.Sh ERRORS
The
.Fn madvise

View File

@ -56,11 +56,7 @@ Not all implementations will guarantee that the inheritance characteristic
can be set on a page basis;
the granularity of changes may be as large as an entire region.
.Sh RETURN VALUES
Upon successful completion,
.Fn minherit
returns 0. Otherwise, a value of -1 is returned and
.Va errno
is set to indicate the error.
.Rv -std minherit
.Sh ERRORS
The
.Fn minherit

View File

@ -58,9 +58,7 @@ The directory's owner ID is set to the process's effective user ID.
The directory's group ID is set to that of the parent directory in
which it is created.
.Sh RETURN VALUES
A 0 return value indicates success. A -1 return value
indicates an error, and an error code is stored in
.Va errno .
.Rv -std mkdir
.Sh ERRORS
.Fn Mkdir
will fail and no directory will be created if:

View File

@ -60,9 +60,7 @@ The fifo's owner ID is set to the process's effective user ID.
The fifo's group ID is set to that of the parent directory in
which it is created.
.Sh RETURN VALUES
A 0 return value indicates success. A -1 return value
indicates an error, and an error code is stored in
.Va errno .
.Rv -std mkfifo
.Sh ERRORS
.Fn Mkfifo
will fail and no fifo will be created if:

View File

@ -64,10 +64,7 @@ is ignored.
.Fn Mknod
requires super-user privileges.
.Sh RETURN VALUES
Upon successful completion a value of 0 is returned.
Otherwise, a value of -1 is returned and
.Va errno
is set to indicate the error.
.Rv -std mknod
.Sh ERRORS
.Fn Mknod
will fail and the file will be not created if:

View File

@ -54,12 +54,7 @@ changes the specified pages to have protection
Not all implementations will guarantee protection on a page basis;
the granularity of protection changes may be as large as an entire region.
.Sh RETURN VALUES
Upon successful completion,
.Fn mprotect
returns 0. Otherwise a value of -1 is returned
and
.Va errno
is set to indicate the error.
.Rv -std mprotect
.Sh ERRORS
The
.Fn mprotect

View File

@ -72,9 +72,7 @@ MS_SYNC Perform synchronous writes
MS_INVALIDATE Invalidate all cached data
.Ed
.Sh RETURN VALUES
If any errors occur, -1 is returned and errno is set to indicate the
error.
Otherwise, a 0 value is returned.
.Rv -std msync
.Sh ERRORS
.Fn msync
will fail if:

View File

@ -53,12 +53,7 @@ deletes the mappings for the specified address range,
and causes further references to addresses within the range
to generate invalid memory references.
.Sh RETURN VALUES
Upon successful completion,
.Fn munmap
returns zero.
Otherwise, a value of -1 is returned and
.Va errno
is set to indicate the error.
.Rv -std munmap
.Sh ERRORS
.Fn Munmap
will fail if:

View File

@ -88,12 +88,7 @@ portable to older systems, so it is recommended to use the convention
for using the endpoints in the traditional manner when using a
pipe in one direction.
.Sh RETURN VALUES
On successful creation of the pipe, zero is returned.
Otherwise,
a value of -1 is returned and the variable
.Va errno
set to indicate the
error.
.Rv -std pipe
.Sh ERRORS
The
.Fn pipe

View File

@ -151,10 +151,7 @@ and
parameters are ignored.
.El
.Sh RETURN VALUES
A successful call returns 0,
otherwise the value -1 is returned and the global variable
.Va errno
indicates the reason for the failure.
.Rv -std quotactl
.Sh ERRORS
A
.Fn quotactl

View File

@ -98,11 +98,7 @@ not the file or directory to which it points.
.\"Hard links to directories should be
.\"replaced by symbolic links by the system administrator.
.Sh RETURN VALUES
A 0 value is returned if the operation succeeds, otherwise
.Fn rename
returns -1 and the global variable
.Va errno
indicates the reason for the failure.
.Rv -std rename
.Sh ERRORS
.Fn Rename
will fail and neither of the argument files will be

View File

@ -73,10 +73,7 @@ device files.
It is normally used to prepare a terminal device for a new login session,
preventing any access by a previous user of the terminal.
.Sh RETURN VALUES
A 0 value indicated that the call succeeded. A \-1 return value
indicates an error occurred and
.Va errno
is set to indicated the reason.
.Rv -std revoke
.Sh ERRORS
Access to the named file is revoked unless one of the following:
.Bl -tag -width Er

View File

@ -55,9 +55,7 @@ than
and
.Ql \&.. .
.Sh RETURN VALUES
A 0 is returned if the remove succeeds; otherwise a -1 is
returned and an error code is stored in the global location
.Va errno .
.Rv -std rmdir
.Sh ERRORS
The named file is removed unless:
.Bl -tag -width Er

View File

@ -41,12 +41,7 @@ The
function forces the running process to relinquish the processor until it
again becomes the head of its process list. It takes no arguments.
.Sh RETURN VALUES
The
.Fn sched_yield
function will return zero if it completes successfully, or it
will return a value of -1 and set
.Va errno
to indicate the error.
.Rv -std sched_yield
.Sh ERRORS
On failure
.Va errno

View File

@ -163,11 +163,7 @@ for each semaphore is added to the semaphore's value. This can
be used to insure that a resource is released if a process terminates
unexpectedly.
.Sh RETURN VALUES
On success,
.Fn semop
returns 0; otherwise, -1 is returned and
.Va errno
is set to indicate the error.
.Rv -std semop
.Sh ERRORS
.Fn Semop
will fail if:

View File

@ -132,11 +132,7 @@ unlocks
and
.Fa s .
.Sh RETURN VALUES
Upon successful completion,
.Fn sendfile
returns 0. Otherwise a -1 is returned and the global variable
.Va errno
is set to indicate the error.
.Rv -std sendfile
.Sh ERRORS
.Bl -tag -width Er
.It Bq Er EBADF

View File

@ -60,9 +60,7 @@ as defined in
.Pp
Only the super-user may set new groups.
.Sh RETURN VALUES
A 0 value is returned on success, -1 on error, with
an error code stored in
.Va errno .
.Rv -std setgroups
.Sh ERRORS
The
.Fn setgroups

View File

@ -74,10 +74,7 @@ the standard
.Fn setgid
function is preferred.
.Sh RETURN VALUES
Upon successful completion, a value of 0 is returned. Otherwise,
a value of -1 is returned and
.Va errno
is set to indicate the error.
.Rv -std setregid
.Sh ERRORS
.Bl -tag -width Er
.It Bq Er EPERM

View File

@ -109,11 +109,7 @@ struct shmid_ds {
};
.Ed
.Sh RETURN VALUES
Upon successful completion,
.Fn shmctl
returns 0. Otherwise, it returns -1 and
.Va errno
is set to indicate the error.
.Rv -std shmctl
.Sh ERRORS
.Fn Shmctl
will fail if:

View File

@ -448,10 +448,7 @@ This protects against the side effect of
.Va errno
being set by functions called from inside the signal handler.
.Sh RETURN VALUES
A 0 value indicated that the call succeeded. A \-1 return value
indicates an error occurred and
.Va errno
is set to indicated the reason.
.Rv -std sigaction
.Sh EXAMPLES
There are three possible prototypes the handler may match:
.Bl -tag -offset indent -width short

View File

@ -133,10 +133,7 @@ are not ``grown'' automatically as is done for the normal stack.
If the stack overflows and this space is not protected
unpredictable results may occur.
.Sh RETURN VALUES
Upon successful completion, a value of 0 is returned.
Otherwise, a value of -1 is returned and
.Va errno
is set to indicate the error.
.Rv -std sigaltstack
.Sh ERRORS
.Fn Sigaltstack
will fail and the signal stack context will remain unchanged

View File

@ -57,10 +57,7 @@ Signals may be pending because they are currently masked,
or transiently before delivery (although the latter case is not
normally detectable).
.Sh RETURN VALUES
A 0 value indicated that the call succeeded. A \-1 return value
indicates an error occurred and
.Va errno
is set to indicated the reason.
.Rv -std sigpending
.Sh ERRORS
.Fn sigpending
will fail if:

View File

@ -96,10 +96,7 @@ or
.Dv SIGSTOP
to be blocked.
.Sh RETURN VALUES
A 0 value indicated that the call succeeded. A -1 return value
indicates an error occurred and
.Va errno
is set to indicated the reason.
.Rv -std sigprocmask
.Sh ERRORS
The
.Fn sigprocmask

View File

@ -62,7 +62,7 @@ and
.Fa sv Ns [1] .
The two sockets are indistinguishable.
.Sh RETURN VALUES
A 0 is returned if the call succeeds, -1 if it fails.
.Rv -std socketpair
.Sh ERRORS
The call succeeds unless:
.Bl -tag -width Er

View File

@ -58,10 +58,7 @@ used in creating the symbolic link).
Either name may be an arbitrary path name; the files need not
be on the same file system.
.Sh RETURN VALUES
Upon successful completion, a zero value is returned.
If an error occurs, the error code is stored in
.Va errno
and a -1 value is returned.
.Rv -std symlink
.Sh ERRORS
The symbolic link succeeds unless:
.Bl -tag -width Er

View File

@ -61,10 +61,7 @@ Eventually, the
functionality may be expanded to other filesystems able to recover
deleted files such as the log-structured filesystem.
.Sh RETURN VALUES
Upon successful completion, a value of 0 is returned.
Otherwise, a value of -1 is returned and
.Va errno
is set to indicate the error.
.Rv -std undelete
.Sh ERRORS
The
.Fn undelete

View File

@ -62,10 +62,7 @@ all references to it have been closed.
.Fa path
may not be a directory.
.Sh RETURN VALUES
Upon successful completion, a value of 0 is returned.
Otherwise, a value of -1 is returned and
.Va errno
is set to indicate the error.
.Rv -std unlink
.Sh ERRORS
The
.Fn unlink

View File

@ -49,12 +49,7 @@ After a successful call to
is unuseable until re-initialized by another call to
.Fn sem_init .
.Sh RETURN VALUES
If successful,
.Fn sem_destroy
returns 0. Otherwise, -1 is returned and
.Va errno
is set to indicate the type of
error.
.Rv -std sem_destroy
.Sh ERRORS
.Fn sem_destroy
will fail if:

View File

@ -49,12 +49,7 @@ as of the time that the call to
.Fn sem_getvalue
is actually run.
.Sh RETURN VALUES
If successful,
.Fn sem_getvalue
returns 0. Otherwise, -1 is returned and
.Va errno
is set to indicate the type of
error.
.Rv -std sem_getvalue
.Sh ERRORS
.Fn sem_getvalue
will fail if:

View File

@ -63,12 +63,7 @@ and
is no longer valid after a successful call to
.Fa sem_destroy .
.Sh RETURN VALUES
If successful,
.Fn sem_init
returns 0. Otherwise, -1 is returned and
.Va errno
is set to indicate the type of
error.
.Rv -std sem_init
.Sh ERRORS
.Fn sem_init
will fail if:

View File

@ -52,12 +52,7 @@ the semaphore will be allowed to return from
.Fn sem_post
is signal-reentrant and may be called within signal handlers.
.Sh RETURN VALUES
If successful,
.Fn sem_post
returns 0. Otherwise, -1 is returned and
.Va errno
is set to indicate the type of
error.
.Rv -std sem_post
.Sh ERRORS
.Fn sem_post
will fail if:

View File

@ -49,12 +49,7 @@ After a successful call to
is unuseable until re-initialized by another call to
.Fn sem_init .
.Sh RETURN VALUES
If successful,
.Fn sem_destroy
returns 0. Otherwise, -1 is returned and
.Va errno
is set to indicate the type of
error.
.Rv -std sem_destroy
.Sh ERRORS
.Fn sem_destroy
will fail if:

View File

@ -49,12 +49,7 @@ as of the time that the call to
.Fn sem_getvalue
is actually run.
.Sh RETURN VALUES
If successful,
.Fn sem_getvalue
returns 0. Otherwise, -1 is returned and
.Va errno
is set to indicate the type of
error.
.Rv -std sem_getvalue
.Sh ERRORS
.Fn sem_getvalue
will fail if:

View File

@ -63,12 +63,7 @@ and
is no longer valid after a successful call to
.Fa sem_destroy .
.Sh RETURN VALUES
If successful,
.Fn sem_init
returns 0. Otherwise, -1 is returned and
.Va errno
is set to indicate the type of
error.
.Rv -std sem_init
.Sh ERRORS
.Fn sem_init
will fail if:

View File

@ -52,12 +52,7 @@ the semaphore will be allowed to return from
.Fn sem_post
is signal-reentrant and may be called within signal handlers.
.Sh RETURN VALUES
If successful,
.Fn sem_post
returns 0. Otherwise, -1 is returned and
.Va errno
is set to indicate the type of
error.
.Rv -std sem_post
.Sh ERRORS
.Fn sem_post
will fail if: