package mirage-runtime

  1. Overview
  2. Docs
The base MirageOS runtime library, part of every MirageOS unikernel

Install

Dune Dependency

Authors

Maintainers

Sources

mirage-4.9.0.tbz
sha256=0c07d59eb52dc3d1506eb4121c4953104a12df79d08a0f0923c9b71e7474a026
sha512=666bf9ee20c9f9de058441f252f4f40ceec6a9ffd00e5cd3b7bfa9532fd65000aeb8a83f9e55586be98d0a86ea72f2dda94e924608135e3d63441359505de58a

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.

OCaml

Innovation. Community. Security.