X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/95e9c4e6befb17ca3e691c26f024fb55eeae5e31..07661005b9a36338ab158bcbe7762788a1df4030:/man/mhstore.man diff --git a/man/mhstore.man b/man/mhstore.man index 3838d802..7e6f8506 100644 --- a/man/mhstore.man +++ b/man/mhstore.man @@ -1,4 +1,4 @@ -.TH MHSTORE %manext1% "%nmhdate%" MH.6.8 [%nmhversion%] +.TH MHSTORE %manext1% "March 21, 2013" "%nmhversion%" .\" .\" %nmhwarning% .\" @@ -12,6 +12,8 @@ mhstore \- store contents of MIME messages into files .RI [ msgs ] .RB [ \-file .IR file ] +.RB [ \-outfile +.IR outfile ] .RB [ \-part .IR number ] \&... @@ -38,7 +40,7 @@ messages. .PP .B mhstore manipulates multi-media messages as specified in -RFC\-2045 thru RFC\-2049. +RFC 2045 to RFC 2049. .PP By default, .B mhstore @@ -53,10 +55,10 @@ switches, you may limit the scope of to particular subparts (of a multipart content) and/or particular content types. .PP -The option +The .B \-file .I file -directs +switch directs .B mhstore to use the specified file as the source message, rather than a message from a folder. @@ -91,7 +93,7 @@ the content from being acted upon. .PP A content specification consists of a content type and a subtype. The initial list of \*(lqstandard\*(rq content types and subtypes -can be found in RFC\-2046. +can be found in RFC 2046. .PP A list of commonly used contents is briefly reproduced here: .PP @@ -154,18 +156,21 @@ If this entry isn't present, the current working directory is used. .PP If the +.B \-outfile +switch is given, its argument is used for the filename to store all +of the content, with \*(lq-\*(rq indicating standard output. 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 +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 \*(lqfilename\*(rq attribute in the +\*(lqContent-Disposition\*(rq header or as the \*(lqname\*(rq +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 @@ -395,6 +400,8 @@ ftp local-file .IP \(bu 4 mail-server +.IP \(bu 4 +url .PP For the \*(lqanon-ftp\*(rq and \*(lqftp\*(rq access types, .B mhstore @@ -422,6 +429,19 @@ 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. +.PP +For the \*(lqurl\*(rq access types, +.B mhstore +will look for the \*(lqnmh-access-url\*(rq profile entry, e.g., +.PP +.RS 5 +nmh-access-url: curl -l +.RE +.PP +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. +.PP .SS "The Content Cache" When .B mhstore @@ -499,6 +519,15 @@ which is created automatically during .B nmh installation. .SH FILES +.B mhstore +looks for additional profile files in multiple locations: absolute +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 +is checked. +.PP .fc ^ ~ .nf .ta \w'%etcdir%/ExtraBigFileName 'u @@ -514,6 +543,7 @@ installation. ^Path:~^To determine the user's nmh directory ^Current\-Folder:~^To find the default current folder ^nmh-access-ftp:~^Program to retrieve contents via FTP +^nmh-access-url:~^Program to retrieve contents via HTTP ^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