home *** CD-ROM | disk | FTP | other *** search
/ ProfitPress Mega CDROM2 …eeware (MSDOS)(1992)(Eng) / ProfitPress-MegaCDROM2.B6I / MISC / NETWORK / KA9QBGN.ZIP / BM.TXT next >
Encoding:
Text File  |  1991-04-28  |  15.3 KB  |  587 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                                 BM User Manual
  8.  
  9.  
  10.  
  11.                               Dave Trulli, NN2Z
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.           1.  What is BM?
  22.  
  23.  
  24.  
  25.           BM is designed to serve as the mail user-interface for the
  26.  
  27.           KA9Q  TCP/IP  inter-networking package. It provides a full
  28.  
  29.           set of mail services to the user which allows the  sending
  30.  
  31.           and receipt of electronic mail.
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.           2.  BM Installation
  40.  
  41.  
  42.  
  43.           To install BM requires the modification  of  the  supplied
  44.  
  45.           configuration   files  and  the  creation  of  the  proper
  46.  
  47.           directory structure.  The following sections describe  the
  48.  
  49.           file and directory structure used by BM and SMTP.
  50.  
  51.  
  52.  
  53.  
  54.  
  55.           2.1  Directory Structure
  56.  
  57.  
  58.  
  59.           \spool\mqueue   This directory  holds  the  outbound  mail
  60.  
  61.                           jobs  for  SMTP.  Each  job  consists of 2
  62.  
  63.                           files a xxxx.txt and xxxx.wrk  file  where
  64.  
  65.                           xxxx  is  a  unique numerical prefix.  The
  66.  
  67.                           format of the files  are  described  in  a
  68.  
  69.                           later section.
  70.  
  71.  
  72.  
  73.  
  74.  
  75.           \spool\rqueue   This directory is used by  SMTP  for  jobs
  76.  
  77.                           that   have  been  received  and  will  be
  78.  
  79.                           processed by a user defined  mail  routing
  80.  
  81.                           program.    This  directory  is  not  used
  82.  
  83.                           directly by BM.
  84.  
  85.  
  86.  
  87.  
  88.  
  89.           \spool\mail     This  directory   holds   the   individual
  90.  
  91.                           mailboxes  for  each  user  name  on  your
  92.  
  93.                           system. The extension .txt is add  to  the
  94.  
  95.                           user  name  to form the mailbox name. Mail
  96.  
  97.                           received by the SMTP server is appended to
  98.  
  99.                           the mailbox file.
  100.  
  101.  
  102.  
  103.  
  104.  
  105.           2.2  Configuration Files
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.                                  - 2 -
  140.  
  141.  
  142.  
  143.  
  144.  
  145.  
  146.  
  147.           2.2.1  The\bm.rc file  The \bm.rc file provides  BM  with
  148.  
  149.           the configuration needed for the operation of the mailer.
  150.  
  151.  
  152.  
  153.           The format for the \bm.rc file is:
  154.  
  155.  
  156.  
  157.                variable <space>  value <newline>
  158.  
  159.  
  160.  
  161.  
  162.  
  163.           The following variables are valid in the bm.rc file:
  164.  
  165.  
  166.  
  167.  
  168.  
  169.           smtp <mailpath>
  170.  
  171.  
  172.  
  173.           defines the path to the directory containing  the  mailbox
  174.  
  175.           files.   The  default  directory  is  \spool\mail  on  the
  176.  
  177.           current drive.
  178.  
  179.  
  180.  
  181.  
  182.  
  183.           host <yourhostname>
  184.  
  185.  
  186.  
  187.           Is used to set the local hostname for use  in  the  RFC822
  188.  
  189.           mail headers. This is a required field.
  190.  
  191.  
  192.  
  193.  
  194.  
  195.           user <username>
  196.  
  197.  
  198.  
  199.           Defines the user name of the person who is  sending  mail.
  200.  
  201.           This is also used as the default mailbox for reading mail.
  202.  
  203.           On the AMPRNET this is usually set to your call.  There is
  204.  
  205.           a DOS limit of 8 characters for the user name.
  206.  
  207.  
  208.  
  209.  
  210.  
  211.           edit <pathofyoureditor>
  212.  
  213.  
  214.  
  215.           Defines the name of your favorite editor which can be used
  216.  
  217.           to construct and  edit the text of outgoing messages.  The
  218.  
  219.           use of edit is optional.
  220.  
  221.  
  222.  
  223.  
  224.  
  225.           fullname <yourfullname>
  226.  
  227.  
  228.  
  229.           Is used to provide your full name to the mailer for use in
  230.  
  231.           the  comment  portion  of "From:" header line.  The use of
  232.  
  233.           fullname is optional.
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271.                                      - 3 -
  272.  
  273.  
  274.  
  275.  
  276.  
  277.  
  278.  
  279.           reply <returnaddress>
  280.  
  281.  
  282.  
  283.           Defines the address where you wish to receive  replies  to
  284.  
  285.           messages sent.  This option is useful if you are operating
  286.  
  287.           your pc on a local area network and would like  your  mail
  288.  
  289.           replies  sent  to  a  more "well known host".  The address
  290.  
  291.           specified by reply  is  used  to  generate  a  "Reply-To:"
  292.  
  293.           header  in outbound mail. The "Reply-To:" header overrides
  294.  
  295.           the "From:" header which is the address normally  used  to
  296.  
  297.           reply to mail. This field is optional.
  298.  
  299.  
  300.  
  301.  
  302.  
  303.           maxlet <numberofmessages>
  304.  
  305.  
  306.  
  307.           defines  the  maximum  number  of  messages  that  can  be
  308.  
  309.           processed by BM  in one mailbox file. The default value of
  310.  
  311.           maxlet is 100.
  312.  
  313.  
  314.  
  315.  
  316.  
  317.           mbox <filename>
  318.  
  319.  
  320.  
  321.           Specifies the default file  to  be  used  for  the  "save"
  322.  
  323.           command.  This file is in the same format as a mailbox and
  324.  
  325.           may later be viewed using the -f option  of  BM.  If  this
  326.  
  327.           option is not used then the default is set to mbox.
  328.  
  329.  
  330.  
  331.  
  332.  
  333.           record <filename>
  334.  
  335.  
  336.  
  337.           If defined a copy of each message sent will  be  saved  in
  338.  
  339.           <filename>.
  340.  
  341.  
  342.  
  343.  
  344.  
  345.           folder <directoryname>
  346.  
  347.  
  348.  
  349.           If defined folder contains  the  path  used  by  the  save
  350.  
  351.           command.
  352.  
  353.  
  354.  
  355.  
  356.  
  357.           screen [bios|direct]
  358.  
  359.  
  360.  
  361.           In the Turboc compiled version  of  BM,  screen  sets  the
  362.  
  363.           display  output mode to use either direct writes to screen
  364.  
  365.           memory or the ROM  BIOS.   The  default  is  direct  which
  366.  
  367.           provides  the  fastest  output  mode.   If you are using a
  368.  
  369.           windowing system such as Desqview you should set the  mode
  370.  
  371.           to bios.
  372.  
  373.  
  374.  
  375.           Here is a sample bm.rc file.
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.  
  401.  
  402.  
  403.                     - 4 -
  404.  
  405.  
  406.  
  407.  
  408.  
  409.  
  410.  
  411.                host nn2z.ampr
  412.  
  413.                user nn2z
  414.  
  415.                fullname Dave Trulli
  416.  
  417.                # send my replies to the Sun
  418.  
  419.                reply nn2z@ka9q.bellcore.com
  420.  
  421.                screen  direct
  422.  
  423.                edit /bin/vi
  424.  
  425.                mbox c:/folder/mbox
  426.  
  427.                record c:/folder/outmail
  428.  
  429.                folder c:/folder
  430.  
  431.                maxlet 200
  432.  
  433.  
  434.  
  435.  
  436.  
  437.  
  438.  
  439.           2.13.1  The\alias file  The alias file provides  an  easy
  440.  
  441.           way to maintain mailing lists.  An alias can be any string
  442.  
  443.           of characters not containing the "@" symbol.   The  format
  444.  
  445.           for the alias file is:
  446.  
  447.  
  448.  
  449.                alias   recip1 recip2 recip3
  450.  
  451.                <tab>   recip4
  452.  
  453.  
  454.  
  455.           Note that a long list of aliases can be  continued  on  an
  456.  
  457.           additional   line  by  placing  a  tab  or  space  on  the
  458.  
  459.           continuation line.
  460.  
  461.  
  462.  
  463.           Some examples aliases are:
  464.  
  465.  
  466.  
  467.                dave    nn2z@nn2z.ampr
  468.  
  469.  
  470.  
  471.                phil    karn@ka9q.bellcore.com
  472.  
  473.  
  474.  
  475.                # mail to local nnj users
  476.  
  477.                nnj     wb2cop@wb2cop.ampr karn@ka9q.bellcore.com
  478.  
  479.                        wb0mpq@home.wb0mpq.ampr w2kb@w2kb.ampr 
  480.  
  481.                ka2tsm@ka2tsm.ampr
  482.  
  483.  
  484.  
  485.           In  the  above  example,  when  specifying  nnj   as   the
  486.  
  487.           recipient,  BM  will  expand  the  alias  into the list of
  488.  
  489.           recipients from the alias file.  At this time an alias may
  490.  
  491.           not contain any other aliases.
  492.  
  493.  
  494.  
  495.  
  496.  
  497.           2.13.2  \spool\mqueue\sequence.seq   The   sequence   file
  498.  
  499.           maintains  a  message counter which is used by BM and SMTP
  500.  
  501.           to generate message ids and unique filenames.   This  file
  502.  
  503.           is created by BM.
  504.  
  505.  
  506.  
  507.  
  508.  
  509.  
  510.  
  511.  
  512.  
  513.  
  514.  
  515.  
  516.  
  517.  
  518.  
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525.  
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532.  
  533.  
  534.  
  535.  
  536.  
  537.                     - 5 -
  538.  
  539.  
  540.  
  541.  
  542.  
  543.  
  544.  
  545.           2.14  Environment
  546.  
  547.  
  548.  
  549.           The timezone used in mail headers is obtained from the DOS
  550.  
  551.           environment variable TZ. An example TZ setting is:
  552.  
  553.  
  554.  
  555.                set TZ=EDT4
  556.  
  557.  
  558.  
  559.           It  is  set  in  your  AUTOEXEC.BAT  file.  The  first   3
  560.  
  561.           characters  are  the  timezone and the fourth character is
  562.  
  563.           the number of hours from GMT time. If TZ is not  set,  GMT
  564.  
  565.           is assumed.
  566.  
  567.  
  568.  
  569.  
  570.  
  571.  
  572.  
  573.           3.  Commands
  574.  
  575.  
  576.  
  577.           All BM commands are single letters  followed  by  optional
  578.  
  579.           arguments.   The  command  list  has been designed to make
  580.  
  581.           those familiar with Berkeley mailers comfortable with BM.
  582.  
  583.  
  584.  
  585.  
  586.  
  587.           3.1  Main menu commands
  588.  
  589.  
  590.  
  591.           m [userlist]
  592.  
  593.  
  594.  
  595.           The mail command is used to send a message to one or  more
  596.  
  597.           recipients.  All local recipient names ( those which don't
  598.  
  599.           contain an '@' ) are checked for possible aliases.  If  no
  600.  
  601.           arguments   are  supplied  you  will  be  prompted  for  a
  602.  
  603.           recipient list.  While entering a message  into  the  text
  604.  
  605.           buffer several commands are available such as: invoking an
  606.  
  607.           editor, and reading in text from other messages or  files.
  608.  
  609.           See the section below for a description of these commands.
  610.  
  611.           To end a message enter a line containing a single period.
  612.  
  613.  
  614.  
  615.           It is important to remember that the input line buffer has
  616.  
  617.           a  128  character  limit.  You  should format your text by
  618.  
  619.           entering a carriage return at the end of each line. Typing
  620.  
  621.           excessively   long  lines  may  cause  data  loss  due  to
  622.  
  623.           truncation when passing the message through  other  hosts.
  624.  
  625.           Keeping  lines  less  than  80 characters is always a good
  626.  
  627.           idea.
  628.  
  629.  
  630.  
  631.  
  632.  
  633.           d [msglist]
  634.  
  635.  
  636.  
  637.           Mark messages for deletion.  Messages marked for  deletion
  638.  
  639.           are  removed  when  exiting  BM  via the q command or when
  640.  
  641.           changing to an alternate mailbox with the n command.
  642.  
  643.  
  644.  
  645.  
  646.  
  647.  
  648.  
  649.  
  650.  
  651.  
  652.  
  653.  
  654.  
  655.  
  656.  
  657.  
  658.  
  659.  
  660.  
  661.  
  662.  
  663.  
  664.  
  665.  
  666.  
  667.  
  668.  
  669.                     - 6 -
  670.  
  671.  
  672.  
  673.  
  674.  
  675.  
  676.  
  677.           h
  678.  
  679.  
  680.  
  681.           Display message headers. The message headers  contain  the
  682.  
  683.           message  number, the status indicating whether it has been
  684.  
  685.           read or deleted, the sender, size, date, and subject.
  686.  
  687.  
  688.  
  689.  
  690.  
  691.           u [msglist]
  692.  
  693.  
  694.  
  695.           Undelete a message that is marked for deletion. The status
  696.  
  697.           of  a  message  can be determined by looking at the status
  698.  
  699.           field of the message using the h command.
  700.  
  701.  
  702.  
  703.  
  704.  
  705.           n [mailbox]
  706.  
  707.  
  708.  
  709.           Display or change mailbox. The n command with no arguments
  710.  
  711.           will  display  a  list of mailboxes containing mail. If an
  712.  
  713.           argument is supplied, then the current mailbox  is  closed
  714.  
  715.           and a new mailbox is opened.
  716.  
  717.  
  718.  
  719.  
  720.  
  721.           !cmd
  722.  
  723.  
  724.  
  725.           Run a DOS command from inside BM. An  error  message  will
  726.  
  727.           result if there is not enough memory available to load the
  728.  
  729.           command.
  730.  
  731.  
  732.  
  733.  
  734.  
  735.           ?
  736.  
  737.  
  738.  
  739.           Print a help menu for BM commands.
  740.  
  741.  
  742.  
  743.  
  744.  
  745.           s [msglist] [file]
  746.  
  747.  
  748.  
  749.           The s command is used to save messages in a  file.  If  no
  750.  
  751.           filename  is  given  the default from the mbox variable in
  752.  
  753.           \bm.rc is used.  If no message number is supplied then the
  754.  
  755.           current  message  is  saved.  The message is stored in the
  756.  
  757.           same format as a mailbox file with all mail  headers  left
  758.  
  759.           intact.
  760.  
  761.  
  762.  
  763.  
  764.  
  765.           p [msglist]
  766.  
  767.  
  768.  
  769.           The p command is used to send  messages  to  the  printer.
  770.  
  771.           This  command  uses  the  DOS device PRN for output.  This
  772.  
  773.           command is equivalent to:
  774.  
  775.  
  776.  
  777.  
  778.  
  779.  
  780.  
  781.  
  782.  
  783.  
  784.  
  785.  
  786.  
  787.  
  788.  
  789.  
  790.  
  791.  
  792.  
  793.  
  794.  
  795.  
  796.  
  797.  
  798.  
  799.  
  800.  
  801.                     - 7 -
  802.  
  803.  
  804.  
  805.  
  806.  
  807.  
  808.  
  809.                               s [ msglist ] PRN
  810.  
  811.  
  812.  
  813.  
  814.  
  815.  
  816.  
  817.           w [msglist] file
  818.  
  819.  
  820.  
  821.           The w command is used to save messages in a file. Only the
  822.  
  823.           message  body  is saved. All mail headers are removed.  If
  824.  
  825.           no message number is supplied then the current message  is
  826.  
  827.           saved.
  828.  
  829.  
  830.  
  831.  
  832.  
  833.           f [msg]
  834.  
  835.  
  836.  
  837.           The f command is used to forward a mail message to another
  838.  
  839.           recipient.   If  no message number is supplied the current
  840.  
  841.           message is used.  The user is prompted for the  recipients
  842.  
  843.           and  a  subject. The RFC822 header is added to the message
  844.  
  845.           text while retaining the complete original message in  the
  846.  
  847.           body.  Also see the ~m command.
  848.  
  849.  
  850.  
  851.  
  852.  
  853.           b [msg]
  854.  
  855.  
  856.  
  857.           Bounce a message. Bounce  is  similar  to  forwarding  but
  858.  
  859.           instead  of  your  user  information,  the original sender
  860.  
  861.           information  is  maintained.   If  no  message  number  is
  862.  
  863.           supplied the current message is used.
  864.  
  865.  
  866.  
  867.  
  868.  
  869.           r [msg]
  870.  
  871.  
  872.  
  873.           Reply to a message. Reply reads the header information  in
  874.  
  875.           order  to construct a reply to the sender. The destination
  876.  
  877.           information is taken  from  the  "From:"  or  the  "Reply-
  878.  
  879.           To:"header, if included.  If no message number is supplied
  880.  
  881.           the current message is used.
  882.  
  883.  
  884.  
  885.  
  886.  
  887.           msg #
  888.  
  889.  
  890.  
  891.           Entering  a message number from the  header  listing  will
  892.  
  893.           cause the message text to be displayed.
  894.  
  895.  
  896.  
  897.  
  898.  
  899.           l
  900.  
  901.  
  902.  
  903.           List outbound messages.  The job number, the  sender,  and
  904.  
  905.           the destination for each message is displayed. A status of
  906.  
  907.           "L" will appear if the SMTP sender has the file locked.
  908.  
  909.  
  910.  
  911.  
  912.  
  913.  
  914.  
  915.  
  916.  
  917.  
  918.  
  919.  
  920.  
  921.  
  922.  
  923.  
  924.  
  925.  
  926.  
  927.  
  928.  
  929.  
  930.  
  931.  
  932.  
  933.                     - 8 -
  934.  
  935.  
  936.  
  937.  
  938.  
  939.  
  940.  
  941.           k [msglist]
  942.  
  943.  
  944.  
  945.           Remove an outbound message from the mqueue.  A message can
  946.  
  947.           be  removed  from  the  send  queue  by specifying the job
  948.  
  949.           number obtained by the  l  command.   If  the  message  is
  950.  
  951.           locked  you will be warned that you may be removing a file
  952.  
  953.           that is currently being sent by SMTP. You  will  asked  if
  954.  
  955.           this job should still be killed.
  956.  
  957.  
  958.  
  959.  
  960.  
  961.  
  962.  
  963.           $
  964.  
  965.  
  966.  
  967.           Update the mailbox.  This  command  updates  the  mailbox,
  968.  
  969.           deleting  messages  marked for deletion and reading in any
  970.  
  971.           new mail that may have arrived since entering BM.
  972.  
  973.  
  974.  
  975.  
  976.  
  977.           x
  978.  
  979.  
  980.  
  981.           Exit to DOS without changing the data in the mailbox.
  982.  
  983.  
  984.  
  985.  
  986.  
  987.           q
  988.  
  989.  
  990.  
  991.           Quit to DOS updating the mailbox.
  992.  
  993.  
  994.  
  995.  
  996.  
  997.           3.21  Text input commands
  998.  
  999.  
  1000.  
  1001.           The  following  commands  are  available  while   entering
  1002.  
  1003.           message text into the message buffer.
  1004.  
  1005.  
  1006.  
  1007.           ~r <filename>  read <filename> into the message buffer.
  1008.  
  1009.  
  1010.  
  1011.           ~m <msg #>     read <msg #> into the message buffer.
  1012.  
  1013.  
  1014.  
  1015.           ~p             display the text in the message buffer.
  1016.  
  1017.  
  1018.  
  1019.           ~e             invoke the editor defined in \bm.rc with  a
  1020.  
  1021.                          temporary  file  containing the text in the
  1022.  
  1023.                          message buffer.
  1024.  
  1025.  
  1026.  
  1027.           ~q             Abort the current message. No data is sent.
  1028.  
  1029.  
  1030.  
  1031.           ~~             Insert a single tilda  character  into  the
  1032.  
  1033.                          message.
  1034.  
  1035.  
  1036.  
  1037.           ~?             Display help menu of tilda escape commands.
  1038.  
  1039.  
  1040.  
  1041.  
  1042.  
  1043.  
  1044.  
  1045.  
  1046.  
  1047.  
  1048.  
  1049.  
  1050.  
  1051.  
  1052.  
  1053.  
  1054.  
  1055.  
  1056.  
  1057.  
  1058.  
  1059.  
  1060.  
  1061.  
  1062.  
  1063.  
  1064.  
  1065.                     - 9 -
  1066.  
  1067.  
  1068.  
  1069.  
  1070.  
  1071.  
  1072.  
  1073.           4.  Mailer    Operation
  1074.  
  1075.  
  1076.  
  1077.           4.1  Command    Line    Options
  1078.  
  1079.  
  1080.  
  1081.           BM may be invoked as follows:
  1082.  
  1083.  
  1084.  
  1085.                To send mail:
  1086.  
  1087.                bm [ -s subject ] recip1 .. .. recipN
  1088.  
  1089.  
  1090.  
  1091.                To read mail:
  1092.  
  1093.                bm [ -u mailbox | -f file ]
  1094.  
  1095.  
  1096.  
  1097.           -s subject     This option sets the subject to the text on
  1098.  
  1099.                          the command line.
  1100.  
  1101.  
  1102.  
  1103.  
  1104.  
  1105.           -u  mailbox     Specify  which  mailbox  to   read.   This
  1106.  
  1107.                          overides the default from the bm.rc.
  1108.  
  1109.  
  1110.  
  1111.  
  1112.  
  1113.           -f file        Read  message  from  "file"  instead  of  a
  1114.  
  1115.                          mailbox.
  1116.  
  1117.  
  1118.  
  1119.  
  1120.  
  1121.           6.  BugReports
  1122.  
  1123.  
  1124.  
  1125.           Please send any comments, suggestions or bug reports to:
  1126.  
  1127.  
  1128.  
  1129.           Dave Trulli
  1130.  
  1131.           Usenet: nn2z@ka9q.bellcore.com
  1132.  
  1133.           packet: nn2z@nn2z
  1134.  
  1135.           AMPRNET: nn2z@nn2z.ampr [44.64.0.10]
  1136.  
  1137.  
  1138.  
  1139.  
  1140.  
  1141.  
  1142.  
  1143.  
  1144.  
  1145.  
  1146.  
  1147.  
  1148.  
  1149.  
  1150.  
  1151.  
  1152.  
  1153.  
  1154.  
  1155.  
  1156.  
  1157.  
  1158.  
  1159.  
  1160.  
  1161.  
  1162.  
  1163.  
  1164.  
  1165.  
  1166.  
  1167.  
  1168.  
  1169.  
  1170.  
  1171.  
  1172.  
  1173.