module Lib_prefs:sig
..end
Lib_prefs
provides standard means for drivers to let the end
user control the assemblage library preferences through command
line arguments and environment variables.
type
t = {
|
fmt_utf8_enabled : |
(* | See Assemblage.Private.Fmt.utf8_enabled | *) |
|
: |
(* | See Assemblage.Private.Fmt.style_tags | *) |
|
log_level : |
(* | See Assemblage.Private.Log.level | *) |
|
cmd_vcs_override_kind : |
(* | See Assemblage.Private.Cmd.Vcs.override_kind | *) |
|
cmd_vcs_override_exec : |
(* | See Assemblage.Private.Cmd.Vcs.override_exec | *) |
val set : t -> unit
set p
sets the library preferences to p
.val get : unit -> t
get ()
is the library's current preferences.val pp : Format.formatter -> t -> unit
pp ppf p
prints an unspecified representation of p
on ppf
.val ui : docs:string -> t Cmdliner.Term.t
ui ~docs
is a Cmdliner
term that defines a library
preferences value either through command line options or through
environment variables (see Assemblage_driver.Lib_prefs.man_vars
). An environment variable
definition takes over a corresponding command line option.
docs
is the manual section in which the command line options are
documented.val man_vars : Cmdliner.Manpage.block list
man_vars
is a man page fragment for the environment variables
used by Assemblage_driver.Lib_prefs.ui
.