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