[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Nmh-workers] Changes to mhstore.man
[Nmh-workers] Changes to mhstore.man
Thu, 23 Mar 2017 22:52:46 +0000
- store -> stored
- some formatting
There is substantial duplication between the mhlist and mhstore man
pages, along with some other page that I can't remember now because
they're all just a blur and I'm hungry and need to go outside. A
reasonable thing to do would be to, in the first instance, ensure
that all the duplicate bits are actually duplicates, and not
variations on a theme. I'll do that some day. It may also be entirely
reasonable, but probably unattainable, to merge some of these
MIME-related pages, if only so one might just have to look at the
phrase 'MIME (multi-media) messages' once.
diff --git a/man/mhstore.man b/man/mhstore.man
index 4d6c53b3..a47d9cef 100644
@@ -1,4 +1,4 @@
-.TH MHSTORE %manext1% "October 7, 2016" "%nmhversion%"
+.TH MHSTORE %manext1% "March 23, 2017" "%nmhversion%"
@@ -38,18 +38,16 @@ mhstore \- store contents of nmh MIME messages into files
-command allows you to store the contents of a
-collection of MIME (multi-media) messages into files or other
+command allows you to store the contents of a collection of MIME
+(multi-media) messages into files or other messages.
-manipulates multi-media messages as specified in
-RFC 2045 to RFC 2049.
+manipulates multi-media messages as specified in RFC 2045 to RFC 2049.
will store all the parts of each message.
-Each part will be store in a separate file. The header fields of
+Each part will be stored in a separate file. The header fields of
the message are not stored. By using the
.BR \-part ,
.BR \-type ,
@@ -63,19 +61,15 @@ The
-to use the specified
-file as the source message, rather than a message from a folder.
-If you specify this file as \*(lq-\*(rq, then
+to use the specified file as the source message, rather than a message
+from a folder. If you specify this file as \*(lq-\*(rq, then
-accept the source message on the standard input. Note that the
-file, or input from standard input should be a validly formatted
+will accept the source message on the standard input. Note that the
+file, or input from standard input, should be a validly formatted
message, just like any other
-message. It should
-be in mail drop format (to convert a file in mail drop format to
-a folder of
+message. It should NOT be in mail drop format (to convert a file in
+mail drop format to a folder of
.IR inc (1)).
@@ -86,7 +80,7 @@ these would be named as 1, 2, and 3, respectively. If part 2
a multipart content containing two parts, these would be named as 2.1
and 2.2, respectively. Note that the
-switch is effective for only messages containing a multipart content.
+switch is effective only for messages containing a multipart content.
If a message has some other kind of content, or if the part is itself
another multipart content, the
@@ -99,19 +93,18 @@ switch can also be used to restrict (or, when used in
to further restrict) the selection of parts according to content type.
One or more
-switches part will only select the first match
-from a multipart/alternative, even if there is more than one
+switches part will only select the first match from a
+multipart/alternative, even if there is more than one
subpart that matches (one of) the given content type(s).
-switches alone will cause either to select
-the part(s) they match. Using them together will select only
-the part(s) matched by both (sets of) switches. In other
-words, the result is the intersection, and not the union, of their
-separate match results.
+switches alone will cause either to select the part(s) they match.
+Using them together will select only the part(s) matched by both
+(sets of) switches. In other words, the result is the intersection,
+and not the union, of their separate match results.
A content specification consists of a content type and a subtype.
The initial list of \*(lqstandard\*(rq content types and subtypes can
@@ -141,19 +134,18 @@ of the content, e.g., \*(lqaudio\*(rq. To specify a
subtype, separate the two with a slash, e.g., \*(lqaudio/basic\*(rq.
Note that regardless of the values given to the
-a multipart content (of any subtype listed above) is always acted
+switch, a multipart content (of any subtype listed above) is always acted
upon. Further note that if the
-switch is used, and it is
-desirable to act on a message/external-body content, then the
+switch is used, and it is desirable to act on a message/external-body
+content, then the
-switch must be used twice: once for message/external-body
-and once for the content externally referenced.
+switch must be used twice: once for message/external-body and once for
+the content externally referenced.
-switch will alter the part ordering of multipart/alternative MIME sections
+switch will alter the part-ordering of multipart/alternative MIME sections
in order to override the sender-imposed default ordering.
@@ -163,7 +155,7 @@ but is also implemented in
-to make common part numbering possible across all three programs.
+to make common part-numbering possible across all three programs.
.IR mhlist (1)
@@ -175,26 +167,24 @@ The
-to check each content for
-an integrity checksum. If a content has such a checksum (specified
-as a Content-MD5 header field), then
+to check each content for an integrity checksum.
+If a content has such a checksum (specified as a Content-MD5 header
-will attempt to
-verify the integrity of the content.
+will attempt to verify the integrity of the content.
.SS "Storing the Contents"
will store the contents of the named messages in
\*(lqnative\*(rq (decoded) format. Two things must be determined:
-the directory to store the content, and the filenames. Files are
-written in the directory given by the \*(lqnmh-storage\*(rq profile
+the directory in which to store the content, and the filenames.
+Files are written in the directory given by the
+\*(lqnmh-storage\*(rq profile entry, e.g.,
-If this entry isn't present,
-the current working directory is used.
+If this entry isn't present, the current working directory is used.
@@ -218,15 +208,12 @@ overwriting existing files.
-switch is not given (or is being ignored for security
+switch is not given (or is being ignored for security reasons) then
-will look in the user's profile for a
-\*(lqformatting string\*(rq to determine how the different contents
-should be stored. First,
+will look in the user's profile for a \*(lqformatting string\*(rq to
+determine how the different contents should be stored. First,
-will look for an entry of
+will look for an entry of the form:
@@ -253,16 +240,16 @@ then the content is sent to the standard output.
If the formatting string starts with a '|', then it represents
a command for
-to execute which should
-ultimately store the content. The content will be passed to the
-standard input of the command. Before the command is executed,
+to execute which should ultimately store the content.
+The content will be passed to the standard input of the command.
+Before the command is executed,
-will change to the appropriate directory, and any
-escapes (given below) in the formatting string will be expanded.
+will change to the appropriate directory, and any escapes (given below)
+in the formatting string will be expanded.
The use of the \*(lq%a\*(rq sequence is not recommended because
the user has no control over the Content-Type parameter data.
-Otherwise the formatting string will represent a pathname in which
+Otherwise, the formatting string will represent a pathname in which
to store the content. If the formatting string starts with a '/',
then the content will be stored in the full path given, else the
file name will be relative to the value of \*(lqnmh-storage\*(rq or
@@ -290,15 +277,13 @@ listed above) content, the p-escapes are ignored.
If no formatting string is found,
-will check to see
-if the content is application/octet-stream with parameter
+will check to see if the content is application/octet-stream with parameter
\*(lqtype=tar\*(rq. If so,
-will choose an appropriate
-filename. If the content is not application/octet-stream, then
+will choose an appropriate filename. If the content is not
-will check to see if the content is a message. If
+will check to see if the content is a message. If so,
will use the value \*(lq+\*(rq. As a last resort,
@@ -325,7 +310,6 @@ to print out the names of files that it stores. For
compatibility, it is the default. The
switch suppresses these printouts.
.SS "Overwriting Existing Files"
@@ -372,12 +356,12 @@ will be the number of files that were requested but not
.IR ask ,
-if standard input is connected to a terminal,
-the user is prompted to respond
+if standard input is connected to a terminal, the user is prompted to
.IR yes ,
.IR no ,
+.IR rename ,
to whether the file should be overwritten. The responses
can be abbreviated. If the user responds with
.IR rename ,
@@ -399,14 +383,14 @@ split into multiple messages of type
When asked to store a content containing a partial message,
-will try to locate all of the portions and combine
-them accordingly. The default is to store the combined parts as
-a new message in the current folder, although this can be changed
-using formatting strings as discussed above. Thus, if someone has
-sent you a message in several parts (such as the output from
+will try to locate all of the portions and combine them accordingly.
+The default is to store the combined parts as a new message in the
+current folder, although this can be changed using formatting
+strings as discussed above. Thus, if someone has sent you a
+message in several parts (such as the output from
.BR sendfiles ),
-you can easily reassemble them all into a single
-message in the following fashion:
+you can easily reassemble them into a single message in the
@@ -431,16 +415,14 @@ This will store exactly one message, containing the sum
parts. It doesn't matter whether the partials are specified in
-will sort the partials, so that they
-are combined in the correct order. But if
+will sort the partials, so that they are combined in the correct
+order. But if
-locate every partial necessary to reassemble the message, it will
-not store anything.
+can not locate every partial necessary to reassemble the message,
+it will not store anything.
.SS "External Access"
For contents of type message/external-body,
\fImhstore\fR supports these access-types:
.IP \(bu 4
.IP \(bu 4
@@ -491,8 +473,8 @@ nmh-access-url: curl -L
to determine the program to use to perform the HTTP retrieval. This program
is invoked with one argument: the URL of the content to retrieve. The program
-should write the content to standard out, and should terminate with a status
of zero if the retrieval is successful and a non\-zero exit status otherwise.
+should write the content to standard out, and should terminate with a status
+of zero if the retrieval is successful and a non\-zero exit status otherwise.
.SS "The Content Cache"
@@ -508,19 +490,17 @@ is controlled with the
-switches, which define the policy for reading from,
-and writing to, the cache, respectively. One of four policies may be
+switches, which define the policy for reading from, and writing to, the cache,
+respectively. One of four policies may be
specified: \*(lqpublic\*(rq, indicating that
should make use
-of a publicly-accessible content cache; \*(lqprivate\*(rq, indicating
+of a publicly-accessible content cache; \*(lqprivate\*(rq, indicating that
should make use of the user's private content cache;
\*(lqnever\*(rq, indicating that
-should never make use of
-caching; and, \*(lqask\*(rq, indicating that
+should never make use of caching; and, \*(lqask\*(rq, indicating that
should ask the user.
@@ -548,16 +528,13 @@ nmh-private-cache: .cache
.SS "User Environment"
Because the environment in which
-operates may vary for
+operates may vary for different machines,
-will look for the environment variable
-.BR $MHSTORE .
-If present, this specifies the name of an additional
-user profile which should be read. Hence, when a user logs in on a
-particular machine, this environment variable should be set to
-refer to a file containing definitions useful for that machine.
+will look for the environment variable MHSTORE .
+If present, this specifies the name of an additional user profile
+which should be read. Hence, when a user logs in on a particular
+machine, this environment variable should be set to refer to a
+file containing definitions useful for that machine. Finally,
will attempt to consult
|[Prev in Thread]
||[Next in Thread]|
- [Nmh-workers] Changes to mhstore.man,
Larry Hynes <=