package b0

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Terminals
Capabilities
ANSI escapes and styling

package b0

B0 v0.0.5
- B00 manual
- Cmdlet manual
- B0 driver development manual
- B0 manual
- B0 manual
- opam support manual
- Why b0 ?
- B0 release support manual
- Design considerations and todo
- Build unit manual
- Library b0
  - B0_build
  - B0_cli
    
    Arg
  - B0_cmdlet
    
    Env
    
    Set
    
    Map
  - B0_def
    
    Scope
    
    VALUE
    
    S
    
    Set
    
    Map
    
    Make
    
    Set
    
    Map
  - B0_dir
  - B0_driver
    
    Exit
    
    Env
    
    Conf
    
    Cli
    
    Compile
  - B0_file
  - B0_meta
    
    Key
  - B0_pack
    
    Set
    
    Map
  - B0_unit
    
    Action
    
    Set
    
    Map
- Library b0.b0
  - B0_b0
    
    Def
    
    Cli
  - B0_cmd_build
  - B0_cmd_cmd
  - B0_cmd_cmdlet
  - B0_cmd_delete
  - B0_cmd_file
  - B0_cmd_list
  - B0_cmd_log
  - B0_cmd_pack
  - B0_cmd_root
  - B0_cmd_scope
  - B0_cmd_unit
  - B0_main
- Library b0.b00
  - B00
    
    Tool
    
    Env
    
    Memo
    
    Store
  - B000
    
    Trash
    
    File_cache
    
    Op
    
    Copy
    
    Delete
    
    Mkdir
    
    Notify
    
    Read
    
    Spawn
    
    Wait_files
    
    Write
    
    Set
    
    Map
    
    Reviver
    
    Guard
    
    Exec
  - B000_conv
    
    Op
- Library b0.kit
  - B0_expect
    
    Outcome
  - B0_jsoo
  - B0_kit
    
    V000
    
    Type
    
    Tty
    
    Fmt
    
    Result
    
    Char
    
    String
    
    List
    
    Fpath
    
    Hash
    
    Mtime
    
    Cmd
    
    Fut
    
    Os
    
    Log
    
    Rqueue
    
    Bincode
  - B0_ocaml
    
    Meta
  - B0_ocaml_eco
  - B0_opam
    
    File
    
    Meta
    
    Cmdlet
  - B0_release
    
    Meta
    
    Cmdlet
  - B0_srcs
- Library b0.std
  - B0_std
    
    Type
    
    Id
    
    Tty
    
    Fmt
    
    Result
    
    Syntax
    
    Char
    
    Ascii
    
    String
    
    Ascii
    
    Set
    
    Map
    
    List
    
    Fpath
    
    Set
    
    Map
    
    Hash
    
    T
    
    Xxh3_64
    
    Xxh3_128
    
    Mtime
    
    Span
    
    Cmd
    
    Fut
    
    Syntax
    
    Os
    
    Cpu
    
    Time
    
    Mtime
    
    Env
    
    Path
    
    File
    
    Dir
    
    Fd
    
    Cmd
    
    Exit
    
    Log
    
    Rqueue
    
    Bincode
- Library b0_b00_kit
  - B00_base64
  - B00_cli
    
    Exit
    
    Arg
    
    B0_std
    
    File_cache
    
    Op
    
    Memo
    
    Log
  - B00_cmark
  - B00_editor
    
    Env
  - B00_fexts
  - B00_findex
  - B00_github
    
    Auth
    
    Repo
    
    Issue
    
    Release
    
    Pages
  - B00_htmlg
    
    At
    
    Name
    
    El
  - B00_http
    
    Uri
    
    Http
    
    Httpr
  - B00_jsoo
  - B00_lines
  - B00_ocaml
    
    Tool
    
    Conf
    
    Mod
    
    Name
    
    Set
    
    Map
    
    Ref
    
    Set
    
    Map
    
    Src
    
    Deps
    
    Cobj
    
    Set
    
    Map
    
    Lib
    
    Name
    
    Set
    
    Map
    
    Resolver
    
    Ocamlpath
    
    Compile
    
    Archive
    
    Link
    
    Crunch
  - B00_odoc
    
    Compile
    
    Dep
    
    Writes
    
    Html
    
    Dep
    
    Writes
    
    Html_fragment
    
    Support_files
    
    Writes
    
    Theme
  - B00_os
  - B00_pager
    
    Env
  - B00_pdf_viewer
    
    Env
  - B00_rsync
  - B00_serialk_json
    
    Json
    
    Jsong
    
    Jsonq
  - B00_serialk_sexp
    
    Sexp
    
    Sexpg
    
    Sexpq
  - B00_serialk_text
    
    Tloc
    
    Tdec
  - B00_trace
    
    Trace_event
    
    Compilation_database
  - B00_vcs
    
    Git
    
    Hg
  - B00_www_browser
    
    Env

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `B0_std.Tty`

ANSI terminal interaction.

Terminals

type t = [ `Dumb | `Term of string ] option

The type for terminals. Either no terminal, a dumb one or a named terminal from the TERM environment variable.

val of_fd : Unix.file_descr -> t

of_fd fd determines the terminal for file descriptor fd by using Unix.isatty fd and consulting the TERM environment variable.

Capabilities

type cap = [

| `None
(*
No capability.
*)
| `Ansi
(*
ANSI terminal.
*)

]

The type for terminal capabilities. Either no capability or ANSI capability.

val cap : t -> cap

cap tty determines tty's capabilities.

ANSI escapes and styling

type color = [

| `Default
| `Black
| `Red
| `Green
| `Yellow
| `Blue
| `Magenta
| `Cyan
| `White

]

The type for ANSI colors.

type style = [

| `Bold
| `Faint
| `Italic
| `Underline
| `Blink of [ `Slow | `Rapid ]
| `Reverse
| `Fg of [ color | `Hi of color ]
| `Bg of [ color | `Hi of color ]

]

The type for ANSI styles.

val styled_str : cap -> style list -> string -> string

styled_str cap styles s styles s according to styles and cap.

val strip_escapes : string -> string

strip_escapes s removes ANSI escapes from s.

package b0

Module B0_std.Tty

Terminals

Capabilities

ANSI escapes and styling

Module `B0_std.Tty`