This is the cl-ansi-text Reference Manual, version 2.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 04:39:22 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-ansi-textANSI control string characters, focused on color
Paul Nathan
Paul Nathan
LLGPL
ANSI control string management, specializing in
colors. Sometimes it is nice to have text output in colors
2.0.1
cl-colors2 (system).
alexandria (system).
cl-ansi-text.lisp (file).
define-colors.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-ansi-text/cl-ansi-text.lispcl-ansi-text (system).
*color-mode* (special variable).
*enabled* (special variable).
+reset-color-string+ (special variable).
color-specifier (type).
color-string (type).
make-color-string (function).
with-color (macro).
+cl-colors-basic-colors+ (special variable).
+term-colors+ (special variable).
+term-effects+ (special variable).
+text-style+ (special variable).
code-from-rgb (function).
color-string-p (function).
find-effect-code (function).
find-style-code (function).
rgb-color-code (generic function).
rgb-to-ansi-3bit (function).
rgb-to-ansi-8bit (function).
term-colors (type).
cl-ansi-text/define-colors.lispcl-ansi-text.lisp (file).
cl-ansi-text (system).
define-colors (macro).
Packages are listed by definition order.
cl-ansi-textcommon-lisp.
*color-mode* (special variable).
*enabled* (special variable).
+reset-color-string+ (special variable).
black (function).
blue (function).
color-specifier (type).
color-string (type).
cyan (function).
green (function).
magenta (function).
make-color-string (function).
red (function).
white (function).
with-color (macro).
yellow (function).
+cl-colors-basic-colors+ (special variable).
+term-colors+ (special variable).
+term-effects+ (special variable).
+text-style+ (special variable).
code-from-rgb (function).
color-string-p (function).
define-colors (macro).
find-effect-code (function).
find-style-code (function).
rgb-color-code (generic function).
rgb-to-ansi-3bit (function).
rgb-to-ansi-8bit (function).
term-colors (type).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Controls the way ‘make-color-string‘ emits the color code.
It should be one of the following keyword symbols: ‘:3bit‘, ‘:8bit‘, ‘:24bit‘.
The specified color is converted to the nearest color in the color space.
Note that the actual appearance of the screen in the ‘:3bit‘ mode may be affected by the terminal setting – For example, many terminals do not use ‘FF0000‘ for the red.
Turns on/off the colorization.
A constant string that resets the color state of the terminal.
Writes out the ANSI escape code string
denoting ‘effect‘, ‘style‘, and a switch to ‘color‘, then executes ‘body‘,
then writes out the string that resets the decoration.
Returns a string decorated in black.
Returns a string decorated in blue.
Returns a string decorated in cyan.
Returns a string decorated in green.
Returns a string decorated in magenta.
Takes an object of ‘color-specifier‘ and returns a string sufficient to change to the given color.
Colorization is controlled by *enabled* unless manually specified otherwise by ‘:enabled‘ keyword.
Returns a string decorated in red.
Returns a string decorated in white.
Returns a string decorated in yellow.
CL-COLORS2 basic colors
Basic colors
ANSI terminal effects
One or the other. Not an ANSI effect
Returns the number for the text effect OR
t if no effect should be used OR
nil if the effect is unknown.
effect should be a member of +term-effects+
find the closest color from +cl-colors-basic-colors+
http://www.frexx.de/xterm-256-notes/
Returns a list of codes suitable for the current color mode.
symbol) &optional style) ¶hsv) &optional style) ¶rgb) &optional style) ¶string) &optional style) ¶Takes RGB integer ala Web integers
integer) &optional style) ¶Takes RGB integer ala Web integers
list) &optional style) ¶| Jump to: | B C D F G M R W Y |
|---|
| Jump to: | B C D F G M R W Y |
|---|
| Jump to: | *
+
S |
|---|
| Jump to: | *
+
S |
|---|
| Jump to: | C D F P S T |
|---|
| Jump to: | C D F P S T |
|---|