home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 4 / DATAFILE_PDCD4.iso / unix / riscbsd / 1_1_contri / usd / 08_mh / msh_me < prev    next >
Encoding:
Text File  |  1986-04-15  |  5.8 KB  |  213 lines
  1. .\"    This file is automatically generated.  Do not edit!
  2. .SC MSH 1
  3. .NA
  4. msh \- MH shell (and BBoard reader)
  5. .SY
  6. msh
  7. \%[\-prompt\ string]
  8. \%[\-scan] \%[\-noscan]
  9. \%[\-topcur] \%[\-notopcur]
  10. \%[file]
  11. \%[\-help]
  12. .DE
  13. \fImsh\fR is an interactive program that
  14. implements a subset of the normal \fIMH\fR commands
  15. operating on a single file in \fIpackf\fR'd format.
  16. That is, \fImsh\fR is used to read a file that contains a number of
  17. messages,
  18. as opposed to the standard
  19. \fIMH\fR
  20. style of reading a number of files,
  21. each file being a separate message in a folder.
  22. \fImsh\fR's chief advantage is that the normal \fIMH\fR style does not allow
  23. a file to have more than one message in it.
  24. Hence, \fImsh\fR is ideal for reading \fIBBoards\fR,
  25. as these files are delivered by the transport system in this format.
  26. In addition, \fImsh\fR can be used on other files,
  27. such as message archives which have been \fIpack\fRed (see \fIpackf\fR\0(1)).
  28. Finally, \fImsh\fR is an excellent \fIMH\fR
  29. tutor.
  30. As the only commands available to the user are \fIMH\fR commands,
  31. this allows \fIMH\fR beginners to concentrate on how commands to
  32. \fIMH\fR are formed and (more or less) what they mean.
  33.  
  34. When invoked, \fImsh\fR reads the named file, and enters a command loop.
  35. The user may type most of the normal
  36. \fIMH\fR
  37. commands.
  38. The syntax and semantics of these commands typed to \fImsh\fR are
  39. identical to their \fIMH\fR
  40. counterparts.  In cases where the nature of \fImsh\fR would be inconsistent
  41. (e.g., specifying a `+folder' with some commands),
  42. \fImsh\fR will duly inform the user.
  43. The commands that \fImsh\fR currently supports
  44. (in some slightly modified or restricted forms) are:
  45. .sp 1
  46. .in +.5i
  47. ali
  48. .br
  49. burst
  50. .br
  51. comp
  52. .br
  53. dist
  54. .br
  55. folder
  56. .br
  57. forw
  58. .br
  59. inc
  60. .br
  61. mark
  62. .br
  63. mhmail
  64. .br
  65. msgchk
  66. .br
  67. next
  68. .br
  69. packf
  70. .br
  71. pick
  72. .br
  73. prev
  74. .br
  75. refile
  76. .br
  77. repl
  78. .br
  79. rmm
  80. .br
  81. scan
  82. .br
  83. send
  84. .br
  85. show
  86. .br
  87. sortm
  88. .br
  89. whatnow
  90. .br
  91. whom
  92. .in -.5i
  93.  
  94. In addition,
  95. \fImsh\fR has a \*(lqhelp\*(rq command which gives a brief overview.
  96. To terminate \fImsh\fR, type CTRL\-D, or use the \*(lqquit\*(rq command.
  97. If \fImsh\fR is being invoked from \fIbbc\fR,
  98. then typing CTRL\-D will also tell \fIbbc\fR to exit as well,
  99. while using the \*(lqquit\*(rq command will return control to \fIbbc\fR,
  100. and \fIbbc\fR will continue examining the list of BBoards
  101. that it is scanning.
  102.  
  103. If the file is writable and has been modified,
  104. then using \*(lqquit\*(rq will query the user if the file should be updated.
  105.  
  106. The `\-prompt string' switch sets the prompting string for \fImsh\fR.
  107.  
  108. You may wish to use an alternate \fIMH\fR profile for the commands that
  109. \fImsh\fR executes;
  110. see \fImh-profile\fR\0(5) for details about the \fB$MH\fR environment variable.
  111.  
  112. When invoked from \fIbbc\fR,
  113. two special features are enabled:
  114. First,
  115. the `\-scan' switch directs \fImsh\fR to do a `scan\0unseen' on
  116. start\-up if new items are present in the BBoard.
  117. This feature is best used from \fIbbc\fR,
  118. which correctly sets the stage.
  119. Second,
  120. the \fImark\fR command in \fImsh\fR acts specially when you are reading
  121. a BBoard,
  122. since \fImsh\fR will consult the sequence \*(lqunseen\*(rq in determining
  123. what messages you have actually read.
  124. When \fImsh\fR exits, it reports this information to \fIbbc\fR.
  125. In addition, if you give the \fImark\fR command with no arguments,
  126. \fImsh\fR will interpret it
  127. as `mark\0\-sequence\0unseen\0\-delete\0\-nozero\0all'
  128. Hence, to discard all of the messages in the current BBoard you're
  129. reading, just use the \fImark\fR command with no arguments.
  130.  
  131. When invoked from \fIvmh\fR,
  132. another special feature is enabled:
  133. The `topcur' switch directs \fImsh\fR to have the current message
  134. \*(lqtrack\*(rq the top line of the \fIvmh\fR scan window.
  135. Normally, \fImsh\fR has the current message \*(lqtrack\*(rq the center of the
  136. window (under `\-notopcur', which is the default).
  137.  
  138. \fImsh\fR supports an output redirection facility.
  139. Commands may be followed by one of
  140.  
  141. .nf
  142. .in +.5i
  143. .ta \w'| \fIcommand\fR  'u
  144. ^> \fIfile\fR~^write output to \fIfile\fR
  145. ^>> \fIfile\fR~^append output to \fIfile\fR
  146. ^| \fIcommand\fR~^pipe output to UNIX \fIcommand\fR
  147. .re
  148. .in -.5i
  149. .fi
  150.  
  151. If \fIfile\fR starts with a `\~' (tilde),
  152. then a \fIcsh\fR-like expansion takes place.
  153. Note that \fIcommand\fR is interpreted by \fIsh\fR\0(1).
  154. Also note that \fImsh\fR does NOT support
  155. history substitutions, variable substitutions, or alias substitutions.
  156.  
  157. When parsing commands to the left of any redirection symbol,
  158. \fImsh\fR will honor `\\' (back\-slash) as the quote next\-character symbol,
  159. and `"' (double\-quote) as quote\-word delimiters.
  160. All other input tokens are separated by whitespace
  161. (spaces and tabs).
  162. .Fi
  163. ^$HOME/\&.mh\(ruprofile~^The user profile
  164. ^/usr/new/lib/mh/mtstailor~^tailor file
  165. .Pr
  166. ^Path:~^To determine the user's MH directory
  167. .Ps
  168. ^Msg\-Protect:~^To set mode when creating a new `file'
  169. .Ps
  170. ^fileproc:~^Program to file messages
  171. .Ps
  172. ^showproc:~^Program to show messages
  173. .Sa
  174. bbc(1)
  175. .De
  176. `file' defaults to \*(lq./msgbox\*(rq
  177. .Ds
  178. `\-prompt\ (msh)\ '
  179. .Ds
  180. `\-noscan'
  181. .Ds
  182. `\-notopcur'
  183. .Co
  184. None
  185. .Bu
  186. The argument to the `\-prompt' switch must be interpreted as a single token
  187. by the shell that invokes \fImsh\fR.
  188. Therefore,
  189. one must usually place the argument to this switch inside double\-quotes.
  190.  
  191. There is a strict limit of messages per file in \fIpackf\fR'd format which
  192. \fImsh\fR can handle.
  193. Usually, this limit is 1000 messages.
  194.  
  195. Please remember that \fImsh\fR is not the \fICShell\fR,
  196. and that a lot of the nice facilities provided by the latter are not
  197. present in the former.
  198.  
  199. In particular, \fImsh\fR does not understand back\-quoting,
  200. so the only effective way to use \fIpick\fR inside \fImsh\fR is to always use
  201. the `\-seq\0select' switch.
  202. Clever users of \fIMH\fR will put the line
  203.  
  204. .ti +.5i
  205. pick:\0\-seq\0select\0\-list
  206.  
  207. in their \&.mh\(ruprofile file so that \fIpick\fR works equally well from
  208. both the shell and \fImsh\fR.
  209.  
  210. The \fImsh\fR program inherits most (if not all) of the bugs from the
  211. \fIMH\fR commands it implements.
  212. .En
  213.