From: Ken Hornstein <kenh@pobox.com>
Date: Thu, 17 Oct 2013 19:43:15 +0000 (-0400)
Subject: Update the mh-sequence(5) man page with details of the format of the
X-Git-Url: https://diplodocus.org/git/nmh/commitdiff_plain/da0f112f05d57488a7c7f1fcf6a696696d7df385

Update the mh-sequence(5) man page with details of the format of the
sequence file.  Also mention that nonexistant messages will be removed
from sequences.
---

diff --git a/man/mh-sequence.man b/man/mh-sequence.man
index 79918465..0f876e97 100644
--- a/man/mh-sequence.man
+++ b/man/mh-sequence.man
@@ -267,6 +267,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
+nonexistant messages when the sequence file is updated.  The exception to 
+this is the \*(lqcur\*(rq sequence, which is allowed to point to a
+nonexistant 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