home *** CD-ROM | disk | FTP | other *** search
/ Lion Share / lionsharecd.iso / bbs_oth / fan_110.zip / FAN.DOC < prev    next >
Text File  |  1992-05-29  |  6KB  |  146 lines
  1.      
  2.      
  3.      
  4.      
  5.      
  6.      
  7.      
  8.                                     FAN
  9.      
  10.                          File Announcement Utility
  11.                                         
  12.                              Version 1.10 beta
  13.                                         
  14.                                         
  15.                                         
  16.                                         
  17.                                         
  18.                                         
  19.                                         
  20.                                         
  21.                                         
  22.                                         
  23.                                         
  24.                                         
  25.                                         
  26.                                 Dave Fisher
  27.                                         
  28.                         LiveNet, 1:170/110@fidonet
  29.      
  30.      
  31.      Description
  32.      
  33.      FAN is a utility that will create fidonet mail packet files
  34.      (*.PKT) to announce the arrival of files via a file distribution
  35.      system that uses Barry Geller's TIC file format or the standard
  36.      FILES.BBS file format.  Many of the ideas for this program have
  37.      come from Doug Belkofer's program RFD (Received For
  38.      Distribution), which worked soley on TIC files.
  39.      
  40.      I created FAN since there were some things that RFD did not do
  41.      (such as support long file descriptions, FAN allows up to 1024
  42.      characters for a description) and was a DOS only program (and I
  43.      wanted to run it specifically under OS/2).
  44.      
  45.      FAN is a bound utility, which means that it will run under DOS or
  46.      OS/2.
  47.      
  48.      Currently, FAN does everything I need it to do.  If you find that
  49.      you need it to do something different, I would be interested in
  50.      hearing your suggestions, which could very well become part of a
  51.      future release.
  52.      
  53.      Please note that this is a BETA release.  I wrote this program
  54.      over the weekend, and have not sufficiently tested it yet.  If
  55.      you decide to use FAN, and run across any bugs, please let me
  56.      know and I will promptly fix the program and make a new version
  57.      available to you.
  58.      
  59.      Note!  In addition to this brief document, there are also
  60.      important notes in the configuration file that comes distributed
  61.      with FAN.
  62.      
  63.      The most recent version of FAN can be file-requested from me with
  64.      the magic name of "FAN" (quotes not included) at 1:170/110.
  65.      
  66.      Usage
  67.      
  68.      Fan
  69.          /Config = <path+file name>          default: Fan.cfg
  70.          /[no]Log                            default: NoLog
  71.          /LogFile = <path+file name>         default: None
  72.          /LogLevel = <1..4>                  default: 4
  73.          /[no]Quiet                          default: NoQuiet
  74.          /TossLogFile = <path+file name>     default: None
  75.      
  76.      Notes on the syntax:
  77.      
  78.           Qualifiers can appear in any order, in any case, and are
  79.           only significant to four characters.  Thus, /TossLogFile is
  80.           the same as /toss.
  81.           
  82.      
  83.      Disclaimer!
  84.      
  85.      This program is shareware.  There is absolutely no warranty for
  86.      this program or guarantee that it will work.  The user of the
  87.      program assumes all risk.  While I feel confident that this
  88.      program will not harm your system in any way, by using this
  89.      program, you agree to assume full responsibility for any adverse
  90.      effect to your system.
  91.      
  92.      Ok.  Now with that out of the way -- please send me mail and let
  93.      me know if you are using FAN!  I'd like to get an idea of whether
  94.      this program has been useful for others, as it has been for me.
  95.      Also, please send any comments, suggestions and/or problem
  96.      reports.  I can be reached at:
  97.      
  98.           Dave Fisher
  99.           LiveNet, 1:170/110@fidonet.org
  100.           
  101.           
  102.      Qualifiers
  103.      
  104.      Config = <path+file name>
  105.      ---------------------------------------------------------
  106.      
  107.      This is the name of the configuration file.  The default is
  108.      Fan.Cfg in the current directory.  You can also define the
  109.      environment variable FAN_CONFIG=<path+file name> instead of using
  110.      this qualifier.
  111.      
  112.      /[no]Log
  113.      ---------------------------------------------------------
  114.      
  115.      This qualifier will turn the logging function on and off.
  116.      
  117.      /LogFile = <path+file name>
  118.      ---------------------------------------------------------
  119.      
  120.      This qualifier defines the name of the log file.
  121.      
  122.      /LogLevel = <1..4>
  123.      ---------------------------------------------------------
  124.      
  125.      This qualifier defines the level of message detail in the log
  126.      file.  Level 1 is the least detailed, while Level 4 is the most
  127.      verbose.  The levels indicate the 'importance' of a message,
  128.      where Level 1 is the most important (usually error messages).
  129.      
  130.      /[no]Quiet
  131.      ---------------------------------------------------------
  132.      
  133.      This qualifier controls whether the program should emit an
  134.      printed output.  If /Quiet, the only output will be the program
  135.      copyright line and any error messages.  The default is /NoQuiet.
  136.      
  137.      /TossLogFile
  138.      ---------------------------------------------------------
  139.      
  140.      This qualifier specifies the name of a file to receive the names
  141.      of message areas for which mail packets were created.  The name
  142.      of the message area will be written to this file, one to a line.
  143.      This file can then be used with a tosser/scanner (such as Squish
  144.      or oMMM) to only scan the areas listed.
  145.      
  146.