package fmt

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 Readme Changelog ISC License Edit opam file Versions (7)

Authors

Maintainers

Daniel Bünzli

Sources

fmt-0.8.5.tbz

sha256=c080cf9a7cd7d383e0c37c80c7a7f6a030f453ac6ffa64569dda58d6d95749fe

md5=77b64aa6f20f09de28f2405d6195f12c

doc/fmt.cli/Fmt_cli/index.html

Module `Fmt_cli`Source

Cmdliner support for Fmt.

v0.8.5 - homepage

Option for setting the style renderer

Source

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.