X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/a514b8a78c447c8abc69386bee9f2c463b1c9362..64f5cda4610fa3de39a9d69aeda2d8a26f147f2e:/man/mhstore.man diff --git a/man/mhstore.man b/man/mhstore.man index 627bcff4..fbdd3702 100644 --- a/man/mhstore.man +++ b/man/mhstore.man @@ -1,4 +1,4 @@ -.TH MHSTORE %manext1% "March 1, 2014" "%nmhversion%" +.TH MHSTORE %manext1% "March 2, 2014" "%nmhversion%" .\" .\" %nmhwarning% .\" @@ -141,7 +141,6 @@ as a Content-MD5 header field), then will attempt to verify the integrity of the content. .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: @@ -170,12 +169,11 @@ specified as the \*(lqfilename\*(rq attribute in the attribute 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 \&.mh\(ruprofile -file. +character '%'. We also recommend using a \*(lqnmh-storage\*(rq profile +entry or a +.B \-clobber +switch setting other than the default of \*(lqalways\*(rq to avoid +overwriting existing files. .PP If the .B \-auto @@ -211,15 +209,17 @@ folder. 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 -will represent a command for +If the formatting string starts with a '|', then it represents +a command for .B mhstore 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, .B mhstore will change to the appropriate directory, and any -escapes (given below) in the display string will be expanded. +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. .PP Otherwise the formatting string will represent a pathname in which to store the content. If the formatting string starts with a '/', @@ -237,7 +237,7 @@ listed above) content, the p-escapes are ignored. .RS 5 .nf .ta \w'%P 'u -%a Parameters from Content-type (only valid with command) +%a Parameters from Content-Type (only valid with command) %m Insert message number %P Insert part number with leading dot %p Insert part number without leading dot @@ -445,7 +445,7 @@ For the \*(lqurl\*(rq access types, will look for the \*(lqnmh-access-url\*(rq profile entry, e.g., .PP .RS 5 -nmh-access-url: curl -l +nmh-access-url: curl -L .RE .PP to determine the program to use to perform the HTTP retrieval. This program @@ -505,7 +505,7 @@ nmh-private-cache: .cache .PP (which is the default value). .SS "User Environment" -Because the display environment in which +Because the environment in which .B mhstore operates may vary for different machines, @@ -518,16 +518,19 @@ particular machine, this environment variable should be set to refer to a file containing definitions useful for that machine. Finally, .B mhstore -will attempt to consult one other additional -user profile, e.g., +will attempt to consult .PP .RS 5 -%etcdir%/mhn.defaults +%nmhetcdir%/mhn.defaults .RE .PP which is created automatically during .B nmh installation. +.PP +See "Profile Lookup" in +.IR mh-profile (5) +for the profile search order, and for how duplicate entries are treated. .SH FILES .B mhstore looks for additional profile files in multiple locations: absolute @@ -535,15 +538,15 @@ pathnames are accessed directly, tilde expansion is done on usernames, and files are searched for in the user's .I Mail directory as specified in their profile. If not found there, the directory -.RI \*(lq %etcdir% \*(rq +.RI \*(lq %nmhetcdir% \*(rq is checked. .PP .fc ^ ~ .nf -.ta \w'%etcdir%/ExtraBigFileName 'u +.ta \w'%nmhetcdir%/ExtraBigFileName 'u ^$HOME/\&.mh\(ruprofile~^The user profile ^$MHSTORE~^Additional profile entries -^%etcdir%/mhn.defaults~^System default MIME profile entries +^%nmhetcdir%/mhn.defaults~^System default MIME profile entries .fi .SH "PROFILE COMPONENTS" .fc ^ ~