Renamed -version switch to -Version to remove the conflict with -verbose.

[mmh] / man / mhstore.man1

diff --git a/man/mhstore.man1 b/man/mhstore.man1
index 5ad0137..e92a82f 100644 (file)
--- a/man/mhstore.man1
+++ b/man/mhstore.man1
@@ -19,12 +19,7 @@ mhstore \- store contents of MIME messages into files
 .IR content ]
 \&...
 .RB [ \-auto " | " \-noauto ]
 .IR content ]
 \&...
 .RB [ \-auto " | " \-noauto ]

-.RB [ \-rcache
-.IR policy ]
-.RB [ \-wcache
-.IR policy ]
-.RB [ \-check " | " \-nocheck ]
-.RB [ \-version ]
+.RB [ \-Version ]

 .RB [ \-help ]
 .ad
 .SH DESCRIPTION
 .RB [ \-help ]
 .ad
 .SH DESCRIPTION

@@ -117,30 +112,28 @@ Note that regardless of the values given to the
 .B \-type
 switch,
 a multipart content (of any subtype listed above) is always acted
 .B \-type
 switch,
 a multipart content (of any subtype listed above) is always acted

-upon.  Further note that if the
-.B \-type
-switch is used, and it is
-desirable to act on a message/external-body content, then the
-.B \-type
-switch must be used twice: once for message/external-body
-and once for the content externally referenced.
-.SS "Checking the Contents"
-The
-.B \-check
-switch tells
-.B mhstore
-to check each content for
-an integrity checksum.  If a content has such a checksum (specified
-as a Content-MD5 header field), then
-.B mhstore
-will attempt to
-verify the integrity of the content.
+upon.

 .SS "Storing the Contents"
 The
 .B mhstore
 will store the contents of the named messages in
 \*(lqnative\*(rq (decoded) format.  Two things must be determined:
 .SS "Storing the Contents"
 The
 .B mhstore
 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
+the directory to store the content, and the filenames.
+.PP
+By default (or if the
+.B \-auto
+switch is given),
+.B mhstore
+uses filename information, contained in the message, if available.
+(This information should be specified
+as the attribute \*(lqname=filename\*(rq in the \*(lqContent-Type\*(rq header
+for the content you are storing.)
+Only the basename of this filename is considered.
+If it begins with the character '.', '|', or '!',
+or if it contains the character '%', automatic naming won't happen for
+security reasons. (See below for the fall-back.)
+.PP
+Files are

 written in the directory given by the \*(lqnmh-storage\*(rq profile
 entry, e.g.,
 .PP
 written in the directory given by the \*(lqnmh-storage\*(rq profile
 entry, e.g.,
 .PP

@@ -148,31 +141,17 @@ entry, e.g.,
 nmh-storage: /tmp
 .RE
 .PP
 nmh-storage: /tmp
 .RE
 .PP

+(Note that \*(lqnmh-storage\*(rq is relative to the folder that contains
+the message.)

 If this entry isn't present,
 the current working directory is used.
 If this entry isn't present,
 the current working directory is used.

+Attachments will get stored in either the `nmh-storage' or the current working
+directory \(en in no case elsewhere.
+Existing files get silently overwritten.

 .PP
 If the
 .PP
 If the

-.B \-auto
-switch is given, then
-.B mhstore
-will check if
-the message contains information indicating the filename that should
-be used to store the content.  This information should be specified
-as the attribute \*(lqname=filename\*(rq in the \*(lqContent-Type\*(rq header
-for the content you are storing.  For security reasons, this filename
-will be ignored if it begins with the character '/', '.', '|', or '!',
-or if it contains the character '%'.  For the sake of security,
-this switch is not the default, and it is recommended that you do
-NOT put the
-.B \-auto
-switch in your
-.I \&.mmh/profile
-file.
-.PP
-If the
-.B \-auto
-switch is not given (or is being ignored for security
-reasons) then
+.B \-noauto
+switch is given (or a filename is being ignored for security reasons) then

 .B mhstore
 will look in the user's profile for a
 \*(lqformatting string\*(rq to determine how the different contents
 .B mhstore
 will look in the user's profile for a
 \*(lqformatting string\*(rq to determine how the different contents

@@ -200,7 +179,7 @@ content is stored in the named folder.  A formatting string consisting
 solely of a \*(lq+\*(rq character is interpreted to be the current
 folder.
 .PP
 solely of a \*(lq+\*(rq character is interpreted to be the current
 folder.
 .PP

-If the formatting string consists solely of a \*(lq-\*(rq character,
+If the formatting string consists solely of a \*(lq\-\*(rq character,

 then the content is sent to the standard output.
 .PP
 If the formatting string starts with a '|', then the display string
 then the content is sent to the standard output.
 .PP
 If the formatting string starts with a '|', then the display string

@@ -216,9 +195,9 @@ escapes (given below) in the display string will be expanded.
 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
 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
-the current working directory.  Any escapes (given below) will be
-expanded, except for the a-escape.
+file name will be relative to either the value of \*(lqnmh-storage\*(rq,
+if set, or the current working directory.
+Existing files get silently overwritten.

 .PP
 A command or pathname formatting string may contain the following
 escapes.  If the content isn't part of a multipart (of any subtype
 .PP
 A command or pathname formatting string may contain the following
 escapes.  If the content isn't part of a multipart (of any subtype

@@ -239,13 +218,6 @@ listed above) content, the p-escapes are ignored.
 .PP
 If no formatting string is found,
 .B mhstore
 .PP
 If no formatting string is found,
 .B mhstore

-will check to see
-if the content is application/octet-stream with parameter
-\*(lqtype=tar\*(rq.  If so,
-.B mhstore
-will choose an appropriate
-filename.  If the content is not application/octet-stream, then
-.B mhstore

 will check to see if the content is a message.  If
 so,
 .B mhstore
 will check to see if the content is a message.  If
 so,
 .B mhstore

@@ -311,141 +283,12 @@ are combined in the correct order.  But if
 can not
 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.

-RE
-.PP
-By using the
-.B \-auto
-switch,
-.B mhstore
-will automatically do the extraction for you:
-.PP
-.RS 5
-.nf
-% mhlist 5-8
- msg part  type/subtype             size description
-   5       message/partial           47K part 1 of 4
-   6       message/partial           47K part 2 of 4
-   7       message/partial           47K part 3 of 4
-   8       message/partial           18K part 4 of 4
-% mhstore 5-8
-reassembling partials 5,6,7,8 to folder inbox as message 9
-% mhlist 9
- msg part  type/subtype             size description
-   9       application/octet-stream 118K
-             (extract with uncompress | tar xvpf -)
-             type=tar
-             conversions=compress
-% mhstore -auto 9
--- tar listing appears here as files are extracted
-.fi

 .RE
 .RE

-.PP
-As the second
-.B tar
-listing is generated, the files are extracted.
-A prudent user will never put
-.B \-auto
-in the profile.
-The correct procedure is to first use
-.B mhlist
-to find out what will be extracted.  Then
-.B mhstore
-can be invoked with
-.B \-auto
-to perform the extraction.

 .SS "External Access"
 .SS "External Access"

-For contents of type message/external-body,
-\fImhstore\fR supports these access-types:
-.PP
-.IP \(bu 4
-afs
-.IP \(bu 4
-anon-ftp
-.IP \(bu 4
-ftp
-.IP \(bu 4
-local-file
-.IP \(bu 4
-mail-server
-.PP
-For the \*(lqanon-ftp\*(rq and \*(lqftp\*(rq access types,
-.B mhstore
-will look for the \*(lqnmh-access-ftp\*(rq
-profile entry, e.g.,
-.PP
-.RS 5
-nmh-access-ftp: myftp.sh
-.RE
-.PP
-to determine the pathname of a program to perform the FTP retrieval.
-This program is invoked with these arguments:
-.PP
-.RS 5
-.nf
-domain name of FTP-site
-username
-password
-remote directory
-remote filename
-local filename
-\*(lqascii\*(rq or \*(lqbinary\*(rq
-.fi
-.RE
-.PP
-The program should terminate with an exit status of zero if the
-retrieval is successful, and a non-zero exit status otherwise.
-.SS "The Content Cache"
-When
-.B mhstore
-encounters an external content containing a
-\*(lqContent-ID:\*(rq field, and if the content allows caching, then
-depending on the caching behavior of
-.BR mhstore ,
-the content might be read from or written to a cache.
-.PP
-The caching behavior of
-.B mhstore
-is controlled with the
-.B \-rcache
-and
-.B \-wcache
-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
-.B mhstore
-should make use
-of a publically-accessible content cache; \*(lqprivate\*(rq, indicating
-that
-.B mhstore
-should make use of the user's private content cache;
-\*(lqnever\*(rq, indicating that
-.B mhstore
-should never make use of
-caching; and, \*(lqask\*(rq, indicating that
-.B mhstore
-should ask the user.
-.PP
-There are two directories where contents may be cached: the profile entry
-\*(lqnmh-cache\*(rq names a directory containing world-readable contents, and,
-the profile entry \*(lqnmh-private-cache\*(rq names a directory containing
-private contents.  The former should be an absolute (rooted) directory
-name.
-.PP
-For example,
-.PP
-.RS 5
-nmh-cache: /tmp
-.RE
-.PP
-might be used if you didn't care that the cache got wiped after each
-reboot of the system.  The private chace is interpreted relative to the user's
-mail storage, if not rooted, e.g.,
-.PP
-.RS 5
-nmh-private-cache: .cache
-.RE
-.PP
-(which is the default value).
+.B Mhstore
+does not automatically retrieve message/external-body parts (anymore),
+but prints the relevant information to enable the user to retrieve
+the files manually.

 .SS "User Environment"
 Because the display environment in which
 .B mhstore
 .SS "User Environment"
 Because the display environment in which
 .B mhstore

@@ -487,24 +330,18 @@ installation.
 .ta \w'ExtraBigProfileName  'u
 ^Path:~^To determine the user's mail storage
 ^Current\-Folder:~^To find the default current folder
 .ta \w'ExtraBigProfileName  'u
 ^Path:~^To determine the user's mail storage
 ^Current\-Folder:~^To find the default current folder

-^nmh-access-ftp:~^Program to retrieve contents via FTP
-^nmh-cache~^Public directory to store cached external contents
-^nmh-private-cache~^Personal directory to store cached external contents

 ^nmh-storage~^Directory to store contents
 ^mhstore-store-<type>*~^Template for storing contents
 .fi
 
 .SH "SEE ALSO"
 ^nmh-storage~^Directory to store contents
 ^mhstore-store-<type>*~^Template for storing contents
 .fi
 
 .SH "SEE ALSO"

-mhbuild(1), mhlist(1), mhshow(1), sendfiles(1)
+mhbuild(1), mhlist(1), show(1), sendfiles(1)

 
 .SH DEFAULTS
 .nf
 .RB ` +folder "' defaults to the current folder"
 .RB ` msgs "' defaults to cur"
 
 .SH DEFAULTS
 .nf
 .RB ` +folder "' defaults to the current folder"
 .RB ` msgs "' defaults to cur"

-.RB ` \-noauto '
-.RB ` \-nocheck '
-.RB ` \-rcache ask '
-.RB ` \-wcache ask '
+.RB ` \-auto '

 
 .SH CONTEXT
 If a folder is given, it will become the current folder.  The last
 
 .SH CONTEXT
 If a folder is given, it will become the current folder.  The last

@@ -512,3 +349,5 @@ message selected will become the current message.
 
 .SH BUGS
 Partial messages contained within a multipart content are not reassembled.
 
 .SH BUGS
 Partial messages contained within a multipart content are not reassembled.

+.PP
+Existing files get silently overwritten.