Return to mark.me CVS log

Up to [CSRG BSD Unix] / 43BSD / contrib / mh / doc

Annotation of 43BSD/contrib/mh/doc/mark.me, revision 1.1

1.1     ! root        1: .\"    This file is automatically generated.  Do not edit!
        !             2: .TH MARK 1 "April 22, 1986" MH [mh.6]
        !             3: .UC 6
        !             4: .SH NAME
        !             5: mark \- mark messages
        !             6: .SH SYNOPSIS
        !             7: .in +.5i
        !             8: .ti -.5i
        !             9: mark
        !            10: \%[+folder] \%[msgs]
        !            11: \%[\-sequence\ name\ ...]
        !            12: \%[\-add] \%[\-delete] \%[\-list] 
        !            13: \%[\-public] \%[\-nopublic]
        !            14: \%[\-zero] \%[\-nozero]
        !            15: \%[\-help]
        !            16: .in -.5i
        !            17: .SH DESCRIPTION
        !            18: The \fImark\fR command manipulates message sequences by adding or
        !            19: deleting message numbers from folder\-specific message sequences,
        !            20: or by listing those sequences and messages.
        !            21: A message sequence is a keyword, just like one of the
        !            22: \*(lqreserved\*(rq message names,
        !            23: such as \*(lqfirst\*(rq or \*(lqnext\*(rq.
        !            24: Unlike the \*(lqreserved\*(rq message names,
        !            25: which have a fixed semantics on a per\-folder basis,
        !            26: the semantics of a message sequence may be defined, modified, and
        !            27: removed by the user.
        !            28: Message sequences are folder\-specific, e.g.,
        !            29: the sequence name \*(lqseen\*(rq in the context of folder \*(lq+inbox\*(rq
        !            30: need not have any relation whatsoever to the sequence of the same name
        !            31: in a folder of a different name.
        !            32: 
        !            33: Three action switches direct the operation of \fImark\fR.
        !            34: These switches are mutually exclusive:
        !            35: the last occurrence of any of them overrides any previous occurrence of the
        !            36: other two.
        !            37: 
        !            38: The `\-add' switch tells \fImark\fR to add messages to sequences
        !            39: or to create a new sequence.
        !            40: For each sequence named via the `\-sequence\ name' argument
        !            41: (which must occur at least once)
        !            42: the messages named via `msgs'
        !            43: (which defaults to \*(lqcur\*(rq if no `msgs' are given),
        !            44: are added to the sequence.
        !            45: The messages to be added need not be absent from the sequence.
        !            46: If the `\-zero' switch is specified,
        !            47: the sequence will be emptied prior to adding the messages.
        !            48: Hence, `\-add\ \-zero' means that each sequence should be initialized
        !            49: to the indicated messages,
        !            50: while `\-add\ \-nozero' means that each sequence should be appended to
        !            51: by the indicated messages.
        !            52: 
        !            53: The `\-delete' switch tells \fImark\fR to delete messages from
        !            54: sequences, and is the dual of `\-add'.
        !            55: For each of the named sequences,
        !            56: the named messages are removed from the sequence.
        !            57: These messages need not be already present in the sequence.
        !            58: If the `\-zero' switch is specified,
        !            59: then all messages in the folder are appended to the sequence prior to
        !            60: removing the messages.
        !            61: Hence, `\-delete\ \-zero' means that each sequence should contain all
        !            62: messages except those indicated,
        !            63: while `\-delete\ \-nozero' means that only the indicated messages
        !            64: should be removed from each sequence.
        !            65: As expected, the command `mark\0\-sequence\0seen\0\-delete\0all'
        !            66: deletes the sequence \*(lqseen\*(rq from the current folder.
        !            67: 
        !            68: When creating (or modifying) a sequence,
        !            69: the `\-public' switch indicates that the sequence should be made readable
        !            70: for other \fIMH\fR users.
        !            71: In contrast, the `\-nopublic' switch indicates that the sequence should be
        !            72: private to the user's \fIMH\fR environment.
        !            73: 
        !            74: The `\-list' switch tells \fImark\fR to list both the sequences defined
        !            75: for the folder and the messages associated with those sequences.
        !            76: \fIMark\fR will list each sequence named via `\-sequence\ name'
        !            77: (or all of them if `\-sequence' isn't used),
        !            78: and the messages associated with that sequence.
        !            79: The `\-zero' switch does not affect the operation of `\-list'.
        !            80: 
        !            81: The current restrictions on sequences are:
        !            82: 
        !            83: .in +.25i
        !            84: The name used to denote a message sequence must consist solely of
        !            85: alphabetic characters, and can not be one of the \*(lqreserved\*(rq
        !            86: message names
        !            87: (e.g., \*(lqfirst\*(rq, \*(lqcur\*(rq, and so forth).
        !            88: 
        !            89: Only a certain number of sequences may be defined for a given folder.
        !            90: This number is usually limited to 10.
        !            91: 
        !            92: The name used to denote a message sequence can not occur as part of a
        !            93: message range, e.g., constructs like \*(lqseen:20\*(rq or
        !            94: \*(lqseen\-10\*(rq are forbidden.
        !            95: .in -.25i
        !            96: .Fi
        !            97: ^$HOME/\&.mh\(ruprofile~^The user profile
        !            98: .Pr
        !            99: ^Path:~^To determine the user's MH directory
        !           100: .Ps
        !           101: ^Current\-Folder:~^To find the default current folder
        !           102: .Sa
        !           103: pick (1)
        !           104: .De
        !           105: `+folder' defaults to the current folder
        !           106: .Ds
        !           107: `\-add' if `msgs' is specified, `\-list' otherwise
        !           108: .Ds
        !           109: `msgs' defaults to cur (or all if `\-list' is specified)
        !           110: .Ds
        !           111: `\-nopublic' if the folder is read\-only, `\-public' otherwise
        !           112: .Ds
        !           113: `\-nozero'
        !           114: .Co
        !           115: If a folder is given, it will become the current folder.
        !           116: .En

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.