package b0

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Cli arguments

package b0

b0.b00
- B00
  - Env
  - Exec
  - File_cache
    
    Stats
  - Guard
  - Memo
    
    Fut
  - Op
    
    Map
    
    Mkdir
    
    Read
    
    Set
    
    Spawn
    
    Write
  - Op_cache
  - Tool
b0.care
- B0_github
  - Issue
  - Pages
  - Release
  - Repo
- B0_machine
- B0_odoc
  - Compile
    
    Dep
    
    Writes
  - Html
    
    Dep
    
    Writes
  - Html_fragment
  - Support_files
    
    Writes
- B0_trace
  - Compilation_database
  - Trace_event
- B0_ui
  - Browser
  - Cli
    
    Arg
    
    B0_std
  - Editor
  - Memo
  - Pager
- B0_vcs
  - Git
- B0_web
  - Htmlg
    
    Att
    
    El
  - Http
  - Json
  - Jsong
  - Jsonq
b0.std
- B0_std
  - Char
    
    Ascii
  - Cmd
  - Conv
    
    Bin
    
    Txt
  - Fmt
  - Fpath
    
    Map
    
    Set
  - Hash
    
    Murmur3_128
    
    T
    
    Xxh_64
  - List
  - Log
  - Option
  - Os
    
    Cmd
    
    Dir
    
    Env
    
    Fd
    
    File
    
    Path
  - Result
  - String
    
    Ascii
    
    Map
    
    Set
  - Time
    
    Span
  - Tty

Legend:
Library
Module
Module type
Parameter
Class
Class type

B0_std configuration.

Configure B0_std's colored output and B0_std.Log verbosity.

Cli arguments

val color : 
  ?docs:string ->
  ?env:Cmdliner.Arg.env ->
  unit ->
  B0_std.Tty.cap option Cmdliner.Term.t

color ~docs ~env is a cli interface for specifiying the color capability of the terminal. Can be used with Fmt.set_tty_styling_cap. docs is where the options are documented env is an environment variable that can be used to override the default None (auto configuration).

val verbosity : 
  ?docs:string ->
  ?env:Cmdliner.Arg.env ->
  unit ->
  B0_std.Log.level Cmdliner.Term.t

verbosity ~docs ~env () is a cli interface for specifiying the logging level. Can be used with Log.set_level. docs is where the options are documented. env is an environment variable that can be used to override the default value (Log.Warning).

val setup : 
  ?docs:string ->
  ?log_spawns:B0_std.Log.level ->
  ?color_env:Cmdliner.Arg.env ->
  ?verbosity_env:Cmdliner.Arg.env ->
  unit ->
  unit Cmdliner.Term.t

setup ~docs ~log_spawns ~color_env ~verbosity_env () uses color and verbosity to setup:

B0_std.Fmt.set_tty_styling_cap, using Tty.of_fd on Unix.stdout if color is None.
B0_std.Log.set_level with verbosity.
log_spawns log B0_std.Os.Cmd spawns by setting up a B0_std.Os.Cmd.spawn_tracer that traces with the given level. If Level.Quiet is specified no tracer is registered. Defaults to B0_std.Log.Debug.

docs is where the section in which the options are documented and color_env and verbosity_env are used with the env argument of color and verbosity.