home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / alib / d8xx / d855 / banner.lha / Banner / banner.doc < prev    next >
Text File  |  1993-02-02  |  7KB  |  168 lines
  1.  
  2.  NAME
  3.       banner - render a banner from a string
  4.  
  5.  
  6.  VERSION
  7.       $VER: banner.c,v 1.4 93/01/30 00:59:37 tf Exp
  8.  
  9.  
  10.  SYNPOSIS
  11.       banner [options] string
  12.  
  13.  
  14.  DESCRIPTION
  15.       BANNER is a smart character rendering utility for - surprise -
  16.       banners.  It can only be used from within the command line of a
  17.       CLI or a SHELL. By default BANNER will print your string into the
  18.       SHELL using an internal font which contains the ASCII characters
  19.       from 32 (space) to 126 (overscore).  If you don't like them you
  20.       can also tell BANNER to render the characters out of any other font
  21.       that is accessable via the diskfont.library.
  22.  
  23.       Legal BANNER options are:
  24.  
  25.        STRING        This option forces the next argument to be a string
  26.                      which BANNER should print.  You'll only need to force
  27.                      this if your string is equal to one of BANNER's option
  28.                      keywords.
  29.  
  30.        RENDER        If you don't want BANNER to use it's internal font you
  31.                      should add this keyword to your command line.  BANNER
  32.                      will then render each character of the input string
  33.                      using the amiga standard font: topaz.font size 8.
  34.                      By default BANNER will print the currently rendered
  35.                      character for each set pixel in it's bitmap, i.e. an 'A'
  36.                      will be BANNER'ed using 'A' characters, a 'B' using B's
  37.                      etc.  See SET/UNSET to change this.
  38.  
  39.        NORENDER      This option forces BANNER to use the internal font
  40.                      table.  This is the default.
  41.  
  42.        FONT          The FONT or '-f' option allows you to specify the name
  43.                      of the font which banner should use for rendering.
  44.                      The default font name is "topaz.font" a trailing
  45.                      ".font" is optional. To specify the font style see
  46.                      UNDERLINED,ITALIC and BOLD further down; the
  47.  
  48.        SIZE          or '-s' option allows you to specify the font size.
  49.                      The argument should be numerical, the maximum size is
  50.                      4294967295. (This is the maximum for BANNER, your
  51.                      chip memory may offer less... ;)
  52.                      The default size is 8.
  53.  
  54.        NORMAL        This switch sets the font style to normal.  This is
  55.                      set by default.  Specifying NORMAL forces banner to
  56.                      ignore all previously made font style settings, i.e.
  57.                      one or more of the following three:
  58.  
  59.        UNDERLINED    These keywords tell banner which falgs to set when
  60.        BOLD          opening your font.  BANNER's behaviour in case of
  61.        ITALIC        a non-existant font style depends on the version of
  62.                      your operating system and the specified font.
  63.  
  64.        SET           If you don't like BANNER to render each character in your
  65.                      string with different characters you can set one common
  66.                      character for all SET raster dots in the font's bitmap.
  67.  
  68.                      Note: You should always define a common SET character if
  69.                            you want BANNER to render from italic fonts!  This
  70.                            is because BANNER often has problems finding the
  71.                            borders of overlapping characters.
  72.  
  73.        UNSET         This option allows you to specify the character printed
  74.                      for UNSET raster dots in your font's bitmap.
  75.  
  76.        ASPECT        If your banner gets wider than your printer's tractor
  77.                      you can rotate the output by typing ASPECT Y.
  78.                      The default is ASPECT X.
  79.  
  80.        SMART         tells BANNER to render the SET character by evaluating the
  81.                      3x3 context of each set pixel.
  82.  
  83.  EXAMPLES
  84.       Print the string 'banner' using the internal font
  85.  
  86.        1> banner banner
  87.  
  88.       will result in the following output
  89.  
  90.                     __
  91.                    / /
  92.                   / /___ ______ ______ ______ ______ _____
  93.                  / __  // __  // __  // __  // ____// .__/
  94.                 / /_/ // __  // / / // / / // __/_ / /
  95.                /_____//_/ /_//_/ /_//_/ /_//_____//_/
  96.  
  97.  
  98.       Rendering 'banner' from topaz.font 8
  99.  
  100.        1> banner render banner
  101.  
  102.  
  103.                 bbb
  104.                 bb
  105.                 bb bb    aaaa   nnnnn   nnnnn    eeee  rrr rr
  106.                 bbb bb      aa  nn  nn  nn  nn  ee  ee  rrr rr
  107.                 bb  bb    aaaa  nn  nn  nn  nn  eeeeee  rr  rr
  108.                 bb  bb  aa  aa  nn  nn  nn  nn  ee      rr
  109.                  bbbb    aaa aa nn  nn  nn  nn   eeee  rrrr
  110.  
  111.  
  112.       Rendering from the new topaz.font (Kick 2.0+) using an asterisk '*' for
  113.       set pixels and a period '.' for unset pixels
  114.  
  115.        1> banner render font topaz.font size 8 set * unset . string banner
  116.  
  117.                .**.............................................
  118.                .**.............................................
  119.                .*****....****...*****...*****....****...*****..
  120.                .**..**......**..**..**..**..**..**..**..**..**.
  121.                .**..**...*****..**..**..**..**..******..**.....
  122.                .**..**..**..**..**..**..**..**..**......**.....
  123.                .*****....*****..**..**..**..**...****...**.....
  124.                ................................................
  125.  
  126.       You may also pipe or redirect a file into banner.
  127.       Note that you *MUST* specify RENDER or NORENDER in this case:
  128.  
  129.        1> banner render < foo:foobar
  130.  
  131.       renders the contents of the file "foo:foobar" to your CLI/SHELL.
  132.  
  133.        1> dir | banner norender >prt:
  134.  
  135.       prints the contents of your current directory using BANNER's
  136.       internal font.
  137.  
  138.       That's it, have fun
  139.  
  140.                                         -Tobi
  141.  
  142.  AUTHOR
  143.       This Shareware was written by Tobias Ferber, Baden-Baden, Germany.
  144.       If you want to contact me, please write to:
  145.  
  146.       Tobias Ferber
  147.       Bismarckstraße 22
  148.       D-7570 Baden-Baden
  149.       Germany
  150.  
  151.       EMail:       Earn: ukjg@dkauni2.bitnet
  152.                   X.400: ukjg@ibm3090.rz.uni-karlsruhe.dbp.de
  153.                InterNet: ukjg@ibm3090.rz.uni-karlsruhe.de
  154.  
  155.  
  156.  THANKS
  157.       BANNER was written in C using DICE by Matthew Dillon.
  158.  
  159.       DICE is copyright (c)1990 by Matthew Dillon
  160.                                    891 Regal Rd.
  161.                                    Berkeley, Ca. 94708
  162.                                    USA
  163.  
  164.                                    dillon@overload.Berkeley.CA.US
  165.                                    uunet.uu.net!overload!dillon
  166.  
  167.                                    BIX: mdillon
  168.