DOCSEARCHbyAlgolia
Submit Docs

FIGlet Documentation

repository·master·Indexed 23 days ago

https://github.com/cmatsuoka/figlet

A program that creates large, stylized characters from ordinary text for terminal art and email signatures. Includes installation guides for Unix and DOS, usage instructions for font specification, and a reference of command line options such as centering, kerning, and terminal width detection.

Tokens
651
Snippets
0
Records
4
Agent score
32%

What's inside FIGlet

  1. Use FIGlet to create large text

    master

    FIGlet converts ordinary text into large, stylized characters.

    Basic Usage

    Run the command figlet and type your text. Press Enter to see the output and Ctrl-D (EOF) to quit.

    To save the output to a file, use redirection:

    figlet > file

    Using Specific Fonts

    Use the -f flag to specify a font file (e.g., smslant).

    figlet -f smslant

  2. Install FIGlet on DOS

    master

    To install FIGlet on DOS:

    1. Unpack the ZIP file using a compatible program (e.g., PKUNZIP, Info-Zip UNZIP, or WinUnzip).
    2. If using PKUNZIP, use the -d option to preserve the directory structure.
    3. It is recommended to unpack the archive into C:\FIGLET.
    4. Important: If you are upgrading from an older version, delete the FIGLET.COM file, as the new executable is named FIGLET.EXE.
    5. You can preserve old fonts by placing them in a FONTS subdirectory before unpacking.

  3. Install FIGlet on Unix

    master

    To install FIGlet on a Unix-based system, you can either compile it manually or perform a complete installation using the provided Makefile.

    Prerequisites

    Before installing, edit the Makefile to set the following variables:

    • DEFAULTFONTDIR: The full pathname of the directory where FIGlet font files (.flf) will be stored (e.g., /usr/games/lib/figlet.dir).
    • DEFAULTFONTFILE: The filename of the default font (e.g., standard.flf).
    • BINDIR: The directory for executable files (e.g., /usr/games).
    • MANDIR: The directory for the man page (e.g., /usr/man/man6).

    Option 1: Manual Compilation

    Use this if you want to compile the binary and manually move files to their locations.

    1. Run make figlet in the source directory.
    2. Copy the figlet, figlist, and showfigfonts executables to your executable path.
    3. Copy the fonts (.flf) and control files (.flc) to your DEFAULTFONTDIR.
    4. Copy the man page (figlet.6) to your man page directory.

    Option 2: Complete Installation

    Use this to automate the placement of all files.

    1. Ensure BINDIR, MANDIR, DEFAULTFONTDIR, and DEFAULTFONTFILE are set in the Makefile.
    2. Run make install in the source directory.

  4. Reference FIGlet command line options

    master

    The following command line options are available for FIGlet:

    OptionLong NameDescription
    -c--centerCenters the output.
    -kKerns characters without smushing them together.
    -t--terminalAsks the terminal for its width to determine line breaks (defaults to 80 columns).
    -p--paragraphEliminates spurious line breaks when piping multi-line files.
    -v--versionPrints FIGlet version information.
    -fSpecifies a font file to use.