Use `Er' variable to define first column width in ERRORS section. It was

initially suggested by mdoc(7) style, but was broken over the years
This commit is contained in:
Alexey Zelkin 2000-05-04 13:09:25 +00:00
parent 8cc2d40041
commit 4f79a4117a
Notes: svn2git 2020-12-20 02:59:44 +00:00
svn path=/head/; revision=59954
53 changed files with 54 additions and 54 deletions

View File

@ -165,7 +165,7 @@ integer that is a descriptor for the accepted socket.
The
.Fn accept
will fail if:
.Bl -tag -width EWOULDBLOCK
.Bl -tag -width Er
.It Bq Er EBADF
The descriptor is invalid.
.It Bq Er EINTR

View File

@ -95,7 +95,7 @@ further specified in the global
The
.Fn bind
call will fail if:
.Bl -tag -width EADDRNOTAVA
.Bl -tag -width Er
.It Bq Er EAGAIN
Kernel resources to complete the request are
temporarily unavilable.

View File

@ -122,7 +122,7 @@ or
.Fn sbrk
will fail and no additional memory will be allocated if
one of the following are true:
.Bl -tag -width [ENOMEM]
.Bl -tag -width Er
.It Bq Er ENOMEM
The limit, as set by
.Xr setrlimit 2 ,

View File

@ -97,7 +97,7 @@ is set to indicate an error.
.Sh ERRORS
.Fn Chroot
will fail and the root directory will be unchanged if:
.Bl -tag -width [ENOTDIR]
.Bl -tag -width Er
.It Bq Er ENOTDIR
A component of the path name is not a directory.
.It Bq Er EPERM

View File

@ -101,7 +101,7 @@ case an error code is stored into the global variable
.Sh ERRORS
The following error codes may be set in
.Va errno :
.Bl -tag -width [EFAULT]
.Bl -tag -width Er
.It Bq Er EINVAL
The
.Fa clock_id

View File

@ -105,7 +105,7 @@ code is stored in
The
.Fn connect
call fails if:
.Bl -tag -width EADDRNOTAVAILABB
.Bl -tag -width Er
.It Bq Er EBADF
.Fa s
is not a valid descriptor.

View File

@ -220,7 +220,7 @@ is set to indicate the error.
.Sh ERRORS
.Fn Execve
will fail and return to the calling process if:
.Bl -tag -width [ENAMETOOLONG]
.Bl -tag -width Er
.It Bq Er ENOTDIR
A component of the path prefix is not a directory.
.It Bq Er ENAMETOOLONG

View File

@ -143,7 +143,7 @@ the global location
The
.Fn flock
call fails if:
.Bl -tag -width EWOULDBLOCKAA
.Bl -tag -width Er
.It Bq Er EWOULDBLOCK
The file is locked and the
.Dv LOCK_NB

View File

@ -88,7 +88,7 @@ is set to indicate the error.
.Sh ERRORS
.Fn Fork
will fail and no child process will be created if:
.Bl -tag -width [EAGAIN]
.Bl -tag -width Er
.It Bq Er EAGAIN
The system-imposed limit on the total
number of processes under execution would be exceeded.

View File

@ -84,7 +84,7 @@ unlocks
A 0 is returned if the call succeeds, -1 if it fails.
.Sh ERRORS
The call succeeds unless:
.Bl -tag -width ENOTSOCKAA
.Bl -tag -width Er
.It Bq Er EBADF
The argument
.Fa s

View File

@ -82,7 +82,7 @@ unlocks
A 0 is returned if the call succeeds, -1 if it fails.
.Sh ERRORS
The call succeeds unless:
.Bl -tag -width ENOTSOCKAA
.Bl -tag -width Er
.It Bq Er EBADF
The argument
.Fa s

View File

@ -362,7 +362,7 @@ unlocks
A 0 is returned if the call succeeds, -1 if it fails.
.Sh ERRORS
The call succeeds unless:
.Bl -tag -width ENOPROTOOPTAA
.Bl -tag -width Er
.It Bq Er EBADF
The argument
.Fa s

View File

@ -115,7 +115,7 @@ case an error code is stored into the global variable
.Sh ERRORS
The following error codes may be set in
.Va errno :
.Bl -tag -width [EFAULT]
.Bl -tag -width Er
.It Bq Er EFAULT
An argument address referenced invalid memory.
.It Bq Er EPERM

View File

@ -114,7 +114,7 @@ is set to indicate the error.
.Sh ERRORS
.Fn Ioctl
will fail if:
.Bl -tag -width [ENOTTY]
.Bl -tag -width Er
.It Bq Er EBADF
.Fa d
is not a valid descriptor.

View File

@ -77,7 +77,7 @@ set for the prison for jailed processes.
.Sh ERRORS
.Fn jail
will fail if:
.Bl -tag -width EWOULDBLOCK
.Bl -tag -width Er
.It Bq Er EINVAL
The version number of the argument is not correct.
.El

View File

@ -110,7 +110,7 @@ is set to indicate the error.
.Sh ERRORS
.Fn Kill
will fail and no signal will be sent if:
.Bl -tag -width [EINVAL]
.Bl -tag -width Er
.It Bq Er EINVAL
.Fa Sig
is not a valid signal number.

View File

@ -130,7 +130,7 @@ bytes of a
.Nm ktr_type
record.
The type specific records are defined in the
.Pa <sys/ktrace.h>
.Aq Pa sys/ktrace.h
include file.
.Sh RETURN VALUES
On successful completion a value of 0 is returned.
@ -140,7 +140,7 @@ is set to show the error.
.Sh ERRORS
.Fn Ktrace
will fail if:
.Bl -tag -width ENAMETOOLONGAA
.Bl -tag -width Er
.It Bq Er ENOTDIR
A component of the path prefix is not a directory.
.It Bq Er ENAMETOOLONG

View File

@ -87,7 +87,7 @@ is set to indicate the error.
.Sh ERRORS
.Fn Link
will fail and no link will be created if:
.Bl -tag -width Ar
.Bl -tag -width Er
.It Bq Er ENOTDIR
A component of either path prefix is not a directory.
.It Bq Er ENAMETOOLONG

View File

@ -112,7 +112,7 @@ A 0 return value indicates success; -1 indicates an error.
.Sh ERRORS
.Fn Listen
will fail if:
.Bl -tag -width [EOPNOTSUPP]
.Bl -tag -width Er
.It Bq Er EBADF
The argument
.Fa s

View File

@ -114,7 +114,7 @@ the error.
.Sh ERRORS
.Fn Lseek
will fail and the file position pointer will remain unchanged if:
.Bl -tag -width [EINVAL]
.Bl -tag -width Er
.It Bq Er EBADF
.Em Fildes
is not an open file descriptor.

View File

@ -64,7 +64,7 @@ indicates an error, and an error code is stored in
.Sh ERRORS
.Fn Mkdir
will fail and no directory will be created if:
.Bl -tag -width ENAMETOOLO
.Bl -tag -width Er
.It Bq Er ENOTDIR
A component of the path prefix is not a directory.
.It Bq Er ENAMETOOLONG

View File

@ -66,7 +66,7 @@ indicates an error, and an error code is stored in
.Sh ERRORS
.Fn Mkfifo
will fail and no fifo will be created if:
.Bl -tag -width ENAMETOOLO
.Bl -tag -width Er
.It Bq Er ENOTSUPP
The kernel has not been configured to support fifo's.
.It Bq Er ENOTDIR

View File

@ -186,7 +186,7 @@ is set to indicate the error.
The
.Fn mount
function will fail when one of the following occurs:
.Bl -tag -width [ENOTBLK]
.Bl -tag -width Er
.It Bq Er EPERM
The caller is not the super-user.
.It Bq Er ENAMETOOLONG

View File

@ -221,7 +221,7 @@ Otherwise, -1 is returned and the global variable
.Va errno
is set to specify the error.
.Sh ERRORS
.Bl -tag -width [ENEEDAUTH]
.Bl -tag -width Er
.It Bq Er ENEEDAUTH
This special error value
is really used for authentication support, particularly Kerberos,

View File

@ -98,7 +98,7 @@ error.
The
.Fn pipe
call will fail if:
.Bl -tag -width [EMFILE]
.Bl -tag -width Er
.It Bq Er EMFILE
Too many descriptors are active.
.It Bq Er ENFILE

View File

@ -234,7 +234,7 @@ can be set to 0 before the call and checked afterwards.
The
.Fn ptrace
function may fail if:
.Bl -tag -width 4n
.Bl -tag -width Er
.It Bq Er ESRCH
.Bl -bullet -compact
.It

View File

@ -159,7 +159,7 @@ indicates the reason for the failure.
A
.Fn quotactl
call will fail if:
.Bl -tag -width ENAMETOOLONGAA
.Bl -tag -width Er
.It Bq Er EOPNOTSUPP
The kernel has not been compiled with the
.Dv QUOTA

View File

@ -66,7 +66,7 @@ code in the global variable
.Sh ERRORS
.Fn Readlink
will fail if:
.Bl -tag -width ENAMETOOLONG
.Bl -tag -width Er
.It Bq Er ENOTDIR
A component of the path prefix is not a directory.
.It Bq Er ENAMETOOLONG

View File

@ -256,7 +256,7 @@ These calls return the number of bytes received, or -1
if an error occurred.
.Sh ERRORS
The calls fail if:
.Bl -tag -width ENOTCONNAA
.Bl -tag -width Er
.It Bq Er EBADF
The argument
.Fa s

View File

@ -107,7 +107,7 @@ indicates the reason for the failure.
.Fn Rename
will fail and neither of the argument files will be
affected if:
.Bl -tag -width ENAMETOOLONG
.Bl -tag -width Er
.It Bq Er ENAMETOOLONG
A component of either pathname exceeded 255 characters,
or the entire length of either path name exceeded 1023 characters.

View File

@ -106,7 +106,7 @@ is set to indicate the error.
.Sh ERRORS
.Fn Rfork
will fail and no child process will be created if:
.Bl -tag -width [EAGAIN]
.Bl -tag -width Er
.It Bq Er EAGAIN
The system-imposed limit on the total
number of processes under execution would be exceeded.

View File

@ -60,7 +60,7 @@ returned and an error code is stored in the global location
.Va errno .
.Sh ERRORS
The named file is removed unless:
.Bl -tag -width [ENAMETOOLONG]
.Bl -tag -width Er
.It Bq Er ENOTDIR
A component of the path is not a directory.
.It Bq Er ENAMETOOLONG

View File

@ -95,7 +95,7 @@ to indicate the error.
On failure
.Va errno
will be set to the corresponding value:
.Bl -tag -width [EFAULT]
.Bl -tag -width Er
.It Bq Er EINVAL
The value of the
.Fa policy

View File

@ -142,7 +142,7 @@ to indicate the error.
On failure
.Va errno
will be set to the corresponding value:
.Bl -tag -width [EFAULT]
.Bl -tag -width Er
.It Bq Er ENOSYS
The system is not configured to support this functionality.
.It Bq Er EPERM

View File

@ -137,7 +137,7 @@ to indicate the error.
On failure
.Va errno
will be set to the corresponding value:
.Bl -tag -width [EFAULT]
.Bl -tag -width Er
.It Bq Er ENOSYS
The system is not configured to support this functionality.
.It Bq Er EPERM

View File

@ -51,7 +51,7 @@ to indicate the error.
On failure
.Va errno
will be set to the corresponding value:
.Bl -tag -width [EFAULT]
.Bl -tag -width Er
.It Bq Er ENOSYS
The system is not configured to support this functionality.
.Sh STANDARDS

View File

@ -69,7 +69,7 @@ indicates the reason.
.Sh ERRORS
.Fn Setpgid
will fail and the process group will not be altered if:
.Bl -tag -width indent
.Bl -tag -width Er
.It Bq Er ESRCH
The requested process does not exist.
.It Bq Er EPERM

View File

@ -76,7 +76,7 @@ a value of -1 is returned and
.Va errno
is set to indicate the error.
.Sh ERRORS
.Bl -tag -width [EPERM]
.Bl -tag -width Er
.It Bq Er EPERM
The current process is not the super-user and a change
other than changing the effective group-id to the real group-id

View File

@ -58,7 +58,7 @@ and the global variable
.Va errno
is set to indicate the error.
.Sh ERRORS
.Bl -tag -width indent
.Bl -tag -width Er
.It Er EPERM
The calling process was not privileged
and tried to change one or more IDs to a value

View File

@ -75,7 +75,7 @@ a value of -1 is returned and
.Va errno
is set to indicate the error.
.Sh ERRORS
.Bl -tag -width [EPERM]
.Bl -tag -width Er
.It Bq Er EPERM
The current process is not the super-user and a change
other than changing the effective user-id to the real user-id

View File

@ -71,7 +71,7 @@ further sends and receives will be disallowed.
A 0 is returned if the call succeeds, -1 if it fails.
.Sh ERRORS
The call succeeds unless:
.Bl -tag -width ENOTCONNAA
.Bl -tag -width Er
.It Bq Er EBADF
.Fa S
is not a valid descriptor.

View File

@ -141,7 +141,7 @@ is set to indicate the error.
.Fn Sigaltstack
will fail and the signal stack context will remain unchanged
if one of the following occurs.
.Bl -tag -width [ENOMEM]
.Bl -tag -width Er
.It Bq Er EFAULT
Either
.Fa ss

View File

@ -105,7 +105,7 @@ The
.Fn sigprocmask
call will fail and the signal mask will be unchanged if one
of the following occurs:
.Bl -tag -width Bq Er EINVAL
.Bl -tag -width Er
.It Bq Er EINVAL
.Fa how
has a value other than those listed here.

View File

@ -96,7 +96,7 @@ is set to indicate the error.
.Fn Sigreturn
will fail and the process context will remain unchanged
if one of the following occurs.
.Bl -tag -width [EINVAL]
.Bl -tag -width Er
.It Bq Er EFAULT
.Fa Scp
points to memory that is not a valid part of the process

View File

@ -251,7 +251,7 @@ value is a descriptor referencing the socket.
The
.Fn socket
call fails if:
.Bl -tag -width EPROTONOPSUPPORTA
.Bl -tag -width Er
.It Bq Er EPROTONOSUPPORT
The protocol type or the specified protocol is not supported
within this domain.

View File

@ -65,7 +65,7 @@ The two sockets are indistinguishable.
A 0 is returned if the call succeeds, -1 if it fails.
.Sh ERRORS
The call succeeds unless:
.Bl -tag -width EPROTONOSUPPORTA
.Bl -tag -width Er
.It Bq Er EMFILE
Too many descriptors are in use by this process.
.It Bq Er EAFNOSUPPORT

View File

@ -220,7 +220,7 @@ fields.
and
.Fn lstat
will fail if:
.Bl -tag -width ENAMETOOLONGAA
.Bl -tag -width Er
.It Bq Er ENOTDIR
A component of the path prefix is not a directory.
.It Bq Er ENAMETOOLONG

View File

@ -131,7 +131,7 @@ is set to indicate the error.
.Sh ERRORS
.Fn Statfs
fails if one or more of the following are true:
.Bl -tag -width ENAMETOOLONGA
.Bl -tag -width Er
.It Bq Er ENOTDIR
A component of the path prefix of
.Fa Path

View File

@ -62,7 +62,7 @@ is set to indicate the error.
.Sh ERRORS
.Fn Swapon
succeeds unless:
.Bl -tag -width ENAMETOOLONG
.Bl -tag -width Er
.It Bq Er ENOTDIR
A component of the path prefix is not a directory.
.It Bq Er ENAMETOOLONG

View File

@ -64,7 +64,7 @@ If an error occurs, the error code is stored in
and a -1 value is returned.
.Sh ERRORS
The symbolic link succeeds unless:
.Bl -tag -width ENAMETOO
.Bl -tag -width Er
.It Bq Er ENOTDIR
A component of the
.Fa name2

View File

@ -72,7 +72,7 @@ specifies the error.
.Sh ERRORS
.Fn Truncate
succeeds unless:
.Bl -tag -width [ENOTDIR]
.Bl -tag -width Er
.It Bq Er ENOTDIR
A component of the path prefix is not a directory.
.It Bq Er ENAMETOOLONG

View File

@ -69,7 +69,7 @@ is set to indicate the error.
The
.Fn undelete
succeeds unless:
.Bl -tag -width ENAMETOOLONGAA
.Bl -tag -width Er
.It Bq Er ENOTDIR
A component of the path prefix is not a directory.
.It Bq Er ENAMETOOLONG

View File

@ -70,7 +70,7 @@ is set to indicate the error.
The
.Fn unlink
succeeds unless:
.Bl -tag -width ENAMETOOLONGAA
.Bl -tag -width Er
.It Bq Er ENOTDIR
A component of the path prefix is not a directory.
.It Bq Er ENAMETOOLONG