home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / PTKTDOC3.ZIP / OMMM_150.DOC < prev    next >
Text File  |  1990-03-19  |  12KB  |  267 lines

  1. Documentation supplement for oMMM 1.50
  2.  
  3. This document is intended to be used in addition to the excellent
  4. oMMM document written by Alan Applegate titled version 1.30.
  5. This document explains the new features for version 1.50, and also
  6. attempts to point out the diffences between 1.50 and prior versions.
  7.  
  8. HIGHLIGHTS
  9. ==========
  10.  
  11. - Verbs OPUS and BINKLEY are now simply NAKED. Ommm operates in a request
  12. mode compatible with Opus. Use the verb NAKED or option -R to generate file
  13. requests ALA Binkley Style.
  14.  
  15. - Ommm now defaults to Forwarding messages, and adding to any exisiting bundle
  16. of a different flavor. Therefore making routing verbs ARCADDCM, etc...
  17. obsolete. They are still there and by using the NO_ADD verb or -U options you
  18. can use them. If no one objects, ADD routing verbs will dissapear in a later
  19. release. As for Forwarding messages, use the NO_FORWARD verb (FORWARD verb is
  20. no longer valid) or the -F option.
  21.  
  22. *** NOTE ***
  23. the -F option now toggles the forwarding setting of Ommm.
  24.  
  25. - Routing verbs with 'ARC' (except the ADD verbs) are being replaced as
  26. follows:
  27. ARCCM  ==  STUFFCM
  28. ARCDIRECT  ==  STUFFDIR
  29. ARCHOLD  ==  STUFFHOLD
  30. both are valid, but the ARC verbs will disappear in a future release, start
  31. converting.
  32.  
  33. - Check the OMMM.CFG file, it's now a complete source of whats valid and
  34. what isn't. Also do an OMMM -? for a list of command line options.
  35.  
  36. - NOTE: OMMM.CFG is REQUIRED!
  37.  
  38. - Routing now acts as documented.
  39.  
  40. - ADDRESS verb in OMMM.CFG MUST appear with full specifications as:
  41.   ZZ:TT/NN.PP
  42.   for example:
  43.   ADDRESS 1:109/315.0
  44.  
  45. - Gone is the -I and Info_path in OMMM.CFG. This will allow OMMM to work with
  46. other mailers.
  47.  
  48. - The -Z and Zone are gone. Use the ADDRESS verb with zone 0: for no zone
  49. mailing or #: for acting in zone aware mode as the -Z option use to do.
  50.  
  51. - The -F now toggles mail forwarding (use to be -N).
  52.  
  53. - The -N now toggles normalizing the outbound area (use to be -F).
  54.  
  55. - To make file requests with mailers that treat .REQ files as normal mail use
  56. the -R or NAKED verb in OMMM.CFG. This will create 'naked' request files for
  57. mailers like Binkley. If your mailer requires a FLO packet such as Opus, do
  58. not use these options. The -R and NAKED replace -B and Binkley.
  59.  
  60. - The -B, Binkley and Opus verbs are no longer supported. See the -R and NAKED
  61. verb above.
  62.  
  63. - ALL routing verbs dealing with ZOO, ZIP, etc... (i.e. ZOOCM, ZI1direct) are
  64. gone. Use the DEFINE_STUFFER and STUFFER verbs for other kinds of ARCMail.
  65.  
  66. COMMAND LINE OPTIONS
  67. ====================
  68.  
  69. The command line switches are intended to override values set in the
  70. oMMM.CFG file. The only switch which would normally be used is the
  71. -s(schedule) switch.
  72.  
  73.  -aZ:N/n        use the address Zone:Net/Node as the default
  74.                 instead of the first address in the CFG file
  75.  -bOMMM_CFG     alternate configuration file name
  76.  -cROUTEFILE    the file with routing information
  77.  -f             Toggles forwarding messages from other nodes
  78.  -g             tells oMMM to gate route interzone messages
  79.  -hHOLDPATH     the outbound directory for the OUT/FLO files
  80.  -mMESSAGEPATH  the directory containing netmail messages
  81.  -n             Toggles normalizing 'no-send' packets
  82.  -o             tells oMMM to use the old .MO? extensions and not .TU1, etc.
  83.  -pPRESCANPATH  the file with routing information to be used
  84.                 before message scanning takes place
  85.  -q             tells oMMM to run quietly (and marginally faster)
  86.  -r             tells oMMM to make naked file requests
  87.  -sSCHED        a single character for this schedule tag
  88.  -tDAYS         delete bundles more than 'DAYS' days old
  89.  -u             tells oMMM not to add to exisiting bundles.
  90.  -xSIZE         maximum bundle size in kbytes (default 512k).
  91.  
  92. FILE COMPRESSOR SUPPORT
  93. =======================
  94.  
  95. oMMM now supports any file compressor that's out there, as long as
  96. that compressor's command line adheres to the following convention:
  97.  
  98.    name <options> compressed_file_name filename_to_be_compressed
  99.  
  100. All you have to do is define it in the CFG file, and declare which
  101. nodes are to be bundled by that file compressor.
  102.  
  103. The advantages of using this method are:
  104.  1.     No need for separate routing verbs for each compressor.
  105.  2.     Compression type is specified for each node only once. This
  106.         eliminates the chance of overlooking a node which may be declared
  107.         in more than one place in the route file.
  108.  3.     Users can add a new compressor without any source code changes.
  109.  
  110. When stuffers are declared the arce/pkarc switch is ignored, and
  111. the first STUFFER declared will be used as the default. This allows you
  112. to have a default other than ARCE or PKARC. Be careful here, since many
  113. nodes cannot support other file compressors.
  114.  
  115.  
  116. syntax: DEFINE_STUFFER <tag> <dos command line and arguments>
  117.  
  118.        This statement is used in conjunction with the STUFFER command.
  119.        The tag must be unique, since it is used in the STUFFER command
  120.        to identify the compressor. The tag can be anything you want.
  121.  
  122.        The dos command line and arguments is the same one you would use
  123.        to invoke the file compressor from the dos prompt or in a bat file,
  124.        to add a file to the compressed file (which may have to be created).
  125.        Do not specify the option to delete the file once it's added, since
  126.        oMMM will delete the packet only if the compressor returns a result
  127.        code of 0.
  128.  
  129.        The first STUFFER defined will be used as the default STUFFER.
  130.        This means that any node declared in the route file as receiving
  131.        compressed bundles (ARCxxx or ONExxx) and not specified in any
  132.        of the STUFFER statements, will be compressed by the first
  133.        DEFINE_STUFFER statement found in the CFG file.
  134.  
  135.  
  136.         WARNING!!!!!
  137.         YOU DO NOT WANT TO CREATED "MIXED" BUNDLES. SOME COMPRESSORS
  138.         WILL BLINDLY ADD TO A COMPRESSED FILE CREATED BY ANOTHER
  139.         COMPRESSOR, WHICH "GRUNGES" THE FILE, SINCE NO COMPRESSOR CAN
  140.         DE-COMPRESS IT. THE BEST TIME TO ADD OR CHANGE A FILE COMPRESSOR
  141.         FOR A GIVEN NODE IS WHEN THERE IS NOTHING IN THE OUTBOUND DIRECTORY
  142.         FOR THAT NODE. IF YOU CHANGE THE COMPRESSOR FOR A NODE, AND THERE
  143.         IS A BUNDLE FOR THAT NODE IN THE OUTBOUND, YOU MUST MANUALLY
  144.         UNCOMPRESS THAT BUNDLE WITH THE OLD COMPRESSOR, AND THEN COMPRESS
  145.         ALL THE PACKETS WITH THE NEW COMPRESSOR.
  146.  
  147.  
  148. syntax: STUFFER <tag> <[zone:][net/]node ...>
  149.  
  150.         Declare which nodes are to be bundled by one of the compressors
  151.         defined. The tag must be the same declared in one of the
  152.         DEFINE_STUFFER statements. There is no limit on # of nodes that
  153.         can be declared for any stuffer, other than a line length limit
  154.         of 512 characters per line. Therefore a tag may be used more
  155.         than once.  If no zone is declared, the default zone will be used.
  156.         Shorthand net/nodes may also be used.
  157.  
  158.  
  159.  
  160. Here is an example of the STUFFER declarations for the .CFG file:
  161.  
  162.  
  163. Define_Stuffer  ARCA    arca
  164. Define_Stuffer  PKARC   pkarc -oct a
  165. Define_Stuffer  PAK     pak a
  166. Define_Stuffer  ZOO     zoo -add
  167. Define_Stuffer  ZIP     pkzip -a
  168. Define_Stuffer  LHARC   lharc a /m
  169.  
  170. Stuffer  LHARC  307/1 7 381/48
  171. Stuffer  PKARC  114/23
  172. Stuffer  ZIP    103/501 114/18 30 33 36 45 47 58 115/876 128/40 303/3 307/9
  173. Stuffer  ZIP    308/30 309/2 3 104/312 300/11 15/13 305/103
  174. Stuffer  PAK    114/80
  175. Stuffer  ZOO    3:123/456
  176. Stuffer  ARCA   2:123/4567
  177.  
  178.  
  179. Thanks to Jeffrey J. Nonken for the following features.
  180.  
  181. BUNDLE SIZE LIMIT
  182. =================
  183.  
  184. oMMM  1.50   now  has  a way of  limiting  bundle  sizes  and  of
  185. automatically deleting unsent bundles after a certain date. There
  186. are limitations to both these functions, however.
  187.  
  188. Size limit: you can invoke a packet size limit by including a  -x
  189. parameter  on  the command line or the keyword  'maxarc'  in  the
  190. configuration  file.  Follow the keyword or  the  parameter  with
  191. the  desired  limit size in kilobytes. For example, if  you  wish
  192. packets to be limited to 256 kilobytes, do this:
  193.      oMMM -x256 ...
  194. If  you leave the number off the command line, or if you  specify
  195. less than 1, it will default to 512k.
  196.  
  197. When oMMM 1.40 compresses and exports a packet, it simply adds it
  198. to the first existing bundle it finds; or if there is a truncated
  199. packet,  it  deletes the old one, increments the  extention,  and
  200. starts a new one. oMMM 1.50 , however, looks for several  bundles
  201. and  appends  only to the last one, if it  exists,  deleting  all
  202. truncated bundles. If the packet size limitation option has  been
  203. invoked, oMMM 1.50  will check the bundle size before  appending;
  204. if  it is too large, oMMM will create a new bundle and add it  to
  205. the outbound list.
  206.  
  207. oMMM 1.50  does not actively limit the bundle size; if the packet
  208. it  adds  brings the bundle size over the requested  size  limit,
  209. oMMM  will not attempt to do anything about it. oMMM will  simply
  210. not  add to a bundle that already meets or exceeds the  requested
  211. size limit. It is up to the export program to limit packet sizes.
  212.  
  213. oMMM  will use the .MO?, .TU?, .WE? extension  naming  convention
  214. for bundles unless the sysop overrides with the -o parameter,  in
  215. which  case oMMM only uses the .MO? extension. However, when  the
  216. size  limit  feature is invoked, if the bundle .MO9  exceeds  the
  217. size limit, oMMM will override the -o parameter and name the next
  218. bundle  .TU0.  This ONLY happens if the bundle exceeds  the  size
  219. limit.
  220.  
  221. In  the  unlikely event that 69 of the 70  possible  bundles  get
  222. filled up, oMMM will override the size limit feature and continue
  223. to append to the last bundle. (This has not been tested.)
  224.  
  225. KILL OLD BUNDLES
  226. ================
  227.  
  228. Old bundles: if you have a system that fails to pick up its  mail
  229. regularly, you may want to automatically delete its old  bundles.
  230. oMMM  will  not  seek these out, but if it finds  an  old  bundle
  231. destined  for  a  system it's processing,  it  can  automatically
  232. delete  it for you. This is especially useful for a  system  that
  233. gets sent mail regularly, when you have a bundle size  limitation
  234. set. Invoke the automatic 'timed' deletion with the -t  parameter
  235. on  the  command  line, or with the keyword  'oldbundle'  in  the
  236. configuration  file, followed by the number of days you  want  to
  237. wait before deleting. For example:
  238.      oMMM -t7 ...
  239. This causes oMMM to delete any bundle it finds that is more  than
  240. seven  days old. If you specify less than 1 it will default to  7
  241. days.
  242.  
  243. Because of the way this function is implemented, if the bundle in the
  244. example  is as much as 7 days and 1 second old, oMMM will  delete
  245. it.  So  you could see oMMM delete one bundle that has  the  same
  246. date stamp as another that it leaves alone.
  247.  
  248. Again,  oMMM  does  not actively seek out old  bundles.  It  only
  249. checks  the  dates  of existing bundles that  it  happens  to  be
  250. processing. However, if it finds a single bundle that is too old,
  251. it  will delete it and then re-use its name for the  new  packet.
  252. Since  the  intended recipient never got the  deleted  bundle,  I
  253. cannot  think  of  any practical reason to  increment  the  name.
  254. However, if it bothers enough people, I will go ahead and add the
  255. code to do that.
  256.  
  257. There is an extremely unlikely situation that could come up: oMMM
  258. finds  there are 69 bundle names used, the last one  exceeds  the
  259. size limitation, and there is at least one aged bundle. oMMM will
  260. delete the aged bundle(s) and append to the last one, even though
  261. it  is oversized. (The next time oMMM is run it will  find  there
  262. are  less than 69 bundles used and create a new one.) This is  an
  263. artifact  of  the  structure of the  code,  and  considering  how
  264. unlikely  an  occurrance this is, I refuse to bother to  make  it
  265. work differently.
  266.  
  267.