Man pages: Replaced \*(lq and \*(rq with ` and '.

[mmh] / man / mh-sequence.man7

diff --git a/man/mh-sequence.man7 b/man/mh-sequence.man7
index 0cfb552..60568ed 100644 (file)
--- a/man/mh-sequence.man7
+++ b/man/mh-sequence.man7
@@ -22,62 +22,62 @@ Most
 commands accept a `msg' or `msgs' specification, where
 `msg' indicates one message and `msgs' indicates one or more messages.
 To designate a message, you may use either its number (e.g., 1, 10, 234)
 commands accept a `msg' or `msgs' specification, where
 `msg' indicates one message and `msgs' indicates one or more messages.
 To designate a message, you may use either its number (e.g., 1, 10, 234)

-or one of these \*(lqreserved\*(rq message names:
+or one of these `reserved' message names:

 .PP
 .RS 5
 .nf
 .ta +\w'\fIName\fP      'u
 .PP
 .RS 5
 .nf
 .ta +\w'\fIName\fP      'u

-.I Name        Description
+.I "Name       Description

 first  the first message in the folder
 last   the last message in the folder
 cur    the most recently accessed message
 first  the first message in the folder
 last   the last message in the folder
 cur    the most recently accessed message

-prev   the message numerically preceding \*(lqcur\*(rq
-next   the message numerically following \*(lqcur\*(rq
+prev   the message numerically preceding `cur'
+next   the message numerically following `cur'

 .fi
 .RE
 .PP
 .fi
 .RE
 .PP

-In commands that take a `msg' argument, the default is \*(lqcur\*(rq.
-As a shorthand, \*(lq\&.\*(rq is equivalent to \*(lqcur\*(rq.
+In commands that take a `msg' argument, the default is `cur'.
+As a shorthand, `\&.' is equivalent to `cur'.

 .PP
 For example: In a folder containing five messages numbered 5, 10, 94, 177
 .PP
 For example: In a folder containing five messages numbered 5, 10, 94, 177

-and 325, \*(lqfirst\*(rq is 5 and \*(lqlast\*(rq is 325.  If \*(lqcur\*(rq
-is 94, then \*(lqprev\*(rq is 10 and \*(lqnext\*(rq is 177.
+and 325, `first' is 5 and `last' is 325.  If `cur'
+is 94, then `prev' is 10 and `next' is 177.

 .PP
 The word `msgs' indicates that one or more messages may be specified.
 Such a specification consists of one message designation or of several
 message designations separated by spaces.  A message designation consists
 either of a message name as defined above, or a message range.
 .PP
 .PP
 The word `msgs' indicates that one or more messages may be specified.
 Such a specification consists of one message designation or of several
 message designations separated by spaces.  A message designation consists
 either of a message name as defined above, or a message range.
 .PP

-A message range is specified as \*(lqname1\-name2\*(rq or
-\*(lqname:n\*(rq, where `name', `name1' and `name2' are message names,
+A message range is specified as `name1\-name2' or
+`name:n', where `name', `name1' and `name2' are message names,

 and `n' is an integer.
 .PP
 and `n' is an integer.
 .PP

-The specification \*(lqname1\-name2\*(rq designates all currently existing
-messages from `name1' to `name2' inclusive.  The \*(lqreserved\*(rq
-message name \*(lqall\*(rq is a shorthand for the message range
-\*(lqfirst\-last\*(rq.
+The specification `name1\-name2' designates all currently existing
+messages from `name1' to `name2' inclusive.  The `reserved'
+message name `all' is a shorthand for the message range
+`first\-last'.

 .PP
 .PP

-The specification \*(lqname:n\*(rq designates up to `n' messages.
+The specification `name:n' designates up to `n' messages.

 These messages start with `name' if `name' is a message number or one of
 These messages start with `name' if `name' is a message number or one of

-the reserved names \*(lqfirst\*(rq \*(lqcur\*(rq, or \*(lqnext\*(rq, The
-messages end with `name' if `name' is \*(lqprev\*(rq or \*(lqlast\*(rq.
+the reserved names `first' `cur', or `next', The
+messages end with `name' if `name' is `prev' or `last'.

 The interpretation of `n' may be overridden by preceding `n' with a
 plus or minus sign; `+n' always means up to `n' messages starting with
 `name', and `\-n' always means up to `n' messages ending with `name'.
 .PP
 In commands which accept a `msgs' argument, the default is either
 The interpretation of `n' may be overridden by preceding `n' with a
 plus or minus sign; `+n' always means up to `n' messages starting with
 `name', and `\-n' always means up to `n' messages ending with `name'.
 .PP
 In commands which accept a `msgs' argument, the default is either

-\*(lqcur\*(rq or \*(lqall\*(rq, depending on which makes more sense
+`cur' or `all', depending on which makes more sense

 for each command (see the individual man pages for details).  Repeated
 specifications of the same message have the same effect as a single
 specification of the message.
 .PP
 for each command (see the individual man pages for details).  Repeated
 specifications of the same message have the same effect as a single
 specification of the message.
 .PP

-There is also a special \*(lqreserved\*(rq message name \*(lqnew\*(rq
+There is also a special `reserved' message name `new'

 which is used by the
 .B mhpath
 command.
 
 .SS "User\-Defined Message Sequences"
 which is used by the
 .B mhpath
 command.
 
 .SS "User\-Defined Message Sequences"

-In addition to the \*(lqreserved\*(rq (pre-defined) message names given
+In addition to the `reserved' (pre-defined) message names given

 above,
 .B nmh
 supports user-defined sequence names.  User-defined
 above,
 .B nmh
 supports user-defined sequence names.  User-defined

@@ -89,23 +89,23 @@ a group of messages to a meaningful symbolic name.
 .PP
 The name used to denote a message sequence must consist of an alphabetic
 character followed by zero or more alphanumeric characters, and can not
 .PP
 The name used to denote a message sequence must consist of an alphabetic
 character followed by zero or more alphanumeric characters, and can not

-be one of the \*(lqreserved\*(rq message names above.  After defining a
+be one of the `reserved' message names above.  After defining a

 sequence, it can be used wherever an
 .B nmh
 command expects a `msg' or
 `msgs' argument.
 .PP
 Some forms of message ranges are allowed with user-defined sequences.
 sequence, it can be used wherever an
 .B nmh
 command expects a `msg' or
 `msgs' argument.
 .PP
 Some forms of message ranges are allowed with user-defined sequences.

-The specification \*(lqname:n\*(rq may be used, and it designates up
+The specification `name:n' may be used, and it designates up

 to the first `n' messages (or last `n' messages for `\-n') which are
 elements of the user-defined sequence `name'.
 .PP
 to the first `n' messages (or last `n' messages for `\-n') which are
 elements of the user-defined sequence `name'.
 .PP

-The specifications \*(lqname:next\*(rq and \*(lqname:prev\*(rq may also
+The specifications `name:next' and `name:prev' may also

 be used, and they designate the next or previous message (relative to the
 current message) which is an element of the user-defined sequence `name'.
 be used, and they designate the next or previous message (relative to the
 current message) which is an element of the user-defined sequence `name'.

-The specifications \*(lqname:first\*(rq and \*(lqname:last\*(rq are
-equivalent to \*(lqname:1\*(rq and \*(lqname:\-1\*(rq, respectively.  The
-specification \*(lqname:cur\*(rq is not allowed (use just \*(lqcur\*(rq
+The specifications `name:first' and `name:last' are
+equivalent to `name:1' and `name:\-1', respectively.  The
+specification `name:cur' is not allowed (use just `cur'

 instead).  The syntax of these message range specifications is subject
 to change in the future.
 .PP
 instead).  The syntax of these message range specifications is subject
 to change in the future.
 .PP

@@ -121,7 +121,7 @@ There are two varieties of user-defined sequences:
 public and private.  Public sequences of a folder are accessible to any
 .B nmh
 user that can read that folder.  They are kept in each folder
 public and private.  Public sequences of a folder are accessible to any
 .B nmh
 user that can read that folder.  They are kept in each folder

-in the file determined by the \*(lqMh\-Sequences\*(rq profile entry
+in the file determined by the `Mh\-Sequences' profile entry

 (default is
 .IR \&.mh_sequences ).
 Private sequences are accessible
 (default is
 .IR \&.mh_sequences ).
 Private sequences are accessible

@@ -145,20 +145,23 @@ For most commands, this can be overridden by using the switches
 and
 .BR \-private .
 But if the folder is read\-only, or if
 and
 .BR \-private .
 But if the folder is read\-only, or if

-the \*(lqMh\-Sequences\*(rq profile entry is defined but empty, then
+the `Mh\-Sequences' profile entry is defined but empty, then

 \fIprivate\fR sequences will be created instead.
 
 .SS "Sequence Negation"
 .B Nmh
 \fIprivate\fR sequences will be created instead.
 
 .SS "Sequence Negation"
 .B Nmh

-provides the ability to select all messages not elements of a
-user-defined sequence.  To do this, the user should define the entry
-\*(lqSequence\-Negation\*(rq in the
+provides the ability to select all messages
+.B not
+elements of a user-defined sequence.
+A special string is used to preface an existing user-defined
+sequence name.  This specification then refers to those
+messages not elements of the specified sequence name.
+The default negation prefix is the exlamation mark `!',
+but it may be change to any string, by defining the entry
+`Sequence\-Negation' in the

 .B nmh
 .B nmh

-profile file; its value
-may be any string.  This string is then used to preface an existing
-user-defined sequence name.  This specification then refers to those
-messages not elements of the specified sequence name.  For example, if
-the profile entry is:
+profile file.
+For example, if the profile entry is:

 .PP
 .RS 5
 Sequence\-Negation: not
 .PP
 .RS 5
 Sequence\-Negation: not

@@ -166,24 +169,31 @@ Sequence\-Negation: not
 .PP
 then anytime an
 .B nmh
 .PP
 then anytime an
 .B nmh

-command is given \*(lqnotfoo\*(rq as a `msg' or
+command is given `notfoo' as a `msg' or

 `msgs' argument, it would substitute all messages that are not elements
 `msgs' argument, it would substitute all messages that are not elements

-of the sequence \*(lqfoo\*(rq.
+of the sequence `foo'.

 .PP
 Obviously, the user should beware of defining sequences with names that
 .PP
 Obviously, the user should beware of defining sequences with names that

-begin with the value of the \*(lqSequence\-Negation\*(rq profile entry.
+begin with the value of the `Sequence\-Negation' profile entry.
+The default value `!' was chosen due to its similar meaning in the C
+programming language, and because it cannot be part of a user-defined
+sequence. But if your shell provides history expansion,
+you might need to quote the exlamation mark (prefix it with a backslash).
+.PP
+To deactivate the negation mechanism, define Sequence\-Negation in your
+profile to an empty value.

 
 .SS "The Previous Sequence"
 .B Nmh
 provides the ability to remember the `msgs' or `msg' argument
 last given to an
 .B nmh
 
 .SS "The Previous Sequence"
 .B Nmh
 provides the ability to remember the `msgs' or `msg' argument
 last given to an
 .B nmh

-command.  The entry \*(lqPrevious\-Sequence\*(rq
+command.  The entry `Previous\-Sequence'

 should be defined in the
 .B nmh
 profile; its value should be a sequence
 name or multiple sequence names separated by spaces.  If this entry
 should be defined in the
 .B nmh
 profile; its value should be a sequence
 name or multiple sequence names separated by spaces.  If this entry

-is defined, when when an
+is defined, when an

 .B nmh
 command finishes, it will define the
 sequence(s) named in the value of this entry to be those messages that
 .B nmh
 command finishes, it will define the
 sequence(s) named in the value of this entry to be those messages that

@@ -196,17 +206,17 @@ Previous\-Sequence: pseq
 directs any
 .B nmh
 command that accepts a `msg' or `msgs' argument to
 directs any
 .B nmh
 command that accepts a `msg' or `msgs' argument to

-define the sequence \*(lqpseq\*(rq as those messages when it finishes.
+define the sequence `pseq' as those messages when it finishes.

 .PP
 .BR Note :
 there can be a performance penalty in using the
 .PP
 .BR Note :
 there can be a performance penalty in using the

-\*(lqPrevious\-Sequence\*(rq facility.  If it is used,
+`Previous\-Sequence' facility.  If it is used,

 .B all
 .B nmh
 programs have to write the sequence information to the
 .I \&.mh_sequences
 file for the folder each time they run.  If the
 .B all
 .B nmh
 programs have to write the sequence information to the
 .I \&.mh_sequences
 file for the folder each time they run.  If the

-\*(lqPrevious\-Sequence\*(rq profile entry is not included, only
+`Previous\-Sequence' profile entry is not included, only

 .B pick
 and
 .B mark
 .B pick
 and
 .B mark

@@ -215,50 +225,49 @@ will write to the
 file.
 
 .SS "The Unseen Sequence"
 file.
 
 .SS "The Unseen Sequence"

-Finally, many users like to indicate which messages have not been
-previously seen by them.  The commands
+Finally, the unseen sequence indicates which messages have not been
+previously seen by the user.
+The commands

 .BR inc ,
 .BR rcvstore ,
 .BR show ,
 .BR inc ,
 .BR rcvstore ,
 .BR show ,

-.BR mhshow ,

 and
 .B flist
 and
 .B flist

-honor the profile entry
-\*(lqUnseen\-Sequence\*(rq to support this activity.  This entry
-in the
-.I .mmh/profile
-should be defined as one or more sequence
-names separated by spaces.  If there is a value for
-\*(lqUnseen\-Sequence\*(rq in the profile, then whenever new messages
-are placed in a folder (using
+honor the sequence.
+Whenever new messages are placed in a folder (using

 .B inc
 or
 .BR rcvstore ),
 .B inc
 or
 .BR rcvstore ),

-the new messages will also be added to all the sequences named in this
-profile entry.  For example, a profile entry of
-.PP
-.RS 5
-Unseen\-Sequence: unseen
+the new messages will also be added to the unseen sequence.

 .RE
 .PP
 .RE
 .PP

-directs
-.B inc
-to add new messages to the sequence \*(lqunseen\*(rq.
-Unlike the behavior of the \*(lqPrevious\-Sequence\*(rq entry in the
-profile, however, the sequence(s) will
+.BR inc ,
+for example,
+adds new messages to the unseen sequence.
+Unlike the behavior of the previous sequence, however,
+the unseen sequence will

 .B not
 be zeroed by
 .BR inc .
 .PP
 Similarly, whenever
 .BR show ,
 .B not
 be zeroed by
 .BR inc .
 .PP
 Similarly, whenever
 .BR show ,

-.BR mhshow ,

 .BR next ,
 or
 .B prev
 .BR next ,
 or
 .B prev

-displays a message, that message will be removed from
-any sequences named by the \*(lqUnseen\-Sequence\*(rq entry in the
-profile.
+display a message, that message will be removed from
+the unseen sequence.
+.PP
+The default unseen sequence is named `u'.
+To change, define a `Unseen\-Sequence' entry in your profile.
+It may also contain multiple sequence names, separated by spaces.
+In this case, anything that applied to a single unseen sequence,
+applies to multiple ones, too.
+.PP
+The unseen sequence mechanism is automatically activated.
+To deactivate it, define the `Unseen\-Sequence' entry
+in your profile with an empty value.
+

 
 .SH FILES
 .fc ^ ~
 
 .SH FILES
 .fc ^ ~