package fmt

Overview
No Docs

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Option for setting the style renderer

OCaml Format pretty-printer combinators

Install

dune-project

Dependency

erratique.ch Edit opam file Versions (7)

Authors

T

The fmt programmers

Maintainers

Daniel Bünzli

Sources

fmt-0.9.0.tbz

sha512=66cf4b8bb92232a091dfda5e94d1c178486a358cdc34b1eec516d48ea5acb6209c0dfcb416f0c516c50ddbddb3c94549a45e4a6d5c5fd1c81d3374dec823a83b

doc/fmt.cli/Fmt_cli/index.html

Module `Fmt_cli`

Cmdliner support for Fmt.

Option for setting the style renderer

val style_renderer : 
  ?env:Cmdliner.Arg.env ->
  ?docs:string ->
  unit ->
  Fmt.style_renderer option Cmdliner.Term.t

style_renderer ?env ?docs () is a Cmdliner option --color that can be directly used with the optional arguments of TTY setup or to control style rendering. The option is documented under docs (defaults to the default in Cmdliner.Arg.info).

The option is a tri-state enumerated value that when used with TTY setup takes over the automatic setup:

--color=never, the value is Some `None, forces no styling.
--color=always, the value is Some `Ansi, forces ANSI styling.
--color=auto or absent, the value is None, automatic setup takes place.

If env is provided, the option default value (None) can be overridden by the corresponding environment variable.