home *** CD-ROM | disk | FTP | other *** search
/ Crawly Crypt Collection 1 / crawlyvol1.bin / bbs / mr_happy / mr_happy.asc < prev    next >
Text File  |  1994-05-05  |  4KB  |  160 lines
  1.           Documentation for Mr Happy - The Automatic Message Sender
  2.           =========================================================
  3.                   (Example CTL file enclosed with archive)
  4.  
  5. Mr Happy allows you to define any number of messages that may be written
  6. into any area Hudson Format message area that you wish. You may define
  7. netmail or echomail messages, which can be sent with date limiting.
  8.  
  9. There is no GEM front end to this program, the reason being I just haven't
  10. got round to it - if there is enough interest then I may decide to do one
  11. in the future, but don't hold your breath.
  12.  
  13. HAPPY.CTL format
  14. ================
  15.  
  16. Mr Happy is controlled by his domineering wife whose name is CTL, because
  17. of the way of the world usually defines the man first, her full title is
  18. HAPPY.CTL :)
  19.  
  20. There are five lines that usually always reside within the CTL file, they
  21. are :
  22.  
  23.     NETMAIL
  24.     DEFAULT_TO
  25.     DEFAULT_FROM
  26.     DEFAULT_SUBJECT
  27.     DEFAULT_ADDRESS
  28.  
  29. NETMAIL drive:\path\file
  30. -------
  31.  
  32.     This defines the path and stub of the Netmail area on your system, this
  33.     file is used when sending Netmail (!)
  34.  
  35. DEFAULT_TO ~~~
  36. DEFAULT_FROM ~~~
  37. DEFAULT_SUBJECT ~~~
  38. DEFAULT_ADDRESS ~~~
  39. ---------------
  40.  
  41.     Defines the defaults to be used when writing any messages
  42.  
  43.  
  44. A send block must be defined for Mr Happy to know what to do ...
  45.  
  46. START_SEND       -  Defines the start of the block
  47. END_SEND         -  marks the end of the block, when this control word is
  48.                     read from the CTL file the parameters of the block are
  49.                     checked and if necessary the message is sent.
  50.  
  51.     START_SEND/END_SEND must be matched pairs.
  52.  
  53. DATE CONTROLS
  54. -------------
  55.  
  56.     At least one or more date controls are needed before a message can be
  57.     sent, obviously defining a month and not a day(or date) means nothing
  58.     and so the message send will be aborted - you can test your CTL file by
  59.     entering DEBUG on the command line - this reports what Mr Happy found
  60.     and what actions he would normally take - using DEBUG on the command
  61.     line does not send any messages.
  62.  
  63. DAY (Mon Tue Wed Thu Fri Sat Sun)
  64. ---
  65.  
  66.     One day, and one day only may be specified with this control word -
  67.     although you may have upto 7 DAY commands in each block.
  68.  
  69. DAYS ALL
  70. --------
  71.  
  72.     This is one command - this is the same as 7 DAY commands.
  73.  
  74. MONTH (Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec)
  75. -----
  76.  
  77.     As with DAY, one month and only one month may follow this command, but
  78.     you can have upto 12 MONTH statements in a block.
  79.  
  80. DATE (01 - 31)
  81. ----
  82.  
  83.     Same again but for dates, one date per command line, upto 31 DATE
  84.     commands per block - Date validity is not checked, so if it never
  85.     occurs it'll never get sent.
  86.  
  87. MESSAGE DEFINITIONS
  88. -------------------
  89.  
  90.     If normal EchoMail is sent then it is flagged as local, Netmail is
  91.     flagged as local and private.
  92.  
  93. TO ~~~
  94. --
  95.  
  96.     Defines the recipient of the message.
  97.  
  98. FROM ~~~
  99. ____
  100.  
  101.     Defines the sender of the message.
  102.  
  103. SUBJECT ~~~
  104. -------
  105.  
  106.     Defines the subject of the message.
  107.  
  108. TO_ADDRESS n:n/n.n
  109. ----------
  110.  
  111.     Used for Netmail Addressing, if defined then Netmail status is assumed.
  112.  
  113. FROM_ADDRESS n:n/n.n
  114. ------------
  115.  
  116.     Used to define the senders address for Netmail, if defined that Netmail
  117.     status is assumed.
  118.  
  119. FILE drive:\path\file.ext
  120. ----
  121.  
  122.     Defines the preformatted ASCII file to be sent as the message.
  123.  
  124. WINDOWS
  125. =======
  126.  
  127.     such a little dear of a proggy doesn't use windows, and so you may put
  128.     NOPRINT on the command line to prevent text output to the screen.
  129.  
  130.     Any error messages are then sent to an error log.
  131.  
  132. DEFAULTS & ERRORS
  133. =================
  134.  
  135.     If you define a FROM_ADDRESS then you must define a TO_ADDRESS
  136.  
  137.     You can reassign DEFAULT_* statements *OUTSIDE* of send blocks.
  138.  
  139.     ERRORS are not logged - no logging is performed - if you think you have
  140.     a problem, or would just like to test your CTL file then pass DEBUG on
  141.     the command line to Mr Happy and he will write you a .DBG file.
  142.  
  143.     If you think you have discovered a bug then please send full details of
  144.     the problem along with a .DBG file to me - I'll have a look and a
  145.     laugh at it at my pleasure - what do you expect for free :)
  146.  
  147. CONTACT
  148. =======
  149.  
  150.     Dave Meaker
  151.  
  152.     The Holodeck SbbS
  153.  
  154.     +44-454-880267 24Hrs V32b
  155.  
  156.     NeST 90:106/151.0
  157.     Fido 2:255/43.0
  158.     Trek 107:1709/0.0
  159.     Fish 777:100/0.0
  160.