X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/d1cb667bddf8d1c5c0721fc7ab642c22946baf1f..94187a80bd60baab4b9c4b949ad820d730578123:/man/mark.man diff --git a/man/mark.man b/man/mark.man index 500fdb16..130bce6f 100644 --- a/man/mark.man +++ b/man/mark.man @@ -1,38 +1,38 @@ -.TH MARK %manext1% "February 11, 2012" "%nmhversion%" -.\" +.TH MARK %manext1% 2013-03-31 "%nmhversion%" +. .\" %nmhwarning% -.\" +. .SH NAME -mark \- manipulate message sequences +mark \- manipulate nmh message sequences .SH SYNOPSIS .HP 5 .na .B mark +.RB [ \-help ] +.RB [ \-version ] .RI [ +folder ] .RI [ msgs ] .RB [ \-sequence .I name \&...] .RB [ \-add " | " \-delete ] -.RB [ \-list ] +.RB [ \-list ] .RB [ \-public " | " \-nopublic ] .RB [ \-zero " | " \-nozero ] -.RB [ \-version ] -.RB [ \-help ] .ad .SH DESCRIPTION The .B mark command manipulates message sequences by adding or deleting -message numbers from folder\-specific message sequences, or by listing +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 \*(lqreserved\*(rq message names, such as \*(lqfirst\*(rq or \*(lqnext\*(rq. Unlike the \*(lqreserved\*(rq message names, which have a fixed semantics on -a per\-folder basis, the semantics of a message sequence may be +a per-folder basis, the semantics of a message sequence may be defined, modified, and removed by the user. Message sequences are -folder\-specific, e.g., the sequence name \*(lqseen\*(rq in the context +folder-specific, e.g., the sequence name \*(lqseen\*(rq in the context of folder .RI \*(lq +inbox \*(rq need not have any relation whatsoever to the @@ -97,8 +97,8 @@ As expected, the command .B \-sequence .I foo .B \-delete -all\*(rq -deletes the sequence \*(lqfoo\*(rq from the current folder. +all\*(rq empties the sequence \*(lqfoo\*(rq, and therefore removes +that sequence from the current folder's list of sequences. .PP When creating or modifying sequences, you can specify the switches .B \-public @@ -118,9 +118,9 @@ sequences should be made \*(lqprivate\*(rq, and will only be accessible by you. If neither of these switches is specified, then existing sequences will maintain their current status, and new sequences will default to \*(lqpublic\*(rq if you have write permission for the relevant folder. -Check the +Check .IR mh\-sequence (5) -man page for more details about the difference +for more details about the difference between \*(lqpublic\*(rq and \*(lqprivate\*(rq sequences. .PP The @@ -129,7 +129,7 @@ switch tells .B mark to list both the sequences defined for the folder and the messages associated with those sequences. -.B Mark +.B mark will list the name of each sequence given by .B \-sequence .I name @@ -143,7 +143,7 @@ will be listed. The switch does not affect the operation of .BR \-list . .PP -The current restrictions on sequences are: +The restrictions on sequences are: .PP .IP \(bu 2 The name used to denote a message sequence must consist of an alphabetic @@ -152,41 +152,50 @@ be one of the (reserved) message names \*(lqnew\*(rq, \*(lqfirst\*(rq, \*(lqlast\*(rq, \*(lqall\*(rq, \*(lqnext\*(rq, or \*(lqprev\*(rq. .PP .IP \(bu 2 -Only a certain number of sequences may be defined for a given folder. -This number is usually limited to 27 (11 on small systems). (The -internal implementation relies on bitmasks, with some bits set aside -for internal use.) -.PP -.IP \(bu 2 -Message ranges with user\-defined sequence names are restricted to the +Message ranges with user-defined sequence names are restricted to the form \*(lqname:n\*(rq, \*(lqname:+n\*(rq, or \*(lqname:-n\*(rq, and refer to the first or last `n' messages of the sequence `name', respectively. Constructs of the form \*(lqname1\-name2\*(rq are forbidden for user defined sequences. .SH FILES -.fc ^ ~ -.nf -.ta \w'%etcdir%/ExtraBigFileName 'u -^$HOME/\&.mh\(ruprofile~^The user profile -.fi +.TP 20 +$HOME/.mh_profile +The user's profile. .SH "PROFILE COMPONENTS" -.fc ^ ~ -.nf -.ta 2.4i -.ta \w'ExtraBigProfileName 'u -^Path:~^To determine the user's nmh directory -^Current\-Folder:~^To find the default current folder -.fi +.PD 0 +.TP 20 +Path: +To determine the user's nmh directory. +.TP +Current\-Folder: +To find the default current folder. +.PD .SH "SEE ALSO" .IR flist (1), .IR pick (1), .IR mh-sequence (5) .SH DEFAULTS -.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 ` \-nozero ' +.PD 0 +.TP 20 ++folder +The current folder. +.TP +\-add +If +.B \-sequence +is specified, +.B \-list +otherwise. +.TP +msgs +The current message, or +.B all +if +.B \-list +is specified. +.TP +\-nozero +.PD .SH CONTEXT If a folder is given, it will become the current folder. .SH "HELPFUL HINTS"