git.marmaro.de Git - mmh/blob - man/inc.man

   1 .\"
   2 .\" %nmhwarning%
   3 .\" $Id$
   4 .\"
   5 .\" include the -mh macro file
   6 .so %etcdir%/tmac.h
   7 .\"
   8 .TH INC %manext1% MH.6.8 [%nmhversion%]
   9 .SH NAME
  10 inc \- incorporate new mail
  11 .SH SYNOPSIS
  12 .in +.5i
  13 .ti -.5i
  14 inc
  15 \%[+folder]
  16 \%[\-audit\ audit\-file] \%[\-noaudit]
  17 \%[\-changecur]
  18 .br
  19 \%[\-nochangecur]
  20 \%[\-form\ formatfile]
  21 \%[\-format\ string]
  22 .br
  23 \%[\-file\ name]
  24 \%[\-silent] \%[\-nosilent]
  25 \%[\-truncate]
  26 .br
  27 \%[\-notruncate]
  28 \%[\-width\ columns]
  29 %nmhbeginpop%
  30 \%[\-host\ hostname]
  31 .br
  32 \%[\-user\ username]
  33 \%[\-pack\ file]
  34 \%[\-nopack]
  35 \%[\-kpop]
  36 .br
  37 %nmhendpop%
  38 \%[\-version]
  39 \%[\-help]
  40 .in -.5i
  41 .SH DESCRIPTION
  42 \fIInc\fR incorporates mail from the user's incoming mail drop into
  43 an \fInmh\fR folder.
  44
  45 You may specify which folder to use with `+folder'.  If no folder
  46 is specified, then \fIinc\fR will use either the folder given by a
  47 (non\-empty) \*(lqInbox:\*(rq entry in the user's profile, or the folder
  48 named \*(lqinbox\*(rq.  If the specified (or default) folder doesn't
  49 exist, the user will be queried prior to its creation.
  50
  51 When the new messages are incorporated into the folder, they are assigned
  52 numbers starting with the next highest number for the folder.  As the
  53 messages are processed, a \fIscan\fR listing of the new mail is produced.
  54
  55 If the user's profile contains a \*(lqMsg\-Protect: nnn\*(rq entry, it
  56 will be used as the protection on the newly created messages, otherwise
  57 the \fInmh\fR default of 0644 will be used.  For all subsequent operations
  58 on these messages, this initially assigned protection will be preserved.
  59
  60 If the switch `\-audit\ audit\-file' is specified (usually as a default
  61 switch in the profile), then \fIinc\fR will append a header line and a
  62 line per message to the end of the specified audit\-file with the format:
  63
  64 .nf
  65 .ti 1i
  66 \*(<<inc\*(>> date
  67 .ti 1.5i
  68 <scan line for first message>
  69 .ti 1.5i
  70 <scan line for second message>
  71 .ti 2.5i
  72 <etc.>
  73 .fi
  74
  75 This is useful for keeping track of volume and source of incoming mail.
  76 Eventually, \fIrepl\fR, \fIforw\fR, \fIcomp\fR, and \fIdist\fR
  77 may also produce audits to this (or another) file, perhaps with
  78 \*(lqMessage\-Id:\*(rq information to keep an exact correspondence
  79 history.  \*(lqAudit\-file\*(rq will be in the user's nmh directory unless
  80 a full path is specified.
  81
  82 \fIInc\fR will incorporate even improperly formatted messages into the
  83 user's nmh folder, inserting a blank line prior to the offending component
  84 and printing a comment identifying the bad message.
  85
  86 In all cases, the user's mail drop will be zeroed, unless the
  87 `\-notruncate' switch is given.
  88
  89 If the profile entry \*(lqUnseen\-Sequence\*(rq is present and non\-empty,
  90 then \fIinc\fR will add each of the newly incorporated messages to
  91 each sequence named by the profile entry.  \fIInc\fR will not zero each
  92 sequence prior to adding messages.
  93
  94 The interpretation of the `\-form\ formatfile', `\-format\ string', and
  95 `\-width\ columns' switches is the same as in \fIscan\fR\0(1).
  96
  97 By using the `\-file\ name' switch, one can direct \fIinc\fR to
  98 incorporate messages from a file other than the user's maildrop.
  99 Note that the name file will NOT be zeroed, unless the `\-truncate'
 100 switch is given.
 101
 102 If the environment variable \fB$MAILDROP\fR is set, then \fIinc\fR
 103 uses it as the location of the user's maildrop instead of the default
 104 (the `-file\ name' switch still overrides this, however).  If this
 105 environment variable is not set, then \fIinc\fR will consult the profile
 106 entry \*(lqMailDrop\*(rq for this information.  If the value found is
 107 not absolute, then it is interpreted relative to the user's \fInmh\fR
 108 directory.  If the value is not found, then \fIinc\fR will look in the
 109 standard system location for the user's maildrop.
 110
 111 The `\-silent' switch directs \fIinc\fR to be quiet and not ask any
 112 questions at all.  This is useful for putting \fIinc\fR in the background
 113 and going on to other things.
 114 %nmhbeginpop%
 115
 116 .Uh "Using POP"
 117 \fIinc\fR will normally check local mail drops for mail, as given
 118 above.  But if the option \*(lqpophost:\*(rq is set in the mts
 119 configuration file \*(lqmts.conf\*(rq, or if the `\-host\ hostname'
 120 switch is given, then \fIinc\fR will query this POP service host
 121 for mail to incorporate.
 122
 123 The default is for \fIinc\fR to assume that your account name on
 124 the POP server is the same as your current username.  To specify
 125 a different username, use the `\-user\ username' switch.
 126
 127 When using POP, you will normally need to type the password for
 128 your account on the POP server, in order to retrieve your messages.
 129 It is possible to automate this process by creating a \*(lq.netrc\*(rq
 130 file containing your login account information for this POP server.
 131 For each POP server, this file should have a line of the following
 132 form.  Replace the words mypopserver, mylogin, and mypassword with
 133 your own account information.
 134
 135 machine mypopserver login mylogin password mypassword
 136
 137 This \*(lq.netrc\*(rq file should be owned and readable only by
 138 you.
 139
 140 If \fIinc\fR uses POP, then the `\-pack\ file' switch is considered.
 141 If given, then \fIinc\fR simply uses the POP to \fIpackf\fR\0(1) the
 142 user's maildrop from the POP service host to the named file.  This switch
 143 is provided for those users who prefer to use \fImsh\fR to read their
 144 maildrops.
 145
 146 For debugging purposes, you may give the switch `\-snoop', which will
 147 allow you to watch the POP transaction take place between you and the
 148 POP server.
 149
 150 If nmh has been compiled with KPOP #defined, the `\-kpop' switch will allow
 151 \fIinc\fR to use Kerberized POP rather than standard POP3 on a given invocation.
 152 If POPSERVICE was also #defined to "kpop", \fIinc\fR will be hardwired to always
 153 use KPOP.
 154 %nmhendpop%
 155 .Fi
 156 ^$HOME/\&.mh\(ruprofile~^The user profile
 157 ^%etcdir%/mts.conf~^nmh mts configuration file
 158 ^%mailspool%/$USER~^Location of mail drop
 159 .Pr
 160 ^Path:~^To determine the user's nmh directory
 161 .Ps
 162 ^Alternate\-Mailboxes:~^To determine the user's mailboxes
 163 .Ps
 164 ^Inbox:~^To determine the inbox, default \*(lqinbox\*(rq
 165 .Ps
 166 ^Folder\-Protect:~^To set mode when creating a new folder
 167 .Ps
 168 ^Msg\-Protect:~^To set mode when creating a new message and audit\-file
 169 .Ps
 170 ^Unseen\-Sequence:~^To name sequences denoting unseen messages
 171 .Sa
 172 mhmail(1), scan(1), mh\-mail(5), post(8)
 173 .De
 174 `+folder' defaulted by \*(lqInbox\*(rq above
 175 .Ds
 176 `\-noaudit'
 177 .Ds
 178 `\-changecur'
 179 .Ds
 180 `\-format' defaulted as described above
 181 .Ds
 182 `\-nosilent'
 183 .Ds
 184 `\-truncate' if `\-file\ name' not given, `\-notruncate' otherwise
 185 .Ds
 186 `\-width' defaulted to the width of the terminal
 187 %nmhbeginpop%
 188 .Ds
 189 `\-nopack'
 190 %nmhendpop%
 191 .Co
 192 The folder into which messages are being incorporated will become the
 193 current folder.  The first message incorporated will become the current
 194 message, unless the `\-nochangecur' option is specified.  This leaves
 195 the context ready for a \fIshow\fR of the first new message.
 196 .Bu
 197 The argument to the `\-format' switch must be interpreted as a single
 198 token by the shell that invokes \fIinc\fR.  Therefore, one must usually
 199 place the argument to this switch inside double\-quotes.
 200 .En