From 1ba1ca6484d35f40b87d515302ea76e7b7b01f32 Mon Sep 17 00:00:00 2001 From: markus schnalke Date: Wed, 11 Feb 2015 08:04:35 +0100 Subject: [PATCH] Update the man pages to the shortened reserved sequence names 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. --- man/anno.man1 | 2 +- man/burst.man1 | 2 +- man/dist.man1 | 2 +- man/forw.man1 | 2 +- man/mark.man1 | 10 +++---- man/mh-draft.man7 | 10 +++---- man/mh-sequence.man7 | 80 +++++++++++++++++++++++++++++++------------------- man/mhlist.man1 | 2 +- man/mhpath.man1 | 26 ++++++++-------- man/mhstore.man1 | 2 +- man/pick.man1 | 4 +-- man/refile.man1 | 6 ++-- man/repl.man1 | 2 +- man/rmm.man1 | 2 +- man/show.man1 | 2 +- 15 files changed, 86 insertions(+), 68 deletions(-) diff --git a/man/anno.man1 b/man/anno.man1 index d545f2d..9772031 100644 --- a/man/anno.man1 +++ b/man/anno.man1 @@ -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 diff --git a/man/burst.man1 b/man/burst.man1 index b5babf6..a13e476 100644 --- a/man/burst.man1 +++ b/man/burst.man1 @@ -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 diff --git a/man/dist.man1 b/man/dist.man1 index 8e27f66..773663b 100644 --- a/man/dist.man1 +++ b/man/dist.man1 @@ -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 diff --git a/man/forw.man1 b/man/forw.man1 index ae4f670..8091c42 100644 --- a/man/forw.man1 +++ b/man/forw.man1 @@ -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 diff --git a/man/mark.man1 b/man/mark.man1 index 6577f64..dacf4ce 100644 --- a/man/mark.man1 +++ b/man/mark.man1 @@ -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 diff --git a/man/mh-draft.man7 b/man/mh-draft.man7 index 40ab626..04c8446 100644 --- a/man/mh-draft.man7 +++ b/man/mh-draft.man7 @@ -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 diff --git a/man/mh-sequence.man7 b/man/mh-sequence.man7 index 60568ed..516b8af 100644 --- a/man/mh-sequence.man7 +++ b/man/mh-sequence.man7 @@ -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 diff --git a/man/mhlist.man1 b/man/mhlist.man1 index e0724b2..80bdcca 100644 --- a/man/mhlist.man1 +++ b/man/mhlist.man1 @@ -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 diff --git a/man/mhpath.man1 b/man/mhpath.man1 index 1c35fcd..d5d3327 100644 --- a/man/mhpath.man1 +++ b/man/mhpath.man1 @@ -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 diff --git a/man/mhstore.man1 b/man/mhstore.man1 index 8445a5f..e4fdfdc 100644 --- a/man/mhstore.man1 +++ b/man/mhstore.man1 @@ -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 diff --git a/man/pick.man1 b/man/pick.man1 index 7b1263f..42971fe 100644 --- a/man/pick.man1 +++ b/man/pick.man1 @@ -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 diff --git a/man/refile.man1 b/man/refile.man1 index 3bc85f7..47f825b 100644 --- a/man/refile.man1 +++ b/man/refile.man1 @@ -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 diff --git a/man/repl.man1 b/man/repl.man1 index c0feecb..698d9c8 100644 --- a/man/repl.man1 +++ b/man/repl.man1 @@ -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 ' diff --git a/man/rmm.man1 b/man/rmm.man1 index 07d6cc3..07af34f 100644 --- a/man/rmm.man1 +++ b/man/rmm.man1 @@ -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 diff --git a/man/show.man1 b/man/show.man1 index f7b30fd..d4f90d1 100644 --- a/man/show.man1 +++ b/man/show.man1 @@ -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 -- 1.7.10.4