home *** CD-ROM | disk | FTP | other *** search
/ HAM Radio 3 / hamradioversion3.0examsandprograms1992.iso / tcp / nos18b / bm.doc < prev    next >
Text File  |  1988-04-22  |  17KB  |  595 lines

  1.  
  2.  
  3.  
  4.                                 BM User Manual
  5.  
  6.                               Dave Trulli, NN2Z
  7.  
  8.  
  9.  
  10.  
  11.           1.  _W_h_a_t__i_s__B_M__?
  12.  
  13.           BBBBMMMM is designed to serve as the mail user-interface for the
  14.           KA9Q  TCP/IP  inter-networking package. It provides a full
  15.           set of mail services to the user which allows the  sending
  16.           and receipt of electronic mail.
  17.  
  18.  
  19.  
  20.           2.  _B_M__I_n_s_t_a_l_l_a_t_i_o_n
  21.  
  22.           To install BBBBMMMM requires the modification  of  the  supplied
  23.           configuration   files  and  the  creation  of  the  proper
  24.           directory structure.  The following sections describe  the
  25.           file and directory structure used by BBBBMMMM and SMTP.
  26.  
  27.  
  28.           2.1  _D_i_r_e_c_t_o_r_y__S_t_r_u_c_t_u_r_e
  29.  
  30.           \spool\mqueue   This directory  holds  the  outbound  mail
  31.                           jobs  for  SMTP.  Each  job  consists of 2
  32.                           files a xxxx.txt and xxxx.wrk  file  where
  33.                           xxxx  is  a  unique numerical prefix.  The
  34.                           format of the files  are  described  in  a
  35.                           later section.
  36.  
  37.  
  38.           \spool\rqueue   This directory is used by  SMTP  for  jobs
  39.                           that   have  been  received  and  will  be
  40.                           processed by a user defined  mail  routing
  41.                           program.    This  directory  is  not  used
  42.                           directly by BBBBMMMM.
  43.  
  44.  
  45.           \spool\mail     This  directory   holds   the   individual
  46.                           mailboxes  for  each  user  name  on  your
  47.                           system. The extension .txt is add  to  the
  48.                           user  name  to form the mailbox name. Mail
  49.                           received by the SMTP server is appended to
  50.                           the mailbox file.
  51.  
  52.  
  53.           2.2  _C_o_n_f_i_g_u_r_a_t_i_o_n__F_i_l_e_s
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.                                     - 2 -
  71.  
  72.  
  73.  
  74.           2.2.1  _T_h_e__\_b_m_._r_c__f_i_l_e  The \bm.rc file provides  BBBBMMMM  with
  75.           the configuration needed for the operation of the mailer.
  76.  
  77.           The format for the \bm.rc file is:
  78.  
  79.                variable <space>  value <newline>
  80.  
  81.  
  82.           The following variables are valid in the bm.rc file:
  83.  
  84.  
  85.           _s_m_t_p___<_m_a_i_l__p_a_t_h_>
  86.  
  87.           defines the path to the directory containing  the  mailbox
  88.           files.   The  default  directory  is  \spool\mail  on  the
  89.           current drive.
  90.  
  91.  
  92.           _h_o_s_t__<_y_o_u_r__h_o_s_t__n_a_m_e_>
  93.  
  94.           Is used to set the local hostname for use  in  the  RFC822
  95.           mail headers. This is a required field.
  96.  
  97.  
  98.           _u_s_e_r__<_u_s_e_r__n_a_m_e_>
  99.  
  100.           Defines the user name of the person who is  sending  mail.
  101.           This is also used as the default mailbox for reading mail.
  102.           On the AMPRNET this is usually set to your call.  There is
  103.           a DOS limit of 8 characters for the user name.
  104.  
  105.  
  106.           _e_d_i_t___<_p_a_t_h__o_f__y_o_u_r__e_d_i_t_o_r_>
  107.  
  108.           Defines the name of your favorite editor which can be used
  109.           to construct and  edit the text of outgoing messages.  The
  110.           use of edit is optional.
  111.  
  112.  
  113.           _f_u_l_l_n_a_m_e__<_y_o_u_r__f_u_l_l__n_a_m_e_>
  114.  
  115.           Is used to provide your full name to the mailer for use in
  116.           the  comment  portion  of "From:" header line.  The use of
  117.           fullname is optional.
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.                                     - 3 -
  137.  
  138.  
  139.  
  140.           _r_e_p_l_y___<_r_e_t_u_r_n__a_d_d_r_e_s_s_>
  141.  
  142.           Defines the address where you wish to receive  replies  to
  143.           messages sent.  This option is useful if you are operating
  144.           your pc on a local area network and would like  your  mail
  145.           replies  sent  to  a  more "well known host".  The address
  146.           specified by reply  is  used  to  generate  a  "Reply-To:"
  147.           header  in outbound mail. The "Reply-To:" header overrides
  148.           the "From:" header which is the address normally  used  to
  149.           reply to mail. This field is optional.
  150.  
  151.  
  152.           _m_a_x_l_e_t___<_n_u_m_b_e_r__o_f__m_e_s_s_a_g_e_s_>
  153.  
  154.           defines  the  maximum  number  of  messages  that  can  be
  155.           processed by BBBBMMMM  in one mailbox file. The default value of
  156.           maxlet is 100.
  157.  
  158.  
  159.           _m_b_o_x__<_f_i_l_e_n_a_m_e_>
  160.  
  161.           Specifies the default file  to  be  used  for  the  "save"
  162.           command.  This file is in the same format as a mailbox and
  163.           may later be viewed using the -f option  of  BBBBMMMM.  If  this
  164.           option is not used then the default is set to mbox.
  165.  
  166.  
  167.           _r_e_c_o_r_d__<_f_i_l_e_n_a_m_e_>
  168.  
  169.           If defined a copy of each message sent will  be  saved  in
  170.           <filename>.
  171.  
  172.  
  173.           _f_o_l_d_e_r__<_d_i_r_e_c_t_o_r_y__n_a_m_e_>
  174.  
  175.           If defined folder contains  the  path  used  by  the  save
  176.           command.
  177.  
  178.  
  179.           _s_c_r_e_e_n__[_b_i_o_s__|__d_i_r_e_c_t_]
  180.  
  181.           In the Turboc compiled version  of  BBBBMMMM,  screen  sets  the
  182.           display  output mode to use either direct writes to screen
  183.           memory or the ROM  BIOS.   The  default  is  direct  which
  184.           provides  the  fastest  output  mode.   If you are using a
  185.           windowing system such as Desqview you should set the  mode
  186.           to bios.
  187.  
  188.           Here is a sample bm.rc file.
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.                                     - 4 -
  203.  
  204.  
  205.  
  206.                host nn2z.ampr
  207.                user nn2z
  208.                fullname Dave Trulli
  209.                # send my replies to the Sun
  210.                reply nn2z@ka9q.bellcore.com
  211.                screen  direct
  212.                edit /bin/vi
  213.                mbox c:/folder/mbox
  214.                record c:/folder/outmail
  215.                folder c:/folder
  216.                maxlet 200
  217.  
  218.  
  219.  
  220.           2.13.1  _T_h_e__\_a_l_i_a_s__f_i_l_e  The alias file provides  an  easy
  221.           way to maintain mailing lists.  An alias can be any string
  222.           of characters not containing the "@" symbol.   The  format
  223.           for the alias file is:
  224.  
  225.                alias   recip1 recip2 recip3
  226.                <tab>   recip4
  227.  
  228.           Note that a long list of aliases can be  continued  on  an
  229.           additional   line  by  placing  a  tab  or  space  on  the
  230.           continuation line.
  231.  
  232.           Some examples aliases are:
  233.  
  234.                dave    nn2z@nn2z.ampr
  235.  
  236.                phil    karn@ka9q.bellcore.com
  237.  
  238.                # mail to local nnj users
  239.                nnj     wb2cop@wb2cop.ampr karn@ka9q.bellcore.com
  240.                        wb0mpq@home.wb0mpq.ampr w2kb@w2kb.ampr ka2tsm@ka2tsm.ampr
  241.  
  242.           In  the  above  example,  when  specifying  nnj   as   the
  243.           recipient,  BBBBMMMM  will  expand  the  alias  into the list of
  244.           recipients from the alias file.  At this time an alias may
  245.           not contain any other aliases.
  246.  
  247.  
  248.           2.13.2  _\_s_p_o_o_l_\_m_q_u_e_u_e_\_s_e_q_u_e_n_c_e_._s_e_q   The   sequence   file
  249.           maintains  a  message counter which is used by BBBBMMMM and SSSSMMMMTTTTPPPP
  250.           to generate message ids and unique filenames.   This  file
  251.           is created by BBBBMMMM.
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.                                     - 5 -
  269.  
  270.  
  271.  
  272.           2.14  _E_n_v_i_r_o_n_m_e_n_t
  273.  
  274.           The timezone used in mail headers is obtained from the DOS
  275.           environment variable TZ. An example TZ setting is:
  276.  
  277.                set TZ=EDT4
  278.  
  279.           It  is  set  in  your  AUTOEXEC.BAT  file.  The  first   3
  280.           characters  are  the  timezone and the fourth character is
  281.           the number of hours from GMT time. If TZ is not  set,  GMT
  282.           is assumed.
  283.  
  284.  
  285.  
  286.           3.  _C_o_m_m_a_n_d_s
  287.  
  288.           All BBBBMMMM commands are single letters  followed  by  optional
  289.           arguments.   The  command  list  has been designed to make
  290.           those familiar with Berkeley mailers comfortable with BBBBMMMM.
  291.  
  292.  
  293.           3.1  _M_a_i_n__m_e_n_u__c_o_m_m_a_n_d_s
  294.  
  295.           _m__[__u_s_e_r_l_i_s_t__]
  296.  
  297.           The mail command is used to send a message to one or  more
  298.           recipients.  All local recipient names ( those which don't
  299.           contain an '@' ) are checked for possible aliases.  If  no
  300.           arguments   are  supplied  you  will  be  prompted  for  a
  301.           recipient list.  While entering a message  into  the  text
  302.           buffer several commands are available such as: invoking an
  303.           editor, and reading in text from other messages or  files.
  304.           See the section below for a description of these commands.
  305.           To end a message enter a line containing a single period.
  306.  
  307.           It is important to remember that the input line buffer has
  308.           a  128  character  limit.  You  should format your text by
  309.           entering a carriage return at the end of each line. Typing
  310.           excessively   long  lines  may  cause  data  loss  due  to
  311.           truncation when passing the message through  other  hosts.
  312.           Keeping  lines  less  than  80 characters is always a good
  313.           idea.
  314.  
  315.  
  316.           _d__[__m_s_g_l_i_s_t__]
  317.  
  318.           Mark messages for deletion.  Messages marked for  deletion
  319.           are  removed  when  exiting  BBBBMMMM  via the qqqq command or when
  320.           changing to an alternate mailbox with the nnnn command.
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.                                     - 6 -
  335.  
  336.  
  337.  
  338.           _h
  339.  
  340.           Display message headers. The message headers  contain  the
  341.           message  number, the status indicating whether it has been
  342.           read or deleted, the sender, size, date, and subject.
  343.  
  344.  
  345.           _u__[__m_s_g_l_i_s_t__]
  346.  
  347.           Undelete a message that is marked for deletion. The status
  348.           of  a  message  can be determined by looking at the status
  349.           field of the message using the hhhh command.
  350.  
  351.  
  352.           _n__[__m_a_i_l_b_o_x__]
  353.  
  354.           Display or change mailbox. The nnnn command with no arguments
  355.           will  display  a  list of mailboxes containing mail. If an
  356.           argument is supplied, then the current mailbox  is  closed
  357.           and a new mailbox is opened.
  358.  
  359.  
  360.           _!__c_m_d
  361.  
  362.           Run a DOS command from inside BBBBMMMM. An  error  message  will
  363.           result if there is not enough memory available to load the
  364.           command.
  365.  
  366.  
  367.           _?
  368.  
  369.           Print a help menu for BBBBMMMM commands.
  370.  
  371.  
  372.           _s__[__m_s_g_l_i_s_t__]__[__f_i_l_e__]
  373.  
  374.           The ssss command is used to save messages in a  file.  If  no
  375.           filename  is  given  the default from the mbox variable in
  376.           \bm.rc is used.  If no message number is supplied then the
  377.           current  message  is  saved.  The message is stored in the
  378.           same format as a mailbox file with all mail  headers  left
  379.           intact.
  380.  
  381.  
  382.           _p__[__m_s_g_l_i_s_t__]
  383.  
  384.           The pppp command is used to send  messages  to  the  printer.
  385.           This  command  uses  the  DOS device PPPPRRRRNNNN for output.  This
  386.           command is equivalent to:
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.                                     - 7 -
  401.  
  402.  
  403.  
  404.                               s [ msglist ] PRN
  405.  
  406.  
  407.  
  408.           _w__[__m_s_g_l_i_s_t__]__f_i_l_e
  409.  
  410.           The wwww command is used to save messages in a file. Only the
  411.           message  body  is saved. All mail headers are removed.  If
  412.           no message number is supplied then the current message  is
  413.           saved.
  414.  
  415.  
  416.           _f__[__m_s_g__]
  417.  
  418.           The ffff command is used to forward a mail message to another
  419.           recipient.   If  no message number is supplied the current
  420.           message is used.  The user is prompted for the  recipients
  421.           and  a  subject. The RFC822 header is added to the message
  422.           text while retaining the complete original message in  the
  423.           body.  Also see the ~m command.
  424.  
  425.  
  426.           _b__[__m_s_g__]
  427.  
  428.           Bounce a message. Bounce  is  similar  to  forwarding  but
  429.           instead  of  your  user  information,  the original sender
  430.           information  is  maintained.   If  no  message  number  is
  431.           supplied the current message is used.
  432.  
  433.  
  434.           _r__[__m_s_g__]
  435.  
  436.           Reply to a message. Reply reads the header information  in
  437.           order  to construct a reply to the sender. The destination
  438.           information is taken  from  the  "From:"  or  the  "Reply-
  439.           To:"header, if included.  If no message number is supplied
  440.           the current message is used.
  441.  
  442.  
  443.           _m_s_g_#
  444.  
  445.           Entering  a message number from the  header  listing  will
  446.           cause the message text to be displayed.
  447.  
  448.  
  449.           _l
  450.  
  451.           List outbound messages.  The job number, the  sender,  and
  452.           the destination for each message is displayed. A status of
  453.           "L" will appear if the SMTP sender has the file locked.
  454.  
  455.  
  456.  
  457.  
  458.  
  459.  
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466.                                     - 8 -
  467.  
  468.  
  469.  
  470.           _k__[__m_s_g_l_i_s_t__]
  471.  
  472.           Remove an outbound message from the mqueue.  A message can
  473.           be  removed  from  the  send  queue  by specifying the job
  474.           number obtained by the  l  command.   If  the  message  is
  475.           locked  you will be warned that you may be removing a file
  476.           that is currently being sent by SMTP. You  will  asked  if
  477.           this job should still be killed.
  478.  
  479.  
  480.  
  481.           _$
  482.  
  483.           Update the mailbox.  This  command  updates  the  mailbox,
  484.           deleting  messages  marked for deletion and reading in any
  485.           new mail that may have arrived since entering BBBBMMMM.
  486.  
  487.  
  488.           _x
  489.  
  490.           Exit to DOS without changing the data in the mailbox.
  491.  
  492.  
  493.           _q
  494.  
  495.           Quit to DOS updating the mailbox.
  496.  
  497.  
  498.           3.21  _T_e_x_t__i_n_p_u_t__c_o_m_m_a_n_d_s
  499.  
  500.           The  following  commands  are  available  while   entering
  501.           message text into the message buffer.
  502.  
  503.           ~r <filename>  read <filename> into the message buffer.
  504.  
  505.           ~m <msg #>     read <msg #> into the message buffer.
  506.  
  507.           ~p             display the text in the message buffer.
  508.  
  509.           ~e             invoke the editor defined in \bm.rc with  a
  510.                          temporary  file  containing the text in the
  511.                          message buffer.
  512.  
  513.           ~q             Abort the current message. No data is sent.
  514.  
  515.           ~~             Insert a single tilda  character  into  the
  516.                          message.
  517.  
  518.           ~?             Display help menu of tilda escape commands.
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525.  
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532.                                     - 9 -
  533.  
  534.  
  535.  
  536.           4.  _M_a_i_l_e_r__O_p_e_r_a_t_i_o_n
  537.  
  538.           4.1  _C_o_m_m_a_n_d__L_i_n_e__O_p_t_i_o_n_s
  539.  
  540.           BBBBMMMM may be invoked as follows:
  541.  
  542.                To send mail:
  543.                bm [ -s subject ] recip1 .. .. recipN
  544.  
  545.                To read mail:
  546.                bm [ -u mailbox | -f file ]
  547.  
  548.           -s subject     This option sets the subject to the text on
  549.                          the command line.
  550.  
  551.  
  552.           -u  mailbox     Specify  which  mailbox  to   read.   This
  553.                          overides the default from the bm.rc.
  554.  
  555.  
  556.           -f file        Read  message  from  "file"  instead  of  a
  557.                          mailbox.
  558.  
  559.           4.2  _S_e_n_d_i_n_g__M_a_i_l
  560.  
  561.           4.3  _R_e_a_d_i_n_g__M_a_i_l
  562.  
  563.  
  564.           5.  _B_M_/_S_M_T_P__I_n_t_e_r_f_a_c_e
  565.  
  566.           5.1  _F_i_l_e__F_o_r_m_a_t_s
  567.  
  568.  
  569.           6.  _B_u_g__R_e_p_o_r_t_s
  570.  
  571.           Please send any comments, suggestions or bug reports to:
  572.  
  573.           Dave Trulli
  574.           Usenet: nn2z@ka9q.bellcore.com
  575.           packet: nn2z@nn2z
  576.           AMPRNET: nn2z@nn2z.ampr [44.64.0.10]
  577.  
  578.  
  579.  
  580.  
  581.  
  582.  
  583.  
  584.  
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.  
  592.  
  593.  
  594.  
  595.