package binsec

  1. Overview
  2. Docs

doc/binsec.cli/Binsec_cli/Cli/index.html

Module Binsec_cli.CliSource

Functors for command-line parameters declarations

Sourcemodule type GENERIC = sig ... end
Sourcemodule type GENERIC_OPT = sig ... end
Module types for option builders
Sourcemodule type BOOLEAN = GENERIC with type t = bool
Sourcemodule type INTEGER = GENERIC with type t = int
Sourcemodule type INTEGER_LIST = GENERIC with type t = int list
Sourcemodule type INTEGER_OPT = GENERIC_OPT with type t = int
Sourcemodule type FLOAT = GENERIC with type t = float
Sourcemodule type FLOAT_LIST = GENERIC with type t = float list
Sourcemodule type FLOAT_OPT = GENERIC_OPT with type t = float
Sourcemodule type STRING = GENERIC with type t = string
Sourcemodule type STRING_OPT = GENERIC_OPT with type t = string
Sourcemodule type STRING_LIST = GENERIC with type t = string list

Builder functors for command-line parameters

Sourcemodule type DECL = sig ... end
Sourcemodule type CLI_DECL = sig ... end
Sourcemodule type DEFAULTED_CLI_DECL = sig ... end
Sourcemodule type DETAILED_CLI_DECL = sig ... end
Sourcemodule type ENABLEABLE = sig ... end
Sourcemodule type S = sig ... end

Functor signature

Sourcemodule type Cli_sig = sig ... end

Functor

Sourcemodule Make (_ : DECL) : sig ... end

Call Cli.Make to create a kind of command line namespace

Call Cli.Options instead if you just want to have dedicated options to a ** set of functionalities. ** ** The difference with Cli.Make is the absence of a dedicated command line ** switch for this set of options. ** ** For example Cli.Make(struct let name = "foo" ... end) will add a '-foo' ** global switch to the command line whereas Cli.Options(struct let name = ** "foo" ... end) will not. ** ** Also, using Cli.Options entails that there should not be any associated ** functions to be automatically run at startup (i.e., no Cli.Boot.enlist ** call from inside the functionality kernel associated with this set of ** command-line switches).

Sourcemodule Make_from_logger (_ : Binsec_base.Logger.S) (_ : DECL) : sig ... end

Boot

This module collects the functions to be executed at startup time.

Sourcemodule Boot : sig ... end
Sourceval parse : unit -> string list

parse () parses options from the command line.

Sourceval parse_configuration_file : filename:string -> string list

parse () parses options from configuration file filename.

Plugin

Sourcemodule Sites : sig ... end

The signature of the modules present in the module generated by the stanza generate_sites_module