home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / BBS / XST26A.ZIP / XST.DOC < prev    next >
Text File  |  1991-09-16  |  11KB  |  280 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.               XST Version 2.6a - A Scanner/Tosser for XBBS
  9.                             by Wayne Michaels
  10.                                 1:380/100
  11.  
  12.  
  13.  
  14.  
  15.        Copyright (C) 1989, 1990, 1991 by Wayne Michaels. ALL RIGHTS
  16.        RESERVED. COMMERCIAL DISTRIBUTION AND/OR USE PROHIBITED WITHOUT
  17.        WRITTEN PERMISSION FROM WAYNE MICHAELS.
  18.  
  19.        Non-commercial users may use XST without charges. It may also
  20.        be distributed without charge provided no modifications are
  21.        made to the program or this documentation. Distribution by
  22.        software services that charge a fee for distributing software
  23.        is expressly forbidden.
  24.  
  25.        XST is distributed in LZH archives created by LHArc. I do not
  26.        object to repackaging by some other archiving method but I do
  27.        object to added comments. DON'T ADD COMMENTS. If I had wanted
  28.        comments in the archive I would have put them there. Also, if
  29.        you repackage it don't leave out files or add files. If all
  30.        this bothers you or you feel I'm somehow infringing on your
  31.        rights then DON'T distribute XST!
  32.  
  33.  
  34.                               NO WARRANTY
  35.  
  36.        AS XST IS BEING PROVIDED FREE OF CHARGE, THERE IS ABSOLUTELY
  37.        NO WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED. ALL
  38.        RISK IS ASSUMED BY YOU. WAYNE MICHAELS WILL NOT BE RESPONSIBLE
  39.        FOR ANY SERVICING, REPAIR OR CORRECTION DUE TO PERFORMANCE
  40.        OF XST.
  41.  
  42.  
  43.  
  44.                                      2
  45.  
  46.  
  47.        XST is a tool to be used with XBBS. It is used to
  48.        import/export FidoNet messages in/out of XBBS.
  49.  
  50.        The syntax for XST is: XST -[option]<parameters>. A brief list
  51.        of the options may be obtained by typing XST without options or
  52.        with the ? option. The following are the options currently
  53.        available for XST. All options except the ? option must be
  54.        preceeded with a hyphen. Do not include a space between the
  55.        [option] and the <parameter>.
  56.  
  57.        Example: XST -FC:\NET.
  58.  
  59.        The following are the options available for XST at this time:
  60.  
  61.        -A<unarcing program>
  62.  
  63.            The unarchiving program to use for unarcing compressed
  64.            packets. If the unarchive program is included in your path
  65.            then only the program name is needed. If it is not in your
  66.            path then the complete path must be given. XST supports
  67.            ARC, ARCE, PKXARC, PAK and ZOO.
  68.  
  69.        -C<control file>
  70.  
  71.            This file contains information that XST needs to function.
  72.            It contains such things as your echo area names, your net/node
  73.            etc. The Format of this file will be discussed later. If
  74.            you do not specify this option then it will default to XST.CTL.
  75.            
  76.        -E
  77.  
  78.            Will cause XST to export messages only. No importing will be done.
  79.  
  80.        -F<incoming directory>
  81.  
  82.            Tells XST where your incoming files are located. This option
  83.            is required for importing messages.
  84.  
  85.        -I
  86.  
  87.            Will cause XST to import messages only. No exporting will be done.
  88.  
  89.                                      3
  90.  
  91.        -L  Linefeed and soft C/R's will be stripped from messages before
  92.            they are tossed to XBBS.
  93.  
  94.        -O<outbound directory>
  95.  
  96.            This is where XST will put outbound packets and other files
  97.            needed by your mailer program. IE: CLO, OUT, CUT etc files.
  98.            This must be the same directory that your mailer looks in to
  99.            find outgoing mail and packets. XST is Zone aware when exporting
  100.            netmail and will create an outbound directory with the zone
  101.            number as the extension for use by your mailer. Therefore do not
  102.            put extensions on your outbound directory. For example DON'T name
  103.            your outbound directory OUTBOUND.DIR! NOTE: XST is NOT Zone aware
  104.            for Echo mail and can NOT be used as a ZoneGate!
  105.  
  106.        -P<message base directory>   Required Option
  107.            The directory where our XBBS message bases are located.
  108.  
  109.        -R
  110.  
  111.            Forces XST to rescan all the messages in the NetMail base.
  112.  
  113.        -S
  114.  
  115.            Tells XST to strip SEEN-BY lines from echo mail messages.
  116.            PATH lines will be kept. If you use this option, do NOT use -T.
  117.  
  118.        -T
  119.            Tells XST to strip SEEN-BY and PATH lines from echo mail
  120.            messages. If you use this option, do NOT use -S.
  121.  
  122.        -#<netmail msg base>       Required Option
  123.  
  124.            This is the XBBS message base that you have designated as
  125.            your netmail base. If your netmail base is number 5 then
  126.            this option would be: -#5
  127.  
  128.        Control File
  129.  
  130.        As stated above, XST requires a control file which contains info
  131.        XST must have in order to function. It is a required file and
  132.        XST will fail to run if it can not find this file. If you do not
  133.        specify the file name with the -C option then it will default to
  134.        XST.CTL. Following is a sample file with comments.
  135.  
  136.                                      4
  137.  
  138.         ; This is a comment. Any line that begins with an ; is ignored.
  139.         ;
  140.         ; The following parameter tells XST ARC the mail to the listed nodes.
  141.         ARCTO 380/16 380/0 21000/1
  142.         ;
  143.         ; This parameter tells XST what which command to use for ARCing the
  144.         ; mail. Note that you MUST use the complete program name IE: PKARC.COM
  145.         ARCCMD PKARC.COM -M
  146.         ;
  147.         ; This parameter tells XST to ARC the mail but hold it for pickup.
  148.         ARCHOLD 380/16
  149.         ;
  150.         ; The following keyword is used to tell XST to forward netmail.
  151.         ; It's primary use is for net hosts. If you uncoment the FORWARD
  152.         ; keyword then XST will forward netmail if it is not for your node.
  153.         ; It will only forward to other nodes in your net.
  154.         FORWARD
  155.         ; The following line is your net/node number. If you are a point
  156.         ; then your Boss Net/Node goes here.
  157.         NetNode  380/100
  158.         ; The following line is used if you have a second net/node. For use
  159.         ; by net hosts or mail hubs. You may have up to five AKAs.
  160.         AKA 1:381/0
  161.         ; If you are a point then uncomment this line and replace the
  162.         ; nnn/nnn with the net/node assigned to you by the Boss
  163.         POINT 21000/1
  164.         ; The following line is for a Boss system only. It specifies
  165.         ; the net number you have assigned to your points. Replace the
  166.         ; nnnnnnn with the net number. Do not include node numbers
  167.         POINTNET 21000
  168.         ; The following line is your zone
  169.         Zone     1
  170.         ; Following line tells XST what file to use for logging
  171.         LogFile  SYSTEM.LOG
  172.         ; The next lines are the areas. They take the format of:
  173.         ; Message_Base_Number Echo_Tag Net/Node Net/Node Net/Node. The
  174.         ; Net/Node fields are the net/nodes you forward the echo to. Note
  175.         ; the space between each field. The maximum number of Net/Nodes is 30.
  176.         ; If you are a point then there must be only ONE Net/Node
  177.         ; listed and it MUST be your Boss Net/Node!
  178.         Area  2  QUIK_BAS  380/0 380/16
  179.  
  180.  
  181.                                      5
  182.  
  183.        If you do not want a particular echo to be tossed into your message
  184.        base you may specify NUL as the first net/node in field three. For
  185.        instance:
  186.  
  187.        Area  3  DR_DEBUG  NUL 380/0 380/16
  188.  
  189.        This line would cause all messages that are received for the DR_DEBUG
  190.        echo to be forwarded on to 380/0 and 380/16 but would not toss them
  191.        into your messages bases.
  192.  
  193.        VERSION NUMBERS
  194.  
  195.        XST version numbers that end in an odd number (1.1, 1.3 etc)  are beta
  196.        test versions. Even numbered versions (1.0, 1.2 etc) are for general
  197.        release and should be bug free (I hope!).
  198.  
  199.        LIMITATIONS
  200.  
  201.        XST can support a maximum of 400 XBBS message bases and 30
  202.        net/nodes per messages base. You may overcome this limitation
  203.        by running XST more than once with a different CTL file for each
  204.        run.
  205.  
  206.        XST will check for dups against the last 1000 messages received
  207.        in an echo mail message base.
  208.  
  209.        XST is NOT Zone aware for Echos and can NOT be used as a ZoneGate.
  210.  
  211.        LOGGING
  212.  
  213.        XST will log its activities in the file name specified by the CTL
  214.        file parameter LOGFILE. If you do not specify a LOGFILE it will log
  215.        to XST.LOG.
  216.  
  217.        XST will log the number of netmail and echo mail messages sent and
  218.        received. It will also log problems it encounters such as an invalid
  219.        directory specified in a command line option.
  220.  
  221.        XST will also log severe errors (program bugs) in the system log.
  222.        Please report all severe errors to Wayne via the XBBS Echo or
  223.        netmail.
  224.  
  225.        POINTS
  226.  
  227.        XST will support points only if they use XBBS and BinkleyTerm.
  228.  
  229.                                      6
  230.  
  231.        ARCMAIL
  232.  
  233.        XST supports ARCing of outgoing mail to a maximum of 30 net/nodes.
  234.  
  235.        SUPPORT
  236.  
  237.        Support for XST will be via NetMail or the XBBS echo. Because this
  238.        program is being offered free I can not justify spending any money
  239.        on support. I may be reached via NetMail at 1:380/100. If you need
  240.        to ask a question do so via NetMail, then wait at least 7 days and
  241.        then poll for your answer. If 7 days seems like a long time I'm
  242.        sorry but I do this as a hobby, I work days and I have other
  243.        interests that may prohibit me from answering in a shorter time.
  244.        The XBBS echo is not on the backbone but you may get a link to it
  245.        at 380/16 (the XBBS home node) or 380/100. You must poll to get it
  246.        as neither Mark nor myself can afford to send it to you!
  247.  
  248.        DON'T CALL ME ON THE PHONE! I WILL RUDELY HANG UP ON YOU AND WILL
  249.        NOT ANSWER ANY FURTHER NETMAIL FROM YOU!
  250.  
  251.  
  252.  
  253.        ACKNOWLEDGEMENTS
  254.  
  255.        First and foremost to Mark Kimes, without whom there would be no
  256.        need for XST. Mark created the XBBS system. He also has been
  257.        invaluable in his testing of XST and has made many suggestions
  258.        to help steer XST in the right direction. The XBBS system is
  259.        available for file request from Mark at 1:380/16. There are
  260.        more programs than can be mentioned here; file request
  261.        XBBSFILE.LZH for a more-or-less current listing.
  262.  
  263.        I would also like to thank beta testers Mark Kimes, Tom Cadorette,
  264.        Mike Hamilton and Clinton Adams for finding many of the creepy
  265.        crawly thing in XST.
  266.  
  267.        The following names are either trademarks or the work of the
  268.        individuals and/or companies shown.
  269.  
  270.        XBBS - Mark Kimes
  271.        FidoNet - Tom Jennings and Fido Software
  272.        oMMM - BS Software, Marshall Presnell, Jim Nutt, etc.
  273.        ARC - Thom Henderson, System Enhancement Associates, Inc.
  274.        EchoMail - Jeff Rush
  275.        Zoo - Rahul Dhesi
  276.        ARCE - Wayne Chin, Vernon D. Buerg
  277.        PAK - NoGate Consulting
  278.        PKXARC - PKWare, Inc.
  279.        BinkleyTerm - Bit Bucket Software, Co.
  280.