home *** CD-ROM | disk | FTP | other *** search
/ ARM Club 3 / TheARMClub_PDCD3.iso / hensa / internet / fidomail_1 / !FidoMail / Dox / Config < prev    next >
Text File  |  1994-02-19  |  11KB  |  279 lines
  1. Config file syntax
  2. ------------------
  3.  
  4. The Config file contains information about your system and your preferences.
  5. It consists of lines of the following form:
  6.  
  7. <command> <parametres>
  8.  
  9. If the first char on a line is '|', the rest of the line is ignored.
  10. The <command> is one of the words defined below.
  11. The <parametres> are any numbers or strings required by the command, separated
  12. by spaces.
  13. Strings must be surrounded by "" if they contain spaces.
  14. The order of the commands is currently of no significance.
  15.  
  16. Mandatory commands.
  17. -------------------
  18. There are certain commands which MUST be there. These are:
  19.  
  20.     Address <zone>:<net>/<node>.<point>
  21.  
  22. This is to tell FidoMail your fidonet address.
  23.  
  24.     Sysop <name>
  25.  
  26. Your name for writing mail, and for spotting mail addressed to you.
  27. The 'Address' and 'Sysop' commands actually just set the first AKA you have.
  28. You can therefore omit them and have an AKA line instead, if you wish.
  29.   
  30.     Origin <origin_line>
  31.  
  32. This line is written at the bottom of your echomails. See the 'ExpandInfo' file
  33. if you wish to have a fancy origin line.
  34.  
  35.     RouteMap <dest_addr> <scan_addr> [H]
  36.  
  37. You should have at least one of these lines. It tells FidoMail how to route
  38. netmails, normally they are all routed to your boss. More details below.
  39.  
  40. Also, you must have a 'SetArea' command for both netmail and junk, these are
  41. described below.
  42.  
  43. Other commands.
  44. ---------------
  45.  
  46.     Include <filename>
  47.  
  48. This command can be used to split the configuration into several files.
  49. You could, for example, have a separate file with the area-definitions
  50. (described below), and then use 'Include <FidoMail$Dir>.!Areas' in the main
  51. config file. DO NOT include a file from within itself!
  52.  
  53.     AKA <zone>:<net>/<node>.<point> <name>
  54.  
  55. This line will make FidoMail accept packets for other systems than the one
  56. given in the 'Address' line. You will need to use this if you are receiving
  57. packets from more than one node.
  58. The <name> is what name you want to use when writing from this address.
  59. You will be able to select which AKA to use from the summary and outgoing
  60. windows.
  61.  
  62.     SetArea <name> ECHO <id> [<options>]
  63.  
  64. This command is used for defining an area. You must define an area if you wish
  65. to be able to read and write messages in it.
  66. The <name> is any name you want to give to the area. It is usually a prettier
  67. version of the <id>. (Eg. "Archimedes Communications" instead of "ARCCOMMS")
  68. The <id> is the fidonet identifier of the area. (Eg. "ARCCOMMS")
  69. <options> is any number of these special keywords:
  70.  
  71. ReadOnly    If this is used, you will not be able to write messages in the
  72.         area.
  73. FileLists    This makes the 'Reply' button initiate a file request from the
  74.         sender of the message. Also, if you click in the message text,
  75.         the freq filename will be the first word of the line on which
  76.         you clicked.
  77.  
  78.     SetArea <name> NET
  79.  
  80. This command is used for defining the netmail area. You must have exactly one
  81. of these lines in your config file.
  82.  
  83.     SetArea <name> JUNK
  84.  
  85. This command is used for defining the junk area. As with netmail, you must
  86. have exactly one of these. The junk area is used if you get mail in an area
  87. which isn't defined. If you ever see mail in the junk area, check the area-ID
  88. with 'Full info' and define the area if you expect to receive more.
  89.  
  90.     RouteMap <dest_addr> <scan_addr> [H]
  91.  
  92. Lines of this form defines the route map. It is used for netmails only, and
  93. determines where to send them if they have got a specific destination address.
  94. For example, if you write a netmail to Australia, you wouldn't want your
  95. computer to actually call Australia and deliver the mail (unless you actually
  96. live there of course). Instead, you send the mail to your boss, who then in
  97. turn sends it to his boss and so on... until the mail arrives at it's
  98. destination. The way to do that is to set up different routes for different
  99. destinations. To define that example, if your boss is called 2:252/102.0:
  100.  
  101. RouteMap 3:*/*.* 2:252/102.0
  102.  
  103. So everything aimed at zone 3 (where Austalia is) will instead go to 252/102.
  104. The '*' means any number. Now, if you live in zone 2, you wouldn't want to
  105. write the above line for each possible zone, so there's an easier way. The
  106. RouteMap lines are checked from the top until FidoMail meets a line that
  107. matches the destination address. So, for example, to make everything to zone 2
  108. go direct, and everything else via 252/102, you would write:
  109.  
  110. RouteMap 2:*/*.* 2:*/*.*
  111. RouteMap *:*/*.* 2:252/102.0
  112.  
  113. Note that the stars in the <scan_addr> means that the real destination numbers
  114. will be used there. You should always have a '*:*/*.*' at the end of your
  115. RouteMap list, to ensure that there is always somewhere to send netmails.
  116. If you haven't got that, and a netmail comes in with a destination which can't
  117. be found in the route map, it will be put on hold for that destination, so
  118. your system will not begin calling anywhere unpleasant.
  119. (This is equivalent to a 'RouteMap *:*/*.* *:*/*.* H' at the end of the list)
  120.  
  121. Let's take a final example. You may need to send all national netmails to your
  122. boss, all international mail to another node, and if you have any points, you
  123. would want to put everything to those on hold for them to pick it up.
  124. So, if you are called 2:252/256.0, your boss is 2:252/102.0, and the
  125. international node is 2:254/27.0, you would write:
  126.  
  127. RouteMap 2:252/456.* 2:252/456.* H
  128. RouteMap 2:25?/*.*   2:252/102.0
  129. RouteMap *:*/*.*     2:254/27.0
  130.  
  131. There are some unknown things here: Appending an 'H' to the line means 'put the
  132. packet on hold', so your system won't dial out, but wait for someone to call
  133. and fetch the packet.
  134. '?' means 'any digit', so 25? matches the numbers from 250 to 259.
  135.  
  136. If the netmail has crash status, the routing is disabled.
  137.  
  138.     DummyPkt <addr>
  139.  
  140. When scanning, FidoMail will normally generate a 'dummy packet' to your
  141. boss. This is to force the mailer to call your boss, even if you don't have any
  142. mail for him. You may want to change this or turn it off (e.g. if your boss
  143. calls you), by writing another address or omitting this line.
  144.  
  145.     5DOutbond <directory>
  146.  
  147. This command will change the format of the outbound files. The files will then
  148. end up as '<FM$Outbound$Dir>.<directory>.zzzznnnn.ooooppppxx' instead of
  149. '<FM$Outbound$Dir>.nnnnooooxx'.
  150.  
  151.     Spark <pathname>
  152.  
  153. This command is used to define the location of Spark. It is needed if you
  154. wish to be able to use '-unarc' or '-sparkmail' or the equivalent menu entries.
  155.  
  156.     SparkMail <pathname>
  157.  
  158. This command is used to define the location of SparkMail. It is needed if
  159. you wish to be able to use '-sparkmail' or the equivalent menu entry.
  160.  
  161.     Quote <quote_header>
  162.     Footer <footer>
  163.     TearLine <tearline>
  164.  
  165. These commands defines the quote-header, footer, and tear line. See the file
  166. 'ExpandInfo' for details.
  167.  
  168.     ForwardFile <filename>
  169.     GroupSplit <filename>
  170.  
  171. These commands points to files, which defines the format of forwarded messages,
  172. and how saved groups should look. See the file 'SaveAGroup' for details.
  173.  
  174.     DateFormat <format>
  175.     TimeFormat <format>
  176.  
  177. These commands defines how you want the date and time to appear when using %d
  178. and %t in footers, quote-headers etc. The <format> is a string with the same
  179. syntax as Sys$DateFormat uses.
  180.  
  181.     WeedType <name> <flags>
  182.  
  183. This command defines a weedtype. See the 'WeedHelp' file for details.
  184.  
  185.     ArcMail <pattern>
  186.     MailPkt <pattern>
  187.  
  188. These commands defines what pattern is used when looking after inbound
  189. mail-files. ArcMail files are arc'ed MailPkt files, and are unarced before
  190. being tossed. See the default Config file for the most common definitions.
  191.  
  192.     BaseOrder <sort_method>
  193.  
  194. This command instructs FidoMail to keep the message base sorted with the given
  195. <sort_method>. The sort method is one of the following:
  196. 'Date',
  197. 'Subject',
  198. 'Sender',
  199. 'Area'.
  200. If any other method is given (or the command is missing), the 'Area'-method
  201. is selected. This order of the messages is not defined with this method
  202. (but in the current version, they are actually sorted by their size).
  203. The message base will be completely resorted after a toss. The 'Area' method
  204. is barely noticeable, but the others takes time. If you are using a floppy-
  205. msgbase and are tossing manually, it may become annoying.
  206. FidoMail keeps a record of how the base is currently sorted, and will keep it
  207. that way until you specify otherwise. If you change the sorting method using
  208. the Sort-menu, FidoMail will resort the messages next time it starts up.
  209. This can be avoided by _not_ having a 'BaseOrder' command in the Config file.
  210. The order of the base will then remain as after the last sort requested.
  211.  
  212.     EditAll
  213.  
  214. This command defines the default state of the 'Edit all' switch in the incoming
  215. window. Present=On.
  216.  
  217.     OutMaximise
  218.  
  219. This is what the outgoing editor does when you move beneath the bottom edge of
  220. the window. If there's room on the screen and this command is present, it will
  221. extend itself.
  222.  
  223.     OpenSummary
  224.     OpenStatus
  225.  
  226. Including these commands will open the summary and/or status windows whenever
  227. you start FidoMail.
  228.  
  229.     QuickToss
  230.  
  231. This will reserve space on the disc before tossing, so use it if you have the
  232. space. It will speed the toss up by about 1.8 times.
  233.  
  234.     AutoBook <mode>
  235.  
  236. If this line is omitted, the address book will never update itself unless
  237. requested by you. If it is present, you have 2 choices:
  238.  
  239. 1. AutoBook Quiet
  240. 2. AutoBook Confirm
  241.  
  242. 1. will make FidoMail change the address book, if it discovers that a known
  243.    person is using a different number. It will also add any unknown persons,
  244.    if you write netmail to them.
  245. 2. will do the same, but it will ask for confirmation before updating the
  246.    address book.
  247.  
  248.     AutoWeed <id> <flags>
  249.  
  250. Lines of this type defines an autoweed sequence. The <id> is the area
  251. identifier of the area you want to weed in, and the <flags> are equivalent
  252. to the ones in the WeedType command. When an autoweed is requested, the
  253. message base is weeded according to these lines, from the first to the last.
  254. That way you can have different 'expiry' dates on different areas, and you can
  255. choose to keep e.g. personal mail longer than all the rest.
  256. There are 3 special kinds of <id>:
  257. '<NET>' is the netmail area.
  258. '<JUNK>' is the junkarea.
  259. '<ALL>' will weed in all the areas.
  260.  
  261.     AutoWeedAfter <action>
  262.  
  263. This command will make FidoMail initiate an autoweed operation after <action>
  264. has happened. <action> can be one of:
  265. 'Scanning' will autoweed after scanning
  266. 'Startup'  will autoweed every time you start the program.
  267.  
  268. This command has no influence on your ability to use the -autoweed CLI-option.
  269.  
  270.     NoFuss
  271.  
  272. This command will disable the warnings given when you are about to discard an
  273. edited outgoing message.
  274.  
  275.     KeepLogOpen
  276.  
  277. Including this command will cause the log file to be kept open while FidoMail
  278. is running. The result is faster operation, especially on floppy.
  279.