1toilet(1) General Commands Manual toilet(1)
2
6 TOIlet - display large colourful characters
7
9 toilet [ -hkostvSW ] [ -d fontdirectory ]
10 [ -f fontfile ] [ -F filter ] [ -w outputwidth ]
11 [ -I infocode ] [ -E format ] [ message ]
12
14 TOIlet prints text using large characters made of smaller characters.
15 It is similar in many ways to FIGlet with additional features such as
16 Unicode handling, colour fonts, filters and various export formats.
17
19 TOIlet either reads its input from the command line or from the stan‐
20 dard input.
21
23 -f, --font <name>
24 Use the given font instead of the default value. Fonts are .flf
25 or .tlf files stored in the /usr/share/figlet directory. Fonts
26 are looked first in the font directory, then in the current
27 directory. There is also a special built-in font called term
28 that serves as a fallback if no font is available.
29 -d, --directory <dir>
31 Specify the directory in which to look for fonts. The default
32 value is set at build time and usually defaults to
33 /usr/share/figlet.
34 -s, -S, -k, -W, -o
36 Select character composition rules. -S sets smushing (nicely
37 merging glyphs), -k sets kerning (rendering subcharacters as
38 close to each other as possible), -W renders characters at their
39 full width and -o sets overlapping (glyphs slightly overlap the
40 previous one). -s (default behaviour) uses the font's smushing
41 information if any, otherwise forces overlapping, or does noth‐
42 ing if the glyph only has one subcharacter.
43 -w, --width <width>
45 Set the output width. By default, TOIlet will wrap its output at
46 80 character columns.
47 -t, --termwidth
49 Set the output width to the terminal width.
50 -F, --filter <filters>
52 -F, --filter list
53 --gay, --metal
54 Specify a list of filters to be applied to the output. <fil‐
55 ters> is a colon-separated list of filters such as
56 crop:rotate:gay and the special argument list outputs a list of
57 available filters.
58 --gay and --metal are shortcuts to commonly used filters that
60 are guaranteed to exist. Several -F flags can also be specified
61 on the command line, in which case filters will be applied in
62 order of appearance.
63 -E, --export <format>
65 -E, --export list
66 --irc, --html
67 Specify the output format. By default, TOIlet will output UTF-8
68 text using ANSI colour codes suitable for most terminals such as
69 XTerm or rxvt. <format> is the name of the export format as
70 recognised by libcaca. The special argument list outputs a list
71 of available export formats.
72 --irc and --html are shortcuts to commonly used export formats
74 that are guaranteed to exist.
75 -h, --help
77 Display a short help message and exit.
78 -I, --infocode <code>
80 Print a FIGlet infocode. This flag is only here for FIGlet com‐
81 patibility, see the figlet manpage for more information about
82 it.
83 -v, --version
85 Output version information and exit.
86
88 toilet Hello World
89 toilet Hello | toilet
91 tail -f /var/log/messages | toilet -f term --gay
93
95 FIGlet compatibility is not complete yet.
96
98 TOIlet and this manual page were written by Sam Hocevar <sam@hoce‐
99 var.net>. There is a webpage available at http://caca.zoy.org/wiki/toi‐
100 let .
101
103 figlet(6)
104libcaca @PACKAGE_VERSION@ 2006-11-10 toilet(1)