home *** CD-ROM | disk | FTP | other *** search
/ PC Online 1997 December / PCO1297.ISO / FilesBBS / DOS / LYME20.EXE / LYME.DOC < prev    next >
Encoding:
Text File  |  1997-08-10  |  19.5 KB  |  478 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.                                   LYME
  9.                                     
  10.                    TIC processor for RemoteAccess 2.50
  11.                                     
  12.                                Version 2.0
  13.                           Released 10 Aug 1997
  14.                                     
  15.                              By Pab Sungenis
  16.                     Copr. 1995, 1997 EMPIRE Software
  17.                                     
  18.                        Another Shareware Offering
  19.                                     
  20.  
  21.  
  22.                       ---------------------------
  23.                       INTRODUCTION TO VERSION 2.0
  24.                       ---------------------------
  25.  
  26.         I really can't believe it's been 20 months since the last
  27. release.  Since version 1.1 of Lyme was released, my life has literally
  28. turned itself on its head.  New job, new responsibilities, and sickness
  29. and death in my family.  But somehow, through it all, I found time to
  30. make major changes to the program.  A considerable speed increase and
  31. the addition of downlink capabilities are among the major changes that I
  32. think you'll like in this new version.
  33.         There are other commands and options people asked for which I
  34. have not yet had time to try.  I hope to work these into an upcoming
  35. version.  Sorry, but I decided I had to get this one out finally.
  36.         Thank you all for being so patient while waiting for this version,
  37. I hope it was worth the wait.
  38.                                     
  39.                                     
  40.                               ------------
  41.                               INTRODUCTION
  42.                               ------------
  43.                                     
  44.      LYME was written to implement a number of features I, as a
  45. SysOp, wanted to see in a TIC processor, and to correct a number
  46. of problems that existed in the processor I was using before.  In
  47. addition to the standard features found in most processors, Lyme
  48. offers a number of 'extras' including....
  49.  
  50.      * Support for ALLTICS/*.ZIC files
  51.      * Built-in 'Ticket' message generation
  52.      * Selective killing of unwanted file areas
  53.      * Easy set-up and operation
  54.      * Ability to use LDESC long description fields in TICs
  55.      * Support for .RAR file compression
  56.      * Up to 1,024 file areas in a single config file
  57.      * Ability to feed files to up to 25 downlinks
  58.  
  59.      Plus, Lyme is fully integrated with RA 2.50, allowing you to
  60. make changes to your RA file areas, and have those changes
  61. immediately used by your TIC processor.
  62.      Lyme is easy to install, easy to set up, and even easier to
  63. use.  If you've been using another processor, give it a try.  I
  64. think you won't be disappointed.
  65.  
  66.  
  67.                                   -----
  68.                                   SETUP
  69.                                   -----
  70.                                     
  71.      Extract all files to your RA directory, or another directory
  72. of your choice.  A sample configuration file, with comments, is
  73. included in the archive.
  74.      Lyme uses a simple text file for its configuration.  The
  75. first non-comment line of the file (in other words, not beginning
  76. with a semicolon) must be the path for your files and TICs.  All
  77. other lines of the file may be either commands or file area
  78. definitions.
  79.  
  80.      * COMMANDS: All command lines begin with an exclamation
  81. point.  Commands supported by Lyme are:
  82.  
  83.      !DIZ ON|OFF
  84.  
  85.           This command allows you to specify whether
  86.           FILE_ID.DIZ files will be imported into your
  87.           file database.  Lyme will extract FILE_ID.DIZ
  88.           from files compressed using PAK, ARC, LZH,
  89.           ZIP, ARJ, and RAR compression.  (Note: You
  90.           must have the appropriate utilities --
  91.           PKUNZIP.EXE, LHA.EXE, etc. -- in your search
  92.           path.  If you do not, Lyme will not be able
  93.           to use FILE_ID.DIZ from files of that type.)
  94.           The default is ON.
  95.  
  96.      !LDESC ON|OFF
  97.  
  98.           This determines whether or not LDESC long
  99.           description lines will be imported into your
  100.           database.  Some FDN's use these lines to
  101.           provide long descriptions for uncompressed
  102.           files (such as PCBoard PPE's) and self-
  103.           extracting EXE's.  The default is ON.
  104.  
  105.           Note: if you have both !DIZ ON and !LDESC ON
  106.           in your configuration file, the FILE_ID.DIZ
  107.           will take precedence over any LDESC lines.
  108.  
  109.      !TICKET mbase name
  110.  
  111.           If you include this command in your config
  112.           file, Lyme will generate a "Ticket" message
  113.           in the specified message base, addressed to
  114.           the specified name.
  115.  
  116.           The message will list all files which were
  117.           imported, the file area they came from, and a
  118.           short description of the file.  This allows
  119.           you to see, at a glance, the files that have
  120.           arrived on a given day.
  121.  
  122.      !ORPHAN KEEP|KILL
  123.  
  124.           This controls Lyme's treatment of orphaned
  125.           TIC files (i.e.: TICs which arrive without
  126.           their matching files).  If you choose KILL,
  127.           the orphaned TIC files will be deleted.  The
  128.           default is KEEP.
  129.  
  130.      !UNKNOWN KEEP|KILL
  131.  
  132.           This controls Lyme's treatment of TICs which
  133.           belong to file areas not specified in your
  134.           configuration file.  If you choose KILL, the
  135.           TIC and file will be deleted.  The default is
  136.           KEEP.
  137.  
  138.      !ALLTICS filespec
  139.  
  140.           This allows you to specify a filespec to search
  141.           for which may contain a number of .TIC files
  142.           (and, optionally, files included in the bundle)
  143.           compressed into one file.  This command allows you
  144.           to change the default filespec (ALLTICS.*) to
  145.           another if your provider uses a different file-
  146.           name.  (For example, Allfix's PACK ALL command
  147.           creates bundles named *.ZIC)
  148.  
  149.      !CRC ON|OFF
  150.  
  151.           This command will check the file contents against
  152.           the CRC value in the .TIC file, to make sure that
  153.           the file has not been corrupted in transit.  This
  154.           will slow down processing somewhat, but is worth
  155.           it if you want to make sure your files are intact.
  156.           The default is OFF.
  157.  
  158.      !VERIFY ON|OFF
  159.  
  160.           This command will check the file after it has been
  161.           copied into your file area, to make sure that the
  162.           new file matches the CRC value in the .TIC file.
  163.           Again, this slows down processing, but adds an extra
  164.           level of safety against corruption.  Default is OFF.
  165.  
  166.      All other non-comment lines are assumed to be file area
  167. definitions.  The format for these lines is as follows:
  168.  
  169.      areaname areanum|KILL
  170.  
  171.      The 'areaname' is the name of the file area as specified in
  172. the TIC files.  (Wildcards are allowed.)  'Areanum' is the number
  173. of the file area (as defined in your RA configuration) the file
  174. should be imported to.
  175.      You may also specify 'KILL' as your import area.  Any files
  176. arriving from that area will be deleted.  This feature is most
  177. useful for users of satellite delivery systems (such as Planet
  178. Connect) where you cannot unlink individual areas.
  179.  
  180.      Sample area definitions:
  181.  
  182.      ;Import SDN text to area 37
  183.      1-TEXT 37             
  184.      ;Import RA Distribution to area 1
  185.      RAD* 1
  186.      ;Kill any Amiga files
  187.      ADS* KILL
  188.  
  189.      NOTE: There are several !Commands that pertain to downlink feeding.
  190. Since not everyone is going to be feeding downlinks, these commands have
  191. been set off in their own section of this file.  See "FEEDING DOWNLINKS"
  192. below.
  193.       
  194.                                ----------
  195.                                USING LYME
  196.                                ----------
  197.                                     
  198.      To run Lyme, simply type:
  199.  
  200.           LYME [filename]
  201.  
  202.      where 'filename' is the name of the configuration file to
  203. use.  If none is specified, Lyme will use LYME.CFG for its
  204. configuration.
  205.      Lyme will first read your CONFIG.RA, MESSAGES.RA and
  206. FILES.RA files to get its bearings.  Next, Lyme will unpack any
  207. ALLTICS files found in your TIC directory.
  208.      Each TIC will then be read, and Lyme will check for the
  209. appropriate file.  If the file is not found, the TIC is an orphan
  210. and will be treated as such.  If the file exists, Lyme next
  211. checks the area it arrived in against the areas in your
  212. configuration file.  If it is in an unknown area, it will either
  213. be deleted or ignored depending upon your use of the !UNKNOWN
  214. command.  If the file is compressed and you have not used the
  215. !DIZ OFF command, Lyme will check for and extract the FILE_ID.DIZ
  216. from it.
  217.      Next, Lyme will copy the file to the proper directory and
  218. create an entry in that area's database for the file.  If the
  219. file already exists in that area, or if a file matching the TIC's
  220. 'Replace' field (if any) exists, Lyme will overwrite the entry
  221. for that file with the new one.
  222.      After all TICs have been processed, Lyme will close its log
  223. file (LYME.LOG) and, if you have used the !TICKET command,
  224. generate a 'ticket' message.
  225.  
  226.  
  227.                      ------------------------------
  228.                      USING LYME WITH PLANET CONNECT
  229.                      ------------------------------
  230.                                     
  231.      The advent of Fidonet delivery by satellite has meant many
  232. changes in the way things used to work.  Many 'traditional'
  233. methods (including RAID messages and individual TIC files) are
  234. either impossible or too inefficient to be used over the
  235. satellite.
  236.      Many of the new features in Lyme were designed to work with
  237. standards set by Planet Connect and other satellite services. 
  238. This section will help you configure Lyme to use these features
  239. and work best with these services.
  240.  
  241.      * ALLTICS.*  --  Lyme will automatically decompress and use
  242. any ALLTICS format files found in your TIC path.  There is no
  243. need to process these files manually; remove any lines from batch
  244. files that decompress ALLTICS.
  245.  
  246.      * UNKNOWN AREAS -- Most services will add file areas
  247. regularly, and you may wake some morning to find a number of
  248. files you hadn't expected are sitting on your drive.
  249.      I suggest that you do not delete unknown areas
  250. automatically, but instead use KILL options to delete file areas
  251. you know you do not want.  You can then check these new areas, to
  252. see if you want to import them or not.
  253.  
  254.      * ORPHANS  --  I strongly advise you to not delete orphaned
  255. TICs.  Since the ALLTICS method means that all TICs arrive at
  256. once instead of in matched pairs with their accompanying files,
  257. you may still be receiving the actual files when your BBS starts
  258. tossing.  You may also have a file trashed on the first pass but
  259. have it received correctly later.  Instead you should
  260. occasionally manually erase leftover orphans.
  261.  
  262.      Lyme's defaults are configured to work best with satellite
  263. delivery.  For optimum use, do not override them with !ORPHAN or
  264. !UNKNOWN commands.
  265.  
  266.      -- USING LYME WITH PC AND TVAGENT
  267.  
  268.      If you want to import the TVLIST files into your BBS through
  269. Planet Connect, LYME makes it easy.  Simply copy your LYME.CFG
  270. file to TV.CFG, delete all area definitions but TVLIST, change the
  271. .TIC directory to the directory your TVLIST files land in, and
  272. change the !ALLTICS specification to TVLISTTK.ARC.  Then simply add
  273. LYME TV.CFG to your 'event' when Planet Connect's cycle is complete.
  274.  
  275.  
  276.                            -----------------
  277.                            FEEDING DOWNLINKS
  278.                            -----------------
  279.                  
  280.      The main addition to this new version is the addition of downlink
  281. capability to Lyme.  Originally, I had intended Lyme to only be an
  282. end-of-the-line program, which just imported .TICs into a BBS's file
  283. database.  However, a lot of people began asking if they could use Lyme
  284. to feed files they received to other BBS's.  The addition of downlink
  285. capability allows you to do this.
  286.  
  287.      You do not need to use any of these downlink functions if you do
  288. not want to; Lyme still works well as an end-of-the-line program.  But
  289. for those who wanted it, here is how to go about it.
  290.  
  291.      Before adding downlinks to your configuration, you must tell Lyme a few
  292. things about your system:
  293.  
  294.         !ADDRESS xxx:xxx/xxx.xxx
  295.  
  296.      This is YOUR address, the address that the Raid utility will look for
  297. messages addressed to it at, and the address that will be included in
  298. all hatched .TICs and all Seenby and Path statements in .TICs.
  299.  
  300.         !UPLINK xxx:xxx/xxx.xxx password robotname
  301.  
  302.     This is the address of your file feed, the password you use to add
  303. and drop file areas, and the name you send all add/drop commands to.
  304.  
  305.     For example:
  306.  
  307.     !UPLINK 1:266/73 PAB LYME
  308.  
  309.     This would set up my system as your uplink, with the password "PAB"
  310. and "LYME" as the robot name.  Most programs (with Allfix being a
  311. notable exception) will accept or look for RAID as the file area
  312. add/drop robot.  Lyme will as well.
  313.  
  314.         !NETMAIL path
  315.  
  316.     This is the path (trailing '\' please) to your front-end mailer's *.MSG
  317. message base.
  318.  
  319.         !HATCH path
  320.  
  321.     This is the path where you want all .TICs you hatch out placed.  It
  322. should be in your mailer's outgoing files area.  This command is for
  323. people (like myself) who have separate directories for incoming FDN
  324. files and outgoing files.
  325.  
  326.                                    **
  327.  
  328.     Now that you've told Lyme about yourself, it's time to tell it about
  329. your downlinks.  For each system that will be receiving files through
  330. you, create a LINK command as follows:
  331.  
  332.         !LINK xxx:xxx/xxx password path alltic SysOp
  333.  
  334. Where:
  335.  
  336.         xxx:xxx/xxx is the address of the downlink.  Points allowed.
  337.  
  338.         PASSWORD is the Raid and .TIC password for this system.  The
  339.         downlink's SysOp may change it through Raid.  Please alert your
  340.         links that for security purposes, the password is CASE SENSITIVE.
  341.  
  342.         PATH is the outgoing path to store all outgoing files, .TICs,
  343.         and ALLTICS files for this system.  Each system MUST have its
  344.         own path, since there will be a lot of duplicated file names.
  345.  
  346.         ALLTIC is the desired compression for ALLTICS files.
  347.         Compressors currently supported by Lyme are ZIP, ARJ, ARC, LZH,
  348.         and RAR.  If the system does not want to use ALLTICS files, then
  349.         this should be TIC, and all .TIC files will be sent
  350.         individually.  I suggest you start each system off with TIC, and
  351.         let them change this if they wish.
  352.  
  353.         SYSOP is the SysOp's name for this downlink.  All file attaches
  354.         will be sent to this name.
  355.  
  356. Examples:
  357.  
  358.         !LINK 1:266/73 password E:\RA\OUTBOUND\266-73\ RAR Pab Sungenis
  359.         !LINK 1:266/12 tick E:\RA\OUTBOUND\266-12\ TIC Barry Geller
  360.         !LINK 100:100/0 gnet C:\GNETOUTB\ ZIP Darryl Pierce
  361.  
  362.     Once your downlinks are configured, they may start adjusting their
  363. configuration, and adding and dropping areas, by sending messages to
  364. LYME (or RAID) at your address.  Place LYMERAID.EXE in your Lyme directory,
  365. and run it every time you check incoming netmail.  It will automate the
  366. entire process.
  367.  
  368.     Be warned: LYMERAID, by necessity, rewrites your configuration files.
  369. Your comments will all be moved to the top of the file, followed by !
  370. commands, then downlinks, then areas.  This is not a bug, it is
  371. necessary to keep track of everything.
  372.  
  373.     If you want to add or delete areas for a particular downlink by hand,
  374. you may do so.  Simply add the address (preceded by a @) to each area
  375. they want to receive.  For example:
  376.  
  377.         NODEDIFF 3 @1:266/74 @100:100/0
  378.  
  379.     You may leave off the zone and net information for any nodes.  Lyme will
  380. then assume they are in the same net and/or zone as you.  For example,
  381. if I'm at 1:266/73, and 1:266/901 wants to hook up to an area, I can
  382. just add @901 as the address.
  383.  
  384.     Passthrough areas should be noted by just the area tag and downlink
  385. addresses, leaving out the filebase number.
  386.  
  387.         EP_ASCII @1:266/74
  388.  
  389.     Downlinks are processed before the file is processed locally, allowing
  390. you to link systems to areas that you KILL.  Also, if a downlink
  391. requests an area that is currently covered by one of your wildcard
  392. definitions, LYMERAID will copy your information for that wildcard to
  393. the new entry.  All areas added by LYMERAID will be at the very
  394. beginning of your area definitions.
  395.  
  396.                                    **
  397.  
  398.     The HATCH utility is basically an extra little nicety, rather than part
  399. of the downlink system itself.  It allows you to create .TICs to send
  400. files out to particular file areas.  It's designed to use your LYME.CFG
  401. file for much of its information, so keep it in and run it from your
  402. Lyme directory.
  403.  
  404.     Hatch may be run in two ways: interactive or command-line.  Simply
  405. typing HATCH with no parameters will use the interactive mode, prompting
  406. you for all information it needs.  This is the easiest way to do it.
  407.  
  408.     The command-line option is mainly there for people who hatch out files
  409. on a semi-regular basis, and want to automate the process.  It's also
  410. handy for those command-line junkies like myself, who find it's easier
  411. to type everything as parameters.
  412.  
  413.     The usage for the command-line mode is as follows:
  414.  
  415.     HATCH \path\filename [repl [xxx:xxx/xxx [area [descript]]]]
  416.  
  417. Where:
  418.  
  419.         \PATH\FILENAME are the full path and filename of the file to
  420.         hatch.
  421.  
  422.         REPL is the name of the file to replace with the new one.  For
  423.         example, LYME20.RAR will supersede LYME110.RAR on systems that
  424.         carry it, so I would have on my command-line:
  425.  
  426.                 HATCH \IM\FILES\LYME20.RAR LYME110.RAR
  427.  
  428.         AREA is the area tag to hatch the file to
  429.  
  430.         xxx:xxx/xxx is the address to hatch the file to
  431.  
  432.         DESCRIPT is a one-line description for the file.
  433.  
  434.     Any information you leave off the end of the command line will be
  435. prompted for in interactive mode.
  436.  
  437.     If you want to hatch files out to particular FDNs often, you may want
  438. to save yourself time by creating the file HATCH.CFG.  This allows you,
  439. when using interactive mode, to automatically assign that area tag to a
  440. particular address, and also include a hatch password for that area.
  441.  
  442.     A HATCH.CFG file is a text file, with one line for each area, in the
  443. format:
  444.  
  445.         area xxx:xxx/xxx password
  446.  
  447.     For example, from my own (passwords changed to protect the innocent!)
  448.  
  449.         RAD_UTIL 1:135/71 REMOTE
  450.         RAD_MAIL 1:135/71 REMOTE
  451.         PC-UTILS 1:3615/50 OBSOLETE
  452.  
  453.  
  454.                               -------------
  455.                               IN CONCLUSION
  456.                               -------------
  457.                                     
  458.  
  459.      Lyme is released under the Shareware concept.  If you use
  460. the program and like it, you are strongly encouraged to register
  461. it.  No fee is required to register the program, but donations
  462. are not refused.
  463.      Registrations, along with all comments, questions, and hate
  464. mail may be sent to me via one of the following methods:
  465.  
  466.      Internet:  pab@cnx.com
  467.      Netmail:   Pab Sungenis  1:266/73
  468.      Snail:     1349 Roosevelt Blvd., East Vineland, NJ, 08361
  469.  
  470.      We also offer a Fido echomail area called EMPIRE for support
  471. of Lyme, Shut Up And Run The Mail, OLMS Answering Machine, my
  472. GIGO utilities, and EMPIRE Doorware.  For information on
  473. connecting to this area, send netmail.  It's also available as an
  474. Internet mailing list, E-Mail for details.
  475.      Thanks, and enjoy the program.
  476.  
  477.                                              Pab Sungenis
  478.