package mirage-runtime

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

Install

dune-project
 Dependency

Authors

Maintainers

Sources

mirage-4.10.2.tbz
sha256=4184cbc7e51b0dcdcf4345c98818c34129ff42879ef091e54849faa57b29d397
sha512=cb54de5a1741c9b5702a5c5290feb01c41ac39b220bf7d249dbaf6506834f1ac5c832726230e8ecd2fbc49f5550f9109560434e01746f0d20b6b6578e7174961

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.

On This Page
  1. Exit Codes