package fmt

You can search for identifiers within the package.

in-package search v0.2.0

OCaml Format pretty-printer combinators

Install

Dune Dependency

erratique.ch Readme Changelog ISC License Edit opam file Versions (6)

Authors

T

The fmt programmers

Maintainers

Daniel Bünzli

Sources

fmt-0.8.8.tbz

sha256=64eeaf0659fe3b8cbf334ac6d55ff41d04310b400f895142ae028c6627cfc0c7

md5=473490fcfdf3ff0a8ccee226b873d4b2

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.

On This Page

Option for setting the style renderer