package fmt

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

TTY setup

OCaml Format pretty-printer combinators

Install

dune-project

Dependency

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

Authors

T

The fmt programmers

Maintainers

Daniel Bünzli

Sources

fmt-0.10.0.tbz

sha512=26d7f2002f0f1d605c08129ec09d487a8c37d764b77370e56b869fd94fe6bc903f808159ab7b79e85c2e2b6263ee5fa7df66f9f9625bdf0e726e8a92a9056258

doc/fmt.tty/Fmt_tty/index.html

Module `Fmt_tty`

Fmt TTY setup.

Fmt_tty provides simple automatic setup on channel formatters for:

Fmt.set_style_renderer. `Ansi_tty is used if the channel is a tty and the environment variable TERM is defined and its value is not "dumb". `None is used otherwise.
Fmt.set_utf_8. true is used if one of the following environment variables has "UTF-8" as a case insensitive substring: LANG, LC_ALL, LC_CTYPE.

TTY setup

val setup : 
  ?style_renderer:Fmt.style_renderer ->
  ?utf_8:bool ->
  out_channel ->
  Format.formatter

setup ?style_renderer ?utf_8 outc is a formatter for outc with Fmt.set_style_renderer and Fmt.set_utf_8 correctly setup. If style_renderer or utf_8 are specified they override the automatic setup.

If outc is stdout, Fmt.stdout is returned. If outc is stderr, Fmt.stderr is returned.

val setup_std_outputs : 
  ?style_renderer:Fmt.style_renderer ->
  ?utf_8:bool ->
  unit ->
  unit

setup_std_outputs ?style_renderer ?utf_8 () applies setup on stdout and stderr.