package b0

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Environment variables
Show URIs
Cli interaction

b0.b0
- B0_build
  - Unit
- B0_def
  - Make
    
    Map
    
    Set
    
    V
  - S
    
    Map
    
    Set
  - Scope
  - VALUE
- B0_meta
  - Key
- B0_pack
  - Map
  - Set
- B0_unit
  - Map
  - Set
b0.b00
- B00
  - Env
  - Memo
    
    Fut
  - Store
  - Tool
- B000
  - Exec
  - File_cache
  - Guard
  - Op
    
    Copy
    
    Delete
    
    Map
    
    Mkdir
    
    Notify
    
    Read
    
    Set
    
    Spawn
    
    Wait_files
    
    Write
  - Reviver
  - Trash
- B000_conv
  - Op
b0.b00.kit
- B00_base64
- B00_cmark
- B00_editor
  - Env
- B00_fexts
- B00_findex
- B00_github
  - Issue
  - Pages
  - Release
  - Repo
- B00_htmlg
  - At
  - El
- B00_http
  - Http
  - Httpr
  - Uri
- B00_lines
- B00_ocaml
  - Cobj
    
    Map
    
    Set
  - Compile
  - Conf
  - Lib
  - Lib_name
    
    Map
    
    Set
  - Lib_resolver
  - Link
    
    Deps
  - Mod_name
  - Mod_ref
    
    Map
    
    Set
  - Mod_src
    
    Deps
  - Ocamlpath
  - Tool
- B00_odoc
  - Compile
    
    Dep
    
    Writes
  - Html
    
    Dep
    
    Writes
  - Html_fragment
  - Support_files
    
    Writes
  - Theme
- B00_os
- B00_pager
  - Env
- B00_pdf_viewer
  - Env
- B00_serialk_json
  - Json
  - Jsong
  - Jsonq
- B00_serialk_sexp
  - Sexp
  - Sexpg
  - Sexpq
- B00_serialk_text
  - Tdec
  - Tloc
- B00_std_ui
- B00_trace
  - Compilation_database
  - Trace_event
- B00_ui
  - Cli
  - File_cache
  - Memo
    
    Log
  - Op
- B00_vcs
  - Git
- B00_www_browser
  - Env
b0.b00.std
- B00_std
  - Bincode
  - Char
    
    Ascii
  - Cmd
  - Fmt
  - Fpath
    
    Map
    
    Set
  - Hash
    
    Murmur3_128
    
    T
    
    Xxh_64
  - List
  - Log
  - Option
  - Os
    
    Cmd
    
    Cpu
    
    Dir
    
    Env
    
    Fd
    
    File
    
    Path
    
    Sig_exit
  - Result
  - Rqueue
  - String
    
    Ascii
    
    Map
    
    Set
  - Tid
  - Time
    
    Span
  - Tty
b0.driver
- B0_driver
  - Cli
  - Compile
  - Conf
  - Env
  - Exit
    
    Info
- B0_file
b0.driver.b0
- B0_b0
  - Cli
  - Def
- B0_cmd_build
- B0_cmd_delete
- B0_cmd_file
- B0_cmd_log
- B0_cmd_pack
- B0_cmd_unit
- B0_main
b0.kit
- B0_kit
  - V000
- B0_ocaml
  - Meta
  - Unit
- B0_srcs

Legend:
Library
Module
Module type
Parameter
Class
Class type

Web browser interaction.

Browser shows URIs in the user's browsers. Up to severe platform and browser application limitations it tries to limit the creation of new tabs, reloading existing one which have the same URI or are, if requested, prefixed by the URI.

Environment variables

module Env : sig ... end

Environment variables.

Show URIs

type t

The type for specifying a browser.

val find : 
  ?search:B00_std.Fpath.t list ->
  browser:B00_std.Cmd.t option ->
  unit ->
  (t option, string) result

find ~search ~browser tries to find a browser in a rather complex and platform dependent way.

val show : 
  background:bool ->
  prefix:bool ->
  t option ->
  string ->
  (unit, string) result

show ~background ~prefix browser uri shows URI using browser browser (if None an error message is returned mentioning that no browser was found. If background is true tries to keep the browser application in the background, if false brings it in user focus.

The function tries to limit the creation of new tabs using the following strategy:

Repeat from the frontmost browser window to the backmost one until a tab to reload is found:
1. If the window's current tab's URI is uri (or is prefixed by uri when prefix is true), reload this tab.
2. If the window has one or more tab whose URI is uri (or is prefixed by uri when prefix is true), pick the left most one, make it current in the window and reload it.
If no tab was found, get the frontmost window. If the current tab has no URI, use that tab with uri otherwise create a new tab with uri and make it current for the window.

Cli interaction

val browser : 
  ?docs:string ->
  ?opts:string list ->
  unit ->
  B00_std.Cmd.t option Cmdliner.Term.t

browser is an option and BROWSER environment variable to use with the browser argument of find. opts are the cli options and default to ["browser"].

val prefix : ?docs:string -> ?opts:string list -> unit -> bool Cmdliner.Term.t

prefix is option to use the with prefix argument of show. opts are the cli options and default to ["prefix"].

val background : 
  ?docs:string ->
  ?opts:string list ->
  unit ->
  bool Cmdliner.Term.t

background is an option to use with the background argument of !show. opts are the cli options and default to ["background"]