home *** CD-ROM | disk | FTP | other *** search
/ synchro.net / synchro.net.tar / synchro.net / modem.madness / SMMNETML / SCANT137.ZIP / STENGL.DOC < prev    next >
Encoding:
Text File  |  1991-11-26  |  20.5 KB  |  471 lines

  1.     Scantoss   Version 1.37                FTS-Productcode 82 Hex
  2.  
  3.     Scantoss is an echomail processor for Points with QBBS-compatible
  4.     message base (also known as the Hudson message base). Functions
  5.     that allow forwarding of mail to other systems are not included.
  6.     Dupe checking is also not included, your boss is responsible for
  7.     that.
  8.     
  9.     In comparison to QEcho and similar programs Scantoss has several
  10.     advantages:
  11.     - it doesn't cost anything
  12.       (perhaps, you'll send me a smiley per netmail ?)
  13.     - easy to use (I hope)
  14.     - four dimensional addressing is available
  15.     - password support
  16.     - allows for Frontdoor editor bug
  17.     - allows change of Tearline during scan
  18.     - allows redirection of imported mail to another folder
  19.     
  20.     Installation:
  21.     
  22.     Scantoss should be placed on the same drive (partition) as the
  23.     message base and the inbound directory so it can calculate the
  24.     space remaining accurately.
  25.     
  26.     To install the program use the STSETUP.EXE installation program.
  27.     The setup is very easy (as we don't use the SAA user interface :-) ).
  28.     There are a total of four setup displays for differing parts of
  29.     the configuration.  You can use the following keys to navigate
  30.     through the setup:
  31.  
  32.     - Return, Tab:              jump to next input field
  33.     - Cursor up/down:           move to the previous/next line
  34.     - Cursor left/right:        jump to previous/next input field,
  35.                                 or movement within the input field
  36.     - Home/End:                 move to the beginning/end of an input
  37.                                 field
  38.     - Backspace/Del             delete character to the left/under the
  39.                                 cursor
  40.     - Page up/down:             switch between the four setup displays
  41.     - F9:                       shell to DOS, to return enter 'exit' at
  42.                                 the DOS prompt
  43.     - Insert:                   Import data from another file (context
  44.                                 sensitive)
  45.     - Escape:                   Check data, save and exit. If an error is
  46.                 encountered then the program will not
  47.                 exit, instead it will display an error
  48.                 message indicating the problem
  49.                 encountered.
  50.     - F1 through F8             Press F10 to find out more about these
  51.                                 keys.
  52.  
  53.     STSETUP can be optionally be called with any of the following 5
  54.     parameters:
  55.       /IF   Import the folders from Folder.fd
  56.       /IA   Import the folders from AREAS.BBS
  57.       /ES   Export the complete setup to a text file ('Scantoss.txt')
  58.       /EA   Export the folder setup to a text file ('Areas.bbs'), usefull
  59.             for other utilities such as MBUtil
  60.       /MB   Creates an empty message base, of course you must first
  61.         configure the paths is STSETUP and actually have made the
  62.         directories in that path.
  63.  
  64.       /EB   Export the current setup to the file 'Scantoss.bin'
  65.       /IB   Import the current setup from the file 'Scantoss.bin'
  66.             This will make the installation of new versions much easier.
  67.  
  68.  
  69.     If an error occurs during /IA or /IF the STSETUP program will
  70.     prompt you for corrective action.
  71.  
  72.  
  73.     Following is a description of the information you must enter,
  74.     together with examples.  STSETUP will show you a short description
  75.     of the presently highlighted field at the bottom of the screen.  If
  76.     you see the word '(optional)' in this line, then you do not need to
  77.     enter anything and can skip to the next field.  You should go
  78.     through the four setup displays sequentially.
  79.  
  80.     Page 1: (Miscellaneous)
  81.  
  82.     Netmail-Path: C:\FD\NETMAIL
  83.      ; This is where the mailer puts netmail messages.
  84.     Qbbs/Ra-Path: C:\FD\QBBS
  85.      ; The directory path where your message base resides.
  86.     Inbound:      C:\FD\FILES
  87.      ; This is where your incoming mail packets are.
  88.     Outbound:     C:\FD\OUTBOUND
  89.      ; This is where the outgoing mail packets should be put.
  90.     Logfile:      C:\FD\FD.LOG
  91.      ; The name of the log file (see below).
  92.     Packer:       C:\PACK\LHA.EXE               Options: a /m
  93.      : Name an path of the program with which you wish to pack mail that
  94.      ; is sent to your boss.  Often LHArc or PkZip are used, but ARCA
  95.      ; can be used just as well.  Optional parameters may be needed
  96.      ; (ARCA and PkZip don't need any extra parameters).
  97.     Extractor:    C:\FD\PAK\SPAZ.COM             Options:
  98.      ; Name and path with which incomming mail is unpacked.  You should
  99.      ; definately use a 'universal' unpacker (eg: GUS, NGUS or SPAZ).
  100.      ; These automatically recognize the format of the incomming mail and
  101.      ; call up the correct unpacker automatically. btw. i'm using the new
  102.      ; gus 1.4 by Johan Zwiekhorst and it's great.
  103.     Default-Area: 200
  104.      ; This is the area which in which echomail is put for which you
  105.      ; have not setup a folder.  You should also install this area into
  106.      ; your editor program so that you can see if any mail is received
  107.      ; for areas which you have not configured.
  108.     Binkley: N
  109.      ; Enter 'Y' if you use a Binkley Mailer.  The mail packets and the
  110.      ; *.dlo files will be put into the outbound directory; no netmail
  111.      ; with file attaches will be produced.
  112.  
  113.     You must give absolute path names, this way you do not have to enter
  114.     the paths into the DOS 'path' or set any environment variables.
  115.     The packers that are called by the 'universal' unpacker must be in
  116.     the DOS path however.
  117.  
  118.  
  119.     Page 2: (Origin and Destination Addresses)
  120.  
  121.     You can enter up to 10 different addresses, normally one is enough.
  122.  
  123.     AKA_0: 2:243/44.103      ; 4d
  124.     AKA_0: 24344.103         ; 2d
  125.      ; You should enter your address here, either four dimensional or
  126.      ; two dimensional.  If you are not sure which, then ask you boss.
  127.     Route: 2:243/44          ; 4d (3d)
  128.     Route: 243/44            ; 2d
  129.      ; This is the address of your boss, again 4d (3d) or 2d.
  130.     4d: Y
  131.      ; You should enter 'Y' here if this line contains a 4d addresses.
  132.      ; Note that not every boss-node can use 4d addressing. Ask him before
  133.      ; you setup for 4d addressing. You can only enter 'Y' or 'N' here.
  134.     TSnode: N
  135.      ; Enter Y if you use 4D addressing and your boss uses the program
  136.      ; Tosscan.  You can only enter 'Y' or 'N' here.
  137.     Pw: password
  138.      ; Enter the password here that you and your boss agreed on, leave
  139.      : it empty if you have not yet made out a password (see also Security).
  140.  
  141.      Frontdoor users should enter their addresses in the same order
  142.      that they have in Frontdoor.
  143.  
  144.      Some of the data for setup screens 1 and 2 can be imported from
  145.      Setup.fd.  In screen one a few of the paths are set, on page 2 the
  146.      AKAs are set.  STSETUP trys to guess which address your boss node
  147.      has, please check this!  The settings for whether your boss node
  148.      has Tosscan and whether to use 2d or 4d addressing must be done by
  149.      hand.  If you use 2d addressing please remove all Zone numbers at
  150.      the beginning of all addresses.
  151.  
  152.  
  153.     Page 3:
  154.  
  155.     All entries on screen 3 are optional.
  156.  
  157.     (Retear-Function)
  158.  
  159.     T_1: Golded 4.01                        = Golded 4.01 via Scantoss
  160.     T_2:                                    = FD 2.01 via Scantoss
  161.     T_3: old Tearline                       = new Tearline
  162.  
  163.     You can enter up to three old Tearlines that are to be replaced by
  164.     new tearlines. If you leave the field 'old tearline' empty, every
  165.     tearline, will be changed (Including an empty tearline as in
  166.     FD 2.01).
  167.  
  168.     When you use the retear option, you will not see any change in the
  169.     your own message base, only the exported packets contain the new
  170.     tearline (this is done out of performance reasons).  Don't forget
  171.     the /RE command line parameter!
  172.  
  173.     (User Copy-Function)
  174.  
  175.     ID_1: FU   String: GURU                                   Board: 160
  176.     ID_2: TU   String: JOHN USER                              Board: 161
  177.     ID_3: RE   String: TEST                                   Board: 162
  178.      ; Up to three differing user copy definitions.  Messages that have
  179.      ; the 'String' in the 'ID' field are copied to 'Board'.  Use the
  180.      ; command line parameter /UC.
  181.  
  182.  
  183.     Page 4: (Areas and Routing)
  184.  
  185.     Line  Area  Foldername                                         Route
  186.       1   1     REGION13                                           0
  187.       2   3     PASCAL                                             0
  188.       3   7     LOCAL
  189.       4   160   The wise comments of the Guru
  190.       5   6     GAMES                                              0
  191.      
  192.      ; Line is the number of the entry (no special meaning).
  193.      ; Area is the number of the QBBS folder.  You can also enter the
  194.      ; folders that you have used for the default area, or the user copy
  195.      ; function, but you don't have to.
  196.      ; Foldername is the exact name, which is used to sort incomming echo
  197.      ; mail into the appropriate folder.
  198.      ; Route is the address pair that is used to decide where to send
  199.      ; the mail.  You can send the mail from differing folders to
  200.      ; differing systems, if you wish.  If you don't enter a route then
  201.      ; the mail in that folder will not be sent.
  202.  
  203.  
  204.      The data for this page can be imported from external files.
  205.      Import from 'Folder.fd':
  206.        STSETUP expects that Folder.fd is in the directory in which you
  207.        called STSETUP.  Areas that are marked as read-only in
  208.        Folder.fd will be installed without an 'export flag' (Route).
  209.        The export flag is the index for the default Aka of the area in
  210.        Folder.fd.
  211.        Normally the folder names don't have to be correct in
  212.        Folder.fd.  You could for example enter "Fido Network Technical
  213.        Discussion" instead of "NETDEV".  For importing the setup into
  214.        STSETUP the names have to be correct!  Comments in Folder.fd
  215.        (starting with a ";" semi-colon) are allowed.
  216.      Import From 'AREAS.BBS':
  217.       Just like Folder.fd, AREAS.BBS must be in the directory in which
  218.       you started STSETUP.  It is used to configure the proper "Route"
  219.       address, it trys to match the addresses with the addresses you
  220.       entered into page 2.
  221.  
  222.      As you can see the import operation tries to ease the
  223.      installation.  You should definately double check (at least) the
  224.      route information.  For this purpose a window will pop up with all
  225.      known boss nodes when you enter the Route field with the cursor.
  226.  
  227.  
  228.      Page 5: (Netmail packing and routing)
  229.  
  230.      Scantoss now packs your netmail into the echomailbundle to your boss.
  231.      This Function has some restrictions:
  232.        You may pack netmail for only one Boss per zone.
  233.        The flags  Crash, File, FileRequest, UpdateRequest may not be set.
  234.        If the flag 'direct' is set, then the netmail is only packed, if
  235.        this netmail is adressed to the Boss, which receives the complete
  236.        mailbundle. (or to one of his points).
  237.  
  238.      If you want to pack netmail, enter 'Y' at 'Route Netmail'; this
  239.      will generally allow netmailpacking. Now enter the default- system
  240.      (boss) to which the netmail should be routed. This system must be
  241.      predefined on page 2.
  242.      Don't forget to issue the parameter '/sn' on commandline.
  243.  
  244.      That's the whole setup for points, which didn't receive and send
  245.      netmail from several net's as described below in 'special points'.
  246.      If your point has more than one boss, than refer this chapter.
  247.  
  248.  
  249.      Logfile:
  250.  
  251.      If you want you can log all Scantoss activities.  The log file you
  252.      enter in page 1 will be used, this may be a logfile in which other
  253.      programs write information.  If you leave the entry blank, no log
  254.      is generated.  Scantoss uses the Frontdoor style date and time log
  255.      format.
  256.      The abbreviations used are:
  257.      tossing:  arc =   number of archives (*.mo? etc.)
  258.                pkt =   number of packets (*.pkt)
  259.                echo =  number of unpacked echo messages
  260.                net =   number of unpacked net messages
  261.                user =  number of user copies
  262.      scanning: pkt =   number of packets
  263.                exp =   number of exported messages
  264.                ioe =   number of messages that have an illegal export
  265.                        flag (Frodo-Bug)
  266.                route?  number of messages that have an legal export
  267.                        flag, but no route in the folder setup (page 4)
  268.                area?   number of messages that have an legal export
  269.                        flag, but no area entry in AREAS.BBS
  270.     Further all packets that were not properly addressed as well as
  271.     password errors and runtime errors are put into the log.
  272.     If you ever see something other than "0" in route? or area?, please
  273.     check your folder setup.
  274.  
  275.  
  276.     User Copy-Function:
  277.  
  278.     With this function you can copy certain messages into specific
  279.     folder.  This is usefull for readers without much time or to
  280.     archive important messages.
  281.     You can define up to 3 areas like this.  To access the folders you
  282.     must also configure the message reader for these areas.  You can
  283.     not export messages out of these folders, as messages from several
  284.     other folders may end up in them.  You do not need to enter the
  285.     folders on page 4 of the setup, however if you wish you may do so,
  286.     just remember not to enter any route information!  If you use
  287.     Frontdoor, then you may enter them in Folder.fd if you set them to
  288.     read-only, "STSETUP /IF" will then work properly.
  289.  
  290.     The configuration of a user copy definition must look like this:
  291.  
  292.     The 'ID' consists of 2 characters. It is used to determine which
  293.     field is searched.  The following IDs are allowed:
  294.       FU:          From User
  295.       TU:          To User
  296.       RE:          Subject
  297.     
  298.     The 'String' field contains the characters you wish to search for
  299.     in the ID field (max. 36 characters).
  300.     
  301.     The 'areanr' field is the number of the folder in which a copy of
  302.     the message should be placed.
  303.     
  304.     Examples:
  305.     
  306.     FU: Betty Blue = 88
  307.     this would copy all the messages of your girl friend (Betty) into
  308.     the folder 88.
  309.     
  310.     TO: Michael = 150
  311.     this would copy all the messages to Michael into the folder 150.
  312.     
  313.     RE: Scantoss = 151
  314.     this would copy all the messages with Scantoss in the subject into
  315.     the folder 151
  316.  
  317.     The search is not case sensitive, it also does not care at which
  318.     position in the field it finds the search string.
  319.  
  320.     Of course the original message will also be in the (original)
  321.     destination folder.  The number of the original message is usually
  322.     smaller by one than the copied message in the user copy folder.
  323.     Don't forget that you need an additional command line parameter to
  324.     activate the user copy function.
  325.  
  326.     Command line parameters:
  327.     
  328.     The program requires as its first parameter an 's' or a 't', for
  329.     scanning=export or tossing=import.
  330.         
  331.     the other parameters are optional
  332.     
  333.     1) Scanner (parameter 'S'):
  334.     
  335.        /re     change the Tearline as defined in Scantoss.cfg, page 3.
  336.        /vb     verbose screen-output
  337.        /sn     scan netmail-folder
  338.  
  339.     2) Tosser (parameter 'T'):
  340.  
  341.        /no     don't toss invalidly addressed packets
  342.                (default: every packet gets tossed)
  343.        /cs     cut (remove) the Seen-By line.
  344.        /uc     user copy as defined in Scantoss.cfg
  345.        /vb     verbose screen-output
  346.  
  347.     Error Levels:
  348.     
  349.     The program generates several error levels.  You can use this to
  350.     check diverse situations in a batch file.  For instance to check if
  351.     echomail was received, if not you could skip the reply link run.
  352.  
  353.     Errorlevel:
  354.     0:    Nothing happened
  355.     1:    Nothing there to be scanned (just parameter 'S' for export)
  356.     2:    NBothing there to be tossed  (just parameter 'T' for import)
  357.     77:   Wrong runtime-parameter (usually happens when you use a new
  358.           version with an old configuration) :-)
  359.     88:   Run-time error (Scantoss got confused, or there is not enough
  360.           space on the disk).
  361.     99:   Error in the Setup
  362.     128:  Checksum error; happens when Scantoss.exe has been modified:
  363.             - because of a hardware failure
  364.             - because of a software failure
  365.             - because of a user failure :-)
  366.             - because of software patches
  367.             - because of a virus
  368.             - because of a Exepacker, such as LZExe
  369.  
  370.  
  371.     Security:
  372.     
  373.     (Note: you do not have to read this section as there is no echomail-
  374.     processor that supports this feature on the boss side of things.
  375.     However such a program is supposed to be available soon.)
  376.  
  377.     It is possible to enter an echomail password with your boss that
  378.     insures that only authorized echomail is tossed.  You must enter
  379.     this password on page to of the setup displays.  Please don't
  380.     confuse this password with the session password for the mailer,
  381.     that is something else.
  382.     
  383.     The password is used for correspondence with your boss as well as
  384.     for the import and export of mail.  The passwords are part of the
  385.     packets that get exchanged.
  386.     
  387.     When Scantoss receives a packet for which a password exits then the
  388.     packet is only tossed if the password is correct.
  389.     
  390.     If you want to protect your system from non authorized echomail,
  391.     then please note the following:  Scantoss will normally toss every
  392.     packet upon import, if the receiving address is incorrect then the
  393.     password check will not be performed as there is no password for
  394.     that address.  To insure full security please use the option
  395.     '/no'.
  396.     
  397.     Special Points:
  398.     
  399.     There are Points which have more than one boss, for instance if he
  400.     receives mail from several nets (Eggnet, Alternet, Signet...) or
  401.     because he can't get a certain area from his normal boss.  As of
  402.     version 1.29 ScanToss can handle this situation.
  403.     
  404.     For every net you need to enter an address pair on setup page 2.
  405.     The 'route' index on page 4 points to this address pair, and so
  406.     every echo area ends up with the proper boss.
  407.  
  408.     The difference between this nets is the zone, i.e. Chatnet uses
  409.     zone 44 through 49.
  410.     To route NETMAIL to other bosses than the default (this is a must
  411.     if you have more than one net), you may enter some exceptions on
  412.     page 5 (Netmail routing).
  413.     i.e. your default-netmail-boss is 2:243/44 (Fido) and you want to
  414.     send netmail seperatly to 49:600/1 (Chatnet) in a arcmail-bundle.
  415.     If you enter this exception on page 5, all netmail adressed else-
  416.     where in zone 49 will added to the bundle directed to 49:600/1.
  417.     
  418.  
  419.     Copyright:
  420.     ----------
  421.  
  422.     This software and anything enclosed with it are protected by both
  423.     German and international copyright law and treaty provisions.
  424.  
  425.     This program is freeware. Use of this software is prohibited in a
  426.     governmental or commercial site or situation.
  427.  
  428.     You can give this program with documentation to anybody you like.
  429.     You are not allowed to charge for copying, the media which contains
  430.     SCANTOSS or for 'making it available' via an electronic media (like
  431.     a BBS or other online database).
  432.     Its strictly prohibited to pass a modified copy, or a copy without
  433.     this documentation, to somebody else.
  434.     
  435.     If you plan to use or distribute it in a way violating these
  436.     restrictions or add it to something you charge for you need the prior
  437.     written permission of the author.
  438.     
  439.     
  440.     Disclaimer and Warranty :
  441.     -------------------------
  442.     
  443.     This software is provided AS IS without any warranty, expressed or
  444.     implied, including but not limited to fitness for a particular
  445.     purpose.
  446.  
  447.     The author will not be liable for any direct or consequential
  448.     damages due to loss of data or any other reason, the person using
  449.     the software bears all risk as to the quality and performance of
  450.     the software.
  451.  
  452.     If your local laws do not permit any of the statements made above,
  453.     or if you do not agree with any of them yourself, then you are not
  454.     licensed to use this program!
  455.     
  456.     Names of products mentioned in this text are trademarks of their
  457.     respective owners.
  458.  
  459.     Ok, this was the hard but necessary stuff. Probably you will never
  460.     have any reason to think about the warranty, who knows ?
  461.     
  462.     If You have any questions just ask me, if you find a bug please
  463.     notify me.
  464.     
  465.     Michael Matter, 2:243/44.103 @fidonet
  466.  
  467.  
  468.     History:
  469.     --------
  470.     see the German documentation
  471.