]> git.marmaro.de Git - mmh/commitdiff
Removed note from BUGS section of several man pages saying
authorDavid Levine <levinedl@acm.org>
Wed, 7 Nov 2012 00:43:42 +0000 (18:43 -0600)
committerDavid Levine <levinedl@acm.org>
Wed, 7 Nov 2012 00:43:42 +0000 (18:43 -0600)
that command line arguments must be quoted for protection from
the shell.  That's not a bug, and has nothing to do with nmh.

Changed "back-quoted" to "backquoted" for consistency in a few
man pages.

man/ap.man
man/dp.man
man/inc.man
man/mh-draft.man
man/mh-profile.man
man/mhparam.man
man/mhpath.man
man/msh.man
man/pick.man
man/scan.man
man/whatnow.man

index e0b5f6321dc910e0a649917dc02ea78867293d80..f1b6faa44804f76db4976f41e38a969b86c5af2c 100644 (file)
@@ -1,4 +1,4 @@
-.TH AP %manext8% "March 6, 2012" "%nmhversion%"
+.TH AP %manext8% "November 6, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
@@ -100,11 +100,3 @@ Standard for the Format of ARPA Internet Text Messages
 .fi
 .SH CONTEXT
 None
-.SH BUGS
-The argument to the
-.B \-format
-switch must be interpreted as a single token
-by the shell that invokes
-.BR ap .
-Therefore,
-one must usually place the argument to this switch inside quotes.
index b9b4cc82bd03847a9b1f8a3ee3bc007fd807bfc7..3f98913a87a78afd9d3ebd7428b499f8c7ccaecd 100644 (file)
@@ -1,4 +1,4 @@
-.TH DP %manext8% "March 6, 2012" "%nmhversion%"
+.TH DP %manext8% "November 6, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
@@ -81,9 +81,3 @@ None
 .fi
 .SH CONTEXT
 None
-.SH BUGS
-The argument to the
-.B \-format
-switch must be interpreted as a single token by the shell that invokes
-.BR dp .
-Therefore, one must usually place the argument to this switch inside quotes.
index 04c948b4c7ef3b5584f815384e2737457cb33a74..4c471fcb98a13ce0cf63380117aa218e8b6a0d27 100644 (file)
@@ -1,4 +1,4 @@
-.TH INC %manext1% "July 1, 2012" "%nmhversion%"
+.TH INC %manext1% "November 6, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
@@ -327,11 +327,3 @@ message, unless the
 option is specified.  This leaves the context ready for a
 .B show
 of the first new message.
-.SH BUGS
-The argument to the
-.B \-format
-switch must be interpreted as a single
-token by the shell that invokes
-.BR inc .
-Therefore, one must usually place the argument to this switch inside
-quotes.
index ab16e8a8811370699ec2cea330cfa7345fd1f4bb..6e6f4b1c33ebb2dda760693bbe03ffcbf2bfc522 100644 (file)
@@ -1,4 +1,4 @@
-.TH MH-DRAFT %manext5% "January 2, 2001" "%nmhversion%"
+.TH MH-DRAFT %manext5% "November 6, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
@@ -183,7 +183,7 @@ the user could
 .B scan
 the folder to see which message draft in the
 folder should be used for editing or sending.  Clever users could even
-employ a back-quoted
+employ a backquoted
 .B pick
 to do the work:
 .PP
index 0e92a5fea6bfc2b7f858bb1790cab7df33c35d23..a586eefb8d08f8301ef1fd58692d327ec04eab96 100644 (file)
@@ -1,4 +1,4 @@
-.TH MH-PROFILE %manext5% "October 15, 2012" "%nmhversion%"
+.TH MH-PROFILE %manext5% "November 6, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
@@ -31,6 +31,9 @@ This is a comment.
 .PP
 Blank lines are not permitted in
 .IR \&.mh\(ruprofile.
+The shell quoting conventions are not available in the
+.IR \&.mh\(ruprofile ;
+each token is separated by whitespace.
 .SS "Standard Profile Entries"
 The possible profile components are exemplified below.  The only mandatory
 entry is `Path:'.  The others are optional; some have default values if
@@ -1004,10 +1007,6 @@ lower-case).  If the entry is not absolute (does not start with a
 directory.  As a result, you can actually have more than one set of
 private sequences by using different context files.
 .SH BUGS
-The shell quoting conventions are not available in the
-.IR \&.mh\(ruprofile .
-Each token is separated by whitespace.
-.PP
 There is some question as to what kind of arguments should be placed
 in the profile as options.  In order to provide a clear answer, recall
 command line semantics of all
index 4c2ad889a942054fe7134492902042459440c339..cc614ef0a27814b9004e55eb489a4fe7497ff17b 100644 (file)
@@ -1,4 +1,4 @@
-.TH MHPARAM %manext1% "June 14, 2012" "%nmhversion%"
+.TH MHPARAM %manext1% "November 6, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
@@ -92,7 +92,7 @@ context: context
 .RE
 .PP
 .B mhparam
-is also useful in back\-quoted operations:
+is also useful in backquoted operations:
 .PP
 .RS 5
 .nf
index c4928b4a7de4c62c61deea9effe582b152180216..4ecb614ed04204c34f3930922c837aa818bcc173 100644 (file)
@@ -1,4 +1,4 @@
-.TH MHPATH %manext1% "February 18, 2012" "%nmhversion%"
+.TH MHPATH %manext1% "November 6, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
@@ -105,7 +105,7 @@ mhpath: no messages in range 1\-2
 .RE
 .PP
 .B mhpath
-is also useful in back\-quoted operations:
+is also useful in backquoted operations:
 .PP
 .RS 5
 .nf
@@ -115,6 +115,31 @@ is also useful in back\-quoted operations:
 /r/phyl/Mail
 .fi
 .RE
+Because
+.B mhpath
+expands and sorts
+.RI [ msgs ].
+the command
+.PP
+.RS 5
+.nf
+mv `mhpath 501 500`
+.fi
+.RE
+.PP
+to will not move 501 to 500.
+Quite the reverse.  But
+.PP
+.RS 5
+.nf
+mv `mhpath 501` `mhpath 500`
+.fi
+.RE
+.PP
+will do the trick.
+.PP
+Out of range message 0 is treated far more severely than large out of
+range message numbers.
 .SH FILES
 .fc ^ ~
 .nf
@@ -138,32 +163,3 @@ is also useful in back\-quoted operations:
 .fi
 .SH CONTEXT
 None
-.SH BUGS
-Like all
-.B nmh
-commands,
-.B mhpath
-expands and sorts
-.RI [ msgs ].
-So don't
-expect
-.PP
-.RS 5
-.nf
-mv `mhpath 501 500`
-.fi
-.RE
-.PP
-to move 501 to 500.
-Quite the reverse.  But
-.PP
-.RS 5
-.nf
-mv `mhpath 501` `mhpath 500`
-.fi
-.RE
-.PP
-will do the trick.
-.PP
-Out of range message 0 is treated far more severely than large out of
-range message numbers.
index ba239ceab81e709d1772820246cfd4cc446ac657..2416d7a5fcd0afb6afc649ee17ebadf895a6094a 100644 (file)
@@ -1,4 +1,4 @@
-.TH MSH %manext1% "January 8, 2012" "%nmhversion%"
+.TH MSH %manext1% "November 6, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
@@ -176,7 +176,7 @@ substitutions, or alias substitutions.
 .PP
 When parsing commands to the left of any redirection symbol,
 .B msh
-will honor `\\' (back\-slash) as the quote next\-character symbol, and
+will honor `\\' (backslash) as the quote next\-character symbol, and
 `\*(lq' (double\-quote) as quote\-word delimiters.  All other input tokens
 are separated by whitespace (spaces and tabs).
 .SH FILES
@@ -208,13 +208,6 @@ are separated by whitespace (spaces and tabs).
 .SH CONTEXT
 None
 .SH BUGS
-The argument to the
-.B \-prompt
-switch must be interpreted as a single
-token by the shell that invokes
-.BR msh .
-Therefore, one must usually
-place the argument to this switch inside double\-quotes.
 .PP
 There is a strict limit of messages per file in
 .BR packf 'd
@@ -229,7 +222,7 @@ the nice facilities provided by the latter are not present in the former.
 .PP
 In particular,
 .B msh
-does not understand back\-quoting, so the only
+does not understand backquoting, so the only
 effective way to use
 .B pick
 inside
index aca091828da027b9d01322c6021f0593549e9fea..fe0ddf41348088cfe4a08b413d29e309480a27d7 100644 (file)
@@ -1,4 +1,4 @@
-.TH PICK %manext1% "March 6, 2012" "%nmhversion%"
+.TH PICK %manext1% "November 6, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
@@ -357,16 +357,7 @@ Use
 to enumerate the messages in a sequence
 (such as for use by a shell script).
 .SH BUGS
-The argument to the
-.B \-after
-and
-.B \-before
-switches must be interpreted
-as a single token by the shell that invokes
-.BR pick .
-Therefore, one
-must usually place the argument to this switch inside quotes.
-Furthermore, any occurrence of
+Any occurrence of
 .B \-datefield
 must occur prior to the
 .B \-after
@@ -376,7 +367,7 @@ switch it applies to.
 .PP
 If
 .B pick
-is used in a back\-quoted operation, such as
+is used in a backquoted operation, such as
 .PP
 .RS 5
 scan\0`pick\0\-from\0jones`
index 95cf4286b44728f93f9eb929ba8e2721c357e063..7510505cdf7e07aef87d801eb2e81d6401c963d8 100644 (file)
@@ -1,4 +1,4 @@
-.TH SCAN %manext1% "November 4, 2012" "%nmhversion%"
+.TH SCAN %manext1% "November 6, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
@@ -240,14 +240,6 @@ used to generate
 a heading saying what each column in the listing was.  Format strings
 prevent this from happening.
 .SH BUGS
-The argument to the
-.B \-format
-switch must be interpreted as a single
-token by the shell that invokes
-.BR scan .
-Therefore, one must usually
-place the argument to this switch inside quotes.
-.PP
 The value of each
 .I component
 escape is set by
index 0a7c9529ce2c99c10f8cccedf517a0b32f997ae4..6b205fbfb20780097b3412fa68d898111d56d8bc 100644 (file)
@@ -1,4 +1,4 @@
-.TH WHATNOW %manext1% "April 4, 2012" "%nmhversion%"
+.TH WHATNOW %manext1% "November 6, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
@@ -231,14 +231,6 @@ information.
 .RB ` \-attach "' defaults to \*(lqNmh-Attachment\*(rq"
 .fi
 .SH BUGS
-The argument to the
-.B \-prompt
-switch must be interpreted as a single
-token by the shell that invokes
-.BR whatnow .
-Therefore, one must
-usually place the argument to this switch inside quotes.
-.PP
 If the initial edit fails,
 .B whatnow
 deletes your draft (by renaming