externals/figlet/README

   1 About FIGlet (Frank, Ian & Glenn's Letters) release 2.2.5, 31 May 2012
   2 --------------------------------------------------------------------------
   3 FIGlet is a program that creates large characters out of ordinary
   4 screen characters
   5  _ _ _          _   _     _
   6 | (_) | _____  | |_| |__ (_)___
   7 | | | |/ / _ \ | __| '_ \| / __|
   8 | | |   <  __/ | |_| | | | \__ \_
   9 |_|_|_|\_\___|  \__|_| |_|_|___(_)
  10
  11 (This is meant to be viewed in a monospaced font.)  FIGlet can create
  12 characters in many different styles and can kern and "smush" these
  13 characters together in various ways.  FIGlet output is generally
  14 reminiscent of the sort of "signatures" many people like to put at the
  15 end of e-mail and UseNet messages.
  16
  17 If you like FIGlet (hey, even if you *hate* FIGlet), please send an
  18 e-mail message to <info@figlet.org>
  19
  20 The official FIGlet web page: http://www.figlet.org/
  21
  22 Files -- Unix version
  23 ---------------------
  24
  25 README       -- This file.
  26 figlet.c     -- The FIGlet source code.
  27 zipio.h,     -- A package for reading ZIP archives
  28 zipio.c,
  29 inflate.c,
  30 crc.c
  31 utf8.h,      -- A package to convert strings between UTF-8 and UCS-4.
  32 utf8.c
  33 getopt.c     -- Source for the standard "getopt" routine, in case you
  34                 don't have it in your C library.  Not used by default.
  35 Makefile     -- The FIGlet makefile.  Used by the make command.
  36 figlet.6     -- The FIGlet man(ual) page.
  37 figlist      -- Script that lists available fonts and control files.
  38 showfigfonts -- Script that gives a sample of each available font.
  39 chkfont.c    -- Source code for chkfont: a program that checks FIGlet
  40                 fonts for formatting errors.  You can ignore this file
  41                 unless you intend to design or edit fonts.
  42 figfont.txt  -- Text file that explains the format of FIGlet fonts.
  43                 You can ignore this file unless you intend to design
  44                 or edit fonts.
  45 fonts        -- Directory containing fonts and control files.
  46 <xxx>.flf    -- All files ending in ".flf" are FIGlet font files.
  47 <xxx>.flc    -- All files ending in ".flc" are FIGlet control files.
  48
  49 Files -- DOS version
  50 --------------------
  51
  52 README       -- This file
  53 figlet.exe   -- The FIGlet program.
  54 figlet.man   -- The FIGlet man(ual) page.
  55 showall.bat  -- Batch file that lists available fonts and samples of each.
  56 chkfont.exe  -- A program that checks FIGlet fonts for formatting errors.
  57                 You can ignore this file unless you intend to design
  58                 or edit fonts.
  59 figfont.txt  -- Text file that explains the format of FIGlet fonts.
  60                 You can ignore this file unless you intend to design
  61                 or edit fonts.
  62 fonts        -- Directory containing fonts and control files.
  63 <xxx>.flf    -- All files ending in ".flf" are FIGlet font files.
  64 <xxx>.flc    -- All files ending in ".flc" are FIGlet control files.
  65
  66
  67 Installing FIGlet --- Unix version
  68 ----------------------------------
  69
  70 First decide in which directories FIGlet and the FIGlet font files
  71 (the ".flf" files) will be stored (we recommend "/usr/games" and
  72 "/usr/games/lib/figlet.dir", respectively) and which will be the
  73 default font (we recommend "standard.flf").
  74
  75 Edit "Makefile", and set the variables DEFAULTFONTDIR and
  76 DEFAULTFONTFILE to the appropriate values.  Set DEFAULTFONTDIR to be
  77 the full pathname of the directory in which you will keep the FIGlet
  78 font files.  Set DEFAULTFONTFILE to be the filename of the default
  79 font.
  80
  81 At this point, you have two choices:
  82
  83 (1) Just compile FIGlet.  To go this, go into the directory containing
  84 the FIGlet source, and type "make figlet".  Then copy the various files
  85 to the proper locations.  The executable (figlet), along with figlist
  86 and showfigfonts, goes wherever you keep your executables.  The fonts
  87 (<xxx>.flf) and control files (<xxx>.flc) go in the default font
  88 directory.  The man page (figlet.6) goes in section 6 (usually
  89 /usr/man/man6).  If you cannot, or do not want to, install the man page,
  90 you can probably still read it using
  91
  92         nroff -man figlet.6 | more
  93
  94 (2) Do a complete installation.  To do the this, set the variables
  95 BINDIR and MANDIR in Makefile to the appropriate values.  BINDIR
  96 should be the full pathname of the directory in which the executable
  97 files should be put (we recommend "/usr/games");  MANDIR should be the
  98 full pathname of the directory in which the figlet man page should be
  99 put, generally "/usr/man/man6".  Once DEFAULTFONTDIR, DEFAULTFONTFILE,
 100 BINDIR and MANDIR have been set, in the directory containing the FIGlet
 101 source, type "make install".
 102
 103 If space is a problem, the only files you absolutely must have to run
 104 figlet are "figlet" (the executable) and at least one font (preferably
 105 the one you chose to be the default font).
 106
 107 Installing FIGlet -- DOS version
 108 --------------------------------
 109
 110 Unpack the ZIPfile using PKUNZIP, Info-Zip UNZIP, WinUnzip, or any other
 111 ZIP-compatible program.  Be sure to use the -d option with PKUNZIP
 112 in order to preserve the directory structure.  We recommend that you
 113 unpack the archive into C:\FIGLET, but any directory will do.
 114
 115 If you unpack the archive on top of an older version of FIGlet, be
 116 sure to delete the file FIGLET.COM.  The executable program in this
 117 release is named FIGLET.EXE.  You can keep your old fonts by putting
 118 them in a FONTS subdirectory before unpacking.  (There are upgraded
 119 versions of the standard fonts in the archive.)
 120
 121 Using FIGlet
 122 ------------
 123
 124 (Note: FIGlet needs a good thorough tutorial.  Currently I don't have
 125 the time to write one, but if anyone wants to do so, go right ahead.
 126 I'd be glad to help out a little.  Write us at <ianchai@usa.net> if
 127 you're interested.  -GGC-)
 128
 129 At the shell prompt, type "figlet".  Then type, say, "Hello, world!"
 130 and press return.  "Hello, world!" in nice, big, designer characters
 131 should appear on your screen.  If you chose standard.flf to be the
 132 default font, you should see
 133  _   _      _ _                             _     _ _
 134 | | | | ___| | | ___    __      _____  _ __| | __| | |
 135 | |_| |/ _ \ | |/ _ \   \ \ /\ / / _ \| '__| |/ _` | |
 136 |  _  |  __/ | | (_) |   \ V  V / (_) | |  | | (_| |_|
 137 |_| |_|\___|_|_|\___( )   \_/\_/ \___/|_|  |_|\__,_(_)
 138                     |/
 139 Then type something else, or type an EOF (typically control-D) to quit
 140 FIGlet.
 141
 142 Now you can send the output of figlet to a file (e.g., "figlet > file")
 143 and e-mail it to your friends (who will probably say, "Wow!  It must
 144 have taken you hours to put that together!")
 145
 146 To use other fonts, use the "-f" command line option.  For example, if
 147 you had said "figlet -f smslant" above, you would have seen
 148    __ __    ____                         __   ____
 149   / // /__ / / /__      _    _____  ____/ /__/ / /
 150  / _  / -_) / / _ \_   | |/|/ / _ \/ __/ / _  /_/
 151 /_//_/\__/_/_/\___( )  |__,__/\___/_/ /_/\_,_(_)
 152                   |/
 153
 154 Here are some other useful command line options:
 155
 156 -c   center -- centers the output of FIGlet.
 157 -k   tells FIGlet to kern characters without smushing them together.
 158 -t   terminal -- FIGlet asks your terminal how wide it is, and uses
 159      this to determine when to break lines.  Normally, FIGlet assumes
 160      80 columns so that people with wide terminals won't annoy the
 161      people they e-mail FIGlet output to.
 162 -p   paragraph mode -- eliminates some spurious line breaks when piping
 163      a multi-line file through FIGlet.
 164 -v   version -- prints information about your copy of FIGlet.
 165
 166 For in-depth explanations of these and other options, see the man page.
 167 DOS users, see figlet.man.
 168
 169
 170 Other Fonts & Mailing List
 171 --------------------------
 172
 173 A good number of FIGlet fonts have been developed, most of which are
 174 not included in the standard FIGlet package.  Many of these can be
 175 obtained from http://www.figlet.org/   Some non-Roman fonts are
 176 available at this site.  As of this writing, we have Hebrew, Cyrillic
 177 (Russian) and Greek.
 178
 179 There are 3 mailing lists available for FIGlet:
 180          figlet@figlet.org           General discussion of FIGlet
 181          figletfonts@figlet.org      Announcements about fonts
 182          figletsoftware@figlet.org   Announcements about software
 183          (The last two lists are moderated)
 184
 185 To subscribe or unsubscribe from the FIGlet mailing lists, please visit
 186 the corresponding URL:
 187          http://www.figlet.org/mailman/listinfo/figlet
 188          http://www.figlet.org/mailman/listinfo/figletfonts
 189          http://www.figlet.org/mailman/listinfo/figletsoftware
 190
 191 Also, for those who maintain archives of figlet fonts, please note that
 192 all of the standard fonts have been changed, as of release 2.1, to
 193 include non-ASCII characters.  These fonts are the following:
 194
 195 big.flf (also contains Greek)
 196 banner.flf (also contains Cyrillic and Japanese katakana)
 197 block.flf
 198 bubble.flf
 199 digital.flf
 200 ivrit.flf (right-to-left, also contains Hebrew)
 201 lean.flf
 202 mini.flf
 203 script.flf
 204 shadow.flf
 205 slant.flf
 206 small.flf
 207 smscript.flf
 208 smshadow.flf
 209 smslant.dld
 210 standard.flf
 211 term.flf
 212
 213 The new versions of these fonts can be identified by the words "figlet
 214 release 2.1" somewhere in the first few lines.
 215
 216
 217 Other Stuff
 218 -----------
 219
 220 FIGlet is available for operating systems other than Unix.
 221 Please see ftp://ftp.figlet.org/program/
 222
 223 Although you don't have to design your own fonts to use FIGlet, we'd
 224 certainly like it if lots of people did make up new FIGlet fonts.  If
 225 you feel like giving it a try, see the "FONT FILE FORMAT" section of
 226 the man page.  If you do design a font, please let us know by mailing us
 227 at <info@figlet.org>
 228
 229 See "Other Things to Try" in the EXAMPLES section of the man page
 230 for... well... other things to try.
 231
 232
 233 Authors
 234 -------
 235
 236 FIGlet was written mostly by Glenn Chappell <c486scm@semovm.semo.edu>.  The
 237 author not being an e-mail fanatic, most correspondence (bug reports, rave
 238 reviews, etc.) used to be handled to his secretary (who is definitely
 239 an e-mail fanatic), Ian Chai <ianchai@usa.net> and has since moved on to
 240 another FIGlet enthusiast, Christiaan Keet <info@figlet.org>. Current
 241 maintenance is conducted by Claudio Matsuoka <cmatsuoka@gmail.com>.
 242