X-Git-Url: http://git.marmaro.de/?p=mmh;a=blobdiff_plain;f=man%2Fmhstore.man1;h=fcd833df379a6ebbf04858bff51999cf5c8221d2;hp=ddb43f81ad4131e82f1bac017614595bca63763f;hb=d1fefd9f614e4dc3cda16da6c69133c1b2005269;hpb=4e38095f027a81c005a48a888d0f8937e98543a5 diff --git a/man/mhstore.man1 b/man/mhstore.man1 index ddb43f8..fcd833d 100644 --- a/man/mhstore.man1 +++ b/man/mhstore.man1 @@ -19,12 +19,6 @@ mhstore \- store contents of MIME messages into files .IR content ] \&... .RB [ \-auto " | " \-noauto ] -.RB [ \-verbose " | " \-noverbose ] -.RB [ \-rcache -.IR policy ] -.RB [ \-wcache -.IR policy ] -.RB [ \-check " | " \-nocheck ] .RB [ \-version ] .RB [ \-help ] .ad @@ -125,17 +119,6 @@ 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. .SS "Storing the Contents" The .B mhstore @@ -219,7 +202,9 @@ 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. +expanded, except for the a-escape. Note that if \*(lqnmh-storage\*(rq +is not an absolute path, it will be relative to the folder that +contains the message(s). .PP A command or pathname formatting string may contain the following escapes. If the content isn't part of a multipart (of any subtype @@ -293,7 +278,7 @@ message in the following fashion: 8 message/partial 18K part 4 of 4 % mhstore 5-8 reassembling partials 5,6,7,8 to folder inbox as message 9 -% mhlist -verbose 9 +% mhlist 9 msg part type/subtype size description 9 application/octet-stream 118K (extract with uncompress | tar xvpf -) @@ -312,6 +297,48 @@ are combined in the correct order. But if 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 +.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" For contents of type message/external-body, \fImhstore\fR supports these access-types: @@ -353,58 +380,6 @@ local filename .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). .SS "User Environment" Because the display environment in which .B mhstore @@ -447,8 +422,6 @@ installation. ^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-*~^Template for storing contents .fi @@ -461,10 +434,6 @@ mhbuild(1), mhlist(1), mhshow(1), sendfiles(1) .RB ` +folder "' defaults to the current folder" .RB ` msgs "' defaults to cur" .RB ` \-noauto ' -.RB ` \-nocheck ' -.RB ` \-rcache ask ' -.RB ` \-wcache ask ' -.RB ` \-noverbose ' .SH CONTEXT If a folder is given, it will become the current folder. The last