In addition to HTML and GUI output, Factor has facilities for displaying formatted text -- such as that produced by help -- on terminals that support text attributes and colours.
The io.streams.escape-codes vocabulary provides words for generating ANSI escape codes from text attributes, and is not typically useful to end users. The io.streams.ansi and io.streams.256color vocabularies, however, provide output streams suitable for displaying formatted text on 16- and 256-color terminals, respectively. In deciding which one to use, you may also want to use terminfo to query the capabilities of your controlling terminal.
Limitations
These vocabularies do not attempt to query the terminal to figure out what features they support; it's assumed that the caller has done so, if necessary.
Similarly, it assumes the terminal it's talking to supports ECMA/ISO escape sequences rather than querying terminfo to find out if it uses nonstandard sequences. This may change in the future, but this is sufficient for compatibility with the most commonly used terminal emulators.
Palettes are not standardized across terminals, and even across different installs of the same terminal, individual users may have set up custom palettes. These vocabularies do not attempt to read palette information from the terminal; instead, they use builtin palettes that should closely approximate the default configurations for a wide range of terminals.
Formatted output:
Querying terminal capabilities:
See also
Terminfo Databases
The io.streams.escape-codes vocabulary provides words for generating ANSI escape codes from text attributes, and is not typically useful to end users. The io.streams.ansi and io.streams.256color vocabularies, however, provide output streams suitable for displaying formatted text on 16- and 256-color terminals, respectively. In deciding which one to use, you may also want to use terminfo to query the capabilities of your controlling terminal.
Limitations
These vocabularies do not attempt to query the terminal to figure out what features they support; it's assumed that the caller has done so, if necessary.
Similarly, it assumes the terminal it's talking to supports ECMA/ISO escape sequences rather than querying terminfo to find out if it uses nonstandard sequences. This may change in the future, but this is sufficient for compatibility with the most commonly used terminal emulators.
Palettes are not standardized across terminals, and even across different installs of the same terminal, individual users may have set up custom palettes. These vocabularies do not attempt to read palette information from the terminal; instead, they use builtin palettes that should closely approximate the default configurations for a wide range of terminals.
Formatted output:
with-ansi ( -- * )
with-256color ( -- * )
Querying terminal capabilities:
tty-supports-ansicolor? ( -- ? )
tty-supports-256color? ( -- ? )
tty-supports-rgbcolor? ( -- ? )
tty-supports-attributes? ( -- ? )
See also
Terminfo Databases