home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 4 / DATAFILE_PDCD4.iso / unix / riscbsd / 1_1_contri / usd / 08_mh / folder_me < prev    next >
Encoding:
Text File  |  1986-04-15  |  5.5 KB  |  172 lines
  1. .\"    This file is automatically generated.  Do not edit!
  2. .SC FOLDER 1
  3. .NA
  4. folder, folders \- set/list current folder/message
  5. .SY
  6. folder
  7. \%[+folder] \%[msg]
  8. \%[\-all]
  9. \%[\-fast] \%[\-nofast]
  10. \%[\-header] \%[\-noheader]
  11. \%[\-pack] \%[\-nopack]
  12. \%[\-recurse] \%[\-norecurse]
  13. \%[\-total] \%[\-nototal]
  14. \%[\-print] \%[\-noprint]
  15. \%[\-list] \%[\-nolist]
  16. \%[\-push] \%[\-pop]
  17. \%[\-help]
  18.  
  19. .ti .5i
  20. folders
  21. .DE
  22. Since the \fIMH\fR environment is the shell, it is easy to lose
  23. track of the current folder from day to day.
  24.  
  25. When \fIfolder\fR is given the `\-print' switch (the default),
  26. the current folder and/or message may be set,
  27. or all folders may be listed.
  28. When a `+folder' argument is given,
  29. this corresponds to a \*(lqcd\*(rq operation in the \fICShell\fR;
  30. when no `+folder' argument is given,
  31. this corresponds roughly to a \*(lqpwd\*(rq operation in the \fICShell\fR.
  32.  
  33. \fIFolder\fR will
  34. list the current folder, the number of messages in it, the
  35. range of the messages (low\-high), and the current message within
  36. the folder, and will flag extra files if they exist.
  37. An example of the output is:
  38.  
  39. .nf
  40. .if t .in +.5i
  41. .ta \w'/rnd/phyl/Mail/EP 'u +\w'has ddd messages 'u +\w'(ddd\-ddd); 'u
  42. inbox+    has \016 messages    (\0\03\-\022);    cur=\0\05.
  43. .re
  44. .if t .in -.5i
  45. .fi
  46.  
  47. If a `+folder' and/or `msg' are specified, they will
  48. become the current folder and/or message.
  49. Specifying `\-all'
  50. will produce a line for each folder in the user's MH directory,
  51. sorted alphabetically.
  52. These folders are preceded by the read\-only folders,
  53. which occur as \*(lqatr\-cur\-\*(rq entries in the user's \fIMH\fR context.
  54. For example,
  55.  
  56. .nf
  57. .if t .in +.5i
  58. .ta \w'/rnd/phyl/Mail/EP 'u +\w'has ddd messages 'u +\w'(ddd\-ddd); 'u
  59. Folder    \0\0\0# of messages    (\0range\0)    cur msg (other files)
  60. /fsd/rs/m/tacc    has \035 messages    (\0\01\-\035);    cur=\023.
  61. /rnd/phyl/Mail/EP    has \082 messages    (\0\01\-108);    cur=\082.
  62. ff    has \0no messages.
  63. inbox+    has \016 messages    (\0\03\-\022);    cur=\0\05.
  64. mh    has \076 messages    (\0\01\-\076);    cur=\070.
  65. notes    has \0\02 messages    (\0\01\-\0\02);    cur=\0\01.
  66. ucom    has 124 messages    (\0\01\-124);    cur=\0\06; (others).
  67. .ta \w'/rnd/phyl/Mail/EP has 'u
  68. \0\0\0\0\0\0\0\0\0\0TOTAL=    339 messages in 7 folders
  69. .re
  70. .if t .in -.5i
  71. .fi
  72.  
  73. The \*(lq+\*(rq after inbox indicates that it is the current folder.
  74. The \*(lq(others)\*(rq indicates that the folder `ucom' has files
  75. which aren't messages.
  76. These files may either be sub\-folders,
  77. or files that don't belong under the MH file naming scheme.
  78.  
  79. The header is output if either an `\-all' or a `\-header' switch
  80. is specified; it is suppressed by `\-noheader'.
  81. Also, if \fIfolder\fR
  82. is invoked by a name ending with \*(lqs\*(rq (e.g., \fIfolders\fR\0),
  83. `\-all' is assumed.
  84. A `\-total' switch will produce only the
  85. summary line.
  86.  
  87. If a `+folder' and/or `msg' is given along with the `\-all' switch,
  88. \fIfolder\fR will,
  89. in addition to setting the current folder and/or message,
  90. list the top\-level folders for the current folder (with `\-norecurse')
  91. or list all folders under the current folder recursively (with `\-recurse').
  92.  
  93. If `\-fast' is given, only the folder name (or names in the
  94. case of `\-all') will be listed.
  95. (This is faster because the
  96. folders need not be read.)
  97.  
  98. The `\-pack' switch will compress the message names in a folder, removing
  99. holes in message numbering.
  100.  
  101. The `\-recurse' switch will list each folder recursively.
  102. Use of this option effectively defeats the speed enhancement of the `\-fast'
  103. option,
  104. since each folder must be searched for subfolders.
  105. Nevertheless, the combination of these options is useful.
  106.  
  107. If the specified (or default) folder doesn't exist,
  108. the user will be queried if the folder should be created.
  109. (This is the easy way to create an empty folder for use later.)
  110.  
  111. The `\-push' switch directs \fIfolder\fR to push the current folder onto the
  112. \fIfolder\-stack\fR,
  113. and make the `+folder' argument the current folder.
  114. If `+folder' is not given,
  115. the current folder and the top of the \fIfolder\-stack\fR are exchanged.
  116. This corresponds to the \*(lqpushd\*(rq operation in the \fICShell\fR.
  117.  
  118. The `\-pop' switch directs \fIfolder\fR to discard the top of the
  119. \fIfolder\-stack\fR,
  120. after setting the current folder to that value.
  121. No `+folder' argument is allowed.
  122. This corresponds to the \*(lqpopd\*(rq operation in the \fICShell\fR.
  123. The `\-push' switch and the `\-pop' switch are mutually exclusive:
  124. the last occurrence of either one overrides any previous occurrence of the
  125. other.
  126.  
  127. The `\-list' switch directs \fIfolder\fR to list the contents of the
  128. \fIfolder\-stack\fR.
  129. No `+folder' argument is allowed.
  130. After a successful `\-push' or `\-pop', the `\-list' action is taken.
  131. This corresponds to the \*(lqdirs\*(rq operation in the \fICShell\fR.
  132. .Fi
  133. ^$HOME/\&.mh\(ruprofile~^The user profile
  134. .Pr
  135. ^Path:~^To determine the user's MH directory
  136. .Ps
  137. ^Current\-Folder:~^To find the default current folder
  138. .Ps
  139. ^Folder\-Protect:~^To set mode when creating a new folder
  140. .Ps
  141. ^Folder\-Stack:~^To determine the folder stack
  142. .Ps
  143. ^lsproc:~^Program to list the contents of a folder
  144. .Sa
  145. refile(1), mhpath(1)
  146. .De
  147. `+folder' defaults to the current folder
  148. .Ds
  149. `msg' defaults to none
  150. .Ds
  151. `\-nofast'
  152. .Ds
  153. `\-noheader'
  154. .Ds
  155. `\-nototal'
  156. .Ds
  157. `\-nopack'
  158. .Ds
  159. `\-norecurse'
  160. .Ds
  161. `\-print' is the default if no `\-list', `\-push', or `\-pop' is specified
  162. .Co
  163. If `+folder' and/or `msg' are given, they will become the
  164. current folder and/or message.
  165. .Hi
  166. In previous versions of \fIMH\fR,
  167. the `\-fast' switch prevented context changes from
  168. occurring for the current folder.
  169. This is no longer the case: if `+folder' is given,
  170. then \fIfolder\fR will always change the current folder to that.
  171. .En
  172.