X-Git-Url: http://git.marmaro.de/?p=mmh;a=blobdiff_plain;f=man%2Fmhstore.man1;h=4a821bf97432710bbe6cc4a960ebdbb57662b70d;hp=ea3703771172876eb81f76d9c885e3d56d029002;hb=18591f8e001ecedbee48a51c1d1f08ebaa1c15c8;hpb=4c1efddfd499300c7e74263e57d8aa137e84c853 diff --git a/man/mhstore.man1 b/man/mhstore.man1 index ea37037..4a821bf 100644 --- a/man/mhstore.man1 +++ b/man/mhstore.man1 @@ -19,7 +19,7 @@ mhstore \- store contents of MIME messages into files .IR content ] \&... .RB [ \-auto " | " \-noauto ] -.RB [ \-version ] +.RB [ \-Version ] .RB [ \-help ] .ad .SH DESCRIPTION @@ -53,18 +53,18 @@ directs .B mhstore to use the specified file as the source message, rather than a message from a folder. -If you specify this file as \*(lq-\*(rq, then +If you specify this file as `-', then .B mhstore will accept the source message on the standard input. Note that the file, or input from standard input should be a validly formatted message, just like any other -.B nmh +.B mh message. It should .B NOT be in mail drop format (to convert a file in mail drop format to a folder of -.B nmh +.B mh messages, see .BR inc (1)). .PP @@ -83,7 +83,7 @@ switch will not prevent 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 +The initial list of `standard' content types and subtypes can be found in RFC\-2046. .PP A list of commonly used contents is briefly reproduced here: @@ -106,8 +106,8 @@ video mpeg A legal MIME message must contain a subtype specification. .PP To specify a content, regardless of its subtype, just use the name -of the content, e.g., \*(lqaudio\*(rq. To specify a specific -subtype, separate the two with a slash, e.g., \*(lqaudio/basic\*(rq. +of the content, e.g., `audio'. To specify a specific +subtype, separate the two with a slash, e.g., `audio/basic'. Note that regardless of the values given to the .B \-type switch, @@ -117,7 +117,7 @@ upon. The .B mhstore will store the contents of the named messages in -\*(lqnative\*(rq (decoded) format. Two things must be determined: +`native' (decoded) format. Two things must be determined: the directory to store the content, and the filenames. .PP By default (or if the @@ -126,7 +126,7 @@ 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 +as the attribute `name=filename' in the `Content-Type' header for the content you are storing.) Only the basename of this filename is considered. If it begins with the character '.', '|', or '!', @@ -134,14 +134,14 @@ 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 +written in the directory given by the `nmh-storage' profile entry, e.g., .PP .RS 5 nmh-storage: /tmp .RE .PP -(Note that \*(lqnmh-storage\*(rq is relative to the folder that contains +(Note that `nmh-storage' is relative to the folder that contains the message.) If this entry isn't present, the current working directory is used. @@ -154,7 +154,7 @@ If the 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 +`formatting string' to determine how the different contents should be stored. First, .B mhstore will look for an entry of @@ -174,12 +174,12 @@ mhstore-store- .PP to determine the formatting string. .PP -If the formatting string starts with a \*(lq+\*(rq character, then +If the formatting string starts with a `+' character, then content is stored in the named folder. A formatting string consisting -solely of a \*(lq+\*(rq character is interpreted to be the current +solely of a `+' 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 `\-' character, then the content is sent to the standard output. .PP If the formatting string starts with a '|', then the display string @@ -195,7 +195,7 @@ 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 -file name will be relative to either the value of \*(lqnmh-storage\*(rq, +file name will be relative to either the value of `nmh-storage', if set, or the current working directory. Existing files get silently overwritten. .PP @@ -221,9 +221,9 @@ If no formatting string is found, will check to see if the content is a message. If so, .B mhstore -will use the value \*(lq+\*(rq. As a last resort, +will use the value `+'. As a last resort, .B mhstore -will use the value \*(lq%m%P.%s\*(rq. +will use the value `%m%P.%s'. .PP Example profile entries might be: .PP @@ -232,7 +232,7 @@ Example profile entries might be: mhstore-store-text: %m%P.txt mhstore-store-text: +inbox mhstore-store-message/partial: + -mhstore-store-audio/basic: | raw2audio -e ulaw -s 8000 -c 1 > %m%P.au +mhstore-store-audio/basic: | raw2audio \-e ulaw \-s 8000 \-c 1 > %m%P.au mhstore-store-image/jpeg: %m%P.jpg mhstore-store-application/PostScript: %m%P.ps .fi @@ -241,7 +241,7 @@ mhstore-store-application/PostScript: %m%P.ps .SS "Reassembling Messages of Type message/partial" .B mhstore is also able to reassemble messages that have been -split into multiple messages of type \*(lqmessage/partial\*(rq. +split into multiple messages of type `message/partial'. .PP When asked to store a content containing a partial message, .B mhstore @@ -311,7 +311,7 @@ user profile, e.g., .RE .PP which is created automatically during -.B nmh +.B mmh installation. .SH FILES @@ -340,7 +340,7 @@ mhbuild(1), mhlist(1), show(1), sendfiles(1) .SH DEFAULTS .nf .RB ` +folder "' defaults to the current folder" -.RB ` msgs "' defaults to cur" +.RB ` msgs "' defaults to the current message" .RB ` \-auto ' .SH CONTEXT