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