X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/6c9952d2f2e7466c5b230393feb4701f5bfad3df..9f8418e870a70c264eda1598f2d470e5428c216d:/man/mh-sequence.man?ds=sidebyside diff --git a/man/mh-sequence.man b/man/mh-sequence.man index 79918465..59a582af 100644 --- a/man/mh-sequence.man +++ b/man/mh-sequence.man @@ -20,16 +20,24 @@ To designate a message, you may use either its number (e.g., 1, 10, 234) or one of these \*(lqreserved\*(rq message names: .PP .RS 5 -.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 \*(lqcur\*(rq -next the message numerically following \*(lqcur\*(rq -.fi +.PD 0 +.TP +.B first +the first message in the folder +.TP +.B last +the last message in the folder +.TP +.B cur +the most recently accessed message +.TP +.B prev +the message numerically preceding \*(lqcur\*(rq +.TP +.B next +the message numerically following \*(lqcur\*(rq .RE +.PD .PP In commands that take a `msg' argument, the default is \*(lqcur\*(rq. As a shorthand, \*(lq\&.\*(rq is equivalent to \*(lqcur\*(rq. @@ -67,7 +75,7 @@ selects the 3 messages ending with `name', \*(lqname=-3\*(rq selects just the 2nd previous message. It is an error if the requested message does not exist (i.e., there aren't enough messages in the folder). -.PP +.PP In commands which accept a `msgs' argument, the default is either \*(lqcur\*(rq or \*(lqall\*(rq, depending on which makes more sense for each command (see the individual man pages for details). Repeated @@ -267,6 +275,28 @@ or displays a message, that message will be removed from any sequences named by the \*(lqUnseen\-Sequence\*(rq entry in the profile. +.SS Sequence File Format +The sequence file format is based on the RFC\-5322 message format. Each line +of the sequence file corresponds to one sequence. The line starts with the +sequence name followed by a `:', then followed by a space-separated list of message numbers +that correspond to messages that are part of the named sequence. A contiguous +range of messages can be represented as \*(lqlownum\-highnum\*(rq. +.PP +.B Sample sequence file +.PP +.RS 5 +.nf +work: 3 6 8 22-33 46 +unseen: 47 49-51 54 +cur: 46 +.fi +.RE +.PP +.B Nmh +commands that modify the sequence file will silently remove sequences for +nonexistent messages when the sequence file is updated. The exception to +this is the \*(lqcur\*(rq sequence, which is allowed to point to a +nonexistent message. .SS Sequence File Locking The \*(lqdatalocking\*(rq profile entry controls the type of locking used when reading and writing sequence files. The locking mechanisms supported @@ -298,23 +328,32 @@ the possibility exists that two commands run simultaneously that add messages to a private sequence could result in one command's messages not appearing on the requested sequence. .SH FILES -.fc ^ ~ -.nf -.ta \w'%etcdir%/ExtraBigFileName 'u -^$HOME/\&.mh\(ruprofile~^The user profile -^/context~^The user context -^/\&.mh\(rusequences~^File for public sequences -.fi +.PD 0 +.TP 20 +$HOME/\&.mh\-profile +The user's profile. +.TP 20 +/context +The user's context. +.TP 20 +/\&.mh\-sequences +File for public sequences. +.PD .SH "PROFILE COMPONENTS" -.fc ^ ~ -.nf -.ta 2.4i -.ta \w'ExtraBigProfileName 'u -^mh-sequences:~^Name of file to store public sequences -^Sequence\-Negation:~^To designate messages not in a sequence -^Previous\-Sequence:~^The last message specification given -^Unseen\-Sequence:~^Those messages not yet seen by the user -.fi +.PD 0 +.TP 20 +mh-sequences: +Name of file to store public sequences. +.TP 20 +Sequence\-Negation: +To designate messages not in a sequence. +.TP 20 +Previous\-Sequence: +The last message specification given. +.TP 20 +Unseen\-Sequence: +Those messages not yet seen by the user. +.PD .SH "SEE ALSO" .IR flist (1), .IR mark (1),