diff options
Diffstat (limited to 'share/man/man3/sysexits.3')
-rw-r--r-- | share/man/man3/sysexits.3 | 33 |
1 files changed, 22 insertions, 11 deletions
diff --git a/share/man/man3/sysexits.3 b/share/man/man3/sysexits.3 index 648fb06..b1ba47a 100644 --- a/share/man/man3/sysexits.3 +++ b/share/man/man3/sysexits.3 @@ -40,7 +40,8 @@ According to it is not a good practice to call .Xr exit 3 with arbitrary values to indicate a failure condition when ending -a program. Instead, the pre-defined exit codes from +a program. +Instead, the pre-defined exit codes from .Nm should be used, so the caller of the process can get a rough estimation about the failure class without looking up the source code. @@ -50,14 +51,16 @@ The successful exit is always indicated by a status of 0, or Error numbers begin at .Sy EX__BASE to reduce the possibility of clashing with other exit statuses that -random programs may already return. The meaning of the codes is +random programs may already return. +The meaning of the codes is approximately as follows: .Bl -tag -width "EX_UNAVAILABLEXX(XX)" .It Sy EX_USAGE Pq 64 The command was used incorrectly, e.g., with the wrong number of arguments, a bad flag, a bad syntax in a parameter, or whatever. .It Sy EX_DATAERR Pq 65 -The input data was incorrect in some way. This should only be used +The input data was incorrect in some way. +This should only be used for user's data and not system files. .It Sy EX_NOINPUT Pq 66 An input file (not a system file) did not exist or was not readable. @@ -65,24 +68,31 @@ This could also include errors like .Dq \&No message to a mailer (if it cared to catch it). .It Sy EX_NOUSER Pq 67 -The user specified did not exist. This might be used for mail +The user specified did not exist. +This might be used for mail addresses or remote logins. .It Sy EX_NOHOST Pq 68 -The host specified did not exist. This is used in mail addresses or +The host specified did not exist. +This is used in mail addresses or network requests. .It Sy EX_UNAVAILABLE Pq 69 -A service is unavailable. This can occur if a support program or file -does not exist. This can also be used as a catchall message when +A service is unavailable. +This can occur if a support program or file +does not exist. +This can also be used as a catchall message when something you wanted to do doesn't work, but you don't know why. .It Sy EX_SOFTWARE Pq 70 -An internal software error has been detected. This should be limited +An internal software error has been detected. +This should be limited to non-operating system related errors as possible. .It Sy EX_OSERR Pq 71 -An operating system error has been detected. This is intended to be +An operating system error has been detected. +This is intended to be used for such things as .Dq cannot fork , .Dq cannot create pipe , -or the like. It includes things like getuid returning a user that +or the like. +It includes things like getuid returning a user that does not exist in the passwd file. .It Sy EX_OSFILE Pq 72 Some system file (e.g., @@ -103,7 +113,8 @@ The remote system returned something that was .Dq not possible during a protocol exchange. .It Sy EX_NOPERM Pq 77 -You did not have sufficient permission to perform the operation. This +You did not have sufficient permission to perform the operation. +This is not intended for file system problems, which should use .Sy EX_NOINPUT or |