home *** CD-ROM | disk | FTP | other *** search
/ Aminet 10 / aminetcdnumber101996.iso / Aminet / comm / dlg / DBAreafix.lha / DBAreafix.doc < prev    next >
Text File  |  1995-10-14  |  19KB  |  570 lines
  1.  
  2. *****************************************************************************
  3. *****  DBAreafix V1.5c  *****  ©1995 by Denis Bucher  *****  Shareware  *****
  4. *****************************************************************************
  5.  
  6.  
  7. GENERAL FEATURES :
  8. ~~~~~~~~~~~~~~~~~~
  9.  
  10.     Includes :
  11.          - Change archiver
  12.          - User access to some areas or not
  13.          - Infinite AKAs : DBAreafix, Areafix, Mneurf... !
  14.              - FileManager : Handles with file-areas
  15.          - Complete log file
  16.          And all the common functions :-)
  17.  
  18.     Simple configuration :
  19.          - Configuration editor in DLG or CLI (very simple)
  20.          - Can be added in the DLGMail process cycle
  21.          - No conflits with DLG command "Renumber"
  22.          - You just have to use the DLGMail "MYADDRESS domains!address"
  23.             and replace domain with the name of the following areas.
  24.          - Ready !
  25.  
  26.     Free :
  27.          - Shareware NOT limited if unregistered
  28.     
  29.     UpToDate :
  30.          - I'll take your suggestions, and one week
  31.             after, you'll have YOUR version
  32.              - For example, version 1.5a is at least
  33.                 the 20th version !
  34.  
  35.  
  36.  
  37.  SUMMARY
  38.  ~~~~~~~
  39.                                                      (line)
  40.  
  41.   .....General Features.................................7.....
  42.   .....Summary.........................................37.....
  43.   .....Installation....................................57.....
  44.   .....Updates Installation...........................154.....
  45.   .....Configuration..................................167.....
  46.   .....DLGMail.xxx files..............................294.....
  47.   .....The File Manager...............................347.....
  48.   .....History........................................407.....
  49.   .....To Do..........................................520.....
  50.   .....Bugs...........................................538.....
  51.   .....Bug Report.....................................543.....
  52.   .....Sos Author Contact.............................552.....
  53.  
  54.  
  55.  
  56.  
  57. INSTALLATION :
  58. ~~~~~~~~~~~~~~
  59.  
  60.    You have two ways for the installation of DBAreafix. The first with the
  61. supplied AutoInstall Script.   The second in following the instructions of
  62. this documentation.
  63.  
  64.    If you want to install DBAreafix  with the AutoInstall  script (this is
  65. suggested), you'll just have to double click on it, or to type the follow-
  66. ing command in a Shell (CLI) window :
  67.  
  68.    c:Execute DBAreafix.autoinstall
  69.  
  70.    But  remember  that if you installed DBAreafix  with  this  AutoInstall
  71. script, you won't have completely installed it : DBAreafix is suggested to
  72. be included in the Sysop Menu in DLG Pro BB/OS. It isn't necessary, but is
  73. proved to be sometimes useful, especially when you are already in the BBS.
  74.  
  75.  
  76. Part I : Manual installation of AutoInstall stuff
  77. -------------------------------------------------
  78.  
  79.    Instead of reading this Part, you may prefer to execute AutoInstall  or
  80. to read the AutoInstall script itself.    The following statements are the
  81. conditions for DBAreafix to work.
  82.  
  83.    a) The DBAreafix executable must be in Doors:DBAreafix/ and must be called
  84.    "DBAreafix".
  85.  
  86.    b) You should add DBAreafix in the DLGMail Process Cycle :
  87.  
  88.     1. Close the netmail area access to avoid other programs' access
  89.     2. Execute DBAreafix
  90.     3. Reopen the netmail area to other programs
  91.  
  92.       To do that, add the following to FIDO:Batch/PRE_NetScan.DMB :
  93.  
  94.     DLG:CloseAreas -a "50" -k MultiDiapala -r DBAreafix -m -b
  95.     Doors:DBAreafix/DBAreafix
  96.     DLG:OpenAreas -a "50" -k MultiDiapala -m
  97.  
  98.       Refer to your DIALOG manual  if you want to understand the "CloseAreas"
  99.    and "OpenAreas" DLG commands.
  100.  
  101.  
  102. Part II : Manual installation
  103. -----------------------------
  104.  
  105.    Now that the main part is done, you just need to do facultative things.
  106.  
  107.    a) Assigns :  Just have these two devices assigned, or do it now :  For
  108. DBAreafix to work, you need LOGS: and DOORS:  to be assigned.  Add them to
  109. your Startup-Sequence  so  that  they  will  survive  the next reboot, and 
  110. add them now, for example in a Shell window. How to do that :
  111.  
  112. assign LOGS:  dh0:Logs/
  113. assign DOORS: dh4:BBSConfig/
  114.  
  115.    It's obvious that you don't need to use the same paths ;-)
  116.  
  117.    b) Add DBAreafix in the DLG Sysop menu :  Just go  to "Configure Menus"
  118. in your DLG BBS, and "Select" the SYSOP menu _for_ _example_.  Then select
  119. "Add menu" item and answers the questions the following way :
  120.  
  121.    [ 1] Letter:                   X
  122.  * [ 2] Executable: (path/name)   Doors:DBAreafix/DBAreafix CFG
  123.    [ 4] Description:              Areafix
  124.  * [ 5] Type:                     Executable
  125.    [ 6] Help File:                SYSOP/X
  126.  ! [ 7] Lower level:              255
  127.    [ 8] Upper level:              255
  128.    [ 9] Hidden:                   NO
  129.  * [10] Load type:                OVERLAY
  130.    [11] Ask user if sure:         NO
  131.  * [12] Pend messages:            YES
  132.  * [13] Cli mode:                 YES
  133.    [14] Pause on completion:      NO
  134.    [15] Log value:                None
  135.    [16] Activity string:          Configuring Areafix
  136.    [17] Priority:                 DEFAULT
  137.    [18] Edit help file
  138.  
  139.    The legend is :
  140.  
  141.  * = DON'T CHANGE !!!
  142.  ! = Beware : Users should NEVER have access to that !
  143.  
  144.  
  145.    Now, installation of DBAreafix is complete :-) I would suggest that you
  146. read now the "Configuration" chapter.
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154. UPDATES INSTALLATION :
  155. ~~~~~~~~~~~~~~~~~~~~~~
  156.  
  157.    Just execute the AutoInstall script ...
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167. CONFIGURATION :
  168. ~~~~~~~~~~~~~~~
  169.  
  170.    The way to configure DBAreafix can be summarized in one word, or rather
  171. in a single command :
  172.  
  173. DBAreafix CFG
  174.  
  175.    Now that you (maybe) configured a DLG menu to do that, you may also use
  176. the menu item instead of a CLI command,  but Doors:DBAreafix/DBAreafix CFG
  177. is always valid.
  178.  
  179.    When you enter the configuration menu, there is some choices going from
  180. 1 to 7. Just type number + RETURN to enter the sub-menu ...
  181.  
  182.    We will now review each configuration sub-menu, one by one,  but PLEASE
  183. REMARK that this documentaion about "configuration" is absolutely *not* ne
  184. cessary ... You could just enter the config and see yourself ...
  185.  
  186.    FIRST TIME suggested order : 3, 4, 7, 5 !
  187.  
  188.    0. Quit
  189.    -------
  190.       Just type RETURN to exit.  DBAreafix will there ask you  whether you
  191.    would like to save or not. Default (return or any key) is YES.
  192.  
  193.    1. Path
  194.    -------
  195.       This is the path to your Netmail area. If you enter "1", you will be
  196.    able to change it ... just in case !
  197.  
  198.    2. Last Message Parsed
  199.    ----------------------
  200.       This is the last message parsed, in your netmail area.  It shouldn't
  201.    normally be changed, but if you want to re-answer to an Areafix message
  202.    which would be message 345 and this displays 350, just enter 344 :-)
  203.  
  204.    3. BBS Name
  205.    -----------
  206.       This is the name displayed, for example in "Messages areas available
  207.    at #######", where ######## could be "The Home of the Programmer"
  208.  
  209.    4. Edit People/Passwords
  210.    ------------------------
  211.       In this sub-menu,  you will be able to edit the links you would like
  212.    to give an access to Areafix.
  213.  
  214.       If you choosed this sub-menu, you will be given two choices :
  215.    a) List/Add/Edit
  216.    b) List/Add/Remove
  217.  
  218.       It is very simple :  both have  the "list" and "add" functions,  but
  219.    each has in addition a third function, "edit" or "remove".
  220.  
  221.       Choose for example List/Add/Edit ...   You'll see  a *list*  of your
  222.    links, with two columns :  The first is their name, the second is their
  223.    Areafix password.
  224.  
  225.       One of the listed item is called "NEW".  If you choose "New", you'll
  226.    be able to *add* a new user to this list.
  227.  
  228.       If you choose an user, you'll be able to change his name and his
  229.    password : This is the *edit* function.
  230.  
  231.       Now, choose the second menu (List/Add/Remove).  You'll have exactely
  232.    the same possibilities of *listing* and *adding*, but instead of *edit*
  233.    you'll be *deleting* the choosen user.
  234.  
  235.    5. User Domains Access
  236.    ----------------------
  237.       It's obvious that  your links cannot have access  to any area. As an
  238.    simple example : The Sysops-reserved areas ... So each *type* of *area*
  239.    should be represented as an "DOMAIN".
  240.  
  241.       Examples of Domains :
  242.  
  243.    Sysop_Fidonet
  244.    Fidonet
  245.    Local_areas
  246.    Amiganet
  247.    Private
  248.    Adults_only
  249.  
  250.       COMPATIBILITY with DLGMail:
  251.       To define what domain an area belongs to, you just have to edit your
  252.    fido:DLGMail.are, that you should know very well. If you want to define
  253.    an other domain for all the _following_ areas, just add a MYADDRESS DLG
  254.    Mail command. For Example, to make 
  255.  
  256.       The Access is either '0' or '9'.  0 means no access and 9 means full
  257.    access.  If you need some other levels,  just ask me to add them in the
  258.    program.
  259.  
  260.       When entering this submenu,  you'll see the list of your links  with
  261.    their accesses. Just type the number of the link to edit him/she.
  262.  
  263.       When editing a link,  just type  the number of the access  to toggle
  264.    between "Access" and "No Access".
  265.  
  266.    7. Edit Domains
  267.    ---------------
  268.       Each domain must be known to DBAreafix by its name. This submenu has
  269.    only this aim : Edit the list of domains.  Read point 7. to obtain more
  270.    information about domains.
  271.  
  272.       The editing system (list/add/edit) is the same as in submenu 4.
  273.  
  274.    6. Remplacement Names
  275.    ---------------------
  276.       Your links must normally write to Areafix or DBAreafix. If you want,
  277.    you may enable them to write  to "The_nicest_areafix_never_seen"  or to
  278.    árèàfîx (in some exotic language ;-))
  279.  
  280.       The editing system (list/add/edit) is the same as in submenu 4.
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294. DLGMail.xxx Files :
  295. ~~~~~~~~~~~~~~~~~~~
  296.    Two files may be corrected by DBAreafix.  The first is DLGMail.are, the
  297. file where all your messages areas are defined. The second is DLGMail.bun,
  298. the configuration for the choosen packer of each of your users.
  299.  
  300.    DLGMail.Bun
  301.    -----------
  302.       We'll start with an example of two point entries in your DLGMail.bun
  303.    configuration file :
  304.  
  305. 2:301/317.3        ARCHIVER ZIP    TYPE HOLD
  306. 2:301/317.4        ARCHIVER LHA    TYPE HOLD
  307.  
  308.       A limitation of DBAreafix is that you must have "ARCHIVER", then one
  309.    *single* *space* (not 2, not a TAB),  then the archiver, either XXX for
  310.    ZIP, LHA, ... either XXXX for NONE.
  311.  
  312.    DLGMail.Are
  313.    -----------
  314.       Use this configuration file exactely as said in DLG Manual. The only
  315.    thing you must add for DBAreafix to work is to define *domains*. See at
  316.    chapter "Configuration/5." to understand that. The usage is very simple
  317.    as you just need to put the domain in MYADDRESS commands. The domain is
  318.    then valid for all following areas, until the next MYADDRESS. Just read
  319.    our example :
  320.  
  321. MYADDRESS Local!2:301/317.0
  322.  
  323. AREA    THOTP.C            950    (distribution list)
  324. AREA    THOTP.ASM        951    (distribution list)
  325. AREA    THOTP.CHAT        969    (distribution list)
  326. AREA    THOTP.TESTS        970    (distribution list)
  327.  
  328. MYADDRESS Fidonet!2:301/317.0
  329.  
  330. AREA    HUB3_NEWS        972    (distribution list)
  331. AREA    PGMRS-PROTO.CHF        973    (distribution list)
  332. AREA    CAFEDUCOIN.CHF        974    (distribution list)
  333.  
  334.       In the previous example, there is two domains.   The first is called
  335.    "Local" and the second "Fidonet". If one of your links has the follwing
  336.    access : Fidonet and NOT Local, he will be able to link itself to these
  337.    areas via DBAreafix : HUB3_NEWS, PGMRS-PROTO.CHF and CAFEDUCOIN.CHF.
  338.  
  339.  
  340.  
  341.  
  342.  
  343.  
  344.  
  345.  
  346.  
  347. The File Manager :
  348. ~~~~~~~~~~~~~~~~~~
  349.  
  350. Part I : General
  351. ----------------
  352.  
  353.    The  first thing to understand is what you need for the message part to
  354. work.   The  messages  themself  are  processed  by  a tosser, for example
  355. DLGMail  and  the  *areas* are processed by DBAreafix.  It is the same for
  356. the  files  :   The  file  areas  are  processed by DBFilemgr (included in
  357. DBAreafix)  where  the *files* are processed by another program (available
  358. in free shareware) called DBTicker.
  359.  
  360.    How  does the file areas work ?  Each file is followed (or preceded ;-)
  361. by  another  file, which has the format #?.TIC.  This "TICK" file contains
  362. all  information  about  the main file :  Password, sender, seen-by lines,
  363. name  of  the  main  file, etc ...  So when a .TIC file is found into your
  364. inbound  directory,  DLGMail calls your ticker program (DBTicker) who will
  365. process  the  file.
  366.  
  367.    You  don't  need  to know what DBTicker will do, and if you want please
  368. refer  to  DBTicker.doc, to be found with DBTicker.  You just need to know
  369. that  DBticker uses a file called fido:DBFile.ARE, which contains the file
  370. areas configuration.  DB*File*.ARE is to the file areas what DLG*Mail*.ARE
  371. is to the messages areas.
  372.  
  373.    The  Structure  of DBFile.ARE looks much like DLGMail.ARE :  On a line,
  374. you  have  the  keyword  FILEAREA,  spaces/tabs, the name of the directory
  375. where  the  files have to be kept, spaces/tabs, and the distribution list.
  376. The  name of the directories must be *4* *characters* long, dos convenient
  377. (No "/" or ":" but letters and numbers).  But all this should be explained
  378. in DBTicker.doc ...
  379.  
  380.  
  381. Part II : Your links
  382. --------------------
  383.  
  384.    For your links, the use of the Filemgr part is very alike DBAreafix, as
  385. it is the same program that does both works :-) They just need to write to
  386. "DBFilemgr" or any other name you configurated in the CFG menu.
  387.  
  388.  
  389. Part III : Configuration
  390. ------------------------
  391.  
  392.    The  configuration  of  the Filemgr part is the same as for the Areafix
  393. part ...  Just type "DBAreafix CFG" and choose the right menu :-)
  394.  
  395.    The  configuration  of the file areas is though an other problem, to be
  396. solved with DBTicker.
  397.  
  398.  
  399.  
  400.  
  401.  
  402.  
  403.  
  404.  
  405.  
  406.  
  407. HISTORY :
  408. ~~~~~~~~~
  409.  
  410.  1.0   |   5.6.94 First working version
  411.  1.1   |       94 Added different names for "Areafix" in CFG
  412.  
  413.  1.1 b |          Removed bugs
  414.        |   7.4.95 Added Domains/Access, disabled
  415.        |          Understand %ARCH, but not implemented
  416.  
  417.  1.1 c |   8.4.95 %ARCH IMPLEMENTED, user must be in dlgmail.bun
  418.  
  419.  1.1 d |  13.4.95 Domains/Access enabled, beta-version for 1.2a
  420.        |  14.4.95 Config: Name of BBS / domains addable without bugs
  421.        |  20.4.95 BUG removed : no more fidoaddress in other domains !
  422.  
  423.  1.1 e |  24.4.95 Finished amelioration of User name/pwd menu :
  424.        |          An unique MENU, and possibility of deleting somebody
  425.        |          AND : NOW 100% SECURE !!
  426.        |  25.4.95 No more stupid icon creation
  427.        |          NEW! : DBAreafix.Log !
  428.  
  429.  1.2   |  30.4.95 IMPORTANT BUGS REMOVED :
  430.        |          - DBAreafix understand Spot points (FMPT may be after MSGID)
  431.        |          - No more 2-5 times the same area displayed in lists
  432.  
  433.  1.2 a |  30.4.95 BUG REMOVED : Understand "PID:..."
  434.        |  30.4.95 BUG REMOVED : Understand "CHRS:..."
  435.        |   2.5.95 Able to read its field in User.msg
  436.        |   2.5.95 Updated internet adress.
  437.        |   2.5.95 *Really* able to read User.msg !
  438.        |   3.5.95 Able to write a new User.msg. Just don't use it.
  439.  
  440.  1.2 b |   3.5.95 NO MORE uses his own mark, but User.msg :-)
  441.        |          DLG:Renumber is therefore useable, and
  442.        |          DBAreafix 100% Secure on Netmail area Managing.
  443.        |   6.5.95 The list bug is now *completely* fixed :-)))
  444.  
  445.  1.2 c |   8.5.95 Removed all french / Optimized text strings
  446.        |          Archiver part secure.
  447.        |          Some code procedure optimised, corrected.
  448.        |          Autoinstall full working.
  449.        |          NewPrefs creator corrected.
  450.  
  451.  1.2 d |  11.5.95 Important feature added : Autoinstall in User.msg
  452.        |          (It was maybe a bug, as it is *vital* ;-)
  453.        |  12.5.95 Provisory improvement : + 20k memory !
  454.  
  455.  1.3 a |  14.5.95 Improved some routines
  456.        |          Notify when an area is NOT in DLGMail.Are
  457.        |  14.5.95 Small bugs removed on notifying «Area not found»
  458.  
  459.  1.3 b |  14.5.95 COMPLETELY reprogramed the Kludges procedure.
  460.        |          - Only MSGID is now required
  461.        |          - DBAreafix reads *all* Kludge without risks.
  462.        |          Understands %LANG AND informs user that
  463.        |           it isn't implemented.
  464.        |          Bug hopefully removed : Area not found displays
  465.        |           area name ;-)
  466.        |  14.5.95 Very HARD bug removed : After a FMPT Kludge,
  467.        |           DBAreafix was missing following kludges and
  468.        |           with this bugy >9 points weren't supported :-(
  469.  
  470.  1.3 c |  15.5.95 Small bug : array(-1) !
  471.        |  15.5.95 No more "loss of EOL" bug in DLGMail.BUN
  472.        |  16.5.95 Removed a strange unawaited bug about 5D
  473.        |           adresses : "You are 2:301/317.0@fidonet.org !"
  474.        |          Added VERSION for Preferences :-)
  475.        |  19.5.95 REPLY Kludge added
  476.  
  477.  1.3 d |  19.5.95 Beta-test removed : Now warns if *first* *area*
  478.        |           was not found, too.
  479.        |          Added "(none)" if user linked to >0< areas :-)
  480.        |          Bug removed : %list or %liSt work. (Not %LIST-only !)
  481.  
  482.  1.4 a |  26.5.95 Added a new kludge to DBAreafix replies : PID
  483.        |          Changed PREFS version : Now accepts
  484.        |           language preferences, and takes English for default.
  485.        |          Replaced american date (05-26-95) with european (26.05.95)
  486.        |          Bug removed : Date correct ;-))
  487.        |  27.7.95 Changed  addresses
  488.        |          Bug removed about registration/unregistred not displayed
  489.        |  28.5.95 Completely reviewed the internal struct of menus.
  490.  
  491.  1.4 b |  29.5.95 Corrected menu displayed text
  492.        |          Now replies with the MSGID: signature
  493.        |          And uses the REPLY kludge :-)
  494.        |          I discovered that your address wasn't 2:301/317 !
  495.        |          Address generation more correct ...
  496.  
  497.  1.5 a |   3.6.95 DBAreafix is also **DBFilemgr** ... We'll see if it works
  498.        |   9.6.95 Serious bug removed
  499.        |  15.6.95 Small bug removed
  500.        |  15.6.95 Added date of sent request in message
  501.        |  20.6.95 INTL Kludge was buggy : Now, no more buggy !
  502.  
  503.        |   5.7.95 Very important bug removed : Sometimes, DLGMail.ARE was
  504.        |           deleting itself. Error found and corrected :-)
  505.        |          Some small improvements...
  506.        |  15.7.95 Corrections to the Filemgr part
  507.  
  508.  1.5 b |  21.7.95 Now COMPLETE Filemgr support. Not completely documented,
  509.        |           but working nice !
  510.        |          Understand TID: Kludge
  511.        |          Supports RFC Kludges (from internet)
  512.        |  21.7.95 New functions in menu : Filemgr AKAS and Languages
  513.        |   2.9.95 Understand DOMAIN kludge
  514.        |  8.10.95 More stack added (60kb instead of 40kb)
  515.  
  516.  1.5 c | 14.10.95 Small log change
  517.  
  518.  
  519.  
  520. TO DO :
  521. ~~~~~~~ 
  522.      Implement :
  523.     %LANG
  524.  
  525.      Correct that limitation:
  526.     %arch : ARCHIVER (in DLGMail.BUN) must be followed
  527.         by *one* *space* (no tabs, no two spaces)
  528.  
  529.      Documentation :
  530.         Add an index
  531.  
  532.      Others :
  533.         Just suggest !
  534.  
  535.  
  536.  
  537.  
  538. BUGS :
  539. ~~~~~~
  540.      None known, except "those" here in "TO DO".
  541.  
  542.  
  543. BUG REPORT :
  544. ~~~~~~~~~~~~
  545.      If you find a small bug, I garantee to fix it in three days !!!
  546.      If it is bigger ... let's say ... 1.5 week ?
  547.  
  548.  
  549.  
  550.  
  551.  
  552. SOS CONTACT :    (if my addresses are no more valid)
  553. ~~~~~~~~~~~~~
  554.  
  555.      1) Try Denis Bucher @ 2:301/317.0 (fidonet)
  556.         or denis.bucher@thotp.fn.alphanet.ch
  557.         or dbucher@alphanet.ch
  558.  
  559.      2) Ask Michel Roch at 2:301/315 where you can join me.
  560.  
  561.      3) Write to my postal address :-))
  562.  
  563.      4) Ask anybody in 2:301/3xxx to find me (or him) in the nodelist.
  564.      5) Ask anybody in 2:301/3xxx to find Bertrand Schmitt in the nodelist.
  565.  
  566.  
  567.  
  568.  
  569.  
  570.