home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / MISC / PADI100.ZIP / PADI.DOC < prev    next >
Text File  |  1998-02-01  |  9KB  |  291 lines
  1.  
  2. PADi version 1.00
  3. (K) 1995, 1996, 1998 by Andrew Ziem.
  4.  
  5. Released: 98-02-01
  6.  
  7.  
  8. -= Introduction
  9.  
  10.   PADi, formerly RAADi, stands for Psych0AreafixeDescriptionImporter.
  11.   It reads a standard BACKBONE.NA-style file and updates your BBS's
  12.   message areas descriptions accordingly.
  13.  
  14.   PADi is useful when you have auto-created areas or if you want to save
  15.   yourself time typing in descriptions.  PADi searches for matches using
  16.   your BBS's message area name (not msgbase file name) and changes the
  17.   area name using a template.
  18.  
  19.   This piece of my log file may give you an idea of what the program does:
  20.  
  21. * PADI 13 Thu 19:51:48 area "TEEN" changed to "Fido TEEN (International
  22.      Teenagers' Echo)"
  23. * PADI 13 Thu 19:51:48 area "WUNDERMENT" changed to "Fido WUNDERMENT (General
  24.      Conversation)"
  25. * PADI 13 Thu 19:51:48 area "PYRO" changed to "Fido PYRO (National Pyrotechnic
  26.      Echo)"
  27. * PADI 13 Thu 19:51:48 area "FLAME" changed to "Fido FLAME (National Flame!
  28.      Echo)"
  29. * PADI 13 Thu 19:51:48 area "LORD" changed to "Fido LORD (L.O.R.D Doorgame
  30.      discussion)"
  31. * PADI 13 Thu 19:51:50 area "DOORGAMES" changed to "Fido DOORGAMES (BBS
  32.      Doorgames and discussions)"
  33. * PADI 13 Thu 19:51:50 area "RENEGADE_BBS" changed to "Fido RENEGADE_BBS (The
  34.      Original Renegade BBS Support Echo)"
  35. * PADI 13 Thu 19:51:50 area "PORTAL" changed to "Fido PORTAL (Portal of Power
  36.      Support Conference)"
  37.  
  38.  
  39. -= "License Agreement"
  40.  
  41.   Psych0AreafixedDescriptionImporter (from hereforth "PADi"), is hereby
  42.   released to the public domain.  Portions, however, were not written by
  43.   me and belong to their respect authors.  Much of what I have not
  44.   written has come from SWAG and David van Driessche.
  45.  
  46.   Now that I've given you something, you could do something for me, eh?
  47.  
  48.   If you make any neat improvments or modifications, send them to me.
  49.   At least drop me a note to say you use the program; I'd like to see
  50.   how this thing gets around.
  51.  
  52.   PADi is provided `as is' without warranty of any kind, expresed,
  53.   implied or otherwise.  If it breaks, you may keep both pieces.  There
  54.   are no other gaurantees, I promise.
  55.  
  56.   Leave me some credit as the author.  Also, as a sign of respect,
  57.   include this documentation (including these wishes) for others to
  58.   read.
  59.  
  60.  
  61. -= Highlight of features
  62.  
  63.   * Freeware.  Full source code included.
  64.  
  65.     Use PADi as you wish, for as long as you wish, however you wish. If
  66.     not, freely make your own modifications.
  67.  
  68.  
  69.   * Smart, small, efficent.
  70.  
  71.     PADi will not waste your time or your drivespace.
  72.  
  73.     PADi is fully SHARE compatible, which prevents potentionally
  74.     disasterous file locking conflicts.
  75.  
  76.     PADi buffers data in XMS, EMS and conventional memory, which speeds
  77.     thems up tremendously.
  78.  
  79.  
  80.   * Compatible with a wide range of popular BBS software packages:
  81.  
  82.     Nexus v0.99.b09, T.A.G. v2.7, Telegard v3.0x, RemoteAccess v2.0x &
  83.     v2.5x, Renegade v10-05 & v04-06, SuperBBS v1.17 and ProBoard v2.15.
  84.  
  85.  
  86.   * Simple text configuration.
  87.  
  88.     Easy to handle several networks using several configuration files,
  89.     minimal changes are needed to made to each file.
  90.  
  91.  
  92. -= Included files
  93.  
  94.   PADI    .DOC             this documentation
  95.   PADI    .EXE             PADi executable
  96.  
  97.   SRC     .ZIP             Pascal source
  98.  
  99.   FILE_ID .DIZ             PADi description for BBS use
  100.   PSYCH0  .LST             files, mostly Psych0Soft, and how to get them
  101.   SAMPLE  .CFG             sample configuration
  102.   WHATS   .NEW             what's new in the world of PADi
  103.  
  104.  
  105. -= Requirements
  106.  
  107.   * IBM-PC or compatible computer
  108.  
  109.   * DOS v5.00 (or so) or higher
  110.  
  111.   * a standard BACKBONE.NA file
  112.  
  113.   * one of the listed BBS software packages or compatible
  114.  
  115.   * XMS, EMS, or conventional/disk memory
  116.      current BACKBONE.NA file       50k
  117.      my message base data         + 15k         
  118.      total on my system           = 85k
  119.  
  120.  
  121. -= Use
  122.  
  123.   I highly recommend you backup your BBS's relevent data files before
  124.   running PADi, especailly for the first time.
  125.  
  126.   Usage    : PADI <configuration filename> <log filename>
  127.  
  128.   Examples : PADI PADI.CFG PADI.LOG
  129.              Uses the PADI.CFG as a configuration file and logs to PADI.LOG.
  130.  
  131.              PADI RENEGADE.CFG
  132.              Uses RENEGADE.CFG as a configuration file, no logging is done.
  133.  
  134.  
  135. -= PADi configuration file
  136.  
  137.   PADi's configuration file is a regular text file with atleast 6 lines:
  138.    Line 1 - area style template
  139.    Line 2 - alternative template
  140.    Line 3 - skip areas that are too long
  141.    Line 4 - BBS software type
  142.    Line 5 - BBS data directory
  143.    Line 6 - .NA files (wildcards and multipal lines allowed), blank line ends
  144.  
  145.   area style template MCI:
  146.    ~&1 - echoname
  147.    ~&2 - description
  148.  
  149.   skip areas that are too long (first character is read, case insensitive):
  150.    YES,TRUE  - skip
  151.    NO,FALSE  - truncate
  152.    ALT       - use alternative (if still too long, skip)
  153.  
  154.   BBS software types:
  155.    1 - RemoteAccess v2.0x  (same as v2.50)
  156.    2 - RemoteAccess v2.50
  157.    3 - Renegade v10-05 Exp (compatible with 04-06/05-11)
  158.    4 - ProBoard v2.15
  159.    5 - T.A.G. v2.7
  160.    6 - Telegard v3.0x
  161.    7 - SuperBBS v1.17
  162.    8 - Nexus v0.99.b09
  163.  
  164.   The BBS data directory is where youe message areas file is.
  165.  
  166.  
  167. -= BACKBONE.NA-style file format
  168.  
  169.   Maximum length of the area tag is 25 characters.  Maximum length of
  170.   the description is 56 characters.
  171.  
  172.   A *.NA file must be in the format:
  173.     <Area name>  <Area description>
  174.  
  175.   Examples:
  176.     X.GENERAL    General discussion
  177.     CHATTER      Chit-Chat
  178.  
  179.   Area description starts after the area name.
  180.  
  181.   Area name can NOT contain spaces, however underscores (_) are allowed.
  182.  
  183.   Spaces between the two are ignored.
  184.  
  185.  
  186. -= Note to Nexus and ProBoard users
  187.   
  188.   PADi uses the message area description field, not the tagname field
  189.   for the tagname of the echo area.  If it was to use the tagname field,
  190.   it would change the area name constantly.  As soon as an areafix
  191.   auto-create standard or program becomes available for Nexus or
  192.   Proboard this may change.
  193.  
  194.  
  195. -= Template styles
  196.  
  197.   A couple templates I found.  Just stick in the first line of your PADi
  198.   configuration and go.  =)  And of course, any MCI codes your BBS
  199.   supports, like those for color, are fine with PADi.
  200.  
  201.   LinearNet              (Lin) ~&1 (~&2)
  202.   Maximus BBS            ~&1: ~&2
  203.   Nexus BBS              %080%[%150%IVNet%080%] %030%~&1
  204.   Psych0Style #1         [XNet] ~&2
  205.   Psych0Style #2         Fido ~&2
  206.  
  207.  
  208. -= Thank You, Mr. Psych0 Man
  209.  
  210.   I've put a good deal of time, money, etc. making PADi something useful
  211.   to others.  Those were entertaining and illumating hours, but if you
  212.   want me to continue, please indulge my fantasy that someone is
  213.   actually using it.
  214.  
  215.   The best way to tell me you like the program is to send me something.
  216.   Something material, like a postcard, would be appreciated most.  I'd
  217.   also be tickled to find e-mails, database additions, and... leave keep
  218.   your children.
  219.  
  220.   Andrew Ziem
  221.   3080 Woodview Ct.
  222.   Colorado Springs, CO 80918-4635
  223.   The United States of America
  224.   North American Continent
  225.   Earth
  226.   Third Planet in the Sol System (G2V)
  227.   Orion Arm
  228.   Milky Way Galaxy
  229.   Local Cluster
  230.   And a Cherry On Top
  231.  
  232.  
  233. -= Where in the world is Psych0?
  234.  
  235.   Andrew Ziem is Psych0 and Psych0Soft.
  236.  
  237.   Bug reports, comments, suggestions, and constructive flames welcome.
  238.  
  239.   E-mail      psych0o@juno.com
  240.   FidoNet     1:128/234: RA_UTIL, RENEGADE_BBS, TG_SUPPORT
  241.   Direct      Psychosis BBS
  242.                +1 (719) 532-0053 -- Zoom v34
  243.                +1 (719) 532-1265 -- Supra v34
  244.                login: GUEST  password: GUEST
  245.  
  246.  
  247. -= Distribution
  248.  
  249.  
  250.   FidoNet     1:128/234, F'REQ: PADi
  251.  
  252.   Direct      Psychosis BBS
  253.               (details above)
  254.  
  255.   WWW         http://www.angelfire.com/co/psych0o/psoft.html
  256.  
  257.   FTP         ftp.simtel.net/pub/simtelnet/msdos/
  258.               telegard.net/pub/tg                    (Telegard / TG_SUP)
  259.               ra.uti.com                             (RemoteAccess / RADIST)
  260.               pcmirco.com                            (RemoteAccess / RADIST)
  261.  
  262.  
  263. -= Acknowledgments and credits
  264.  
  265.    Cott Lang, Mark May, Tim Strike and the many others who support
  266.    freeware.
  267.  
  268.    David van Driessche's <david@firstclass.be> TXMSstr unit--allows XMS
  269.    usage.
  270.  
  271.    Eric Marschner for his bulletin style.
  272.  
  273.    Holger Daehre's LONGARR unit--allows me to use EMS.
  274.  
  275.    Mark May's MKMSG unit for the buffered file routines.
  276.    
  277.    Nexus         Intuitive Vision Software
  278.    T.A.G.        The T.A.G. Team
  279.    Telegard      Tim Strike
  280.    RemoteAccess  Wantree Development & Andrew Milner
  281.    Renegade      Cott Lang
  282.    SuperBBS      Risto Virkkala & Aki Antman
  283.    ProBoard      Philippe Leybaert
  284.  
  285.    All other programs are copyright and/or trademarked by their
  286.    respective author unless otherwise noted.
  287.  
  288.  
  289. -- End of file "PADI.DOC"
  290.  
  291.