home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / BGFXFD10.ZIP / BGFAX2FD.DOC < prev    next >
Encoding:
Text File  |  1994-09-15  |  11.2 KB  |  473 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.                            BGFAX2FD v1.00 Table of Contents
  9.  
  10.           What Is BGFAX2FD  . . . . . . . . . . . . . . . . . . . . . . . 2
  11.  
  12.           Features at a Glance  . . . . . . . . . . . . . . . . . . . . . 2
  13.  
  14.           Disclaimer  . . . . . . . . . . . . . . . . . . . . . . . . . . 2
  15.  
  16.           Command-Line Parameters . . . . . . . . . . . . . . . . . . . . 3
  17.  
  18.           Config File . . . . . . . . . . . . . . . . . . . . . . . . . . 4
  19.  
  20.           Cover Page Template Macros  . . . . . . . . . . . . . . . . . . 5
  21.                Macro Functions  . . . . . . . . . . . . . . . . . . . . . 6
  22.  
  23.           Registration  . . . . . . . . . . . . . . . . . . . . . . . . . 7
  24.  
  25.           Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
  26.  
  27.           Credits . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.                         [ BGFAX2FD v1.00 User Manual Page 1 ]
  61.  
  62.  
  63.  
  64.  
  65.  
  66.           What Is BGFAX2FD
  67.           ~~~~~~~~~~~~~~~~
  68.  
  69.                BGFAX2FD will make FrontDoor cover pages from faxes received
  70.           from BGFAX.
  71.  
  72.  
  73.           Features at a Glance
  74.           ~~~~~~~~~~~~~~~~~~~~
  75.  
  76.                *    Logfile Support
  77.  
  78.                *    Multi-Node Aware
  79.  
  80.                *    Templates Supported
  81.  
  82.                *    Works With FD 2.12/2.20/2.30
  83.  
  84.           Disclaimer
  85.           ~~~~~~~~~~
  86.  
  87.                "BGFAX2FD" refers to all executables, and its documentation.
  88.  
  89.                     Although a great deal of care has been put into
  90.                     BGFAX2FD to make it as bug-free as possible, it is very
  91.                     possible that a few bugs have escaped the debugging
  92.                     process.  Because of this, BGFAX2FD is provided "as
  93.                     is."  It has no warranty either written or implied, and
  94.                     is guaranteed to do absolutely nothing.  Although in
  95.                     most cases it will occupy an undetermined amount of
  96.                     drive space.
  97.  
  98.                     In no event shall the author of BGFAX2FD, namely Keith
  99.                     Mitchell, be liable for any damage caused directly or
  100.                     indirectly from the use of BGFAX2FD.  The above
  101.                     mentioned author is also not obligated to support or
  102.                     maintain this or any other version of BGFAX2FD.
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.                         [ BGFAX2FD v1.00 User Manual Page 2 ]
  120.  
  121.  
  122.  
  123.  
  124.  
  125.           System Requirements
  126.           ~~~~~~~~~~~~~~~~~~~
  127.  
  128.                     BGFAX2FD has been tested on a 486/33mhz running under
  129.                Desqview 2.62, but should work on any system with at least
  130.                the following:
  131.  
  132.                     *    FrontDoor (2.12/2.20/2.30)
  133.  
  134.                     *    Fax Modem
  135.  
  136.                     *    BGFAX
  137.  
  138.                     *    Dos 3.0 or Greater
  139.  
  140.                     *    Approximately 150k of free memory
  141.  
  142.  
  143.           Command-Line Parameters
  144.           ~~~~~~~~~~~~~~~~~~~~~~~
  145.  
  146.                     A description of the the command-line parameters are:
  147.  
  148.                     /C   -    Specifies the name of the config file
  149.                               (DEFAULT: BGFAX2FD.CFG)
  150.  
  151.                     /L   -    Specifies the name of the log file to use. 
  152.                               The default is to use the one defined in the
  153.                               config file.
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.                         [ BGFAX2FD v1.00 User Manual Page 3 ]
  179.  
  180.  
  181.  
  182.  
  183.  
  184.           Config File
  185.           ~~~~~~~~~~~
  186.  
  187.                The config file for BGFAX2FD is driven by a number of
  188.           keywords.  The keywords may start on any position as long as no
  189.           character other than the space character precedes it.  The Config
  190.           file keywords are as follows:
  191.  
  192.                SYSOP_NAME          -    The name of the System Operator (in
  193.                                         most cases this is the person
  194.                                         reading this file).
  195.  
  196.                BBSNAME <bbsname>   -    The name of the BBS.
  197.  
  198.                REGISTRATION_NUMBER -    Your registration number (if any).
  199.  
  200.                COVERPAGE_TEMPLATE  -    {+} The name of the temaplet to use
  201.                                         when writing the FAX cover page. 
  202.                                         See the section entitled "Cover
  203.                                         Page Template Macros" for a list of
  204.                                         the available macros.
  205.  
  206.                ADDRESS             -    The fidonet (style) address to use
  207.                                         as the from/to in the FAX Cover
  208.                                         Message and in FrontDoors
  209.                                         Lastcall/Inbound History Files.
  210.  
  211.                FAXIN_LOG           -    Full Path and Filename to BGFAX's
  212.                                         FAXIN.LOG.
  213.  
  214.                FAX_INBOUND         -    Path where BGFAX stores the
  215.                                         Incoming FAX files.
  216.  
  217.                NETMAIL_PATH        -    Path where outgoing Netmail (FAX
  218.                                         Cover Messages) will be written.
  219.  
  220.                FD_PATH             -    Path to FrontDoor's system files.
  221.  
  222.                LOG_FILE            -    Name of the logfile to use.  If
  223.                                         Omitted, then KAMSnoop will not use
  224.                                         a logfile
  225.  
  226.                LOG_TYPE            -    Type of logfile to keep.  Available
  227.                                         types are: FD (FrontDoor), BINK
  228.                                         (Binkley), QUICK (QuickBBS), and
  229.                                         DBRIDGE
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.                         [ BGFAX2FD v1.00 User Manual Page 4 ]
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.                USE_ML_HISTORY      -    Tells BGFAX that you have a
  245.                                         MultiLine version of FrontDoor
  246.                                         (2.20/2.30) and would like to use
  247.                                         seperate Lastcall/Inbound history
  248.                                         files for each node.  The actual
  249.                                         file that gets written to is
  250.                                         determined by the TASK environment
  251.                                         variable.  For instance, if this
  252.                                         option was turned on and TASK was
  253.                                         set to 2, then BGFAX2FD would write
  254.                                         to INB2.HIS and LASTC2.FD.
  255.  
  256.  
  257.           Cover Page Template Macros
  258.           ~~~~~~~~~~~~~~~~~~~~~~~~~~
  259.  
  260.                The FAX cover Message can be customized to fit your needs. 
  261.           To make this possible, a number of macros are available to you.
  262.  
  263.                @faxdensity@        -    The density of the FAX.  This will
  264.                                         either be Lo-1D, Hi-1D, Lo-2D, or
  265.                                         Hi-2D.
  266.  
  267.                @bbsname            -    The name of the BBS (as defined in
  268.                                         the config file).
  269.  
  270.                @sysopname@         -    The name of the System Operator (as
  271.                                         defined in the config file).
  272.  
  273.                @filename@          -    The name of the FAX file (Filename
  274.                                         ONLY).
  275.  
  276.                @faxdate@           -    Date the FAX was received.  This is
  277.                                         a five (5) character date (ie
  278.                                         05/25).
  279.  
  280.                @faxtime@           -    Time the FAX was received.  This is
  281.                                         a five (5) character time (ie
  282.                                         05:25).   
  283.  
  284.                @transfertime@      -    Estimated time the FAX took to
  285.                                         receive.
  286.  
  287.                @remoteid@          -    The remote's FAX ID string.  In
  288.                                         most cases, this will identify the
  289.                                         person sending you that FAX.
  290.  
  291.                @faxstatus@         -    Status of the FAX.  This will
  292.                                         always be finished, since BGFAX2FD
  293.                                         only processes finished FAXes at
  294.                                         this time.
  295.  
  296.                         [ BGFAX2FD v1.00 User Manual Page 5 ]
  297.  
  298.  
  299.  
  300.  
  301.  
  302.                @numpages@          -    The number of pages in the FAX.
  303.  
  304.                @filesize@          -    Size (in bytes) of the FAX file.
  305.  
  306.                @baudrate@          -    Baud rate at which FAX was
  307.                                         received.
  308.  
  309.  
  310.                Macro Functions
  311.                ~~~~~~~~~~~~~~~
  312.  
  313.                     In addition to the above macros, a number of
  314.                "functions" can also be used in the Cover Page Template.
  315.  
  316.                     @padc(nn,"Text")    -    Center Justifies "Text" (adds
  317.                                              spaces to both sides).
  318.  
  319.                     @padl(nn,"Text")    -    Left Justifies "Text" (adds
  320.                                              spaces to the right side
  321.                                              only).
  322.  
  323.                     @padr(nn,"Text")    -    Right Justifies "Text" (Adds
  324.                                              spaces to the left side only).
  325.           
  326.  
  327.  
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.  
  335.  
  336.  
  337.  
  338.  
  339.  
  340.  
  341.  
  342.  
  343.  
  344.  
  345.  
  346.  
  347.  
  348.  
  349.  
  350.  
  351.  
  352.  
  353.  
  354.  
  355.                         [ BGFAX2FD v1.00 User Manual Page 6 ]
  356.  
  357.  
  358.  
  359.  
  360.  
  361.           Registration
  362.           ~~~~~~~~~~~~
  363.  
  364.                     If you find that BGFAX2FD is useful or use it for more
  365.                than 14 days, then you must register.  Registrations are
  366.                good for all current and future versions of BGFAX2FD. 
  367.                Please see the enclosed REGISTER.FRM file for further
  368.                details.
  369.  
  370.  
  371.           Support
  372.           ~~~~~~~
  373.  
  374.                     You may FREQ BGFAX2FD and any other KAM Software
  375.                     product from:
  376.  
  377.                          1:2602/200@fidonet.org
  378.                          1:2602/115@fidonet.org
  379.  
  380.                     You may contact the author (Keith Mitchell) at:
  381.  
  382.                          Fidonet:
  383.  
  384.                               1:2602/200
  385.  
  386.                               GECHO_HELP (Zone 1 Backbone)
  387.                               RA_UTIL (Zone 1 Backbone)
  388.  
  389.                          Internet:
  390.  
  391.                               kmitch@vt.edu
  392.  
  393.                          Snail Mail:
  394.  
  395.                               Keith Mitchell
  396.                               6000 College Drive #102
  397.                               Suffolk, VA 23435
  398.                               USA
  399.  
  400.  
  401.  
  402.  
  403.  
  404.  
  405.  
  406.  
  407.  
  408.  
  409.  
  410.  
  411.  
  412.  
  413.  
  414.                         [ BGFAX2FD v1.00 User Manual Page 7 ]
  415.  
  416.  
  417.  
  418.  
  419.  
  420.           Credits
  421.           ~~~~~~~
  422.  
  423.                All Programs referred to in this document are copyright of
  424.           their respected authors.
  425.  
  426.  
  427.  
  428.  
  429.  
  430.  
  431.  
  432.  
  433.  
  434.  
  435.  
  436.  
  437.  
  438.  
  439.  
  440.  
  441.  
  442.  
  443.  
  444.  
  445.  
  446.  
  447.  
  448.  
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.  
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466.  
  467.  
  468.  
  469.  
  470.  
  471.  
  472.  
  473.                         [ BGFAX2FD v1.00 User Manual Page 8 ]