| 1 | .TH toilet 1 "2006-11-10" "libcaca" |
|---|
| 2 | .SH NAME |
|---|
| 3 | TOIlet \- display large colourful characters |
|---|
| 4 | .SH SYNOPSIS |
|---|
| 5 | .B toilet |
|---|
| 6 | [ |
|---|
| 7 | .B \-hkostvSW |
|---|
| 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 |
|---|
| 40 | prints text using large characters made of smaller characters. It is similar |
|---|
| 41 | in many ways to |
|---|
| 42 | .B FIGlet |
|---|
| 43 | with additional features such as Unicode handling, colour fonts, filters |
|---|
| 44 | and various export formats. |
|---|
| 45 | .RI |
|---|
| 46 | .SH USAGE |
|---|
| 47 | .B TOIlet |
|---|
| 48 | either reads its input from the command line or from the standard input. |
|---|
| 49 | .RI |
|---|
| 50 | .SH OPTIONS |
|---|
| 51 | .TP |
|---|
| 52 | .B \-f, \-\-font <name> |
|---|
| 53 | Use the given font instead of the default value. Fonts are |
|---|
| 54 | .B .flf |
|---|
| 55 | or |
|---|
| 56 | .B .tlf |
|---|
| 57 | files stored in the |
|---|
| 58 | .B @datarootdir@/figlet |
|---|
| 59 | directory. There is also a special built-in font called |
|---|
| 60 | .I term |
|---|
| 61 | that serves as a fallback if no font is available. |
|---|
| 62 | .TP |
|---|
| 63 | .B \-d, \-\-directory <dir> |
|---|
| 64 | Specify the directory in which to look for fonts. The default value is set |
|---|
| 65 | at build time and usually defaults to |
|---|
| 66 | .B @datarootdir@/figlet. |
|---|
| 67 | .TP |
|---|
| 68 | .B \-s, \-S, \-k, \-W, \-o |
|---|
| 69 | Select character composition rules. |
|---|
| 70 | .B \-S |
|---|
| 71 | sets smushing (nicely merging glyphs), |
|---|
| 72 | .B \-k |
|---|
| 73 | sets kerning (rendering subcharacters as close to each other as possible), |
|---|
| 74 | .B \-W |
|---|
| 75 | renders characters at their full width and |
|---|
| 76 | .B \-o |
|---|
| 77 | sets overlapping (glyphs slightly overlap the previous one). |
|---|
| 78 | .B \-s |
|---|
| 79 | (default behaviour) uses the font's smushing information if any, otherwise |
|---|
| 80 | forces overlapping, or does nothing if the glyph only has one subcharacter. |
|---|
| 81 | .TP |
|---|
| 82 | .B \-w, \-\-width <width> |
|---|
| 83 | Set the output width. By default, |
|---|
| 84 | .B TOIlet |
|---|
| 85 | will wrap its output at 80 character columns. |
|---|
| 86 | .TP |
|---|
| 87 | .B \-t, \-\-termwidth |
|---|
| 88 | Set the output width to the terminal width. |
|---|
| 89 | .TP |
|---|
| 90 | .B \-F, \-\-filter <filters> |
|---|
| 91 | .PD 0 |
|---|
| 92 | .TP |
|---|
| 93 | .B \-F, \-\-filter list |
|---|
| 94 | .TP |
|---|
| 95 | .B \-\-gay, \-\-metal |
|---|
| 96 | .PD |
|---|
| 97 | Specify a list of filters to be applied to the output. |
|---|
| 98 | .I <filters> |
|---|
| 99 | is a colon-separated list of filters such as |
|---|
| 100 | .I crop:rotate:gay |
|---|
| 101 | and the special argument |
|---|
| 102 | .I list |
|---|
| 103 | outputs a list of available filters. |
|---|
| 104 | |
|---|
| 105 | .B \-\-gay |
|---|
| 106 | and |
|---|
| 107 | .B \-\-metal |
|---|
| 108 | are shortcuts to commonly used filters that are guaranteed to exist. Several |
|---|
| 109 | .B \-F |
|---|
| 110 | flags can also be specified on the command line, in which case filters will |
|---|
| 111 | be applied in order of appearance. |
|---|
| 112 | .TP |
|---|
| 113 | .B \-E, \-\-export <format> |
|---|
| 114 | .PD 0 |
|---|
| 115 | .TP |
|---|
| 116 | .B \-E, \-\-export list |
|---|
| 117 | .TP |
|---|
| 118 | .B \-\-irc, \-\-html |
|---|
| 119 | .PD |
|---|
| 120 | Specify the output format. By default, |
|---|
| 121 | .B TOIlet |
|---|
| 122 | will output UTF-8 text using ANSI colour codes suitable for most terminals |
|---|
| 123 | such as XTerm or rxvt. |
|---|
| 124 | .I <format> |
|---|
| 125 | is the name of the export format as recognised by libcucul. The special |
|---|
| 126 | argument |
|---|
| 127 | .I list |
|---|
| 128 | outputs a list of available export formats. |
|---|
| 129 | |
|---|
| 130 | .B \-\-irc |
|---|
| 131 | and |
|---|
| 132 | .B \-\-html |
|---|
| 133 | are shortcuts to commonly used export formats that are guaranteed to exist. |
|---|
| 134 | .TP |
|---|
| 135 | .B \-h, \-\-help |
|---|
| 136 | Display a short help message and exit. |
|---|
| 137 | .TP |
|---|
| 138 | .B \-I, \-\-infocode <code> |
|---|
| 139 | Print a |
|---|
| 140 | .B FIGlet |
|---|
| 141 | infocode. This flag is only here for |
|---|
| 142 | .B FIGlet |
|---|
| 143 | compatibility, see the |
|---|
| 144 | .B figlet |
|---|
| 145 | manpage for more information about it. |
|---|
| 146 | .TP |
|---|
| 147 | .B \-v, \-\-version |
|---|
| 148 | Output version information and exit. |
|---|
| 149 | .RI |
|---|
| 150 | .SH EXAMPLES |
|---|
| 151 | toilet Hello World |
|---|
| 152 | |
|---|
| 153 | toilet Hello | toilet |
|---|
| 154 | |
|---|
| 155 | tail -f /var/log/messages | toilet -f term --gay |
|---|
| 156 | .RI |
|---|
| 157 | .SH BUGS |
|---|
| 158 | .B FIGlet |
|---|
| 159 | compatibility is not complete yet. |
|---|
| 160 | .RI |
|---|
| 161 | .SH AUTHOR |
|---|
| 162 | .B TOIlet |
|---|
| 163 | and this manual page were written by Sam Hocevar <sam@zoy.org>. There is a |
|---|
| 164 | webpage available at http://libcaca.zoy.org/toilet.html |
|---|
| 165 | .SH SEE ALSO |
|---|
| 166 | figlet(6) |
|---|
