Removed msh relics from scansbr.c, including a global.

[nmh] / man / mhstore.man

diff --git a/man/mhstore.man b/man/mhstore.man
index 9216bf66c2ba8a610d92716e271ec629165eb6f8..14faaa0e560419dd7e2006d25d5f20379d747e9c 100644 (file)
--- a/man/mhstore.man
+++ b/man/mhstore.man
@@ -1,4 +1,4 @@
-.TH MHSTORE %manext1% "March 20, 2013" "%nmhversion%"
+.TH MHSTORE %manext1% "March 2, 2014" "%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 ]
 \&...
@@ -26,6 +28,7 @@ mhstore \- store contents of MIME messages into files
 .RB [ \-wcache
 .IR policy ]
 .RB [ \-check " | " \-nocheck ]
+.RB [ \-verbose " | " \-noverbose ]
 .RB [ \-version ]
 .RB [ \-help ]
 .ad
@@ -38,7 +41,7 @@ messages.
 .PP
 .B mhstore
 manipulates multi-media messages as specified in
-RFC\-2045 to RFC\-2049.
+RFC 2045 to RFC 2049.
 .PP
 By default,
 .B mhstore
@@ -53,10 +56,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 +94,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,6 +157,9 @@ 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
@@ -164,12 +170,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
@@ -205,15 +210,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 '/',
@@ -231,7 +238,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
@@ -270,6 +277,15 @@ mhstore-store-application/PostScript: %m%P.ps
 .fi
 .RE
 .PP
+The
+.B \-verbose
+switch directs
+.B mhstore
+to print out the names of files that it stores.  For backward
+compatibility, it is the default.  The
+.B \-noverbose
+switch suppresses these printouts.
+.PP
 .SS "Overwriting Existing Files"
 The
 .B \-clobber
@@ -430,7 +446,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
@@ -490,7 +506,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,
@@ -503,8 +519,7 @@ 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
@@ -513,7 +528,20 @@ user profile, e.g.,
 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
+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
@@ -549,6 +577,7 @@ installation.
 .RB ` \-nocheck '
 .RB ` \-rcache\ ask '
 .RB ` \-wcache\ ask '
+.RB ` \-verbose '
 .SH CONTEXT
 If a folder is given, it will become the current folder.  The last
 message selected will become the current message.