ansifilter(1)

1ansifilter(1)                 user documentation                 ansifilter(1)
2
3
4

NAME

6       Ansifilter - ANSI escape code processor and converter
7
8

SYNOPSIS

10       ansifilter  [d:i:F:m:o:r:s:e:fhptvHRT] [-i input file] [-o output file]
11       [--text] [--html] [--latex] [--tex] [--rtf] [input files]
12
13

DESCRIPTION

15       Ansifilter is a small utility to handle text files containing ANSI ter‐
16       minal  escape codes. The command sequences may be stripped or be inter‐
17       preted to generate formatted output (HTML, LaTeX, TeX, RTF).
18
19       See the README file for details.
20

File options

22       -i, --input=<file>
23              Name of input file
24
25       -o, --output=<file>
26              Name of output file
27
28       -O, --outdir=<dir>
29              Name of output directory
30
31       -t, --tail
32              Continue reading after end-of-file (like tail  -f).  Use  system
33              tail if available.
34
35

Output formats

37       -T, --text
38              Output text (default)
39
40       -H, --html
41              Output HTML
42
43       -M, --pango
44              Output Pango markup
45
46       -L, --latex
47              Output LaTeX
48
49       -P, --tex
50              Output Plain TeX
51
52       -R, --rtf
53              Output RTF
54
55       -B, --bbcode
56              Output BBCode
57
58       -S, --svg
59              Output SVG
60
61

Format options

63       -a, --anchors(=self)
64              Add HTML line anchors (opt: self referencing, assumes -l)
65
66       -d, --doc-title
67              Set HTML/LaTeX/SVG document title
68
69       -f, --fragment
70              Omit HTML header and footer
71
72       -F, --font=<font>
73              Set HTML/RTF/SVG font face
74
75       -k, --ignore-clear
76              Do not adhere to clear (ESC K) commands
77
78       -l, --line-numbers
79              Print line numbers in output file
80
81       -m, --map=<path>
82              Read color mapping file (see README)
83
84       -r, --style-ref=<rf>
85              Set HTML/TeX/LaTeX/SVG stylesheet path
86
87       -s, --font-size=<num?>
88              Set HTML/RTF/SVG font size
89
90       -e, --encoding=<enc>
91              Set  HTML encoding (must match input file encoding); omit encod‐
92              ing information if enc=NONE
93
94       -p, --plain
95              Ignore ANSI formatting information
96
97       -w, --wrap=<len>
98              Wrap long lines
99
100       --no-trailing-nl
101              Omit trailing newline
102
103       --no-version-info
104              Omit version info comment
105
106       --wrap-no-numbers
107              Omit line numbers of wrapped lines (assumes -l)
108
109       --derived-styles
110              Output dynamic stylesheets (HTML/SVG)
111
112

ASCII art options

114       --art-cp437
115              Parse codepage 437 ASCII art (HTML and RTF output)
116
117       --art-bin
118              Parse BIN/XBIN ASCII art  (HTML output, no stdin)
119
120       --art-tundra
121              Parse Tundra ANSI art  (HTML output, no stdin)
122
123       --art-width
124              Set ASCII art width (default 80)
125
126       --art-height
127              Set ASCII art height (default 150)
128
129

OTHER OPTIONS

131       -h, --help
132              print help
133
134       -v, --version
135              print version and license info
136
137
138       If no in- or output files are specified, stdin and stdout will be  used
139       for   in- or output.  Plain text will be generated, if no output format
140       is given.  Parsing XBIN files overrides --art-width,  --art-height  and
141       --map  options.   The ANSI art file formats BIN, XBIN and TND cannot be
142       read from stdin.
143
144

Examples

146       File conversions:
147
148       ansifilter -i text_with_ansi.txt -o text_without_ansi.txt
149
150       tail -f server.log | ansifilter
151
152       ansifilter *.txt
153
154

AUTHORS

156       Andre Simon <a.simon@mailbox.org>
157