home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 11 Util / 11-Util.zip / figlet21.zip / README.21 < prev    next >
Text File  |  1995-09-12  |  10KB  |  234 lines
  1. ----------------------------------------------------------------------
  2.  
  3. Note: figlet 2.1.1 is a minor revision of figlet 2.1.  The files
  4. FTP-NOTE, README, chkfont.c, figlet.c, figlist and showfigfonts have
  5. been changed.  All other files are identical with the 2.1 release.
  6.  
  7. For those making figlet 2.1.1 available by anonymous FTP: please put
  8. the version number (2.1.1) in the filename, so that FTP'ers can know
  9. they're not getting the same program they already have.
  10.  
  11. ----------------------------------------------------------------------
  12.  
  13. figlet is a program that creates large characters out of ordinary
  14. screen characters
  15.  _ _ _          _   _     _       
  16. | (_) | _____  | |_| |__ (_)___   
  17. | | | |/ / _ \ | __| '_ \| / __|  
  18. | | |   <  __/ | |_| | | | \__ \_ 
  19. |_|_|_|\_\___|  \__|_| |_|_|___(_)
  20.                                   
  21. (This is meant to be viewed in a monospaced font.)  figlet can create
  22. characters in many different styles and can kern and "smush" these
  23. characters together in various ways.  figlet output is generally
  24. reminiscent of the sort of "signatures" many people like to put at the
  25. end of e-mail and UseNet messages.
  26.  
  27. If you like figlet (hey, even if you _hate_ figlet), please send an
  28. e-mail message to <figlet@uiuc.edu>.
  29.  
  30.  
  31. What's New in figlet 2.1
  32. ------------------------
  33.  
  34. (If you are new to figlet, you may want to skip this section.)
  35.  
  36. - Bug Fixes
  37. A number of minor bugs and major incompatibility problems have been
  38. fixed.  figlet 2.1 should compile correctly on many operating systems for
  39. which figlet 2.0 did not.
  40.  
  41. - "-F" removed
  42. The "-F" command line option, which used to list all the available
  43. fonts, has been removed, since it made figlet incompatible with some
  44. operating systems.  It has been replaced by the "figlist" script.  The
  45. "showfigfonts" script has been updated so that it no longer requires
  46. the "-F" option to be available.
  47.  
  48. - Extended character set
  49. The figlet font file format has been extended to allow an arbitrarily
  50. large number of characters.  The ISO Latin-1 character set, which
  51. includes many accented letters and special symbols, has been added to
  52. most standard fonts.
  53.  
  54. - Right-to-left printing
  55. figlet can now print right-to-left.  This can be specified on the
  56. command line ("-R") or in the font file.  Thus, for example, Hebrew and
  57. Arabic fonts can be handled more easily.
  58.  
  59. - Right-justified text
  60. figlet can now right justify its output.  This is the default when
  61. right-to-left printing is selected.  It can also be specified on the
  62. command line ("-r").
  63.  
  64. - Control files
  65. figlet now supports "control files".  These can be used to change which
  66. character figlet will print when it sees a certain input character --
  67. sort of an expanded version of the "-D" option.  For example, a control
  68. file could convert lower-case letters to upper-case or map certain
  69. ASCII characters to accented letters.  Control file names end with the
  70. suffix ".flc".  Select a control file by using "-C controlfile" on the
  71. command line.  Several controlfiles can be used at once by giving
  72. muliple "-C" options.
  73.  
  74. - Utility Interface
  75. There is now a way for programs that use figlet to get various
  76. information from figlet, for example, what version of figlet is being
  77. used or the name of the default font directory.  This information is
  78. gotten through the "-I" option.  See the man page for details.
  79.  
  80.  
  81. Other Fonts, Mailing List & Web Page
  82. ------------------------------------
  83.  
  84. A good number of figlet fonts have been developed, most of which are
  85. not included in the standard figlet package.  Many of these can be
  86. obtained by anonymous FTP from ftp.nicoh.com in the directory
  87. "pub/figlet/fonts".  Some non-Roman fonts are available at the FTP
  88. site.  As of this writing, we have Hebrew, Cyrillic (Russian) and
  89. Greek.
  90.  
  91. We run an e-mail list dedicated to figlet software and font
  92. announcements, as well as general discussion about figlet.  If you
  93. would like to be on this list, send e-mail to listserv@vmd.cso.uiuc.edu
  94. with the message body
  95.         subscribe figlet-l YOUR NAME
  96. where YOUR NAME should be replaced with your name.  For those who don't
  97. want to be bothered with the discussions, the list can be configured so
  98. that you only see software update notices, or only software and font
  99. announcements.
  100.  
  101. We also maintain a "Figlet Home Page" on the Worldwide Web. The URL is
  102. http://www.math.uiuc.edu/~chappell/figlet
  103.  
  104.  
  105. Files
  106. -----
  107.  
  108. README       -- This file.
  109. figlet.c     -- The figlet source code.
  110. Makefile     -- The figlet makefile.  Used by the make command.
  111. figlet.6     -- The figlet man(ual) page.
  112. figlist      -- Script that lists available fonts and control files.
  113. showfigfonts -- Script that gives a sample of each available font.
  114. chkfont.c    -- Source code for chkfont: a program that checks figlet
  115.                 fonts for formatting errors.  You can ignore this file
  116.                 unless you intend to design or edit fonts.
  117. fonts        -- Directory containing fonts and control files.
  118. <xxx>.flf    -- All files ending in ".flf" are figlet font files.
  119. <xxx>.flc    -- All files ending in ".flc" are figlet control files.
  120.  
  121.  
  122. Installing figlet
  123. -----------------
  124.  
  125. First decide in which directories figlet and the figlet font files
  126. (the ".flf" files) will be stored (we recommend "/usr/games" and
  127. "/usr/games/lib/figlet.dir", respectively) and which will be the
  128. default font (we recommend "standard.flf").
  129.  
  130. Edit "Makefile", and set the variables DEFAULTFONTDIR and
  131. DEFAULTFONTFILE to the appropriate values.  Set DEFAULTFONTDIR to be
  132. the full pathname of the directory in which you will keep the figlet
  133. font files.  Set DEFAULTFONTFILE to be the filename of the default
  134. font.
  135.  
  136. At this point, you have 2 choices:
  137.  
  138. (1) Just compile figlet.  To go this, go into the directory containing
  139. the figlet source, and type "make figlet".  Then copy the various files
  140. to the proper locations.  The executable (figlet), along with figlist
  141. and showfigfonts, goes wherever you keep your executables.  The fonts
  142. (<xxx>.flf) and control files (<xxx>.flc) go in the default font
  143. directory.  The man page (figlet.6) goes in section 6 (usually
  144. /usr/man/man6).  If you cannot, or do not want to, install the man page,
  145. you can probably still read it using
  146.         nroff -man figlet.6 | more
  147.  
  148. (2) Do a complete installation.  To do the this, set the variables
  149. DESTDIR and MANDIR in Makefile to the appropriate values.  DESTDIR
  150. should be the full pathname of the directory in which the executable
  151. files should be put (we recommend "/usr/games");  MANDIR should be the
  152. full pathname of the directory in which the figlet man page should be
  153. put, generally "/usr/man/man6".  Once DEFAULTFONTDIR, DEFAULTFONTFILE,
  154. DESTDIR and MANDIR have been set, in the directory containing the figlet
  155. source, type "make install".
  156.  
  157. If space is a problem, the only files you absolutely must have to run
  158. figlet are "figlet" (the executable) and at least one font (preferably
  159. the one you chose to be the default font).
  160.  
  161.  
  162. Using figlet
  163. ------------
  164.  
  165. (Note: figlet needs a good thorough tutorial.  Currently I don't have
  166. the time to write one, but if anyone wants to do so, go right ahead.
  167. I'd be glad to help out a little.  Write us at <figlet@uiuc.edu> if
  168. you're interested.  -GGC-)
  169.  
  170. At the shell prompt, type "figlet".  Then type, say, "Hello, world!"
  171. and press return.  "Hello, world!" in nice, big, designer characters
  172. should appear on your screen.  If you chose standard.flf to be the
  173. default font, you should see
  174.  _   _      _ _                             _     _ _ 
  175. | | | | ___| | | ___    __      _____  _ __| | __| | |
  176. | |_| |/ _ \ | |/ _ \   \ \ /\ / / _ \| '__| |/ _` | |
  177. |  _  |  __/ | | (_) |   \ V  V / (_) | |  | | (_| |_|
  178. |_| |_|\___|_|_|\___( )   \_/\_/ \___/|_|  |_|\__,_(_)
  179.                     |/                                
  180. Then type something else, or type an EOF (typically control-D) to quit
  181. figlet.
  182.  
  183. Now you can send the output of figlet to a file (e.g., "figlet > file")
  184. and e-mail it to your friends (who will probably say, "Wow!  It must
  185. have taken you hours to put that together!")
  186.  
  187. To use other fonts, use the "-f" command line option.  For example, if
  188. you had said "figlet -f smslant" above, you would have seen
  189.    __ __    ____                         __   ____
  190.   / // /__ / / /__      _    _____  ____/ /__/ / /
  191.  / _  / -_) / / _ \_   | |/|/ / _ \/ __/ / _  /_/ 
  192. /_//_/\__/_/_/\___( )  |__,__/\___/_/ /_/\_,_(_)  
  193.                   |/                              
  194.  
  195. Here are some other useful command line options:
  196.  
  197. -c   center -- centers the output of figlet.
  198. -m0  (that's a zero) tells figlet to kern characters without smushing
  199.      them together.
  200. -t   terminal -- figlet asks your terminal how wide it is, and uses
  201.      this to determine when to break lines.  Normally, figlet assumes
  202.      80 columns so that people with wide terminals won't annoy the
  203.      people they e-mail figlet output to.
  204. -p   paragraph mode -- eliminates some spurious line breaks when piping
  205.      a multi-line file through figlet.
  206. -v   version -- prints information about your copy of figlet.
  207.  
  208. For in-depth explanations of these and other options, see the man page.
  209.  
  210.  
  211. Other Stuff
  212. -----------
  213.  
  214. figlet is available for operating systems other than Unix.  E-mail us
  215. for more information.
  216.  
  217. Although you don't have to design your own fonts to use figlet, we'd
  218. certainly like it if lots of people did make up new figlet fonts.  If
  219. you feel like giving it a try, see the "FONT FILE FORMAT" section of
  220. the man page.  If you do design a font, please let us know!
  221.  
  222. See "Other Things to Try" in the EXAMPLES section of the man page
  223. for... well... other things to try.
  224.  
  225.  
  226. Authors
  227. -------
  228.  
  229. figlet was written mostly by Glenn Chappell <ggc@uiuc.edu>.  The author
  230. not being an e-mail fanatic, most correspondence (bug reports, rave
  231. reviews, etc.) should be directed to his secretary (who is definitely
  232. an e-mail fanatic), Ian Chai <spectre@uiuc.edu>.
  233.  
  234.