home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 2 / FFMCD02.bin / new / amigalibdisks / disk946 / amiqwk / amiqwk.doc < prev    next >
Text File  |  1993-12-21  |  53KB  |  1,563 lines
  1.  
  2.  
  3. Introduction
  4. ************
  5.  
  6. About this manual
  7. =================
  8.  
  9.    This manual assumes that you have at least a basic knowledge of the
  10. Amiga operating system. If you are not familiar with the Amiga I,
  11. recommend reading the 'Basic Operations' chapter of your AmigaDOS
  12. manual.
  13.  
  14.    This manual was written in `Texinfo', the GNU documentation format,
  15. and processed through `MakeGuide' to generate ASCII, `AmigaGuide', and
  16. TeX versions.
  17.  
  18. What is QWKMail?
  19. ================
  20.  
  21.    QWKMail is an offline message format. Using QWKMail allows you to
  22. call a BBS, collect all waiting messages, transfer them to your
  23. computer, and read them after you have logged off of the BBS. You can
  24. then read them with a QWK compatible message reader such as `AmiQWK'.
  25. New messages can be edited with your favorite text editor. Some of the
  26. advantages of using QWKMail include:
  27.  
  28.    * Collecting all waiting messages into a QWKMail packet usually
  29.      takes only a fraction of the time it takes to read messages
  30.      online, resulting in lower phone bills.
  31.  
  32.    * Since your replies are edited offline, you can take as much time
  33.      as you need to enter and reply to messages. You also have the
  34.      advantage of using tools that may not be available when using BBS
  35.      editors, such as spelling and grammar checkers.
  36.  
  37.    * You can easily save or print messages for future reference.
  38.  
  39.    The QWK format was created in 1987 by Mark 'Sparky' Herring. It is
  40. based on Clark Development Corp.'s `PC-Board' Version 12.0 BBS message
  41. base format.  The QWKMail format is now supported by most BBS programs
  42. either internally or by an external 'door' program.
  43.  
  44. What is AmiQWK II?
  45. ==================
  46.  
  47.    `AmiQWK II' is a full featured QWKMail offline message reader for the
  48. Commodore Amiga computer. My goals for `AmiQWK' are (in no particular
  49. order)
  50.  
  51.    * To be the most stable and compatible QWKMail reader available for
  52.      the Commodore Amiga computer.
  53.  
  54.    * To be the most full featured QWKMail reader for the Commodore Amiga
  55.      computer.
  56.  
  57.    * To take advantage of features found Release 2 and higher of the
  58.      Amiga operating system.
  59.  
  60.    * To be easy to use.
  61.  
  62.    * To be highly configurable.
  63.  
  64. Legal Stuff
  65. ***********
  66.  
  67. About Shareware
  68. ===============
  69.  
  70.    `AmiQWK II' is released under the concept of Shareware. This means
  71. that you are granted a license to use `AmiQWK II' for a period of 30
  72. days after the initial use. After 30 days you must either register the
  73. program or discontinue its use. See Registration, for more details.
  74.  
  75. Registration
  76. ============
  77.  
  78.    To register `AmiQWK', fill out the registration form (filename
  79. `Registration.form') and send it along with your payment to the address
  80. on the registration form. You will receive a 16 digit registration key
  81. based on your name. Enter this number into the 'Register' window of the
  82. configuration editor and `AmiQWK II' will generate a keyfile
  83. (`AmiQWK.KEY') that will remove the shareware registration notices.
  84.  
  85.    Recommended method of payment is a check or money order drawn from a
  86. US or Canadian bank. Cash is accepted (US Funds only), however you send
  87. cash at your own risk. Postal money orders are accepted but discouraged
  88. as they take too long to process and it may not be possible to send the
  89. registration form with payment.
  90.  
  91.    AmiQWK users in New Zealand and Australia can register through my
  92. New Zealand distributor. See the registration form (filename
  93. `registration.form' for more details.
  94.  
  95.    The registration key will work with all minor revisions of `AmiQWK
  96. II'. When a new major revision becomes available, registered `AmiQWK
  97. II' users will be eligible for reduced cost updates.
  98.  
  99.    Most registrations are processed within 2 working days.
  100.  
  101.    Group registrations and site licenses are available, Contact the
  102. author for details. See Technical Support.
  103.  
  104. Warranty
  105. ========
  106.  
  107.    THIS PRODUCT IS PROVIDED "AS-IS" WITHOUT WARRANTY OF ANY KIND. ALL
  108. RISKS AND DAMAGES, INCIDENTAL OR OTHERWISE, ARISING FROM THE USE,
  109. MISUSE, OR INABILITY TO USE THIS PROGRAM ARE ENTIRELY THE
  110. RESPONSIBILITY OF THE USER.  THE AUTHOR DOES NOT MAKE ANY GUARANTEES OR
  111. REPRESENTATIONS REGARDING THE CORRECTNESS, RELIABILITY, ACCURACY,
  112. CURRENTNESS, ETC. OF THIS PROGRAM. THE AUTHOR WILL NOT ACCEPT
  113. RESPONSIBILITY FOR ANY DAMAGE OR LOSSES RESULTING FORM THE USE, MISUSE,
  114. OR INABILITY TO USE THIS PRODUCT.
  115.  
  116. Copyright
  117. =========
  118.  
  119.    The `AmiQWK II' software and documentation are copyright (C)
  120. 1992,1993 Jim Dawson. All rights reserved.
  121.  
  122.    `AmigaGuide', `AmigaGuide.info', `amigaguide.library' (C) Copyright
  123. 1992 Commodore-Amiga, Inc. All Rights Reserved. Reproduced and
  124. distributed under license from Commodore.
  125.  
  126.    `ReqTools' and `reqtools.library' are Copyright (C) Nico François.
  127.  
  128.    All product names used in this document are trademarks of their
  129. respective owners.
  130.  
  131. Distribution
  132. ============
  133.  
  134.    Regardless of the method of distribution, `AmiQWK II' is NOT and
  135. never has been public domain.
  136.  
  137.    `AmiQWK II' may be distributed freely, providing the following
  138. criteria are met:
  139.  
  140.    * Distribution is limited to the original shareware distribution
  141.      only. None of the files in the `AmiQWK II' distribution archive
  142.      may be modified or omitted.
  143.  
  144.    * No material gain may be realized from the distribution of `AmiQWK
  145.      II', other than a small amount to cover distribution materials.
  146.  
  147.    * `AmiQWK II' may be included in freely distributable software
  148.      libraries, including the Fred Fish collection.
  149.  
  150.    * `AmiQWK II' may not be bundled with any hardware or software
  151.      product without prior written consent from Jim Dawson.
  152.  
  153.    * Registration numbers for `AmiQWK', and the key file that `AmiQWK
  154.      II' generates from them (`AmiQWK.KEY') may not be distributed.
  155.  
  156. System Requirements
  157. *******************
  158.  
  159. Hardware Requirements
  160. =====================
  161.  
  162.    `AmiQWK' requires the following hardware:
  163.  
  164.    * Amiga computer.
  165.  
  166.    * 512KB RAM. (1MB or more recommended.)
  167.  
  168.    * Floppy drive (Second floppy drive or hard drive highly
  169.      recommended.)
  170.  
  171.    * Printer. (if you want to print messages.)
  172.  
  173. Software Requirements
  174. =====================
  175.  
  176.    `AmiQWK' requires the following software:
  177.  
  178.    * Workbench 2.04 (V37) or higher.
  179.  
  180.    * A text editor that can save ASCII text without any formatting
  181.      info. (ED and MEMACS that come with Workbench are fine.)
  182.  
  183.    * Any archivers you plan to use. (`ZIP', `LHA/LHArc', `ZOO', and
  184.      `ARC' are currently supported)
  185.  
  186.    * `reqtools.library'. (included with `AmiQWK II' distribution
  187.      archive.)
  188.  
  189.    * `amigaguide.library'. (included with `AmiQWK II' distribution
  190.      archive, only required for online help.)
  191.  
  192. Installation and Quick Setup
  193. ****************************
  194.  
  195.    To install `AmiQWK', just double-click on the 'Install_AQ2' icon.
  196. This will copy the `reqtools.library' and `amigaguide.library' to your
  197. `libs:' directory. If newer versions of either library are already
  198. present, the library will not be copied.
  199.  
  200.    Once the libraries have been installed, run `AmiQWK' by
  201. double-clicking on it's icon or by typing `AmiQWK' from the `CLI'.
  202.  
  203.    Once `AmiQWK' is running, you will need to configure it to work on
  204. your system. Click on the gadget labeled 'Config `AmiQWK'...' or type
  205. 'C' (1) to bring up the configuration editor window.
  206.  
  207.    The configuration editor window has 9 gadgets, the first 6 of which
  208. when clicked on will bring up a configuration sub-window. The remaining
  209. 3 gadgets are used to save the configuration to disk, use the
  210. configuration without saving, and to cancel changes you have made to
  211. the configuration. The following describes only the most basic
  212. configuration options needed to get `AmiQWK' running, See
  213. Configuration, for a more detailed description of all of the
  214. configuration options.
  215.  
  216. `Operation'
  217.      Change the 'Editor' string gadget to whatever editor you use.
  218.      About the only restrictions on the editor are that it must save
  219.      text in plain ASCII format (with no formatting codes) and that it
  220.      does not detach itself from the CLI process that spawned it. Here
  221.      are some examples:
  222.  
  223.     `CygnusEd'
  224.           `c:ed -sticky' (See CygnusEd Notes.)
  225.  
  226.     `TurboText'
  227.           `c:ttx WAIT'
  228.  
  229.     `Ed (AmigaDos)'
  230.           `c:ed'
  231.  
  232.     `MEmacs (AmigaDos)'
  233.           `sys:tools/memacs'
  234.  
  235.