home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 4 / DATAFILE_PDCD4.iso / unix / riscbsd / 1_1_contri / usd / 08_mh / inc_me < prev    next >
Encoding:
Text File  |  1986-04-15  |  4.8 KB  |  144 lines
  1. .\"    This file is automatically generated.  Do not edit!
  2. .SC INC 1
  3. .NA
  4. inc \- incorporate new mail
  5. .SY
  6. inc
  7. \%[+folder]
  8. \%[\-audit\ audit\-file] \%[\-noaudit]
  9. \%[\-changecur] \%[\-nochangecur]
  10. \%[\-form\ formatfile]
  11. \%[\-format\ string]
  12. \%[\-file\ name]
  13. \%[\-silent] \%[\-nosilent]
  14. \%[\-truncate] \%[\-notruncate]
  15. \%[\-width\ columns]
  16. \%[\-help]
  17. .DE
  18. \fIInc\fR incorporates mail from the user's incoming mail drop
  19. into an \fIMH\fR folder.
  20. If `+folder' isn't specified,
  21. the folder named \*(lqinbox\*(rq in the user's \fIMH\fR directory will be used.
  22. The
  23. new messages being incorporated are assigned numbers starting
  24. with the next highest number in the folder.
  25. If the specified (or default) folder doesn't exist,
  26. the user will be queried prior to its creation.
  27. As the messages are processed,
  28. a \fIscan\fR listing of the new mail is produced.
  29.  
  30. If the user's profile contains a \*(lqMsg\-Protect: nnn\*(rq entry, it
  31. will be used as the protection on the newly created messages,
  32. otherwise the \fIMH\fR default of 0644 will be used.
  33. During all operations on messages,
  34. this initially assigned protection will
  35. be preserved for each message, so \fIchmod\fR(1) may be used to set a
  36. protection on an individual message, and its protection will be
  37. preserved thereafter.
  38.  
  39. If the switch `\-audit\ audit\-file' is specified (usually as a
  40. default switch in the profile), then \fIinc\fR will append a header
  41. line and a line per message to the end of the specified
  42. audit\-file with the format:
  43.  
  44. .nf
  45. .ti 1i
  46. \*(<<inc\*(>> date
  47. .ti 1.5i
  48. <scan line for first message>
  49. .ti 1.5i
  50. <scan line for second message>
  51. .ti 2.5i
  52. <etc.>
  53. .fi
  54.  
  55. This is useful for keeping track of volume and source of incoming
  56. mail.
  57. Eventually, \fIrepl\fR, \fIforw\fR, \fIcomp\fR, and \fIdist\fR may also
  58. produce audits to this (or another) file, perhaps with
  59. \*(lqMessage\-Id:\*(rq information to keep an exact correspondence history.
  60. \*(lqAudit\-file\*(rq will be in the user's MH directory unless a full
  61. path is specified.
  62.  
  63. \fIInc\fR will incorporate even improperly formatted messages into the
  64. user's MH folder, inserting a blank line prior to the offending
  65. component and printing a comment identifying the bad message.
  66.  
  67. In all cases, the user's mail drop will be zeroed,
  68. unless the `\-notruncate' switch is given.
  69.  
  70. If the profile entry \*(lqUnseen\-Sequence\*(rq is present and non\-empty,
  71. then \fIinc\fR will add each of the newly incorporated messages to each
  72. sequence named by the profile entry.
  73. This is similar to the \*(lqPrevious\-Sequence\*(rq profile entry supported
  74. by all \fIMH\fR commands which take `msgs' or `msg' arguments.
  75. Note that \fIinc\fR will not zero each sequence prior to adding messages.
  76.  
  77. The interpretation of the `\-form\ formatfile', `\-format\ string',
  78. and `\-width\ columns' switches is the same as in \fIscan\fR\0(1).
  79.  
  80. By using the `\-file\ name' switch, one can direct \fIinc\fR to incorporate
  81. messages from a file other than the user's maildrop.
  82. Note that the name file will NOT be zeroed,
  83. unless the `\-truncate' switch is given.
  84.  
  85. If the environment variable \fB$MAILDROP\fR is set,
  86. then \fIinc\fR uses it as the location of the user's maildrop instead of the
  87. default (the `-file\ name' switch still overrides this, however).
  88. If this environment variable is not set,
  89. then \fIinc\fR will consult the profile entry \*(lqMailDrop\*(rq for this
  90. information.
  91. If the value found is not absolute,
  92. then it is interpreted relative to the user's \fIMH\fR directory.
  93. If the value is not found,
  94. then \fIinc\fR will look in the standard system location for the user's
  95. maildrop.
  96.  
  97. The `\-silent' switch directs \fIinc\fR to be quiet and not ask any questions
  98. at all.
  99. This is useful for putting \fIinc\fR in the background and going on to other
  100. things.
  101. .Fi
  102. ^$HOME/\&.mh\(ruprofile~^The user profile
  103. ^/usr/new/lib/mh/mtstailor~^tailor file
  104. ^/usr/spool/mail/$USER~^Location of mail drop
  105. .Pr
  106. ^Path:~^To determine the user's MH directory
  107. .Ps
  108. ^Alternate\-Mailboxes:~^To determine the user's mailboxes
  109. .Ps
  110. ^Folder\-Protect:~^To set mode when creating a new folder
  111. .Ps
  112. ^Msg\-Protect:~^To set mode when creating a new message and audit\-file
  113. .Ps
  114. ^Unseen\-Sequence:~^To name sequences denoting unseen messages
  115. .Sa
  116. mhmail(1), scan(1), mh\-mail(5), post(8)
  117. .De
  118. `+folder' defaults to \*(lqinbox\*(rq
  119. .Ds
  120. `\-noaudit'
  121. .Ds
  122. `\-changecur'
  123. .Ds
  124. `\-format' defaulted as described above
  125. .Ds
  126. `\-nosilent'
  127. .Ds
  128. `\-truncate' if `\-file\ name' not given, `\-notruncate' otherwise
  129. .Ds
  130. `\-width' defaulted to the width of the terminal
  131. .Co
  132. The folder into which messages are being incorporated will become the
  133. current folder.
  134. The first message incorporated will become the current message,
  135. unless the `\-nochangecur' option is specified.
  136. This leaves the context ready for a \fIshow\fR
  137. of the first new message.
  138. .Bu
  139. The argument to the `\-format' switch must be interpreted as a single token
  140. by the shell that invokes \fIinc\fR.
  141. Therefore,
  142. one must usually place the argument to this switch inside double\-quotes.
  143. .En
  144.