package b0

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Cli arguments
Pager

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

Pager interaction.

Cli arguments

val envs : Cmdliner.Term.env_info list

envs describe the PAGER and TERM environment variable.

val don't : ?docs:string -> unit -> bool Cmdliner.Term.t

don't ~docs () is a --no-pager command line option to unconditionally request not use a pager. docs is the manual section where the option is documented.

val find : 
  ?search:B0_std.Fpath.t list ->
  don't:bool ->
  unit ->
  (B0_std.Cmd.t option, string) result

find ~search ~don't finds a suitable pager. This is (in order):

Ok None if don't is true or if the TERM environment variable is dumb or undefined.
Ok (Some pager) if pager is a tool invocation parsed from the PAGER environment variable that can be found via Os.Cmd.find ?search.
Ok (Some pager) if either less or more can be found (in that order) via Os.Cmd.find ?search.
Ok None otherwise.

val page_stdout : B0_std.Cmd.t option -> (unit, string) result

page_stdout pager setups the program so that if pager is Some cmd, the standard output of the program is redirected to a spawn of cmd with the following twists:

If the environment variable LESS is undefined in the current environment it is set to LESS=FRX for the spawn of cmd.
A Pervasive.at_exit function is installed that flushes Fmt.stdout and stdout, closes Unix.stdout and waits upon the cmd spawn termination.

If pager is None this function has no effect.

val page_files : 
  B0_std.Cmd.t option ->
  B0_std.Fpath.t list ->
  (unit, string) result

page_files pager fs uses pager to page the files fs. If pager is:

None, each of the fs files is output on stdout in order separated by a file separator character (U+001C).
Some cmd, cmd is run with fs as arguments. If fs is empty does nothing.