home *** CD-ROM | disk | FTP | other *** search
/ ARM Club 3 / TheARMClub_PDCD3.iso / hensa / internet / fidomail_1 / !FidoMail / Dox / Variables < prev    next >
Text File  |  1994-02-19  |  6KB  |  129 lines
  1. FidoMail variables
  2. ------------------
  3.  
  4. There's some things for you to alter here too, if you wish to customise
  5. FidoMail at a low level. All major filenames and directories can be reset to
  6. point anywhere reasonable.
  7.  
  8. By default, the variables are set in the '!SetVars' file, which usually resides
  9. in the 'Config' directory:
  10.  
  11. SetEval FM%LogLevel   100
  12. Set FM$Inbound$Dir    <Inbound><FM$Postfix>
  13. Set FM$Outbound$Dir   <Outbound><FM$Postfix>
  14. Set FM$CurDomain$Dir  <FM$Domains$Dir>.<FM$Domain>
  15. Set FM$MsgBase$File   <FM$CurDomain$Dir>.Msgs.Heap
  16. Set FM$FSMap$File     <FM$CurDomain$Dir>.Msgs.FSMap
  17. Set FM$AreaLinks$File <FM$CurDomain$Dir>.Msgs.AreaLinks
  18. Set FM$BaseState$File <FM$CurDomain$Dir>.Msgs.BaseState
  19. Set FM$FileLists$Dir  <FM$CurDomain$Dir>.FileLists
  20. Set FM$AreaMap$File   <FM$CurDomain$Dir>.Misc.AreaMap
  21. Set FM$OrigAreas$File <FM$CurDomain$Dir>.Misc.OrigAreas
  22. Set FM$Book$File      <FM$CurDomain$Dir>.Misc.!AddrBook
  23. Set FM$Sig$File       <FM$CurDomain$Dir>.Misc.sig
  24. Set FM$Config$File    <FidoMail$Dir>.Config.Main
  25. Set FM$Limits$File    <FidoMail$Dir>.Config.!Limits
  26. Set FM$Log$File       <FidoMail$Dir>.Log
  27.  
  28. And their meanings are:
  29.  
  30. FM%LogLevel (number)    This variable controls how much information is put in
  31.             the logfile. See below for more details
  32. FM$Inbound$Dir        This var contains the name of the directory when the
  33.             inbound packets are to be found.
  34. FM$Outbound$Dir        This var says where to put the outbound packets.
  35. FM$CurDomain$Dir    This var is just used to set the next ones easier.
  36. FM$MsgBase$File        The filename of the messagebase file. See below for an
  37.             example of usage.
  38. FM$FSMap$File        The name of the msgbase freespace map.
  39. FM$AreaLinks$File    The name of the message-link file.
  40. FM$BaseState$File    The name a file describing the messagebase state.
  41. FM$FileLists$Dir    The name of a directory containing the filelists.
  42. FM$AreaMap$File        A map of your downlinks and which echos they get.
  43. FM$OrigAreas$File    A file for spotting when the areas changes.
  44. FM$Book$File        A file containing the address book.
  45. FM$Sig$File        Not used by FidoMail, but by the UUCP scanner, which I
  46.             haven't released yet.
  47. FM$Config$File        The name of the Config file.
  48. FM$Limits$File        The name of the limit file.
  49. FM$Log$File        The name of the logfile.
  50.  
  51. If you are running FidoMail from a floppy, it is a very good idea to place
  52. the messagebase file on the ram-disc. Do this by changing this line in the
  53. !Run file:
  54.   Set FM$MsgBase$File <FidoMail$Dir>.Msgs.Heap
  55. to:
  56.   Set FM$MsgBase$File RAM:$.Heap
  57. You could also make Copy commands in the !Run file to transfer the file
  58. to/from ram automatically.
  59. If you have space on the ram-disc for the Inbound directory, put it there too.
  60. This will give a major speed increase when tossing. Remember to tell Binkley
  61. about this too!
  62.  
  63. If you wish to experiment with moving the files about, you might want to know
  64. something about what and when they are used.
  65.  
  66. The use of FM$Log$File depends on the loglevel, and if it is non-0, it will be
  67. updated at many different times. 100 is normal, 1000 yields a lot of debugging
  68. info. If it is 0 the file is still opened and closed, but no information is
  69. output. If you want to get rid of the file altogether, set FM$Log$File to
  70. "null:". The FM%LogLevel doesn't matter, then.
  71. You can control whether the log file should be kept open, (which is faster,
  72. especially on floppy) or closed when the program is running. 
  73.  
  74. FM$Inbound$Dir is only used when tossing and unarcing.
  75.  
  76. FM$Outbound$Dir is used when file requesting, dispatching and scanning.
  77.  
  78. FM$MsgBase$File is used very often, and must be put at the fastest device you
  79. can think of. It is usually also the largest one, so a harddisc is the most
  80. obvious place to put it. If you want to make a backup of the messages, it is
  81. vitally important that you copy _ALL_ the files in the Msgs directory or
  82. wherever they might be (i.e. FM$MsgBase$File, FM$FSMap$File, FM$AreaLinks$File,
  83. and FM$BaseState$File), treat them as a single item, and restore them together.
  84. They point into each other, and if one of them gets 'out of sync' with the
  85. others, _anything_ might happen!
  86. If you lose one of them, the reaction depends on which one:
  87. Losing the msgbase file obviously means that all the messages are lost. You
  88. must delete the other files in that case.
  89. Losing the Arealinks file will mean that you lose the information about where
  90. to find the messages in the msgbase file. This is in effect the same as losing
  91. the messages, but if some of them are really important, you will still be able
  92. to cut them out of the msgbase file with an editor.
  93. Losing the freespace map is not as fatal as it sounds. You will end up with a
  94. msgbase file which is larger than actually needed, but you will still be able
  95. to read the messages quite safely. If you know the FSMap file has been
  96. corrupted, it is therefore safer to just delete it. When you've finished using
  97. the larger-than-needed msgbase (and saved any important messages elsewhere),
  98. delete the msgbase, arealinks and fsmap to start from scratch and regain the
  99. lost disc space.
  100. Losing the basestate currently isn't that important. When you start FidoMail
  101. it will assume that the messages are sorted 'by area'. If you have specified
  102. something else in the Config file, it will sort them at once after starting.
  103. If you haven't, you might see some strange behaviour until you sort them
  104. manually from the iconbar menu, so if you do this at once, everything will be
  105. fine.
  106.  
  107. FM$FSMap$File is loaded at startup and saved when quitting. It is also saved
  108. just before a toss to avoid running out of disc space afterwards. A tidy or
  109. heapcheck operation will also save it.
  110.  
  111. FM$AreaLinks$File is loaded at startup and saved when quitting. This file is
  112. also saved before tossing. If you have 'SafeHeap' turned on, both the FSMap and
  113. the AreaLinks will be saved when major changes are made to them.
  114.  
  115. FM$BaseState$File is read at startup and written if you sort the message base
  116. or change AKA.
  117.  
  118. FM$FileLists$Dir is checked for validity at startup and scanned when you
  119. request a file or open the request submenu.
  120.  
  121. FM$AreaMap$File is read at startup and saved whenever it changes. This includes
  122. when messages to AreaFix comes in, when you add or delete areas in the Config
  123. file, and clicking 'Save' in the Area map window of course.
  124.  
  125. FM$OrigAreas$File is read and updated at startup.
  126.  
  127. FM$Config$File and FM$Limits$File are read at startup only.
  128.  
  129.