home *** CD-ROM | disk | FTP | other *** search
/ Amiga Times / AmigaTimes.iso / programme / trionbbs110 / Trion / docs / Utils / areafix.doc < prev    next >
Encoding:
Text File  |  1998-10-06  |  17.0 KB  |  558 lines

  1.  
  2.  
  3.    =====( Areafix V1.10 )============================================
  4.  
  5.  
  6.         Trion areafix Utility.
  7.  
  8.         (c) Copyright Paul Spijkerman, '95-'98. All rights reserved.
  9.  
  10.         Written escpecially for use with the Trion BBS package.
  11.  
  12.  
  13.    ===================================================================
  14.  
  15.  
  16.    Trion Areafix is a program that lets a User control the echomail
  17.    sections and tick file sections he is connected to.
  18.    By writing netmail to the areafix program he can connect
  19.    sections, disconnect sections and ask a list with the sections
  20.    he has access to.
  21.  
  22.  
  23.  
  24.       Features:
  25.  
  26.     -Connect or Disconnect echomail and tick (file) sections.
  27.  
  28.     -Commands to connect or disconnect 'All' sections or all
  29.      echomail or all file (tick) sections.
  30.  
  31.     -Produce 'short' or 'long' lists of echomail or tick sections.
  32.      List can be of All sections, echomail sections, file sections,
  33.      linked or unlinked sections.
  34.  
  35.     -Connect or Disconnect all sections temporarily with
  36.      %Pause and %Resume commands.
  37.  
  38.     -Changing the compression methode for mail compression.
  39.  
  40.     -Changing the Areafix, Tick or mail and session password.
  41.  
  42.     -Echomail sections can be 'locked' with the obligatory flag
  43.      in the mailareas.cfg so they can't be disconnect.
  44.      Which is usefull is a BBS has a 'point' section to inform
  45.      points about changes in access and new services.
  46.  
  47.     -Bounce netmail for unknown nodes.
  48.  
  49.  
  50.  
  51.  
  52.    A user has to write a netmail to the netmail address of
  53.    his boss (the netmail number of the net the wants access to)
  54.    with name Areafix or Filefix in the 'To Name' field and the
  55.    correct password on the subject line.
  56.    In the Message itself the user will place the command's he
  57.    want to send to AreaFix.
  58.  
  59.  
  60.    Areafix will process the message, do the fixes and sends
  61.    a message back with the changes it has made.
  62.    What areafix does during fixes is change the mail.cfg so that
  63.    a nodenumber is added or removed from the list under a 
  64.    section TagName.   
  65.    If there is no Tagname found in the mail.cfg for the section a
  66.    user wants to connect, it will be added with the nodenumber
  67.    of this user.
  68.    Areafix will set the Received flag of the messages it acted
  69.    on so it knows which netmail it has processed when it is
  70.    started later.
  71.    If areafix will receive a message with a wrong password it
  72.    will send an errormessage back but will no attempt to
  73.    interpret the message.
  74.  
  75.  
  76.  
  77.  
  78.  
  79.  
  80.  
  81.       Note: To be compatible with other program's and to be able to
  82.       act on replies of messages from areafix Trion Areafix
  83.       will react on the folowing names (in Upper or lower case):
  84.       "AreaFix", "AreaMgr", "AreaLink", "EchoMgr", "NewEcho",
  85.       "Tron AreaFix" and "Trion AreaFix".
  86.  
  87.  
  88.  
  89.     Available commands are (maybe used in upper and lowercase):
  90.  
  91.  
  92.     %+ALL                 Connect all available sections
  93.     %-ALL                 Disconnect all available sections
  94.     %LIST                 Send a list of all available sections with status
  95.     %LINKED               Send a list of all connected sections
  96.     %UNLINKED             Send a list of all disconnected sections
  97.     %HELP                 Send a message with help text
  98.     +AreaTagName          Connect section with name "AreaTagName"
  99.     -AreaTagName          Disconnect section with name "AreaTagName"
  100.  
  101.  
  102.  
  103.  
  104.  
  105.     %HELP                 For this text.
  106.  
  107.     %+ALL                 To Connect all sections for this nodenumber.
  108.     %-ALL                 To Disconnect all sections for this nodenumber.
  109.     %+MSGS                To Connect all message sections.
  110.     %-MSGS                To Disconnect all message sections.
  111.     %+FILES               To Connect all file sections.
  112.     %-FILES               To Disconnect all file sections.
  113.     %PAUSE                Put all sections on hold.
  114.     %RESUME               Resume all sections paused before.
  115.  
  116.     %COMPRESSION=arc      Change compression methode (LHA, LZX, ARJ).
  117.     %PASSWORD=pass        Change Areafix password.
  118.     %FILEPASSWORD=pass    Change Tick password.
  119.     %ECHOPASSWORD=pass    Change echomail and session password.
  120.  
  121.     %SHORT                Switch to short list mode.
  122.     %LONG                 Switch to long list mode.
  123.  
  124.     %LIST                 For a list of all sections for this nodenumber.
  125.     %MSGS                 For a list of all message sections.
  126.     %FILES                For a list of all file sections.
  127.     %LINKED               For a list of all connected sections.
  128.     %UNLINKED             For a list of all disconnected sections.
  129.  
  130.     TagName               To Connect section 'TagName'.
  131.     +TagName              To Connect section 'TagName'.
  132.     -TagName              To Disconnect section 'TagName'.
  133.  
  134.  
  135.  
  136.  
  137.     Remote use:
  138.     ===========
  139.  
  140.  
  141.     Making the connection:
  142.     ----------------------
  143.  
  144.     Sections can be connected by just putting their name in
  145.     a message on an empty line. (with or without a leading '+'
  146.     character.
  147.  
  148.     Sections can be disconnected by putting their name on an
  149.     empty line with a leading '-' in front of them !!
  150.  
  151.     Also multiple sections can be connected by using the
  152.     +ALL, +FILES or +MSGS commands.
  153.  
  154.  
  155.     When Areafix receives A message to connect or disconnect
  156.     echomail sections it will make changes to the mail.cfg file in
  157.     the configuration directory.
  158.  
  159.     File sections will be changed in the filenet.cfg
  160.  
  161.     When an echomail section didn't exist in mail.cfg when a user tried
  162.     to connect it it will be generated.
  163.  
  164.     Note that you have to put comment lines in the mail.cfg
  165.     on empty lines, because if areafix has to change a line
  166.     the comments on that line are lost.
  167.  
  168.  
  169.     Lists
  170.     -----
  171.  
  172.     Areafix has a short and long list mode.
  173.     The description of a section now can be 79 characters which
  174.     can scramble the whole list.
  175.     Also newsgroup names can be very long.
  176.  
  177.     The short list is like the list in the previous version.
  178.  
  179.     TagName                      "Description"              Connected
  180.     TagName                      "Description"              Connected
  181.  
  182.     The long list puts the description on a separate line
  183.  
  184.     Area: TagName                                           Connected
  185.     Desc: "Description of this echomail message section."
  186.  
  187.     Area: TagName                                           Connected
  188.     Desc: "Description of this echomail message section."
  189.  
  190.  
  191.     Default the program will startup in shortlist mode, unless it
  192.     was started with the -L flag, then it will produce long lists.
  193.  
  194.     But this can be overruled with commands in the fix messages.
  195.  
  196.     %SHORT       Switch to short list mode.
  197.     %LONG        Switch to long list mode.
  198.  
  199.  
  200.     Pause and Resume:
  201.     -----------------
  202.  
  203.     Areafix has %PAUSE and %RESUME commands, so a 'user'
  204.     can temporary disconnect hisself.
  205.  
  206.     When a %PAUSE command is received a file with a list
  207.     of all currently connected sections will be made,
  208.     and then all sections will be disconnected.
  209.  
  210.     When a %RESUME command is received the file with the list
  211.     will be read and all sections in the list will be connected.
  212.  
  213.     The list file will be placed in the trion:users/
  214.     directory and will have the 4 numerical fields of
  215.     a nodenumber in the name separated with points and
  216.     .fix as extension.
  217.  
  218.     If for instance node 14:103/300 would send a %PAUSE command
  219.     a file called 14.103.300.0.fix would be created.
  220.  
  221.  
  222.  
  223.     Changing passwords and compression methode:
  224.     -------------------------------------------
  225.  
  226.     Areafix has options to change the compression methode and
  227.     mail/session, tick or areafix password.
  228.  
  229.  
  230.     %COMPRESSION=arc    Change compression methode (LHA, LZX, ARJ).
  231.     %ECHOPASSWORD=pass  Change echomail and session password.
  232.  
  233.     The Compression and Echopassword commands will change the
  234.     systems.cfg
  235.  
  236.  
  237.     %FILEPASSWORD=pass      Change file password.
  238.  
  239.     This command will change the filenodes.cfg
  240.  
  241.  
  242.     %PASSWORD=pass          Change Areafix password.
  243.  
  244.     This command will change the areafix.cfg
  245.  
  246.  
  247.     %COMPRESSION, %ECHOPASSWORD and %FILEPASSWORD are smart(ish)
  248.     if there was no entry in the configs for the node one will
  249.     be added.
  250.  
  251.  
  252.     Note that you should NOT end node lines in the systems.cfg with comments
  253.     because if something in that line is changed the comment is gone.
  254.     Also the line would change in length.
  255.     (this note is valid for all cfgs that are changed by programs)
  256.  
  257.     So don't use comments like this:
  258.     
  259. 350:1001/0    LHA   XXXXXX     ;My boss
  260.  
  261.     If you want to use comments do it on separate line like this:
  262.  
  263. ;===(  Node #1, User so and so  )===
  264.  
  265. 350:1002/100.2  LHA  XXXX
  266. 350:1002/2      LHA  XXXX
  267. 350:1002/200    LHA  XXXX
  268.  
  269. ;===(  Node #2, Yet another user  )===
  270.  
  271. 14:103/300.3    LHA  XXXXXX
  272. 39:155/300.3    LHA  XXXXXX
  273. 350:1002/100.3  LHA  XXXXXX
  274. 55:1100/1111.3  LHA  XXXXXX
  275. 210:1010/300.3  LHA  XXXXXX
  276. 606:3150/101.3  LHA  XXXXXX
  277.  
  278. ;===(  My big boss  )===  Fido, Trion, AMY, NLA, AGA, F1
  279.  
  280. 2:283/326     LHA   XXXXXX
  281. 350:1001/0    LHA   XXXXXX
  282. 350:1001/1    LHA   XXXXXX
  283. 350:1001/100  LHA   XXXXXX
  284. 39:155/0      LHA   XXXXXX
  285. 39:155/100    LHA   XXXXXX
  286. 14:103/0      LHA   XXXXXX
  287. 14:103/1      LHA   XXXXXX
  288. 14:103/100    LHA   XXXXXX
  289. 171:109/0     LHA   XXXXXX
  290. 171:109/1     LHA   XXXXXX
  291. 171:109/100   LHA   XXXXXX
  292. 606:3150/0    LHA   XXXXXX
  293. 606:3150/1    LHA   XXXXXX
  294. 606:3150/100  LHA   XXXXXX
  295.  
  296.  
  297.  
  298.     Obligatory echomail sections:
  299.     -----------------------------
  300.  
  301.     You can create echomail message sections that users can't
  302.     disconnect with Areafix.
  303.  
  304.     This is usefull if you have an echomail section to inform
  305.     your points of all sort of matters around the BBS.
  306.     If you have such an echo to tell users that you for
  307.     instance will change the phone number of the BBS,
  308.     you don't want everybody to disconnect.
  309.  
  310.     If you have such a section you can add the "O" flag
  311.     for "Obligatory" in the mailareas.cfg
  312.  
  313.     If a user get's a list with sections it now will
  314.     say "obligatory" where it says "connected" with normail
  315.     sections.
  316.  
  317.     The section can no longer be disconnected with a command
  318.     to DISconnect a section of disconnect all sections.
  319.     (new sysop curse)
  320.  
  321.     If a user writes a MESSAGE to areafix all the obligatory
  322.     sections will be connected if they were not connected before.
  323.  
  324.  
  325.  
  326.     Use by the sysop:
  327.     =================
  328.  
  329.     For areafix to process the messages from your points and nodes
  330.     it has to be started now and then, this could be done in
  331.     the 'Mail' script with is probably started after mail calls
  332.     or log offs .. the default mail script will start Areafix
  333.     after the mail processor was started in Unpack mode and if
  334.     there was mail in the inbound directory.
  335.  
  336.     Start Areafix with the F (fix) command to just process
  337.     incoming netmail from nodes and points.
  338.  
  339.     Areafix has a few other options which are interesting
  340.     for the sysop.
  341.  
  342.  
  343.        F  = fix.                           (areafix F           )
  344.        S  = send notices.                  (areafix S           )
  345.        N  = send notice to 1 node.         (areafix N NODENUMBER)
  346.        C  = same as N and connect all.     (areafix C NODENUMBER)
  347.        R  = same as N and disconnect all.  (areafix R NODENUMBER)
  348.  
  349.  
  350.     With the S (send notices) command he can send netmail
  351.     to all nodes with contains a list of all available
  352.     sections with their status (connected/disconnected).
  353.  
  354.     Note that this options only sends netmail to the points/nodes
  355.     who have a SEND flag in the areafix.config.
  356.  
  357.     The N option does almost the same but for 1 node, this can be
  358.     usefull when you want to tell a new node that he is connected
  359.     to the system, and give him a list of the sections which are
  360.     available to him.
  361.  
  362.     The C and R options also send a Notice netmail to a point/node
  363.     be also connect or disconnect all available sections to this
  364.     point/node.
  365.  
  366.  
  367.     Note that if areafix is given the command to send notices it
  368.     will search for the Sysop Name of points and nodes in the
  369.     pointlist or nodelists, if no name is found the messages will
  370.     be directed to "Sysop" .. and probably don't attract the
  371.     attention of the sysop, so keep your nodelist and/or pointlist
  372.     uptodate when connecting new nodes/points.
  373.  
  374.  
  375.     Note that a (Trion) pointlist has a different format as a
  376.     nodelist, a pointlist has no hierarchic structure but only
  377.     lines like:
  378.  
  379.     Point,14:103/300.1,BBS_Name,City,Name,Tel_Number,baud,flags
  380.  
  381.     Where the "Point," field is fixed but all other fields has
  382.     to be edited with the information of the node/point.
  383.     "14:103/300.1" is a demonstration point number and also
  384.     has to be replaced. You can add all nodes and points that
  385.     are not in a nodelist to the pointlist, so you can also
  386.     add the number of your boss and you don't need a nodelist
  387.     note that you have to use the word "Point" in the first
  388.     field.
  389.  
  390.  
  391.     If areafix replies to a message it uses the name from the
  392.     original message, so no pointlist or nodelist is needed in
  393.     this case.
  394.  
  395.  
  396.  
  397.     A new user of areafix has to be added to the areafix configuration
  398.     file (trion:cfg/areafix.cfg).
  399.  
  400.     The areafix.cfg has the folowing format:
  401.  
  402.  
  403.  
  404. ADDRESSES
  405. zz:nnn/nnn.pp
  406. zz:nnn/nnn.pp
  407. zz:nnn/nnn.pp
  408. #
  409.  
  410.  
  411. GROUPS
  412. group_name1   nnn - nnn , nnn - nnn
  413. group_name2   nnn - nnn , nnn
  414. group_name3   nnn - nnn
  415. #
  416.  
  417.  
  418. NODES
  419. NodeNumber1  Password  SEND/NOSEND   OrigNodeNumber   [group(s)]
  420. NodeNumber2  Password  SEND/NOSEND   OrigNodeNumber   [group(s)]
  421. NodeNumber3  Password  SEND/NOSEND   OrigNodeNumber   [group(s)]
  422. #
  423.  
  424.  
  425.  
  426.  
  427.     The areafix.cfg exists of four groups, the first group is the
  428.     Addresses list where you put (all) your netmail addresses.
  429.     These addresses are used be areafix to check if the netmail
  430.     to areafix is directed to the correct system.
  431.     This part of the config can look something like this:    
  432.  
  433.  
  434.  
  435. ;  the adressess which AreaFix needs to check if a message
  436. ;  is adressed to him.
  437.  
  438. ADDRESSES
  439. 14:103/3              ; NLA
  440. 14:103/300
  441.  
  442. 39:155/3.0            ; AMY
  443. 39:155/300.0
  444.  
  445. 350:1002/0            ; Trion-net
  446. 350:1002/1
  447. 350:1002/100
  448.  
  449. 55:1100/0             ; DAN
  450. 55:1100/1
  451. 55:1100/1111
  452. #
  453.  
  454.  
  455.     The second group of lines is the list of echomail group definitions.
  456.     A group definition is a group name plus the ranges of
  457.     areanumber who are part of the group.
  458.     You probably want to make groups for each net you carry and
  459.     make different ones for points, nodes and donaters for instance.
  460.     A point probably doesn't have access to sysop sections so he get's
  461.     fewer sections as a node.
  462.     The sections of a group are listed as ranges after the groupname,
  463.     so   aaa - bbb , ccc  would mean that the group consists of
  464.     sections aaa until bbb and section ccc.
  465.     This part of the config can look something like this:    
  466.  
  467.  
  468.  
  469. ;   Defines groups of sections (nets to certain people)
  470. ;   by lists of ranges of the message sections
  471.  
  472. MAIL GROUPS
  473. TRON_SYSOP    51-99
  474. TRON_BETA     50-99
  475.  
  476. NLA_POINT     100 - 109 , 111 - 115 , 117 - 118 , 120 - 199
  477. NLA_NODE      100 - 109 , 111 - 118 , 120 - 199
  478. NLA_MODERATOR 100 - 109 , 111 - 199
  479. NLA_HUB       100 - 199
  480. #    ;END-OFF-MAIL-GROUPS
  481.  
  482.  
  483.  
  484.  
  485.     The third group of is the list of file (tick) group definitions.
  486.     Which works like the mail groups definitions
  487.     but revers to the ranges in the filenet.cfg
  488.  
  489.     Note that the FN_ part means file net and is especially done
  490.     to see the difference with the mail net names .. but you can use
  491.     every name you want.
  492.  
  493.  
  494.  
  495. FILE GROUPS
  496.  
  497. FN_TRION     100-199
  498. FN_NLA       200-299
  499. FN_AMY       300-399
  500. FN_NUN       400-499
  501.  
  502. #    ;END-OFF-FILE-GROUPS
  503.  
  504.  
  505.  
  506.  
  507.     The fourth group of lines is the list of nodes.
  508.     Each line starts with the nodenumber and is folowed
  509.     with a number of fields who relate to this nodenumber.
  510.     The first field is the password the user needs to use in
  511.     his message so areafix will process them.
  512.     The second field is a SEND/NOSEND flag which is used
  513.     when sending notices to determine is this node will
  514.     receive a notice (see earlier in this doc).
  515.     The third field is the Origin node number used in
  516.     netmail areafix will write to this node.
  517.     The last fields of this line is a list of group names
  518.     this node has access to.
  519.     This part of the config can look something like this:    
  520.  
  521.  
  522.  
  523.  
  524.  
  525. ;    NodeNumber  Password  SEND/NOSEND   OrigNodeNumber   [group(s)]
  526.  
  527. ;    Here you config all your points/nodes/hubs/hosts.
  528.  
  529. ;    if a node has a SEND flag , a message will be send if AreaFix
  530. ;    is started in 'send notices' mode.
  531.  
  532. ;    OrigNodeNumber is Used as the 'origin node number' in replies
  533. ;    from areafix.
  534.  
  535. NODES
  536. 350:1002/101  PASSWORD    SEND    350:1002/1  TRION_BETA  FN_TRION
  537. 350:1002/102  PASSWORD  NOSEND    350:1002/1  TRION_BETA  FN_TRION
  538. 350:1002/199  PASSWORD    SEND    350:1002/1  TRION_BETA
  539. #
  540.  
  541.  
  542.  
  543.  
  544.  
  545.  
  546.  
  547.     Note that areafix has an (optional) bounce netmail function.
  548.     If during the scanning of netmail a message which is not meant
  549.     for your system is found .. and if the destination node number
  550.     is not in a nodelist of pointlist it while send a netmail
  551.     back. But only if the system from which the system originates
  552.     is in a nodelist (or if it is a point.. if the Boss of the
  553.     point is in a nodelist) .. because else if both nodes are
  554.     not in a list Areafix is probably going to write a lot of
  555.     messages to itself (I think).
  556.  
  557.  
  558.