Cmd.Exit
Exit codes and their information.
The type for exit codes.
Warning. You should avoid status codes strictly greater than 125 as those may be used by some shells.
These are documented by defaults
.
val ok : code
ok
is 0
, the exit status for success.
val some_error : code
some_error
is 123
, an exit status for indiscriminate errors reported on stderr
.
val cli_error : code
cli_error
is 124
, an exit status for command line parsing errors.
val internal_error : code
internal_error
is 125
, an exit status for unexpected internal errors.
val info :
?docs:Manpage.section_name ->
?doc:string ->
?max:code ->
code ->
info
info ~docs ~doc min ~max
describe the range of exit statuses from min
to max
(defaults to min
).
doc
is the man page information for the statuses, defaults to "undocumented"
. The documentation markup language can be used with following variables:
$(status)
, the value of min
.$(status_max)
, the value of max
.Cmd.info
docs
is the title of the man page section in which the statuses will be listed, it defaults to Manpage.s_exit_status
.val defaults : info list
defaults
are exit code information for ok
, some_error
, cli_error
and internal_error
.