source: toilet/trunk/doc/toilet.1.in @ 1326

Last change on this file since 1326 was 1326, checked in by Sam Hocevar, 13 years ago
  • Allow setting the font directory using --datadir / --datarootdir.
File size: 2.9 KB
Line 
1.TH toilet 1 "2006-11-10" "libcaca"
2.SH NAME
3TOIlet \- display large colourful characters
4.SH SYNOPSIS
5.B toilet
6[
7.B \-htv
8] [
9.B \-d
10.I fontdirectory
11]
12.PD 0
13.IP
14.PD
15[
16.B \-f
17.I fontfile
18] [
19.B \-F
20.I filter
21] [
22.B \-w
23.I outputwidth
24]
25.PD 0
26.IP
27.PD
28[
29.B \-I
30.I infocode
31] [
32.B \-E
33.I format
34] [
35.I message
36]
37.RI
38.SH DESCRIPTION
39.B TOIlet
40prints text using large characters made of smaller characters. It is similar
41in many ways to
42.B FIGlet
43with additional features such as Unicode handling, colour fonts, filters
44and various export formats.
45.RI
46.SH USAGE
47.B TOIlet
48either reads its input from the command line or from the standard input.
49.RI
50.SH OPTIONS
51.TP
52.B \-f, \-\-font <name>
53Use the given font instead of the default value. Fonts are
54.B .flf
55or
56.B .tlf
57files stored in the
58.B @datarootdir@/figlet
59directory. There is also a special built-in font called
60.I term
61that serves as a fallback if no font is available.
62.TP
63.B \-d, \-\-directory <dir>
64Specify the directory in which to look for fonts. The default value is set
65at build time and usually defaults to
66.B @datarootdir@/figlet.
67.TP
68.B \-w, \-\-width <width>
69Set the output width. By default,
70.B TOIlet
71will wrap its output at 80 character columns.
72.TP
73.B \-t, \-\-termwidth
74Set the output width to the terminal width.
75.TP
76.B \-F, \-\-filter <filters>
77.PD 0
78.TP
79.B \-F, \-\-filter list
80.TP
81.B \-\-gay, \-\-metal
82.PD
83Specify a list of filters to be applied to the output.
84.I <filters>
85is a colon-separated list of filters such as
86.I crop:rotate:gay
87and the special argument
88.I list
89outputs a list of available filters.
90
91.B \-\-gay
92and
93.B \-\-metal
94are shortcuts to commonly used filters that are guaranteed to exist. Several
95.B \-F
96flags can also be specified on the command line, in which case filters will
97be applied in order of appearance.
98.TP
99.B \-E, \-\-export <format>
100.PD 0
101.TP
102.B \-E, \-\-export list
103.TP
104.B \-\-irc, \-\-html
105.PD
106Specify the output format. By default,
107.B TOIlet
108will output UTF-8 text using ANSI colour codes suitable for most terminals
109such as XTerm or rxvt.
110.I <format>
111is the name of the export format as recognised by libcucul. The special
112argument
113.I list
114outputs a list of available export formats.
115
116.B \-\-irc
117and
118.B \-\-html
119are shortcuts to commonly used export formats that are guaranteed to exist.
120.TP
121.B \-h, \-\-help
122Display a short help message and exit.
123.TP
124.B \-I, \-\-infocode <code>
125Print a
126.B FIGlet
127infocode. This flag is only here for
128.B FIGlet
129compatibility, see the
130.B figlet
131manpage for more information about it.
132.TP
133.B \-v, \-\-version
134Output version information and exit.
135.RI
136.SH EXAMPLES
137toilet Hello World
138
139toilet Hello | toilet
140
141tail -f /var/log/messages | toilet -f term --gay
142.RI
143.SH BUGS
144.B FIGlet
145compatibility is not complete yet.
146.RI
147.SH AUTHOR
148.B TOIlet
149and this manual page were written by Sam Hocevar <sam@zoy.org>. There is a
150webpage available at http://libcaca.zoy.org/toilet.html
151.SH SEE ALSO
152figlet(6)
Note: See TracBrowser for help on using the repository browser.