home *** CD-ROM | disk | FTP | other *** search
/ ftp.freefriends.org / ftp.freefriends.org.tar / ftp.freefriends.org / arnold / Source / mush.rstevens.tar.gz / mush.tar / tool_help < prev    next >
Text File  |  1990-12-06  |  19KB  |  440 lines

  1. @(#)tool_help    (c) copyright 10/18/86 (Dan Heller)
  2.  
  3. %general%
  4.  
  5.       IF ALL ELSE FAILS, READ THE DIRECTIONS!
  6.  
  7. This famous  quote applies here more  than ever. If
  8. you are unfamiliar with Mushview, you should get
  9. yourself acquainted with it by choosing HELP options
  10. in menu items. If you get frustrated or confused
  11. about how to use or run a command, or if you want to
  12. know how something works or get to know quick shortcuts
  13. in achieving tasks, it is advisable to look at the
  14. Help option available with some items.
  15. %%
  16.  
  17. %help%
  18. Help was designed for users to get help from all commands
  19. and options.  The last item in many menus is a "help"
  20. choice.  You will get an appropriate help message describing
  21. what you can do at the position you are in on the Mushview
  22. window.
  23.  
  24. If a help message isn't much help, it may be more helpful to
  25. reference a different help item which describes in more detail
  26. what you want to know.  For example, reading the help for
  27. "folder" will help you better understand the method in which
  28. mail messages are stored than it would if you had read the help
  29. message for "save" first.
  30. %%
  31.  
  32. %mouse%
  33. The mouse is an image (cursor) which moves across the screen. Its
  34. position indicates which window is to receive input when you type
  35. or click a mouse button.
  36.  
  37. The mouse may take upon different images which indicate various
  38. things. When the image looks like a "coffee cup", Mushview is in
  39. the process of doing something, like sending mail, or reading in
  40. new mail.  In this event, you should wait till the cursor returns
  41. to its normal state before attempting to do anything else. Go get
  42. some coffee.
  43.  
  44. When in the Header Window, the cursor will look like the mouse
  45. device that you hold with the buttons flashing on and off.  This
  46. is to remind you that you can use each button to do different tasks.
  47. Using the RIGHT mouse button gives you a menu of options to do for
  48. the message under the mouse.
  49. %%
  50.  
  51. %respond%
  52. This item responds to mail in 4 ways.
  53. In all cases, at least one recipient of your message will be the
  54. sender of the message you are responding to. If a subject was in
  55. the author's letter, then it will be used as your subject.
  56.  
  57. The first and most used method of response is to the author of the
  58. message only.  Selecting this item with the LEFT mouse button will
  59. use this method for responding to mail.
  60.  
  61. If you want to include a copy of the author's message, then choose
  62. the menu item which  says to include the message.  If you wish for
  63. all the recipients of the message to receive a copy of your reply,
  64. then choosing the third item will include them.
  65.  
  66. The fourth menu item will mail to the author and everyone listed on
  67. the To and Cc lines of the message, and include the message you are
  68. responding to in your text.
  69.  
  70. In such cases where you include the message you are responding to,
  71. the included message will be indented by "> " to identify it from
  72. your message. If you would like to have a string other than the
  73. default used, then set the appropriate option to whatever you would
  74. prefer by selecting the "Opts" item, moving the mouse on top of the
  75. string, "indent-str", selecting the LEFT mouse button and typing the
  76. desired string.
  77. %%
  78.  
  79. %delete%
  80. You may  delete or undelete  messages with this item.
  81. When using the LEFT mouse button, you will delete the
  82. current message (HIGHLIGHTED in the headers' window).
  83. Otherwise, you may select the menu item for undelete.
  84.  
  85. You may  delete or undelete a  "range" of messages by
  86. typing the range in the Header Window.
  87.  
  88. For help on valid  message ranges, select the menu in
  89. the area  marked "range" in the  Header Panel Window.
  90. %%
  91.  
  92. %folder%
  93. Your "folder" is a place to keep all your individual messages. Usually,
  94. if you are a heavy mail user, you would organize your mail in such a
  95. way in which related mail would be saved together in one folder.   You
  96. create folders simply by saving mail to a filename.  Additional mail
  97. can  be saved to those files in the same way.  To manipulate messages
  98. in folders,  you "change folders" to the folder you wish to access
  99. using the folder item.   Since it may occur that you switch  back and
  100. forth  between two folders, you may use the previous  folder menu item
  101. which updates changes  made to the current folder and  changes your
  102. folder to the one previous to  the current.
  103.  
  104. You may also select  the exact name of the  folder you wish to access
  105. by selecting  the left  mouse button on the "folder"  item and TYPING
  106. the exact  name of the folder  you wish to access.  The "pathname" to
  107. the folder may start with a tilde (~) indicating your home directory.
  108. Or, it may  contain a plus sign before the  name indicating your Mail
  109. directory (+reports, for example).  Alternatively, you  can type  '%'
  110. to access your system Mailbox, the place where all your mail is first
  111. delivered.  And finally, you can type '#' to indicate  the previously
  112. accessed folder.
  113. %%
  114.  
  115. %save%
  116. You may save messages in  two ways. The most commonly used method is to
  117. save messages to  your mailbox folder  ("mbox") in your home directory.
  118. If you use mail very frequently and save large amounts of mail, you can
  119. save messages to other folders for better organization.
  120.  
  121. Usually, when messages are saved, mushtool  marks them for deletion for
  122. the next update.  If you don't want to have saved messages deleted, you
  123. must undelete them or set the variable "keepsave" in the options screen.
  124.  
  125. There is a text item  in the Main Panel Window which allows you to type
  126. the  name of the file to save a message.  Type the filename and then
  127. select the LEFT mouse button over the "Save" item.  If there is no
  128. filename specified, then messages are saved to your mbox file.
  129.  
  130. You may also choose a folder name by selecting the RIGHT mouse button
  131. over the "Save" item and choosing from the menu of files displayed.
  132.  
  133. You can specify a range, or group of messages to save by typing a range
  134. in the  Header Panel Window.  If there is a  message list in that panel
  135. item, then the range of messages specified there will be saved. If not,
  136. the current message will be saved.
  137.  
  138. For additional information, see the help option for Folders.
  139. %%
  140.  
  141. %quit%
  142. There are various ways in which you may be finished with Mushview.
  143. The most commonly used method  is to simply "close" the tool to an
  144. iconic form. This means that you haven't really quit, but you have
  145. merely put it on "hold" till later.  It will become an icon on the
  146. side or corner of the screen and appear to sit and do nothing.  To
  147. close the tool to icon form, there are two methods which have will
  148. have two different effects.
  149.  
  150. The first method is to select  this panel item with the left mouse
  151. button.  This  will update your current  folder (deleting messages
  152. marked for deletion) and close the tool.  The second method  is to
  153. use the tool manager around the perimeter of the window and select
  154. "close".  This will close the tool without updating your mailfile.
  155.  
  156. Whenever Mushview is  in the "closed"  state, it  periodically
  157. checks your mail and updates your folder with the  new mail. While
  158. Mushview is in iconic form, it will display the number of messages
  159. you have in the current folder.
  160.  
  161. There are two equally similar methods of exiting  Mushview, rather
  162. than just closing to an icon:  you may select the second menu item
  163. in the menu given by this panel item or you may use the tool mana-
  164. ger "quit" item.
  165.  
  166. Using the tool manager's quit will exit the tool without updating
  167. your folder whereas the panel item's menu selection will have the
  168. Mushview prompt you whether to update the current folder or not.
  169. %%
  170.  
  171. %update%
  172. This item will update the current folder you are using.  Changes are
  173. updated to the folder; that is, deleted mail is removed and all other
  174. mail is copied back to the folder unless otherwise specified. See the
  175. help in "folder" for more information on folders.
  176.  
  177. If new mail has arrived, it will incorporate it. Otherwise, new mail
  178. is incorporated every two minutes or so, if some comes in.
  179. %%
  180.  
  181. %headers%
  182. The message headers are displayed in their own separate window.
  183. The "current" message is usually displayed in either BOLD or
  184. REVERSE text. This "highlighted" message is the one which is
  185. displayed at the bottom, larger window. In the message window,
  186. each message is displayed in the following format:
  187. the message number is displayed first; if it is the "current"
  188. message, then there is a '>' sign.
  189. The next character is the 'status' character:
  190.     'N' -- New (and unread)
  191.     'U' -- not new, but still Unread
  192.     '*' -- delete messages (set show_deleted)
  193.     'P' -- preserve in spoolfile.
  194.     'O' -- Old message which has also been Read.
  195. If there is just a space (no character), the message is new, but
  196. you've already read it. You should explicitly save or delete these.
  197.  
  198. Following that is the Author of the message and/or all or part of
  199. his network address and login name.  Following that is the number
  200. of lines the message is. In quotes is all or part of the "Subject"
  201. (if one was specified).
  202.  
  203. To read a message, select either the READ item in the main panel
  204. subwindow or move the mouse over the message header you want to read
  205. and press the LEFT mouse button. Or, the MIDDLE mouse button will
  206. delete that message. Choosing the RIGHT mouse button will give you
  207. a menu of things to do then. Included in the menu, is a help item
  208. which describes the selections in the menu.
  209. %%
  210.  
  211. %Menu Read%
  212. When pointing at a message header in the header subwindow, hold down
  213. the RIGHT mouse button and select "Read" from the menu.  A new window
  214. will open containing the text of the message.  In this way, you can
  215. display more than one message at a time.
  216.  
  217. This operation sometimes fails on SunOS 3.5 systems due to limitations
  218. on the number of windows Mush can open at once.  When all the available
  219. windows are in use, the selected message is displayed in the message
  220. subwindow at the bottom of the main window.
  221. %%
  222.  
  223. %preserve%
  224. Usually, after you read mail and you "update" or quit  Mushview, unread
  225. messages are copied back into your system mailbox, deleted messages are
  226. removed, and messages which have been read but not deleted are saved in
  227. your "mbox" file.  Specifying "hold" prevents this from ever happening,
  228. but you can mark specific messages to be held in your system mailbox by
  229. preserving them.
  230. %%
  231.  
  232. %compose%
  233. When you start to compose a letter for mailing, you will be prompted
  234. for a recipient (To:) and other optional mail headers.  The cursor for
  235. the text subwindow will look like a bent arrow to indicate that when
  236. you hit RETURN, the cursor will automatically forward to the next
  237. header (the Subject: line, for example).
  238.  
  239. When the cursor resumes its original shape, the RETURN key enters new
  240. lines as normal.
  241.  
  242. There must be a recipient specified in order to send a message.  The
  243. recipient may be a user or a file or program name.
  244. %%
  245.  
  246. %next%
  247. You can page through all your messages by selecting  "Next" after reading
  248. each message. The same effect is gotten when you select the "Delete" item
  249. when the option,  "autoprint" is set to be true  (see "opts") except that
  250. the current message is deleted before the next one is displayed. Deleting
  251. mail which is  not important  helps the  efficiency of Mushview and reduces
  252. unnecessary use of system resources.
  253.  
  254. In the Header Window, you will notice the cursor looks like the mouse you
  255. use.  The blinking buttons on the mouse image remind you that you can use
  256. any of the  three buttons  at any  time.  When you  move the mouse over a
  257. message and choose a button, the message under the  mouse is going to be
  258. the one affected.  Choosing left button will read the message, the middle
  259. button will delete it, and the right button will give you a menu.
  260. %%
  261.  
  262. %aliases%
  263. Aliases are used as a method of mailing to users with long addresses using
  264. short names. For example, if you wanted to mail to
  265.     argv@sun.com
  266. but didn't want to type that all the time, then you could make an alias by
  267. selecting the alias menu item that specifies "adding alias" and then TYPE:
  268.     Dan argv@sun.com
  269. If you want to mail to a list of people and do so frequently enough to want
  270. an alias name for the whole list, then  you would type something like this:
  271.     project-group fred mary bob@foo-bar herb sly@baz.bitnet
  272.  
  273. To mail to an "alias" you would compose a letter and address the letter:
  274.  
  275. To: Dan
  276. Subject: Alias example
  277. Cc: project-group
  278. (rest of letter)
  279. %%
  280.  
  281. %alts%
  282. "Alternates" are alternate names for YOU.  In messages you receive,
  283. your account will appear on the "To" or "Cc" list.  When you REPLY to
  284. those messages, Mushview will construct a message header for your
  285. letter which will contain the To and Cc lists of recipients from the
  286. original message. You would probably want your name taken off the list
  287. so you do not mail yourself a copy of your own message. If you have
  288. other account names or accounts on other machines, you can let Mushview
  289. know what those mail addresses are so they can be removed from the
  290. lists as well.
  291.  
  292. Note, that if YOU add your name MANUALLY (type it yourself) to either
  293. of the lists, it will not be removed.
  294.  
  295. You can set such a list in your .mailrc file in your home directory by
  296. adding the line:
  297.  
  298. alts hostname1 hostname2 ...
  299.  
  300. If you prefer to not have your name removed from lists when responding
  301. to mail, set the option "metoo"; this prevents the need for alternates
  302. and your name will never be removed.
  303. %%
  304.  
  305. %options%
  306. To set or unset options and their values, move the mouse over the
  307. option of your choice and select the LEFT button to toggle true/false
  308. values. If an option requires a string value, you must type the value,
  309. so select the LEFT button to reference the option, and then type away.
  310.  
  311. NOTE: You must use a Carriage Return to enter the final value for the
  312. option or the value will not change.
  313. %%
  314.  
  315. %ignore%
  316. When reading mail, the message "headers" may clutter up the
  317. window with information you are not interested in.  For
  318. example, you may not be interested in the "Received" or
  319. "Message-Id" field of the mail message. You would find that
  320. in time, it will become annoying to see these uninteresting
  321. message headers.
  322.  
  323. You can specify which message headers should not be shown,
  324. thus shortening the appearance of the length of the message.
  325.  
  326. Typical settings:
  327.     Received
  328.     Message-Id
  329.     Status
  330. %%
  331.  
  332. %printer%
  333. This item will send the current message, or the message specified on
  334. the range item, to the printer.  The printer used is given by the
  335. variable $printer.  To specify a different printer, change the printer
  336. option by selecting the item "Options" in the Main Panel Window, moving
  337. the mouse over the "printer" option, selecting the LEFT mouse button
  338. and typing the name of the printer which you'd like to use.
  339.  
  340. Be sure to set this option before printing because the DEFAULT option
  341. may not be what you want.
  342.  
  343. You can print messages that are NOT the current message by moving the
  344. mouse into the Header Window and selecting the RIGHT mouse button on
  345. top of the message you want to print and selecting the PRINT menu
  346. option.
  347. %%
  348.  
  349. %windows%
  350. "Windows" are the boxes which contain items, text, or graphic
  351. images.  There are two "panel" windows. A panel window is one
  352. which contains items,  which are the little boxes  with words
  353. that you can place the mouse over and click the left or mouse
  354. button.
  355.  
  356. Each  window has a separate  function for different purposes.
  357. Starting at the top of the main "tool" (contains all windows)
  358. we have the "header panel." Everything in this panel pertains
  359. to the message headers, only.  The panel in the middle of the
  360. tool is the "mail panel" which is more general and applies to
  361. just about everything. For a description of each of the items
  362. within any panel, select the  "Help"  option  from  the  menu
  363. you get by selecting the RIGHT mouse button.
  364. %%
  365.  
  366. %message range%
  367. You can specify a large group of messages using a combination of special
  368. symbols in addition to numbers.  For example, if you wish to save all of
  369. the messages, then you can use `*' to represent them all. If you were to
  370. type the  "star" and select the Save  menu option for "save range", then
  371. you would save ALL the messages you have (including deleted ones).
  372.  
  373. If you would like to save messages 4 through 9, then you would specify:
  374.       4-9
  375. If you want to specify the messages between 2 and 32 except for messages
  376. 6, 8 and message 12-14, you would type:
  377.       2-32 {6,8,12-14}
  378. Commas or spaces can be used to separate numbers.
  379.  
  380. Note that you cannot specify negated messages without first specifying
  381. normal messages; e.g. {2-5} 1-11   doesn't make sense.
  382. %%
  383.  
  384. %sort%
  385. Sorting messages can   be accomplished by  selecting one  of the
  386. menu items in this panel item.  By default (using the LEFT mouse
  387. button),  sorting is  done by  message status.  New messages are
  388. first, followed  by unread messages,  old/read messages, replied
  389. to  messages,  and  finally deleted messages.  You may also sort
  390. messages by author, date, or subject by selecting the menu item.
  391. %%
  392.  
  393. %include%
  394. To include a message in your letter, first enter the number of the
  395. message you wish to include in the  Range:  item of the main  mush
  396. frame.  Then select  Include  from the composition window panel by
  397. pressing the LEFT mouse button.    If you do not specify a message
  398. in the  Range:  item, the current message will be included.
  399.  
  400. To forward a message, choose the message to be forwarded as above,
  401. use the RIGHT mouse button on the  Include item and select Forward
  402. Message from the menu.
  403. %%
  404.  
  405. %mark%
  406. Marks can be used to tag messages for later reference.  They are
  407. temporary and will not be saved when the folder is updated.  A
  408. priority setting beteween A and E may also be set on message(s).
  409. Priorities are saved across updated folders.  Sorting by marks
  410. and priorities is also available (marks having highest priority,
  411. followed by A, B, etc.).
  412.  
  413. Marks are set on the current message only while priorities are set
  414. (or unset) on the message list specified in the Range: text field.
  415.  
  416. Messages may have both a temporary mark and a priority, but may not
  417. have more than one priority.  The presence of a mark or a priority
  418. setting is shown by a `+' character immediately following the message
  419. number in the "headers" command display.
  420. %%
  421.  
  422. %close%
  423. There  are various  ways in which  you  may be  finished with  the
  424. compose window. The most commonly used method is to simply "close"
  425. the window to an iconic form.  This means that you  haven't really
  426. quit,  but you  have merely put  it on "hold" till later.  It will
  427. become an icon on the  side or corner of the  screen and appear to
  428. sit  and do  nothing.  To close the window to icon form, there are
  429. two methods. Both methods will have the same effect.
  430.  
  431. The first method is to select  this panel item with the left mouse
  432. button. The second method is to use the tool manager around the
  433. perimeter of the window and select "close".
  434.  
  435. There are two equally similar methods of removing the compose win-
  436. dow rather than just closing to an icon: you may select the second
  437. menu item in  the menu given by this panel item or you may use the
  438. tool manager "quit" item.
  439. %%
  440.