package ez_cmdliner

  1. Overview
  2. Docs

Module EzcmdSource

Sourcemodule V2 : sig ... end
Sourcemodule V1 : sig ... end
include module type of V1.Ezcmd
Sourcemodule TYPES : sig ... end
module MANPAGE = Cmdliner.Manpage
Sourceval parse : ?name:string -> ?version:string -> ?man:TYPES.block list -> (string * TYPES.Arg.spec * string) list -> (string -> unit) -> string -> unit
Sourceval translate : ?docs:string -> (string * TYPES.Arg.spec * string) list -> (string list * TYPES.Arg.spec * TYPES.info) list
Sourceval translate_anon : (string -> unit) -> (string list * TYPES.Arg.spec * TYPES.info) list
Sourceval env : ?docs:string -> ?doc:string -> string -> TYPES.env

env ~docs ~doc var describes an environment variable var. doc is the man page information of the environment variable, defaults to "undocumented". docs is the title of the man page section in which the environment variable will be listed, it defaults to Manpage.s_environment.

In doc the documentation markup language can be used with following variables:

  • $(env), the value of var.
  • The variables mentioned in info
Sourceval info : ?docs:string -> ?docv:string -> ?env:TYPES.env -> string -> TYPES.info

info docs docv env doc defines information for an argument.

  • env defines the name of an environment variable which is looked up for defining the argument if it is absent from the command line. See environment variables for details.

  • doc is the man page information of the argument. The documentation language can be used and the following variables are recognized:

    • "$(docv)" the value of docv (see below).
    • "$(opt)", one of the options of names, preference is given to a long one.
    • "$(env)", the environment var specified by env (if any).

    These functions can help with formatting argument values.

  • docv is for positional and non-flag optional arguments. It is a variable name used in the man page to stand for their value.
  • docs is the title of the man page section in which the argument will be listed. For optional arguments this defaults to Manpage.s_options. For positional arguments this defaults to Manpage.s_arguments. However a positional argument is only listed if it has both a doc and docv specified.
Sourceval main_with_subcommands : name:string -> ?version:string -> ?default:TYPES.command -> doc:string -> ?man:TYPES.block list -> ?topics:(string * Cmdliner.Manpage.block list) list -> ?argv:string array -> TYPES.command list -> unit
Sourceval main : ?version:string -> ?argv:string array -> TYPES.command -> unit
Sourceval main_with_subcommands2 : name:string -> ?version:string -> ?default:TYPES.sub -> doc:string -> ?man:MANPAGE.block list -> ?topics:(string * MANPAGE.block list) list -> ?common_args:TYPES.arg_list -> ?argv:string array -> TYPES.sub list -> unit