package reason
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=ec3d2025f4391f0d2b88d2053e627a85aa1addd9c51320e9e72c690e05fb66a6
sha512=2bc7681a0e7649f619a8e93e961690531f697fadb1ae5d3f2c5913b0fce6995780394f2ce5b3e1920902ca7a2f4e188f62696f58f20ae3dd81c3658528bd0a33
doc/reason.cmdliner/Vendored_cmdliner/Cmd/Exit/index.html
Module Cmd.Exit
Source
Exit codes and their information.
Exit codes
The type for exit codes.
Warning. You should avoid status codes strictly greater than 125 as those may be used by some shells.
some_error
is 123
, an exit status for indisciminate errors reported on stderr.
internal_error
is 125
, an exit status for unexpected internal errors.
Exit code information
The type for exit code information.
exit_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"
. docs
is the title of the man page section in which the statuses will be listed, it defaults to Manpage.s_exit_status
.
In doc
the documentation markup language can be used with following variables:
$(status)
, the value ofmin
.$(status_max)
, the value ofmax
.- The variables mentioned in the
Cmd.info
defaults
are exit code information for ok
, some_error
cli_error
and internal_error
.