Merge from vendor branch SENDMAIL:
[dragonfly.git] / contrib / sendmail-8.13.8 / mail.local / mail.local.0
1 MAIL.LOCAL(8)                                                    MAIL.LOCAL(8)
2
3
4
5 N\bNA\bAM\bME\bE
6        mail.local - store mail in a mailbox
7
8 S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
9        m\bma\bai\bil\bl.\b.l\blo\boc\bca\bal\bl [-\b-7\b7] [-\b-b\bb] [-\b-d\bd] [-\b-D\bD _\bm_\bb_\bd_\bb] [-\b-l\bl] [-\b-f\bf _\bf_\br_\bo_\bm|-\b-r\br _\bf_\br_\bo_\bm] [-\b-h\bh _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be
10        ] _\bu_\bs_\be_\br _\b._\b._\b.
11
12 D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
13        M\bMa\bai\bil\bl.\b.l\blo\boc\bca\bal\bl reads the standard input up to an end-of-file and appends it
14        to each _\bu_\bs_\be_\br_\b'_\bs m\bma\bai\bil\bl file.  The _\bu_\bs_\be_\br must be a valid user name.
15
16        The options are as follows:
17
18        -\b-7\b7        Do not advertise 8BITMIME support in LMTP mode.
19
20        -\b-b\bb        Return  a  permanent  error instead of a temporary error if a
21                  mailbox exceeds quota.
22
23        -\b-d\bd        Specify this is  a  delivery  (for  backward  compatibility).
24                  This option has no effect.
25
26        -\b-D\bD _\bm_\bb_\bd_\bb   Specify  the  name  of  the mailbox database which is used to
27                  look up local recipient names.  This option defaults to "pw",
28                  which means use getpwnam().
29
30        -\b-f\bf _\bf_\br_\bo_\bm   Specify the sender's name.
31
32        -\b-l\bl        Turn on LMTP mode.
33
34        -\b-r\br _\bf_\br_\bo_\bm   Specify the sender's name (for backward compatibility).  Same
35                  as -f.
36
37        -\b-h\bh _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be
38                  Store incoming mail in _\bf_\bi_\bl_\be_\bn_\ba_\bm_\be in the user's home  directory
39                  instead of a system mail spool directory.
40
41        The  next  options  are  only available if m\bma\bai\bil\bl.\b.l\blo\boc\bca\bal\bl has been compiled
42        with -DHASHSPOOL.
43
44        -\b-H\bH _\bh_\ba_\bs_\bh_\bt_\by_\bp_\be_\bh_\ba_\bs_\bh_\bd_\be_\bp_\bt_\bh
45               Select hashed mail directories.  Valid hash types are u\bu for user
46               name  and  m\bm for MD5 (requires compilation with -DHASHSPOOLMD5).
47               Example: -\b-H\bH _\bu_\b2 selects user name hashing with a hash depth of 2.
48               Note:  there  must  be  no  space  between the hash type and the
49               depth.
50
51        -\b-p\bp _\bp_\ba_\bt_\bh
52               Specify an alternate mail spool path.
53
54        -\b-n\bn     Specify that the domain part of recipient addresses in LMTP mode
55               should not be stripped.
56
57        Individual  mail messages in the mailbox are delimited by an empty line
58        followed by a line beginning with the string ``From ''.   A  line  con-
59        taining  the  string  ``From  '', the sender's name and a time stamp is
60        prepended to each delivered mail message.  A blank line is appended  to
61        each  message.   A  greater-than  character (``>'') is prepended to any
62        line in the message which could be mistaken for a ``From  ''  delimiter
63        line (that is, a line beginning with the five characters ``From '' fol-
64        lowing a blank line).
65
66        The mail files are exclusively  locked  with  flock(2)  while  mail  is
67        appended,  and  a  u\bus\bse\ber\br.\b.l\blo\boc\bck\bk  file also is created while the mailbox is
68        locked for compatibility with older MUAs.
69
70        If the ``biff'' service  is  returned  by  getservbyname(3),  the  biff
71        server is notified of delivered mail.
72
73        The m\bma\bai\bil\bl.\b.l\blo\boc\bca\bal\bl utility exits 0 on success, and >0 if an error occurs.
74
75 E\bEN\bNV\bVI\bIR\bRO\bON\bNM\bME\bEN\bNT\bT
76        TZ     Used to set the appropriate time zone on the timestamp.
77
78 F\bFI\bIL\bLE\bES\bS
79        /tmp/local.XXXXXX     temporary files
80        /var/mail/user        user's default mailbox directory
81        /var/mail/user.lock   lock file for a user's default mailbox
82
83 S\bSE\bEE\bE A\bAL\bLS\bSO\bO
84        mail(1), xsend(1), flock(2), getservbyname(3), comsat(8), sendmail(8)
85
86 W\bWA\bAR\bRN\bNI\bIN\bNG\bG
87        m\bma\bai\bil\bl.\b.l\blo\boc\bca\bal\bl  escapes  only "^From " lines that follow an empty line.  If
88        all lines starting with "From " should be escaped, use the 'E' flag for
89        the local mailer in the sendmail.cf file.
90
91 H\bHI\bIS\bST\bTO\bOR\bRY\bY
92        A  superset  of  m\bma\bai\bil\bl.\b.l\blo\boc\bca\bal\bl  (handling  mailbox reading as well as mail
93        delivery) appeared in Version 7 AT&T UNIX as the program m\bma\bai\bil\bl.
94
95
96
97                          $Date: 2003/10/20 20:26:51 $            MAIL.LOCAL(8)