home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / MKMSG201.ZIP / MAKEMSG.DOC < prev    next >
Text File  |  1992-01-21  |  10KB  |  286 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.                             M A K E M S G   2.01
  27.  
  28.                     Tower Enterprises -- Jeff Galbraith
  29.                              Copyright 1990-92
  30.  
  31. LICENCE
  32.  
  33. Copyright 1990-92 by Tower Enterprises -- Jeff Galbraith. All Rights Reserved.
  34.  
  35.         You may copy and distribute copies of MAKEMSG in any medium, provided
  36.         that you display in a conspicuous area and appropriately publish on each
  37.         copy a valid copyright notice "Copyright 1990-92, (c) Tower Enterprises
  38.         -- Jeff Galbraith". Unmodified copies of this documentation must be
  39.         provided with the program - this is absolute. You may charge a
  40.         distribution fee for the physical act of transferring a copy, but no
  41.         more than is necessary to recover your costs incurred in the transfer.
  42.  
  43.  
  44. WARRANTY
  45.  
  46.         There is none. This software is provided "as is" without warranty of any
  47.         kind, either expressed or implied, including, but not limited to, the
  48.         implied warranties of merchantability and fitness for a particular
  49.         purpose. The entire risk as to quality and performance of MAKEMSG and
  50.         the accuracy of its associated documentation, is with you.
  51.  
  52.         In no way will Tower Enterprises or Jeff Galbraith be held responsible
  53.         for the use or misuse of MAKEMSG, including, but not limited to,
  54.         defects, damages, lost monies, lost data, or other special, incidental
  55.         or consequential damages arising out of the use or inability to use
  56.         MAKEMSG.
  57.  
  58.         You can contact the author at any of the addresses listed below:
  59.  
  60.         FidoNet:        1:134/21.0
  61.         BBS:            (403) 254-0278, 14.4K HST DS, v.32, v.42bis
  62.  
  63.         Surface mail:
  64.  
  65.         499 Midridge Dr. S.E.
  66.         Calgary, Alberta
  67.         Canada T2X 1B2
  68.  
  69.         Please feel free to contact the author at any time to share your
  70.         comments about this software or any other software released by Tower
  71.         Enterprises -- Jeff Galbraith.
  72.  
  73.  
  74. WHAT IS MAKEMSG?
  75.  
  76.         MAKEMSG is a program that can take any document and create a message
  77.         suitable for echomail. MAKEMSG supports *.MSG format and Scott Dudley's
  78.         "SQUISH" format. MAKEMSG is used by many echo moderators for automatic
  79.         placing of rules in an echo area. as well, it can be used for placing
  80.         informational reports, like those generated by nodelist formatters, or
  81.         echomail billing programs.
  82.  
  83.  
  84. THE OLD MAKEMSG
  85.  
  86.         The older versions of MAKEMSG supported a header format in the contents
  87.         file. This contained the TO:, FROM:, and SUBJECT: lines. This is no
  88.         longer supported. This information is now gathered from the
  89.         configuration file, or from the command line.
  90.  
  91.  
  92. THE CONFIGURATION FILE
  93.  
  94.         The semi-colon acts as beginning of comment and can be used on any line.
  95.         Anything after a semi-colon is not parsed. You can use the -X command on
  96.         the command line to specify a different configuration file each time
  97.         MAKEMSG is run. Depending on how you want to do it, you can have command
  98.         line arguments override the configuration file by making sure the
  99.         configuration file is specified before any arguments. The the
  100.         configuration file is parsed first and then the arguments. Arguments
  101.         that come later, always override previous ones. Here is a list of key
  102.         words:
  103.  
  104.   SYSTEM          1:134/21.0
  105.  
  106.         MAKEMSG supports full 4D addresses. Include as much information as
  107.         possible about a system. Please do not use @DOMAIN, it will be ignored.
  108.         this is where the message originates.
  109.  
  110.   FROM            Jeff Galbraith
  111.   TO              All
  112.   SUBJECT         Test message
  113.  
  114.         This is the header information. If it is not in a configuration file,
  115.         you must make sure to include it on the command line. MAKEMSG does some
  116.         minor checking on all pertinent fields. If certain ones do not have
  117.         information, default information will be used. On some, if there is no
  118.         information, the process will abort.
  119.  
  120.   DIR     c:\echo\test_sqi
  121.  
  122.         This is the directory where *.MSG files are kept or the name of the
  123.         SQUISH message base, excluding extension (the same rules as used by the
  124.         SQUISHmail Conference Processor).
  125.  
  126.   ORIGIN          C::IDC/PDN/CLN*HST DS*(403)254-0278,Calgary,Ab
  127.  
  128.         This is the origin line to use for all messages. If one is not used, you
  129.         will get a "* Origin: Unknown".
  130.  
  131.   KILL
  132.   PRIVATE
  133.   CRASH
  134.  
  135.         These are the only three verbs used for tagging messages at this time.
  136.  
  137.   MSGTYPE         SQUISH
  138.   ;MSGTYPE        *.MSG
  139.  
  140.         This is the type of message base that DIR points to. Use only one, not
  141.         both, at a time.
  142.  
  143.   CONTENTS        c:\bbs\test.doc
  144.  
  145.         This is the name of the document to be used for the body of the message.
  146.         If it is not in the current directory, make sure you put in the full
  147.         path as well.
  148.  
  149.   RECEIVE         1:134/40.0
  150.  
  151.         This is the node that is to receive the message, IF the message is to be
  152.         netmail. If it is not netmail, then ignore this command.
  153.  
  154.   EDITOR          qedit.exe
  155.   MAX             c:\bbs\area.dat
  156.  
  157.         NOTE: These are not yet implemented in this version yet. In a future
  158.         version of MAKEMSG, an interactive part will be added. This will allow
  159.         you to create messages on the fly, thus the need to know which editor to
  160.         use. The second command will be for Maximus users. You will get a
  161.         picklist of available echoes of where the message will be sent.
  162.  
  163.  
  164.  
  165. THE COMMAND LINE
  166.  
  167. Syntax:
  168. MAKEMSG <args>                                                                  
  169. Args:   !          = Crash message flag                                         
  170.         $          = Squish base (default=*.MSG)                                
  171.         C<path>    = Contents file                                              
  172.         D<path>    = Directory (default=current)                                
  173.         F"string"  = From (default=MAKEMSG v2.00)                               
  174.         H          = Help                                                       
  175.         K          = Kill message flag                                          
  176.         J"string"  = subJect                                                    
  177.         O"string"  = Origin line (default=Unknown)                              
  178.         P          = Private message flag                                       
  179.         R<address> = Receiving node (zone:net/node.point)                       
  180.         S<address> = Sending node (zone:net/node.point)                         
  181.         T"string"  = TO (default=All)                                           
  182.         X<path>    = configuration file                                         
  183.                                                                                 
  184. Retain quotes (") on arguments that have them.                                  
  185. EXAMPLE:                                                                        
  186.   MAKEMSG -$ -F"Jeff Galbraith" -S1:134/21.0 -Cc:\test.doc -Dc:\echo\public     
  187.                                                                                 
  188.  
  189.         Typing MAKEMSG by itself will bring up some help (as above). All
  190.         commands must have a dash (-) or slash (/) in front of them.
  191.  
  192.   -!
  193.  
  194.         Make this message CRASH.
  195.  
  196.   -$
  197.  
  198.         This message is going into a SQUISH format (default=*.MSG).
  199.  
  200.   -C<contents_file>
  201.   -Cc:\bbs\test.doc
  202.  
  203.         This is the file to use for the body of the message. If it is not in the
  204.         current directory, make sure you put in the full path as well.
  205.  
  206.   -D<directory>
  207.   -Dc:\echo\test_sqi
  208.  
  209.         This is the directory where *.MSG files are kept or the name of the
  210.         SQUISH message base, excluding extension (the same rules as used by the
  211.         SQUISHmail Conference Processor).
  212.  
  213.   -F"from name"
  214.   -F"Jeff Galbraith"
  215.  
  216.         This is who the message is from. Make sure the name is enclosed in
  217.         quotation marks.
  218.  
  219.   -H
  220.  
  221.         This will bring up the same help as if you had typed MAKEMSG by itself.
  222.  
  223.   -K
  224.  
  225.         Kill this message after it is sent.
  226.  
  227.   -J"subject line"
  228.   -J"Test Message"
  229.  
  230.         This is the subject line of the message. Make sure the name is enclosed
  231.         in quotation marks.
  232.  
  233.   -O"origin line"
  234.   -O"C::IDC/PDN/CLN*HST DS*(403)254-0278,Calgary,Ab"
  235.  
  236.         This is the line to be used for the Origin line. make sure it is
  237.         enclosed in quotation marks. The length should not exceed 55 characters,
  238.         but if it does, MAKEMSG will truncate it properly.
  239.  
  240.   -P
  241.  
  242.         Make this message Private.
  243.  
  244.   -R<receiving_node>
  245.   -R1:134/40.0
  246.  
  247.         This is the node that is to receive the message, IF the message is to be
  248.         netmail. If it is not netmail, then ignore this command.
  249.  
  250.   -S<sending_node>
  251.   -S1:134/21.0
  252.  
  253.         MAKEMSG supports full 4D addresses. Include as much information as
  254.         possible about a system. Please do not use @DOMAIN, it will be ignored.
  255.         this is where the message originates.
  256.  
  257.   -T"to name"
  258.   -T"All"
  259.  
  260.         This is who the message is addressed to. make sure the name is enclosed
  261.         in quotation marks.
  262.  
  263.   -X<configuration_file>
  264.   -Xc:\bbs\makemsg1.cfg
  265.  
  266.         This is an alternate configuration file that MAKEMSG should use instead
  267.         of the default one.
  268.  
  269.  
  270. HISTORY
  271.  
  272.         1.00 - 1.07, support of Fido *.MSG, various fixes
  273.         2.00, Squish format added using scott Dudley's MSGAPI v.0
  274.         2.01, bug fix release
  275.  
  276. CREDITS and TRADEMARKS
  277.  
  278.         MAKEMSG contains, since release 2.00, some code from Scott Dudley.
  279.         MSGAPI Copyright Scott Dudley.
  280.         SQUISH is a trademark of Scott Dudley.
  281.  
  282.         Special thanks, as always, to Henning Johansen (1:134/40.0@fidonet.org)
  283.         for the best ideas and suggestions. Also, many thanks to Kevin Klement
  284.         (134/77), Kathi Crockett (134/8) and Neil Witwicki (134/64) for the
  285.         thorough beta testing.
  286.