{ "content": [ { "type": "text", "text": "# toilet(1) (man)\n\n## TLDR\n\n> Display ASCII-art fonts.\n\n- Generate ASCII art for a given text:\n `toilet {{input_text}}`\n- Generate ASCII art using a custom font file:\n `toilet {{input_text}} {{-f|--font}} {{font_filename}}`\n- Generate ASCII art using a filter:\n `toilet {{input_text}} {{-F|--filter}} {{filter_name}}`\n- Show available toilet filters:\n `toilet {{-F|--filter}} list`\n\n*Source: tldr-pages*\n\n---\n\n**Summary:** TOIlet - display large colourful characters\n\n**Synopsis:** toilet [ -hkostvSW ] [ -d fontdirectory ]\n[ -f fontfile ] [ -F filter ] [ -w outputwidth ]\n[ -I infocode ] [ -E format ] [ message ]\n\n## Flags\n\n| Flag | Long | Arg | Description |\n|------|------|-----|-------------|\n| -f | --font | | Use the given font instead of the default value. Fonts are .flf or .tlf files stored in the /usr/share/figlet directory. |\n| -d | --directory | | Specify the directory in which to look for fonts. The default value is set at build time and usually defaults to /usr/sh |\n| -o | — | — | Select character composition rules. -S sets smushing (nicely merging glyphs), -k sets kerning (rendering subcharacters a |\n| -w | --width | | Set the output width. By default, TOIlet will wrap its output at 80 character columns. |\n| -t | --termwidth | — | Set the output width to the terminal width. |\n| -F | --filter | | |\n| -F | --filter | — | |\n| — | --metal | — | Specify a list of filters to be applied to the output. is a colon-separated list of filters such as crop:rotat |\n| -E | --export | | |\n| -E | --export | — | |\n| — | --html | — | Specify the output format. By default, TOIlet will output UTF-8 text using ANSI colour codes suitable for most terminals |\n| -h | --help | — | Display a short help message and exit. |\n| -I | --infocode | | Print a FIGlet infocode. This flag is only here for FIGlet compatibility, see the figlet manpage for more information ab |\n| -v | --version | — | Output version information and exit. |\n\n## Examples\n\n- `toilet Hello World`\n- `toilet Hello | toilet`\n- `tail -f /var/log/messages | toilet -f term --gay`\n\n## See Also\n\n- figlet(6)\n\n## Section Outline\n\n- **NAME** (2 lines)\n- **SYNOPSIS** (4 lines)\n- **DESCRIPTION** (4 lines)\n- **USAGE** (2 lines)\n- **OPTIONS** (1 lines) — 14 subsections\n - -f, --font (5 lines)\n - -d, --directory (3 lines)\n - -s, -S, -k, -W, -o (6 lines)\n - -w, --width (2 lines)\n - -t, --termwidth (2 lines)\n - -F, --filter (1 lines)\n - -F, --filter list (1 lines)\n - --gay, --metal (8 lines)\n - -E, --export (1 lines)\n - -E, --export list (1 lines)\n - --irc, --html (8 lines)\n - -h, --help (2 lines)\n - -I, --infocode (3 lines)\n - -v, --version (2 lines)\n- **EXAMPLES** (6 lines)\n- **BUGS** (2 lines)\n- **AUTHOR** (3 lines)\n- **SEE ALSO** (5 lines)\n\n## Full Content\n\n### NAME\n\nTOIlet - display large colourful characters\n\n### SYNOPSIS\n\ntoilet [ -hkostvSW ] [ -d fontdirectory ]\n[ -f fontfile ] [ -F filter ] [ -w outputwidth ]\n[ -I infocode ] [ -E format ] [ message ]\n\n### DESCRIPTION\n\nTOIlet prints text using large characters made of smaller characters. It is similar in many\nways to FIGlet with additional features such as Unicode handling, colour fonts, filters and\nvarious export formats.\n\n### USAGE\n\nTOIlet either reads its input from the command line or from the standard input.\n\n### OPTIONS\n\n#### -f, --font \n\nUse the given font instead of the default value. Fonts are .flf or .tlf files stored\nin the /usr/share/figlet directory. Fonts are looked first in the font directory, then\nin the current directory. There is also a special built-in font called term that\nserves as a fallback if no font is available.\n\n#### -d, --directory \n\nSpecify the directory in which to look for fonts. The default value is set at build\ntime and usually defaults to /usr/share/figlet.\n\n#### -s, -S, -k, -W, -o\n\nSelect character composition rules. -S sets smushing (nicely merging glyphs), -k sets\nkerning (rendering subcharacters as close to each other as possible), -W renders char‐\nacters at their full width and -o sets overlapping (glyphs slightly overlap the previ‐\nous one). -s (default behaviour) uses the font's smushing information if any, other‐\nwise forces overlapping, or does nothing if the glyph only has one subcharacter.\n\n#### -w, --width \n\nSet the output width. By default, TOIlet will wrap its output at 80 character columns.\n\n#### -t, --termwidth\n\nSet the output width to the terminal width.\n\n#### -F, --filter \n\n#### -F, --filter list\n\n#### --gay, --metal\n\nSpecify a list of filters to be applied to the output. is a colon-separated\nlist of filters such as crop:rotate:gay and the special argument list outputs a list\nof available filters.\n\n--gay and --metal are shortcuts to commonly used filters that are guaranteed to exist.\nSeveral -F flags can also be specified on the command line, in which case filters will\nbe applied in order of appearance.\n\n#### -E, --export \n\n#### -E, --export list\n\n#### --irc, --html\n\nSpecify the output format. By default, TOIlet will output UTF-8 text using ANSI colour\ncodes suitable for most terminals such as XTerm or rxvt. is the name of the\nexport format as recognised by libcaca. The special argument list outputs a list of\navailable export formats.\n\n--irc and --html are shortcuts to commonly used export formats that are guaranteed to\nexist.\n\n#### -h, --help\n\nDisplay a short help message and exit.\n\n#### -I, --infocode \n\nPrint a FIGlet infocode. This flag is only here for FIGlet compatibility, see the\nfiglet manpage for more information about it.\n\n#### -v, --version\n\nOutput version information and exit.\n\n### EXAMPLES\n\ntoilet Hello World\n\ntoilet Hello | toilet\n\ntail -f /var/log/messages | toilet -f term --gay\n\n### BUGS\n\nFIGlet compatibility is not complete yet.\n\n### AUTHOR\n\nTOIlet and this manual page were written by Sam Hocevar . There is a webpage\navailable at http://caca.zoy.org/wiki/toilet .\n\n### SEE ALSO\n\nfiglet(6)\n\n\n\nlibcaca @PACKAGEVERSION@ 2006-11-10 toilet(1)\n\n" } ], "structuredContent": { "command": "toilet", "section": "1", "mode": "man", "summary": "TOIlet - display large colourful characters", "synopsis": "toilet [ -hkostvSW ] [ -d fontdirectory ]\n[ -f fontfile ] [ -F filter ] [ -w outputwidth ]\n[ -I infocode ] [ -E format ] [ message ]", "tldr_summary": "Display ASCII-art fonts.", "tldr_examples": [ { "description": "Generate ASCII art for a given text", "command": "toilet {{input_text}}" }, { "description": "Generate ASCII art using a custom font file", "command": "toilet {{input_text}} {{-f|--font}} {{font_filename}}" }, { "description": "Generate ASCII art using a filter", "command": "toilet {{input_text}} {{-F|--filter}} {{filter_name}}" }, { "description": "Show available toilet filters", "command": "toilet {{-F|--filter}} list" } ], "tldr_source": "official", "flags": [ { "flag": "-f", "long": "--font", "arg": "", "description": "Use the given font instead of the default value. Fonts are .flf or .tlf files stored in the /usr/share/figlet directory. Fonts are looked first in the font directory, then in the current directory. There is also a special built-in font called term that serves as a fallback if no font is available." }, { "flag": "-d", "long": "--directory", "arg": "", "description": "Specify the directory in which to look for fonts. The default value is set at build time and usually defaults to /usr/share/figlet." }, { "flag": "-o", "long": null, "arg": null, "description": "Select character composition rules. -S sets smushing (nicely merging glyphs), -k sets kerning (rendering subcharacters as close to each other as possible), -W renders char‐ acters at their full width and -o sets overlapping (glyphs slightly overlap the previ‐ ous one). -s (default behaviour) uses the font's smushing information if any, other‐ wise forces overlapping, or does nothing if the glyph only has one subcharacter." }, { "flag": "-w", "long": "--width", "arg": "", "description": "Set the output width. By default, TOIlet will wrap its output at 80 character columns." }, { "flag": "-t", "long": "--termwidth", "arg": null, "description": "Set the output width to the terminal width." }, { "flag": "-F", "long": "--filter", "arg": "", "description": "" }, { "flag": "-F", "long": "--filter", "arg": null, "description": "" }, { "flag": "", "long": "--metal", "arg": null, "description": "Specify a list of filters to be applied to the output. is a colon-separated list of filters such as crop:rotate:gay and the special argument list outputs a list of available filters. --gay and --metal are shortcuts to commonly used filters that are guaranteed to exist. Several -F flags can also be specified on the command line, in which case filters will be applied in order of appearance." }, { "flag": "-E", "long": "--export", "arg": "", "description": "" }, { "flag": "-E", "long": "--export", "arg": null, "description": "" }, { "flag": "", "long": "--html", "arg": null, "description": "Specify the output format. By default, TOIlet will output UTF-8 text using ANSI colour codes suitable for most terminals such as XTerm or rxvt. is the name of the export format as recognised by libcaca. The special argument list outputs a list of available export formats. --irc and --html are shortcuts to commonly used export formats that are guaranteed to exist." }, { "flag": "-h", "long": "--help", "arg": null, "description": "Display a short help message and exit." }, { "flag": "-I", "long": "--infocode", "arg": "", "description": "Print a FIGlet infocode. This flag is only here for FIGlet compatibility, see the figlet manpage for more information about it." }, { "flag": "-v", "long": "--version", "arg": null, "description": "Output version information and exit." } ], "examples": [ "toilet Hello World", "toilet Hello | toilet", "tail -f /var/log/messages | toilet -f term --gay" ], "see_also": [ { "name": "figlet", "section": "6", "url": "https://www.chedong.com/phpMan.php/man/figlet/6/json" } ], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 4, "subsections": [] }, { "name": "DESCRIPTION", "lines": 4, "subsections": [] }, { "name": "USAGE", "lines": 2, "subsections": [] }, { "name": "OPTIONS", "lines": 1, "subsections": [ { "name": "-f, --font ", "lines": 5, "flag": "-f", "long": "--font", "arg": "" }, { "name": "-d, --directory ", "lines": 3, "flag": "-d", "long": "--directory", "arg": "" }, { "name": "-s, -S, -k, -W, -o", "lines": 6, "flag": "-o" }, { "name": "-w, --width ", "lines": 2, "flag": "-w", "long": "--width", "arg": "" }, { "name": "-t, --termwidth", "lines": 2, "flag": "-t", "long": "--termwidth" }, { "name": "-F, --filter ", "lines": 1, "flag": "-F", "long": "--filter", "arg": "" }, { "name": "-F, --filter list", "lines": 1, "flag": "-F", "long": "--filter" }, { "name": "--gay, --metal", "lines": 8, "long": "--metal" }, { "name": "-E, --export ", "lines": 1, "flag": "-E", "long": "--export", "arg": "" }, { "name": "-E, --export list", "lines": 1, "flag": "-E", "long": "--export" }, { "name": "--irc, --html", "lines": 8, "long": "--html" }, { "name": "-h, --help", "lines": 2, "flag": "-h", "long": "--help" }, { "name": "-I, --infocode ", "lines": 3, "flag": "-I", "long": "--infocode", "arg": "" }, { "name": "-v, --version", "lines": 2, "flag": "-v", "long": "--version" } ] }, { "name": "EXAMPLES", "lines": 6, "subsections": [] }, { "name": "BUGS", "lines": 2, "subsections": [] }, { "name": "AUTHOR", "lines": 3, "subsections": [] }, { "name": "SEE ALSO", "lines": 5, "subsections": [] } ] } }