]> git.marmaro.de Git - mmh/commitdiff
Update the man pages to the shortened reserved sequence names
authormarkus schnalke <meillo@marmaro.de>
Wed, 11 Feb 2015 07:04:35 +0000 (08:04 +0100)
committermarkus schnalke <meillo@marmaro.de>
Wed, 11 Feb 2015 07:04:35 +0000 (08:04 +0100)
These reserved sequence names were shortened to one character
long ago in the code. Now the docs are adjusted to that change.

Thanks to Marcin for spotting it.

15 files changed:
man/anno.man1
man/burst.man1
man/dist.man1
man/forw.man1
man/mark.man1
man/mh-draft.man7
man/mh-sequence.man7
man/mhlist.man1
man/mhpath.man1
man/mhstore.man1
man/pick.man1
man/refile.man1
man/repl.man1
man/rmm.man1
man/show.man1

index d545f2de37ee3a8c2cf2f37725413c990d638b74..9772031570ff5cfd99350a55990432b50e6d3aef 100644 (file)
@@ -216,7 +216,7 @@ dist(1), forw(1), repl(1)
 .SH DEFAULTS
 .nf
 .RI ` +folder "' defaults to the current folder"
-.RI ` msgs "' defaults to cur"
+.RI ` msgs "' defaults to the current message"
 .RB ` \-date '
 .RB ` \-nopreserve '
 .fi
index b5babf600160b2c40149f19c924ce76196ba083e..a13e476be496f2e46661eb6ff90617f0a6550fdd 100644 (file)
@@ -64,7 +64,7 @@ mhstore(1),
 .SH DEFAULTS
 .nf
 .RB ` +folder "' defaults to the current folder"
-.RB ` msgs "' defaults to cur"
+.RB ` msgs "' defaults to the current message"
 .RB ` \-noverbose '
 .fi
 
index 8e27f66366927e58573d92ca21ccb3c9d40bf07d..773663bcf134d8c3f9cfd0093b8e1f4f5b07eb16 100644 (file)
@@ -130,7 +130,7 @@ comp(1), forw(1), repl(1), send(1), whatnow(1)
 .SH DEFAULTS
 .nf
 .RB ` +folder "' defaults to the current folder"
-.RB ` msg "' defaults to cur"
+.RB ` msg "' defaults to the current message"
 .RB ` \-noannotate '
 .fi
 
index ae4f6708cda937400acc2bf8416c95f76569e0c8..8091c4234fde43c3f20aa092b39031184db7991b 100644 (file)
@@ -190,7 +190,7 @@ mhbuild(1), comp(1), repl(1), send(1), whatnow(1), mh\-format(5),
 .SH DEFAULTS
 .nf
 .RB ` +folder "' defaults to the current folder"
-.RB ` msgs "' defaults to cur"
+.RB ` msgs "' defaults to the current message"
 .RB ` \-noannotate '
 .fi
 
index 6577f64ddbb3e4af94cc22076f6f167ee549f4e1..dacf4ce27e82809146a5ac2ef6395ed0f194cde7 100644 (file)
@@ -28,7 +28,7 @@ message numbers from folder\-specific message sequences, or by listing
 those sequences and messages.
 .PP
 A message sequence is a keyword, just like one of the `reserved'
-message names, such as `first' or `next'.  Unlike the
+message names, such as `f' or `n' (see mh-sequence(7)).  Unlike the
 `reserved' message names, which have a fixed semantics on
 a per\-folder basis, the semantics of a message sequence may be
 defined, modified, and removed by the user.  Message sequences are
@@ -54,7 +54,7 @@ create a new sequence.  For each sequence named via the
 .I name
 argument (which must occur at least once) the messages named via
 .I msgs
-(which defaults to `cur' if no
+(which defaults to `c' if no
 .I msgs
 are given), are added to the
 sequence.  The messages to be added need not be absent from the sequence.
@@ -148,8 +148,8 @@ The current restrictions on sequences are:
 .IP \(bu 2
 The name used to denote a message sequence must consist of an alphabetic
 character followed by zero or more alphanumeric characters, and cannot
-be one of the (reserved) message names `new', `first',
-`last', `all', `next', or `prev'.
+be one of the (reserved) message names `c', `f',
+`l', `a', `n', `p', or `b'.
 .PP
 .IP \(bu 2
 Only a certain number of sequences may be defined for a given folder.
@@ -187,7 +187,7 @@ flist(1), pick(1), mh-sequence(7)
 .nf
 .RB ` +folder "' defaults to the current folder"
 .RB ` \-add "' if " \-sequence " is specified, " \-list " otherwise"
-.RB ` msgs "' defaults to cur (or all if " \-list " is specified)"
+.RB ` msgs "' defaults to `c' (or `a' if " \-list " is specified)"
 .RB ` \-nozero '
 
 .SH CONTEXT
index 40ab6264c6c33703080e412a37f2149793e380d9..04c844654790da7d295f22ee5f6cfd32429d80c8 100644 (file)
@@ -33,7 +33,7 @@ with
 in which case the current draft is used.
 .PP
 The last draft message
-the user was composing is known as `cur' in the draft folder.
+the user was composing is the current message in the draft folder.
 .PP
 The user can send off whatever drafts desired from the shell using the
 standard
@@ -41,7 +41,7 @@ standard
 `msgs' convention to the
 .B send
 command..
-If no `msgs' are given, it defaults to `cur'.
+If no `msgs' are given, it defaults to `c'.
 .PP
 .RS
 .nf
@@ -63,8 +63,8 @@ repl
 .fi
 .RE
 .PP
-constructs the message draft in the draft folder using the `new'
-message number.  Furthermore, they each define `cur' in this folder to
+constructs the message draft in the draft folder using the `b'
+message number.  Furthermore, they each define `c' in this folder to
 be that message draft.  If the user were to use the
 .B quit
 option at `What now?' level, then later on, if no other draft composition
@@ -85,7 +85,7 @@ comp -use
 .RE
 .PP
 Instead, if other drafts had been composed in the meantime, so that this
-message draft was no longer known as `cur' in the `draft' folder, then
+message draft was no longer known as `c' in the `draft' folder, then
 the user could
 .B scan
 the folder to see which message draft in the
index 60568edc8f2a13079fbf1cfb95f8f90b21d656c4..516b8afd67ca368936b3b305deee57f88004c756 100644 (file)
@@ -28,20 +28,19 @@ or one of these `reserved' message names:
 .nf
 .ta +\w'\fIName\fP      'u
 .I "Name       Description
-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 `cur'
-next   the message numerically following `cur'
+f      the first message in the folder
+p      the message numerically preceding `c'
+c      the most recently accessed message
+n      the message numerically following `c'
+l      the last message in the folder
 .fi
 .RE
 .PP
-In commands that take a `msg' argument, the default is `cur'.
-As a shorthand, `\&.' is equivalent to `cur'.
+In commands that take a `msg' argument, the default is `c'.
 .PP
 For example: In a folder containing five messages numbered 5, 10, 94, 177
-and 325, `first' is 5 and `last' is 325.  If `cur'
-is 94, then `prev' is 10 and `next' is 177.
+and 325, `f' is 5 and `l' is 325.  If `c'
+is 94, then `p' is 10 and `n' 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
@@ -49,32 +48,51 @@ 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 `name1\-name2' or
-`name:n', where `name', `name1' and `name2' are message names,
-and `n' is an integer.
+`name:i', where `name', `name1' and `name2' are message names,
+and `i' is an integer.
 .PP
 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'.
+message name `a' (``all'') is a shorthand for the message range
+`f\-l'.
 .PP
-The specification `name:n' designates up to `n' messages.
+.RS 5
+.nf
+.ta +\w'\fIName\fP      'u
+.I "Name       Description
+a      all messages in the folder (i.e. `f\-l')
+.fi
+.RE
+.PP
+The specification `name:i' designates up to `i' messages.
 These messages start with `name' if `name' is a message number or one of
-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'.
+the reserved names `f' `c', or `n', The
+messages end with `name' if `name' is `p' or `l'.
+The interpretation of `i' may be overridden by preceding `i' with a
+plus or minus sign; `+i' always means up to `i' messages starting with
+`name', and `\-i' always means up to `i' messages ending with `name'.
 .PP
 In commands which accept a `msgs' argument, the default is either
-`cur' or `all', depending on which makes more sense
-for each command (see the individual man pages for details).  Repeated
+`c' or `a', depending on which makes more sense
+for each command (see the individual man pages for details).
+.PP
+Repeated
 specifications of the same message have the same effect as a single
 specification of the message.
 .PP
-There is also a special `reserved' message name `new'
-which is used by the
+There is also a special `reserved' message name `b' (``beyond'')
+which can be used with the
 .B mhpath
-command.
+command. It refers to the next (not yet used) message number 
+after `l'.
+.PP
+.RS 5
+.nf
+.ta +\w'\fIName\fP      'u
+.I "Name       Description
+b      the next message number beyond `l'
+.fi
+.RE
 
 .SS "User\-Defined Message Sequences"
 In addition to the `reserved' (pre-defined) message names given
@@ -96,17 +114,17 @@ command expects a `msg' or
 `msgs' argument.
 .PP
 Some forms of message ranges are allowed with user-defined sequences.
-The specification `name:n' may be used, and it designates up
-to the first `n' messages (or last `n' messages for `\-n') which are
+The specification `name:i' may be used, and it designates up
+to the first `i' messages (or last `i' messages for `\-i') which are
 elements of the user-defined sequence `name'.
 .PP
-The specifications `name:next' and `name:prev' may also
+The specifications `name:n' and `name:p' 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'.
-The specifications `name:first' and `name:last' are
+The specifications `name:f' and `name:l' 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
+specification `name:c' is not allowed (use just `c' instead).
+Note: The syntax of these message range specifications is subject
 to change in the future.
 .PP
 User-defined sequence names are specific to each folder.  They are
@@ -115,7 +133,7 @@ defined using the
 and
 .B mark
 commands.
-.PP
+
 .SS "Public and Private User-Defined Sequences"
 There are two varieties of user-defined sequences:
 public and private.  Public sequences of a folder are accessible to any
index e0724b275f6fc419267124774ea5d6907af71ddb..80bdccad0d2602b14bad8b78e9f66e1da40d07ba 100644 (file)
@@ -141,7 +141,7 @@ mhbuild(1), show(1), mhstore(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 ` \-noverbose '
 .fi
 
index 1c35fcd1a615b7d8e558e87465f68f90bd835e39..d5d3327d8aa814a5d1049ba150368f550c78205c 100644 (file)
@@ -30,18 +30,18 @@ commands, a message argument to
 may often be intended for writing.  Because of this:
 .PP
 .IP 1) 4
-the name `new' has been added to
+the name `b' has been added to
 .BR mhpath 's
 list of
-reserved message names (the others are `first', `last',
-`prev', `next', `cur', and `all').
-The new message is equivalent to the message after the last message
+reserved message names (the others are `f', `l',
+`p', `n', `c', and `a').
+The `b' (beyond) message is equivalent to the message after the last message
 in a folder (and equivalent to 1 in a folder without messages).
-The `new' message may not be used as part of a message range.
+The `b' message may not be used as part of a message range.
 .IP 2) 4
 Within a message list, the following designations may refer to messages
 that do not exist: a single numeric message name, the single message name
-`cur', and (obviously) the single message name `new'.
+`c', and (obviously) the single message name `b'.
 All other message designations must refer to at least one existing
 message, if the folder contains messages.
 .IP 3) 4
@@ -59,7 +59,7 @@ Cur is 4.
 % mhpath
 /r/phyl/Mail/foo
 
-% mhpath all
+% mhpath a
 /r/phyl/Mail/foo/3
 /r/phyl/Mail/foo/5
 /r/phyl/Mail/foo/6
@@ -72,23 +72,23 @@ Cur is 4.
 /r/phyl/Mail/foo/5
 /r/phyl/Mail/foo/6
 
-% mhpath new
+% mhpath b
 /r/phyl/Mail/foo/7
 
-% mhpath last new
+% mhpath l b
 /r/phyl/Mail/foo/6
 /r/phyl/Mail/foo/7
 
-% mhpath last\-new
-bad message list `last\-new'.
+% mhpath l\-b
+bad message list `l\-b'.
 
-% mhpath cur
+% mhpath c
 /r/phyl/Mail/foo/4
 
 % mhpath 1\-2
 no messages in range `1\-2'.
 
-% mhpath first:2
+% mhpath f:2
 /r/phyl/Mail/foo/3
 /r/phyl/Mail/foo/5
 
index 8445a5f4d1f6a585bcf9e070b0e8421761dec84e..e4fdfdce64d5411d98bb3553f69ebb60fcb1d616 100644 (file)
@@ -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
index 7b1263fd9fc23cbfbb18101ad5bbf7649409dd58..42971fec485af8d515fd47295f89c0998a095429 100644 (file)
@@ -352,14 +352,14 @@ not, and merely matches the messages you specify.  This lets you type
 something like:
 .PP
 .RS 5
-show\0`pick\0last:20\0\-seq\0fear`
+show\0`pick\0l:20\0\-seq\0fear`
 .RE
 .PP
 instead of typing
 .PP
 .RS 5
 .nf
-mark\0\-add\0\-nozero\0\-seq\0fear\0last:20
+mark\0\-add\0\-nozero\0\-seq\0fear\0l:20
 show\0fear
 .fi
 .RE
index 3bc85f7b8a77d662938cb73e8c34639208e72891..47f825bebf35d3c0bb3b6e95bf7ad346a2b8394a 100644 (file)
@@ -38,7 +38,7 @@ multiply\-index messages.  For example, if a message is received from
 Jones about the ARPA Map Project, the command
 .PP
 .RS 5
-refile\0cur\0+jones\0+Map
+refile\0c\0+jones\0+Map
 .RE
 .PP
 would allow the message to be found in either of the two folders `jones'
@@ -49,7 +49,7 @@ You may specify the source folder using
 .IR +folder .
 If this is
 not given, the current folder is used by default.  If no message is
-specified, then `cur' is used by default.
+specified, then the current message is used by default.
 .PP
 The option
 .B \-file
@@ -120,7 +120,7 @@ folder(1), rmf(1), rmm(1)
 .SH DEFAULTS
 .nf
 .RB ` "\-src\ +folder" "' defaults to the current folder"
-.RB ` msgs "' defaults to cur"
+.RB ` msgs "' defaults to the current message"
 .RB ` \-nolink '
 .fi
 
index c0feecbd13902eeee64497c1ce43f97f45f8a8e7..698d9c824f8f76bad5f1db0f0cc54d39e717e2af 100644 (file)
@@ -381,7 +381,7 @@ mhbuild(1), comp(1), forw(1), send(1), whatnow(1), mh\-format(5)
 .SH DEFAULTS
 .nf
 .RB ` +folder "' defaults to the current folder"
-.RB ` msg "' defaults to cur"
+.RB ` msg "' defaults to the current message"
 .RB ` \-nogroup '
 .RB ` "\-nocc\ all" "' with `\-nogroup', `\-cc\ all' with `\-group'"
 .RB ` \-noannotate '
index 07d6cc3e4e87c8ab723bf856f573d423a4377280..07af34f7ed0214dfdf490935c043f4d7ae8e1327 100644 (file)
@@ -64,7 +64,7 @@ refile(1), rmf(1)
 .SH DEFAULTS
 .nf
 .RB ` +folder "' defaults to the current folder"
-.RB ` msgs "' defaults to cur"
+.RB ` msgs "' defaults to the current message"
 .RB ` \-nounlink '
 .fi
 
index f7b30fd1a36b92c43dbea323c8c88e0826aab5bf..d4f90d1675c784cd5af9ea7ce580299175dc2c74 100644 (file)
@@ -423,7 +423,7 @@ mhbuild(1), mhl(1), mhlist(1), mhstore(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 ` \-form \ mhl.headers'
 .RB ` \-noverbose '
 .fi