package mirage-runtime

  1. Overview
  2. Docs
On This Page
  1. Exit Codes
The base MirageOS runtime library, part of every MirageOS unikernel

Install

dune-project
 Dependency

Authors

Maintainers

Sources

mirage-4.10.5.tbz
sha256=c0b2deb8f9cfec44f9dbc256a18b50944f2aa8fcba84aef3165abebd23476e0c
sha512=e354f1cb4d12b424c22b9add0851a8750fe09f095ca97f0ec0360b18f7c69db60b155fdd18b0d7a6cea3432e63f20e4695a5bccaac3fc34588348e4311baa1c5

doc/mirage-runtime.functoria/Functoria_runtime/index.html

Module Functoria_runtimeSource

Functoria runtime.

Sourceval register : 'a Cmdliner.Term.t -> unit -> 'a

register t registers the Cmdliner term k as a runtime argument and return a callback f that evaluates to ts' value passed on the command-line.

f will raise Invalid_argument if called before cmdliner's evaluation.

  • deprecated Use register_arg instead.
Sourceval register_arg : 'a Cmdliner.Term.t -> unit -> 'a

register_arg t registers the Cmdliner term k as a runtime argument and return a callback f that evaluates to ts' value passed on the command-line.

f will raise Invalid_argument if called before cmdliner's evaluation.

Sourceval with_argv : ?sections:string list -> unit Cmdliner.Term.t list -> string -> string array -> unit

with_argv ?sections arguments name argv evaluates the arguments terms on the command-line argv. name is the executable name. sections is a list of sections to include in the man page - useful for enforcing a specific order of sections. On evaluation error the application calls exit(3) with status 64. If `Help or `Version were evaluated, exit(3) is called with status 63.

Sourceval runtime_args : unit -> unit Cmdliner.Term.t list

Exit Codes

Sourceval argument_error : int

argument_error is the exit code used for argument parsing errors: 64.

Sourceval help_version : int

help_version is the exit code used when help/version is used: 63.