home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 2: PC / frozenfish_august_1995.bin / bbs / d02xx / d0230.lha / NComm / ReadMail / ReadMail.doc < prev    next >
Text File  |  1989-07-22  |  17KB  |  410 lines
  1.  ______   _____   _____   ____    _    _   _____   _   _
  2. |  __  | |  ___| |  _  | |  _ \  | \  / | |  _  | | | | |á
  3. | |__| | | |__   | |_| | | | | | |  \/  | | |_| | | | | |
  4. |  _  _| |  __|  |  _  | | | | | | |\/| | |  _  | | | | |
  5. | | \ \  | |___  | | | | | |_| | | |  | | | | | | | | | |__
  6. |_|  \_\ |_____| |_| |_| |____/  |_|  |_| |_| |_| |_| |____|
  7.  
  8. ============================================================
  9.  
  10.  
  11.         DESCRIPTION
  12.         -----------
  13. Amiga  ReadMail  is a tool for use with NComm V1.8 or later,
  14. made  by Torkel Lodberg.  ReadMail lets you read, answer and
  15. enter  MBBS messages offline, using input from the keyboard.
  16. Some  file functions are also implemented.  ReadMail creates
  17. a  NComm  script  that uploads all the messages to the board
  18. and  grabs  new  messages.   Information  about new files is
  19. also collected.
  20.  
  21. It  uses  the  grabfile  created  by the MBBS bulletin board
  22. system   as   input.   Before  using  ReadMail,  you  should
  23. therefore  collect  grabfiles from the different systems you
  24. want  to  use it with.  It will accept a blank file as well,
  25. but the name *must* be correct.
  26.  
  27. First,   create  the  directory  where  you  want  to  place
  28. ReadMail, or use the path "NComm:" if the device where it is
  29. lying  has enough space for the different files.  Then, make
  30. subdirectories  for  the  different  boards.  Place the GRAB
  31. files within these directories.
  32.  
  33.  
  34.         FILES CREATED
  35.         -------------
  36. All  files generated will be placed in the same directory as
  37. the grabfile is situated.  Here is a list of files that will
  38. be  generated.   <filename> equals the name of the grabfile,
  39. and 'n' is a number generated by ReadMail, starting at zero.
  40. It  increases by one for each message written.  It is highly
  41. important  that  you  don't  change the name of the grabfile
  42. after  having  performed  a  GRAB since the filename also is
  43. used in the script to unarc the grabfile after grabbing, and
  44. then to start ReadMail.
  45.  
  46. <filename>.script    -  scriptfile
  47. <filename>.exe       -  'execute' file used by script
  48. <filename>n          -  message(s)
  49. <filename>.keep      -  messages added with 'keep' command
  50. <filename>.newfiles  -  new files since last logon
  51.  
  52. * Script assumes that
  53. * 1. You are using ENGLISH commands
  54. * 2. You have set up to use the SCREEN editor
  55. * 3. You have turned on automatic file transfer
  56. * 4. You have PKAX in the C: directory
  57. * 5. You have a smart enough modem to report offhook
  58. * 6. You are using IBN translation
  59.  
  60.  
  61.         STARTING UP
  62.         -----------
  63. ReadMail has the following synopsis:
  64.  
  65. ReadMail [-s] [filename]
  66.  
  67. As  you  can  see, an optional filename may be appended as a
  68. parameter,  as  well  as  the  option  '-s'  if  you want to
  69. reconfigure the ReadMail setup.  The filename is relative to
  70. the current directory.  The brackets should of course not be
  71. included.   They  just  mean  that  this  is optional.  From
  72. workbench, just click on the icon.
  73.  
  74. ReadMail  first  looks for some important information in the
  75. file   NComm:NComm.config.   If  this  file  doesn't  exist,
  76. ReadMail  won't  work,  so  be  sure  to  save  the  correct
  77. configuration  in  NComm  before using ReadMail.  The colors
  78. configured in NComm's 2 colour mode will be used.
  79.  
  80. If  no  filename  is  entered,  a  File Input Requester will
  81. appear in the center of the screen.  For instructions on how
  82. to  use  this, see the "File Input Requester" below.  Select
  83. the  FULL  directory  and  name of the grabfile, so that the
  84. script later can find it.
  85.  
  86. If the file "ReadMail.config" and "NComm:ReadMail.config" (a
  87. special setup file used by ReadMail only) don't exist, or if
  88. the  parameter  '-s'  is  appended,  a  window that contains
  89. different gadgets will appear.
  90.  
  91. In  the string gadget marked 'User', enter the name you have
  92. registered with on the current board.  It is used to log you
  93. in.
  94.  
  95. In  the string gadget marked 'Editor', enter the name of the
  96. editor  you  want  to  use  with ReadMail.  It must accept a
  97. filename as parameter.  Please note that programs that start
  98. their  own  process can not be used due to problems with the
  99. Amiga  operating  system.   However, there is one exception.
  100. The "ED" command that follows with CygnusED Professional may
  101. be  used as long there is a copy of CygnusED already running
  102. when  called  from ReadMail.  This is also a handy solution,
  103. since  the  editor is only loaded once.  Go and buy CygnusED
  104. folks!   I.e.  start up CygnusED Professional *before* using
  105. ReadMail  and  place  the  ProCED  'Ed'  command  in the 'C'
  106. directory.  A few hints to persons who don't have ProCED and
  107. don't  have a harddisk:  Make your editors resident or place
  108. them on the ram disk for faster loading.
  109.  
  110. In  the string gadget marked 'Readmaildir', specify the FULL
  111. directory  where  ReadMail  is situated.  It will be used to
  112. start ReadMail after grabbing.
  113.  
  114. If  the  specified editor uses the WorkBench screen, turn on
  115. the  'WB  to  front'  option.   This  will pop the workbench
  116. screen to front when the editor is started, and will pop the
  117. ReadMail screen to front when finished editing.
  118.  
  119. If  you  want  to configure this scriptfile with an entry in
  120. NComm's  phonebook, turn the 'PB execute' option on.  If you
  121. turn  this option on, remember to also include your password
  122. in the phonebook.
  123.  
  124. If  you  don't want ReadMail to hang up when it has finished
  125. its  job  on  the BBS, turn the 'Interactive session' option
  126. on.  ReadMail will then wait for the hangup string before it
  127. unarc's the GRAB file and starts ReadMail.
  128.  
  129. Press  the  'OK'  gadget to go on, however, be careful.  The
  130. current  script  (if  any)  will  be  discarded so press the
  131. 'Cancel'  gadget to regret.  Press the 'Save' gadget to save
  132. the  current  configuration.  The information will be stored
  133. in  a file called 'ReadMail.config' if the file exists, else
  134. it will be stored as 'NComm:ReadMail.config'.
  135.  
  136. If  you  have configured 'PB Execute' off, a window will pop
  137. up.   Here,  enter the phonenumber to the current board, and
  138. the  password  you use at this board.  Press 'Return' in the
  139. password gadget to go on.
  140.  
  141.  
  142.         USING THE COMMANDS
  143.         ------------------
  144. You  may  now read through the messages.  Press the HELP key
  145. for a full list of commands.  The commands are mostly 'Less'
  146. or  'More'  compatible.  Here is a description of how to use
  147. the different commands.
  148.  
  149.  
  150. 'NEXT MSG' prompt:
  151.  
  152. Press  'E'  to  enter  a  new message.  This will bring up a
  153. requester  containing  three  string gadgets.  In the gadget
  154. marked  'Conference',  enter the full name of the conference
  155. you  want  the  message  placed  in.   In  the gadget marked
  156. 'Receiver',  enter  the  name of the person you want to send
  157. the  message  to, or press 'ENTER' for 'ALL'.  In the gadget
  158. marked  'Subject', enter the subject of the current message.
  159. If  the  'Conference' or 'Receiver' field is left blank, the
  160. function  will be aborted.  Else, the editor will be started
  161. and  the  workbench  will  pop  to front if specified in the
  162. configuration  file.   The  textfile 'ReadMail.sign' will be
  163. added to the message if it exists in the ReadMail directory.
  164. Go on with editing the message and then save it.
  165.  
  166. Press  'R'  to  reply the current message.  A requester will
  167. pop  up  and  ask  if you want the current message included.
  168. Press  'Cancel' to abort the function.  If you answer 'Yes',
  169. the  message will first be written to disk.  The editor will
  170. be  started and the workbench will pop to front if specified
  171. in  the  configuration  file.   The textfile 'ReadMail.sign'
  172. will  be  added  to the message if it exists in the ReadMail
  173. directory.  Go on with editing the message and then save it.
  174. The next message will be displayed by ReadMail.
  175.  
  176. Press  'I' to import a message from disk.  This function was
  177. specially  designed for persons who don't have enough RAM to
  178. run  ReadMail and their favourite editor simultaneosly.  The
  179. messages must be written before starting ReadMail and should
  180. could  be called <filename>n, where 'n' is the number of the
  181. message.   They  must be placed in the same directory as the
  182. grabfile.   The function will bring up a requester that asks
  183. if  the  message  should  be a reply to the current message.
  184. Select  'Cancel'  to  abort  the function.  If the answer is
  185. negative,  a  window that contains three string gadgets will
  186. pop  up.   In the gadget marked 'Conference', enter the full
  187. name  of  the conference you want the message placed in.  In
  188. the  gadget  marked 'Receiver', enter the name of the person
  189. you want to send the message to, or press 'ENTER' for 'ALL'.
  190. In  the  gadget  marked  'Subject', enter the subject of the
  191. current  message.   If  answer  to  the  first  requester is
  192. positive,  the  next  message will be displayed by ReadMail.
  193. The textfile 'ReadMail.sign' will be added to the message if
  194. it exists in the ReadMail directory.
  195.  
  196. Press  'P' to make a hardcopy of the message on the printer.
  197. The message 'Printing' will be displayed while in progress.
  198.  
  199. Press  'K'  to  store  the message for later retrieval.  The
  200. message will be added to a file called <filename>.keep.
  201.  
  202. Press  'A'  to  append the message to a specific file.  This
  203. function  works  like  the 'keep' command, but will bring up
  204. the  file  requester.   Select  or  enter  a  filename.  The
  205. message  will  be  added  to  the file.  If the file doesn't
  206. exist, it will be created.
  207.  
  208. Press  'T'  or  '<'  to  display  the  first  message in the
  209. grabfile.
  210.  
  211. Press  'BACKSPACE'  or  'Cursor  Left' to move backwards one
  212. message.
  213.  
  214. Press 'B' to move backwards one page.
  215.  
  216. Press  'CTRL-L',  'Cursor  Up' or 'C' to display the current
  217. message from the beginning.
  218.  
  219. Press 'H' to only display the header of the next message.
  220.  
  221. Press 'SPACE', 'ENTER', 'Cursor Right' or 'F' to display the
  222. next message in the grabfile.
  223.  
  224. Press 'S' to display the next message without stopping, i.e.
  225. without displaying the 'More' prompt.
  226.  
  227. Press  '>'  or  'L'  to display the highest message you have
  228. read in the grabfile.
  229.  
  230. Press  from  '1' to '0' on the keyboard to position from 10%
  231. to 100% in the file.  I.e.  '0' will position you at the end
  232. of the file.
  233.  
  234. Press 'M' to move to the next conference.
  235.  
  236. Press 'D' to download a file from the system.  This will pop
  237. up  a  window  that  contains a string gadget marked 'Name'.
  238. Enter  the  name of the file you want to download.  The file
  239. will be placed in the G&R download directory.  If the gadget
  240. is left empty, the function will be aborted.
  241.  
  242. Press  'U' to upload a file to the system.  This will pop up
  243. a  window  that  contains two string gadgets.  In the gadget
  244. marked  'Name',  enter  the  name  of  the  file you want to
  245. upload.   The  file  must  rely in the G&R upload directory.
  246. Enter  a  description  of  the  file  in  the  gadget marked
  247. 'Description'.   If  one  of  the gadgets is left empty, the
  248. function will be aborted.  A requester will pop up that asks
  249. whether  the  file  should  be  private  or not.  A positive
  250. answer  will bring up a new requester that asks who the file
  251. should  be  private for.  Enter the full name of the person.
  252. If the file should be kept private to a conference, remember
  253. to first join the conference before using this function.
  254.  
  255. Press  'J'  to  join  a  new conference.  This will pop up a
  256. window  that  contains a string gadget marked 'Name'.  Enter
  257. the  full  name  of the conference.  Leave the name blank to
  258. abort.
  259.  
  260. Press 'X' to resign from a conference.  A window will pop up
  261. that contains a string gadget marked 'Name'.  Enter the full
  262. name  of  the conference you want to resign from.  Leave the
  263. name blank to abort.
  264.  
  265. Press  '/'  to  search for a string.  The bottom line of the
  266. window will be made active.  Enter the string to search for,
  267. or  leave  the line blank to abort.  The message 'Searching'
  268. will  be  displayed  at  the  same line.  The search is case
  269. insensitive.   If the string is not found, the final message
  270. in the grabfile will be displayed.
  271.  
  272. Press  'N'  to  search for the next occurence of the string.
  273. The search is case insensitive.  If the string is not found,
  274. the final message in the grabfile will be displayed.
  275.  
  276. Press  'G'  to  display  the  file  named <filename>.keep on
  277. screen.   It  contains  the  messaged  added with the 'Keep'
  278. command.
  279.  
  280. Press  'V'  to display the file named <filename>.newfiles on
  281. screen.   This  file  contains  a  list  of new files and is
  282. collected for each logon.
  283.  
  284. Press 'Q' or 'CTRL-C' when finished answering messages.  The
  285. function  will  ask  for a confirm, since the script will be
  286. discarded  the  next  time  you  start ReadMail if you leave
  287. Readmail  by  mistake.  This will create the script and quit
  288. the  program.
  289.  
  290.  
  291.  
  292. 'NEXT MSG' prompt:
  293.  
  294. Press 'ENTER' to display the next line of the message.
  295.  
  296. Press 'SPACE', 'Cursor Down' or 'F' to display the next page
  297. of the message.
  298.  
  299. Press  'S'  to  display  the  rest  of  the  message without
  300. stopping, i.e.  without displaying the 'More' prompt.
  301.  
  302. Press some other key to abort to 'Next Msg' prompt.
  303.  
  304.  
  305. Note;  If  the message 'EDITOR ERROR' appears on screen, the
  306. editor could not be loaded.  This means that the editor name
  307. specified   at   startup   is  uncorrect,  or  the  commands
  308. 'Execute', 'Cd' and 'C:Run' are not available.
  309.  
  310. Also  note; The 'Yes/No/Cancel' requester can be answered by
  311. pressing 'Y', 'N' and 'C' respectively.
  312.  
  313. The  prompts contain a calculated percentage relative to the
  314. current file position.
  315.  
  316.  
  317.         THE FILE INPUT REQUESTER
  318.         ------------------------
  319. Many  functions  call  upon  a  file  name.   The file input
  320. requester then appears on the screen with a sorted directory
  321. listing of the current directory in the window.
  322.  
  323. At the bottom of the requester, eight devices are displayed.
  324. To  change the current device, click in one of these boxes -
  325. the  device  must  be  available  on  your  system  (i.e not
  326. ghosted) for you to chose it.
  327.  
  328. To   enter  a  directory,  position  the  pointer  over  the
  329. directory name and click once or enter the directory name in
  330. the 'Directory' string gadget.
  331.  
  332. The  'PARENT' gadget will move you back one directory - i.e.
  333. this  will  cause  the  parent directory to be displayed, if
  334. such a directory exists.
  335.  
  336. You  may  select  a filename by positioning the pointer over
  337. it.   Open  the file by doubleclicking, or by first clicking
  338. on   the   filename  and  afterwards  on  the  'OK'  gadget.
  339. Alternatively,  type  the  name  of  the desired file in the
  340. requester marked 'File' and press Return.
  341.  
  342. In  the  'Type'  string gadget, enter an optional extension.
  343. This  will  display  only  the  files with that suffix.  For
  344. example, entering ".TXT" will display only the textfiles.
  345.  
  346. The  window only has room for 10 entries.  To scroll through
  347. the directory, use the dragbar.
  348.  
  349. The  number  of  bytes  free  on  the current device will be
  350. displayed in the middle of the two gadgets.  Always check if
  351. there   is   enough  space  on  the  current  device  before
  352. downloading files.
  353.  
  354. The 'Directory' string gadget will be active when the window
  355. opens.  Pressing Return will move the cursor directly to the
  356. 'File' gadget.  This can be handy if you don't want to mouse
  357. around.
  358.  
  359. Use  the  upper  right depth-arrangers to move the window in
  360. front or in back of other windows.
  361.  
  362. Selecting 'CANCEL' will abort the operation.
  363.  
  364. Note:
  365. When the file requester is on screen (active), you can still
  366. send  and receive data.  Sorting and displaying the files on
  367. a  disk  takes  some  time;  you  may  want  to bring up the
  368. requester  early,  and continue talking to the remote system
  369. while this is being done.
  370.  
  371.  
  372.         SPECIAL REQUIREMENTS
  373.         --------------------
  374. None,  but  a harddisk is heavily recommended if you want to
  375. use  this  program  with  more  than one board.  The program
  376. works  with  both  NTSC  and  PAL.
  377.  
  378.         VERSION
  379.         -------
  380. 2.0 / 17-Jun-89.  Comments, suggestions and bug reports are
  381. welcome!
  382.  
  383. Original   idea   taken  from  IBM  ReadMail  made  by  Mike
  384. Robertson.   The  file  requester  is based on the requester
  385. from C.  Heath.  Thanks!  Thanks also go to Daniel Bloch and
  386. Trym  Hansen  for  their help, and to Michael Farion for his
  387. icon.   Doc  icon  from the Swilling collection, courtesy of
  388. Frank Swilling (Minotaur).
  389.  
  390. Contact me on my BBS, international: +47 2 493210
  391.                       national: (02) 493210
  392.  
  393.      ...or by mail to Torkel Lodberg
  394.                       Pilotveien 10
  395.                       N-0384 OSLO 3
  396.                       NORWAY
  397.  
  398. This program is Shareware - you are not allowed to sell this
  399. program,  and  you  may  only  copy  it  for  non-commercial
  400. purposes!
  401.  
  402. This program represents over hundred hours of hard work.  If
  403. you  find this program useful, you really ought to send some
  404. sort  of  a  contribution to my address.  Examples of such a
  405. contribution is 20$ or some disks containing the hottest and
  406. newest  public domain or shareware programs, for my BBS.  If
  407. I receive any contributions, they will probably make me want
  408. to make many more programs!
  409.  
  410.