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.11.1.tbz
sha256=58488022e67513a370f1de91297b6c0de15dd15584381276028c08d4ab4ae158
sha512=0ddc27adfdaa88a5ff492261de57d40df89a968db18501b16ac83393446f994f50674b40345625382728a731c22aa82e70675c400310d015829bf0ec1980ecb2

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.