OSI Certified Open Source Software
Ansifilter handles text files containing ANSI terminal escape codes. The command sequences may be stripped or be interpreted to generate formatted output (HTML, RTF, TeX, LaTeX, BBCode, Pango).
Invocation: ansifilter [OPTION]... [FILE]...
ansifilter handles text files containing ANSI terminal escape codes.
File handling:
-i, --input=<file> Name of input file
-o, --output=<file> Name of output file
-O, --outdir=<dir> Name of output directory
-t, --tail Continue reading after end-of-file (like tail -f)
Output text formats:
-T, --text (default) Output text
-H, --html Output HTML
-M, --pango Output Pango Markup
-L, --latex Output LaTeX
-P, --tex Output Plain TeX
-R, --rtf Output RTF
-S, --svg Output SVG
-B, --bbcode Output BBCode
Format options:
-a, --anchors(=self) Add HTML line anchors (opt: self referencing, assumes -l)
-d, --doc-title Set HTML/LaTeX/SVG document title
-e, --encoding=<enc> Set HTML/RTF encoding (must match input file encoding);
omit encoding information if enc=NONE
-f, --fragment Omit HTML header and footer
-F, --font=<font> Set HTML/RTF/SVG font face
-k, --ignore-clear(=0) Do not adhere to clear (ESC K) commands (default: true)
-l, --line-numbers Print line numbers in output file
-m, --map=<path> Read color mapping file (see README)
-r, --style-ref=<rf> Set HTML/TeX/LaTeX/SVG stylesheet path
-s, --font-size=<fs> Set HTML/RTF/SVG font size
-p, --plain Ignore ANSI formatting information
-w, --wrap=<len> Wrap long lines
--no-trailing-nl Omit trailing newline
--no-version-info Omit version info comment
--wrap-no-numbers Omit line numbers of wrapped lines (assumes -l)
--derived-styles Output dynamic stylesheets (HTML/SVG)
ANSI art options:
--art-cp437 Parse codepage 437 ANSI art (HTML and RTF output)
--art-bin Parse BIN/XBIN ANSI art (HTML output, no stdin)
--art-tundra Parse Tundra ANSI art (HTML output, no stdin)
--art-width Set ANSI art width (default 80)
--art-height Set ANSI art height (default 150)
SVG output options:
--height set image height (units allowed)
--width set image width (see --height)
Other options:
-h, --help Print help
-v, --version Print version and license info
Examples:
ansifilter -i input.ansi -o output.txt
ansifilter *.txt
tail -f server.log | ansifilter
Parsing XBIN files overrides --art-width, --art-height and --map options.
The ANSI art file formats BIN, XBIN and TND cannot be read from stdin.
Ansifilter understands most CSI sequences. Support for ANSI art files (based on
codepage 437 and ANSI.SYS sequences, BIN/XBIN and Tundra files) is enabled with
the --art-cp437 and --art-bin options.
Parsing XBIN files overrides --art-width, --art-height and --map options.
Parsing TND files overrides --art-width and --map options.
Supported SGR parameters:
Formatting: Bold, Underline, Italic, Blink
Colors: Black, Red, Green, Yellow, Blue, Magenta, Cyan, White;
xterm 256 color modes;
16m true color modes
Other: Conceal/Reveal, Image positive/negative
All commands which issue the listed formatting options are supported. Some options like Blink are not supported by all output formats (like RTF).
The command line version recognizes these variables:
ANSIFILTER_OPTIONS: may contain command line options, but no input file paths.
The basic ANSI color set can be adjusted with a color map file (--map option).
This text configuration overrides these color codes:
Normal: Black (0), Red (1), Green (2), Yellow (3), Blue (4), Magenta (5),
Cyan (6), Gray (7)
Bright: DarkGray (8), Red (9), Green (10), Yellow (11), Blue (12), Magenta (13),
Cyan (14), White (15)
File format:
<0..15> = <HTML color code>
Example file content: 1= #0000aa 2= #00aa00 3= #00aaaa 4= #aa0000 5= #aa00aa 6= #aa5500 7= #aaaaaa 8= #555555 9= #5555ff 10= #55ff55 11= #55ffff 12= #ff5555 13= #ff55ff 14= #ffff55 15= #ffffff
Andre Simon a.simon@mailbox.org http://www.andre-simon.de/
Git project with Git repository, bug tracker: https://gitlab.com/saalen/ansifilter
sf.net project with SVN repository, download mirror, bug tracker, help forum: http://sourceforge.net/projects/ansifilter/