Reformat exit code comments for readability

Author: joelparkerhenderson

README.md

@@ -784,397 +784,3 @@ POSIX XDG conventions:
 * `XDG_STATE_HOME` => user-specific cache files, analogous to system /var/state or $HOME/.local/state.
 * `XDG_CONFIG_HOME` => user-specific configuration files, analogous to system /etc or $HOME/.config.
 * `XDG_RUNTIME_HOME` => user-specific runtime files such as sockets, named pipes, etc. or $HOME/.runtime.
-
-## Exit codes
-
-Our POSIX shell programs call "exit" with an exit code value.
-
-Conventions:
-
-* 0 = success, and non-zero indicates any other issue.
-
-* 1 = failure
-
-* 2 = failure due to a usage problem
-
-* 3-63 are for a program's progam-specific exit codes.
-
-* 64-78 are based on sysexits documentation from the 1980's.
-
-* 80-119 are SixArm conventions that we find useful in many programs.
-
-Many POSIX shells use exit code 126 and 127 to signal specific error status:
-126 is for command found but not executable, and 127 is for command not found.
-
-* 126 is for the shell and indicates command found but not executable.
-
-* 127 is for the shell and indicate command not found.
-
-Many POSIX shells use exit codes above 128 in their $? representation of the
-exit status to encode the signal number of a process being killed.
-
-The pre-defined exit codes from sysexits can be used, so the caller of the
-process can get a rough estimation about the failure class without looking up
-the source code.
-
-See https://man.openbsd.org/sysexits.3
-
-We recommend:
-
-* Authentication issues: EXIT_NOUSER
-
-* Authoriziation issues: EXIT_NOPERM
-
-The exit code list below is subject to change over time, as we learn more.
-
-
-### Success
-
-```sh
-EXIT_SUCCESS=0
-```
-
-The program succeeded.
-
-Exit 0 meaning success is a widespread convention as a catch-all code.
-
-
-### Failure
-
-```sh
-EXIT_FAILURE=1
-```
-
-The program failed.
-
-E.g. an error, an abort, found no results, lack of data, etc.
-
-Exit 1 meaning failure is a widespread convention as a catch-all code.
-
-
-### Usage
-
-```sh
-EXIT_USAGE=2
-```
-
-The program usage is incorrect, or malformed, or in conflict, etc.
-
-E.g. wrong number of args, a bad flag, a syntax error in an option, etc.
-
-Exit 2 meaning usage is a widespread convention as a catch-all CLI code.
-
-
-### Data Err
-
-```sh
-EXIT_DATAERR=65
-```
-
-The input data was incorrect in some way. This should only be used
-for user's data and not system files.
-
-
-### No Input
-
-An input file-- not system file-- did not exist or was not readable.
-This could include errors like "No message" to a mailer, if it cared about it.
-
-```sh
-EXIT_NOINPUT=66
-```
-
-### No User
-
-```sh
-EXIT_NOUSER=67
-```
-
-The user specified did not exist.
-
-This might be used for mail addresses or remote logins, or when authentication is required.
-
-
-### No Host
-
-```sh
-EXIT_NOHOST=68
-```
-
-The host specified did not exist. This is used in mail addresses or
-network requests.
-
-
-### Unavailable
-
-```sh
-EXIT_UNAVAILABLE=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
-something you wanted to do does not work, but you do not know why.
-
-
-### Software
-
-```sh
-EXIT_SOFTWARE=70
-```
-
-An internal software error has been detected. This should be limited
-to non-operating system related errors as possible.
-
-
-### OS Err
-
-```sh
-EXIT_OSERR=71
-```
-
-An operating system error has been detected. This is intended for such
-things as "cannot fork", "cannot create pipe", or the like.  It includes
-things like getuid returning a user that does not exist in the passwd file.
-
-
-### OS File
-
-An operating system file (e.g. /etc/passwd) does not exist, or cannot
-be opened, or has some sort of error (e.g. syntax error).
-
-```sh
-EXIT_OSFILE=72
-```
-
-### Can't Create
-
-```sh
-EXIT_CANTCREATE=73
-```
-
-A user-specified output (e.g. a file) cannot be created.
-
-
-### IO Err
-
-An error occurred while doing I/O on some file.
-
-```sh
-EXIT_IOERR=74
-```
-
-### Temp Fail
-
-```sh
-EXIT_TEMPFAIL=75
-```
-
-A temporary failure occurred; this is not a permanent error.
-
-E.g. a mailer could not create a connection. The request can be retried later.
-
-
-### Protocol
-
-```sh
-EXIT_PROTOCOL=76
-```
-
-The remote system returned something that was "not possible" during
-a protocol exchange.
-
-
-### No Perm
-
-```sh
-EXIT_NOPERM=77
-```
-
-You did not have sufficient permission to perform the operation. This
-is not for file system problems, which use EXIT_NOINPUT or EXIT_CANTCREATE,
-but rather for higher level permissions, access control authorization, etc.
-
-
-### Config
-
-```sh
-EXIT_CONFIG=78
-```
-
-Something was found in an unconfigured or misconfigured state.
-
-
-### Exit codes 80-119
-
-Exit codes 80-119 are for our own SixArm conventions.
-
-We propose these are generally useful to many kinds of programs.
-
-Caution: these exit codes and their values are work in progress,
-draft only, as a request for comments, in version 11.x of this file.
-These exit codes will be set in version 12.x when it's released.
-
-* 80+ for user interation issues
-
-* 90+ for access control issues
-
-* 100+: process runtime issues
-
-* 110+: expected ability issues
-
-### Quit
-
-```sh
-EXIT_QUIT=80
-```
-
-The user chose to quit, or cancel, or abort, or not continue, etc.
-
-
-### KYC
-
-```sh
-EXIT_KYC=81
-```
-
-Know Your Customer means the program requires more user information.
-E.g. email validation, age verification, terms of service agreement, etc.
-
-
-### Update
-
-```sh
-EXIT_UPDATE=82
-```
-
-The program or its dependencies need an update, or upgrade, etc.
-
-
-### Conflict
-
-```sh
-EXIT_CONFLICT=91
-```
-
-An item has a conflict e.g. edit collision, or merge error, etc.
-
-Akin to HTTP status code 409 Conflict.
-
-
-### Unlawful
-
-```sh
-EXIT_UNLAWFUL=92
-```
-
-E.g. prohibited due to law, or warrant, or court order, etc.
-
-Akin to HTTP status code 451 Unavailable For Legal Reasons (RFC 7725).
-
-
-### Payment Issue
-
-```sh
-EXIT_PAYMENT_ISSUE=93
-```
-
-E.g. needs a credit card, or invoice, or billing, etc.
-
-Akin to HTTP status code 402 Payment Required.
-
-
-### Busy
-
-```sh
-EXIT_BUSY=100
-```
-
-A process is too busy, or overloaded, or throttled, or breakered, etc.
-
-Akin to HTTP status code 503 Service Unavailable; always means overloaded.
-
-
-### Timeout
-
-```sh
-EXIT_TIMEOUT=101
-```
-
-A process is too slow, or estimated to take too long, etc.
-
-Akin to HTTP status code 408 Request Timeout.
-
-
-### Lockout
-
-```sh
-EXIT_LOCKOUT=102
-```
-
-A process is intentionally blocked as a danger, hazard, risk, etc.
-
-This is for lockout-tagout (LOTO) safety, or protecting users or data, etc.
-
-
-### Loop
-
-```sh
-EXIT_LOOP=103
-```
-
-A process has detected an infinite loop, so is aborting.
-
-Akin to HTTP status code 508 Loop Detected.
-
-
-### Gone
-
-```sh
-EXIT_GONE=110
-```
-
-An expected ability has been intentionally removed, or deleted, etc.
-
-Akin to HTTP status code 410 Gone; the ability should be purged.
-
-
-### TODO
-
-```sh
-EXIT_TODO=111
-```
-
-An expected ability is not yet implemented, or work in progress, etc.
-
-Akin to HTTP status code 501 Not Implemented; implies future availability.
-
-
-### Git bisect skip
-
-```sh
-EXIT_GIT_BISECT_SKIP=125
-```
-
-Git bisect: The special exit code 125 should be used when the current source
-code cannot be tested. If the script exits with this code, the current
-revision will be skipped (see git bisect skip above). 125 was chosen as the
-highest sensible value to use for this purpose, because 126 and 127 are used
-by POSIX shells to signal specific error status; see below for details.
-
-
-### Command found but not executable
-
-```sh
-EXIT_COMMAND_FOUND_BUT_NOT_EXECUTABLE=126
-```
-
-A command is found but is not executable.
-
-
-### Command not found
-
-```sh
-EXIT_COMMAND_NOT_FOUND=127
-```
-
-A command is not found.