home *** CD-ROM | disk | FTP | other *** search
/ Hacker Chronicles 2 / HACKER2.BIN / 469.BM.DOC < prev    next >
Text File  |  1987-08-26  |  8KB  |  169 lines
  1. User Manual for BM, Bdale's MS-Dos Mailer
  2. by Bdale Garbee, N3EUA - last revised 870525
  3.  
  4. * BM is Copyright 1986 by Bdale Garbee.
  5. * Released for non-commercial distribution and use only, as long as all 
  6. * copyright and author notices are retained.
  7.  
  8. Many thanks to Gerard PA0GRI who is primarily responsible for the addition
  9. of features to version 2.
  10.  
  11. Setup:
  12.  
  13. In order to make use of BM, you must first follow the installation 
  14. instructions in the file SMTP.DOC to provide minimal SMTP support.  Then,
  15. you should:
  16.  
  17.     - copy the file SEQUENCE.SEQ to the mqueue directory.
  18.  
  19.     - copy the files BM.RC and HOSTS.NET to the root directory of the 
  20.       default drive used when NET.EXE is running.
  21.  
  22.     - edit HOSTS.NET to reflect the hosts you will exchange mail with.
  23.       the format of each line of this file is:
  24.  
  25.           IP_address <tab> hostname <newline>
  26.  
  27.       The IP address should be of the form 0.0.0.0, and the hostname can
  28.       be any token you wish to use to represent that host.  In 
  29.       particular, it does NOT need to be the full legal name of the
  30.       host.
  31.  
  32.     - edit the file \BM.RC to correctly identify your hostname, username,
  33.       and the IP address of the system you wish to punt mail to when you
  34.       don't know the correct IP address.  The format lines in this file
  35.       is:
  36.  
  37.           token <space> value <newline>
  38.  
  39.       where the currently defined tokens are 'host' for this system's
  40.       hostname, 'user' for your username, and 'gate' for the ip address
  41.       of the nearest 'smart mailer'.  More on this below.  Additonal tokens
  42.       exist for setting your local timezone, and mailbox directory, and
  43.       editor to be used in message creation.
  44.  
  45.  
  46. Operation:
  47.  
  48. BM is designed to serve as the mail user-interface for users of the KA9Q
  49. internetworking software package.  The purpose of BM is to provide a full
  50. set of electronic mail services to the user.  These include sending messages,
  51. listing and reading received messages, and so forth.
  52.  
  53. BM reads mailbox files created by the SMTP server in NET.EXE, which are 
  54. stored in a directory (usually \spool\mail) that is specified in the config
  55. file \bm.rc.  Incoming mail is stored by the server in mailbox files, one
  56. per username.  These mailbox files may also be referred to as "notesfiles".
  57. The default mailbox to read is specified with the 'user' option in the \bm.rc
  58. file.  This username is also used on all outgoing messages.
  59.  
  60. The \bm.rc file also defines a timezone stamp, which in conjunction with the
  61. DOS date and time is used to provide the required RFC822 Date: header.
  62.  
  63. Commands are generally one character long and followed by a space, and 
  64. parameter if needed:
  65.  
  66.    s  Send a message.  The user is prompted for a destination address and
  67.       subject.  BM then creates appropriate RFC822 headers in a temporary
  68.       file, and either invokes the user's favorite editor (specified with
  69.       the 'edit' paramater in \bm.rc) to enter the message text, or uses
  70.       a simple/stupid text entry routine if no editor is defined.  Note that
  71.       if you are using an editor, you should start by jumping to the end of 
  72.       the file.  RFC822 requires that the headers be first and be separated
  73.       from the text of a message by at least one blank line.
  74.  
  75.       In this release, Phil KA9Q has modified BM slightly to be more like
  76.       the Berkeley Unix mail program.  When the message entry routine first
  77.       starts, you will be in the silly text editor.  If you want to use
  78.       your editor on the message, type '~e<ret>'... not obvious to most
  79.       folks, but very obvious to 4bsd fans... [sigh].
  80.  
  81.    t  Transmits an already created file as a message.  RFC822 headers are
  82.       prepended.  This is useful if you don't have an editor that will work
  83.       with the 's' command.  
  84.  
  85.           *** NOTE ***  RFC822 only allows 7bit data.  If you want to send a
  86.                       binary file, use BSQ, or UUENCODE, or something similar
  87.               to convert it to a text file first!  Better yet, use
  88.               FTP...
  89.  
  90.    r  Read all messages in the current notefile.
  91.  
  92.    u  Updates you with new messages in the notesfile, shows them to you
  93.       and updates the read marker to the last one read.  If no new mes-
  94.       sages came in, you will be notified.
  95.  
  96.    f  Forward a message to someone else.  A temporary copy is made of 
  97.       the message specified and that is handed over to the send message
  98.       routine, which treats it as a file ala the 't' command.
  99.  
  100.    d  Delete a message.  Parameter is the message number.  If the number
  101.       of the to be deleted message is higher than the last read message
  102.       an "are you sure" message is printed. 'Y' or 'y' will delete it...
  103.  
  104.    h  Displays message headers, a message number, received date, from
  105.       whom and the subject fields on an single line.  An star is put
  106.       in front of the last read message.
  107.  
  108.    p  Sets the printer on or off so messages to the screen also go to
  109.       the printer.  ** This will be implemented in a future release. **
  110.  
  111.    l  Lists the file names of messages waiting to be sent that are in the
  112.       queue directory, usually \spool\mqueue.  Primarily useful for debugging.
  113.  
  114.    n   Shows the notefiles in the mail directory, the location of which is
  115.        specified by the 'smtp' parameter in the \bm.rc file.  If this command
  116.        is followed with a parameter, the current notesfile will be changed
  117.        to the specified notesfile.  If it does not exist you will be notified
  118.        if you try something with it.
  119.  
  120.    #   Substitute # with a number (1..whatever) and it will show you the 
  121.        message in the current active notesfile with that number. If 
  122.        the message is the one next to the last read one the * will be 
  123.        moved.
  124.  
  125.    ?   Prints a short command summary to the screen.
  126.  
  127.    q   Quit.
  128.  
  129. The program's prompt will always show the current notesfile name.
  130.  
  131.  
  132. Additional Information:
  133.  
  134. BM will prompt you for a To: address.  This should be in the form user@host,
  135. where user will be the name of the mailbox file on the destination KA9Q
  136. system, or the username of the intended recipient on other SMTP-equipped
  137. systems.  The host field should exactly match a host token in the HOSTS.NET
  138. file.  If it does not, the SMTP client in NET.EXE will insert the IP address
  139. of the nearest "smart mail agent" in the workfile instead of the destination 
  140. IP address (since it is unknown).  The rationale behind
  141. this is that many SMTP equipped systems include the ability to forward mail
  142. that is not addressed to them.  If you have a system of this type nearby,
  143. you may be able to "punt" mail to them for handling.
  144.  
  145. Note that if there is such a smart mailer on a system near you, you can
  146. replace the simple 'user' field with a full address that the smart mailer
  147. can understand, since BM will scan from the right taking everything after
  148. the rightmost '@' to be the host token, and will not mangle the address.
  149. For example, from my PC clone I can easily mail to:
  150.     bellcore!karn@winfree           (to get to Phil, KA9Q)
  151. where winfree is my Unix system, which talks to system bellcore via UUCP.
  152. BM really doesn't care what you put for an address as long as there is
  153. a system within range that it can punt to when it doesn't understand what
  154. you mean.  Note that this implies you should be extra careful when typing
  155. addresses!
  156.  
  157. Read the SMTP.DOC file for specification of the queue and mailbox files, and
  158. limitations of the SMTP client that affect BM's capabilities.
  159.       
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.