home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 2 / FFMCD02.bin / new / amigalibdisks / disk945 / reminder / reminder.doc < prev    next >
Text File  |  1993-12-21  |  27KB  |  776 lines
  1.              REMINDER 1.20 DOCUMENTATION
  2.              ---------------------------
  3.  
  4.                by Matti Rintala
  5.                 April 19, 1993
  6.  
  7.                    Abstract
  8.  
  9.     This document describes the usage of Reminder and ReminderCheck
  10. programs.  Both programs and the source code are copyright 1993 Matti
  11. Rintala.  They can be distributed freely however, see section
  12. Distribution below.
  13.  
  14.               Table of Contents:
  15.               ------------------
  16.  
  17.     Copyright and Distribution
  18.     How to avoid reading this manual
  19.     What is Reminder and why?
  20.     System requirements
  21.     How to Contact the author
  22.     Installing Reminder and ReminderCheck
  23.     Reminder
  24.     ReminderCheck
  25.     Source Code
  26.     Final words and Acknowledgements
  27.  
  28.  
  29.  
  30.  
  31.  
  32.               COPYRIGHT AND DISTRIBUTION
  33.  
  34. Reminder and ReminderCheck are (C) 1993 Matti Rintala (This section is
  35. modified from the similar section of ToolManager 2.0 by Stefan Becker.
  36. I hope you don't mind, Stefan!)
  37.  
  38. Permission is granted to make and distribute verbatim copies of this
  39. manual provided the copyright notice and this permission notice are
  40. preserved on all copies.
  41.  
  42. No guarantee of any kind is given that the programs described in this
  43. document are 100 % reliable. You are using this material at your own
  44. risk. The author CAN NOT be made responsible for any damage which is
  45. caused by using these programs.
  46.  
  47. This package is freely distributable, but still copyright by Matti
  48. Rintala. This means that you can copy it freely as long as you don't
  49. ask for a more than nominal copying fee.
  50.  
  51. Permission is granted to include this package in Public-Domain
  52. collections, especially in Fred Fishs Amiga Disk Library (including CD
  53. ROM versions of it). The distribution file may be uploaded to Bulletin
  54. Board Systems or FTP servers. If you want to distribute this program
  55. you MUST use the contents of the original distribution archive
  56. `Reminder-1.20.lha'. The archive may be distributed unpacked or packed
  57. with a different archiver, if necessary.
  58.  
  59. None of the programs nor the source code (nor parts of it) may be
  60. included or used in commercial programs unless by written permission
  61. from the author.
  62.  
  63. NONE of the programs NOR the source code (nor parts of it) may be used
  64. on any machine which is used for the research, development,
  65. construction, testing or production of weapons or other military
  66. applications. This also includes any machine which is used for
  67. training persons for ANY of the above mentioned purposes. The same
  68. goes for unnecessary animal testing.
  69.  
  70. You may modify the source code as you wish, provided that my name
  71. still exists there and you add a comment to the code explaining that
  72. the source is modified. If you think the change you made is useful,
  73. send it to me so that it can be included in the next official version
  74. (I promise to mention your name in the docs). PLEASE DO NOT DISTRIBUTE
  75. MODIFIED VERSIONS OF REMINDER AND REMINDERCHECK YOURSELF, AS THIS ONLY
  76. CREATES CONFLICTING VERSION NUMBERS ETC!
  77.  
  78.  
  79.  
  80.  
  81.            HOW TO AVOID READING THIS MANUAL
  82.  
  83. Read QuickRef.doc. Try programs. Experiment. Guess.
  84.  
  85.  
  86.  
  87.  
  88.               WHAT IS REMINDER AND WHY?
  89.  
  90. For some time I have been searching for a program which would remind
  91. me of important events like birthdays, days when rent has to be paid
  92. etc. There are already several PD or shareware programs like
  93. CyberCron, which do mostly what I want - but they stay in the memory
  94. as background tasks and consume precious RAM.
  95.  
  96. Then I tried MemoMaster which could be made to run once in startup,
  97. but its 1.3-like user interface and certain other features (for
  98. example, the lack of monthly events) made it unsuitable for me.
  99.  
  100. After that I sighed and wrote Reminder. The system consists of two
  101. programs. Reminder is for entering your events to a database file, and
  102. ReminderCheck is put into your WBStartup, where it is run every time
  103. you boot and reminds you about the events and then quits.
  104.  
  105. Both programs use the excellent ReqTools.library ((C) Nico François),
  106. and the user interface of Reminder was created with GadToolsBox ((C)
  107. Jan van den Baard). The binaries in this distribution were compiled
  108. with SAS/C6.2 ((C) SAS Institute Inc.) with optimization on, but the
  109. source files can be compiled with DICE ((C) Matthew Dillon) also.
  110.  
  111.  
  112.  
  113.              SYSTEM REQUIREMENTS
  114.  
  115. Reminder and ReminderCheck require at least AmigaDOS 2.x and
  116. ReqTools.library (A copy of the library is inluded in this
  117. distribution). They were developed and have been tested on Amiga 2000
  118. with GVP G-Force 68030/25MHz, 1 MB Chip and 5 MB Fast running AmigaDOS
  119. 2.04.  They worked also with the G-Force turned off (i.e. normal Amiga
  120. 2000 with 1 MB Chip and no Fast). There is no reason why they
  121. shouldn't run on any Amiga with at least 2.x, however.
  122.  
  123.  
  124.  
  125.               HOW TO CONTACT THE AUTHOR
  126.  
  127. First, if you are using Reminder, please send me e-mail, a postcard,
  128. Amiga 4000 or whatever. I'm interested in knowing that someone else is
  129. using Reminder, too. The feedback may also encourage me to make
  130. improvements etc, so all suggestions are wellcome.
  131.  
  132. The best way to contact me is via e-mail. My mail address is
  133.  
  134. bitti@cs.tut.fi
  135.  
  136. The postcards and the A4000 should go to address
  137.  
  138. Matti Rintala
  139. Pyykkiojankatu 2 C 24
  140. 33710  TAMPERE
  141. FINLAND
  142.  
  143.  
  144.  
  145.         INSTALLING REMINDER AND REMINDERCHECK
  146.  
  147. Reminder and ReminderCheck can be installed from both Workbench or shell.
  148.  
  149.               Installing from Workbench
  150.  
  151. Reminder V1.20 has an Installer (© Commodore-Amiga, Inc) script which
  152. takes care of the whole installation. If you don't have Installer,
  153. Commodore has made it freely available, so it should be found on many
  154. ftp sites. If you can't find it, then you'll have to install Reminder
  155. from shell.
  156.  
  157. Make sure Installer is in the AmigaDOS path (``C:'' is where I have
  158. it), then double click on the ``Install-Reminder'' icon. The script
  159. installs Reminder and ReminderCheck, ReqTools.library (Only if the
  160. version coming with this distribution is newer than yours),
  161. documentation and ARexx examples, asking you for confirmation if you
  162. don't select the Novice user level.
  163.  
  164.  
  165.             Installing from shell
  166.  
  167. Recommended way to install Reminder from shell is to use Installer,
  168. i.e. to cd in the directory where you unpacked this distribution and
  169. then say
  170.  
  171. Installer Install-Reminder
  172.  
  173. If you don't have Installer, however, read further.
  174.  
  175. First, cd into the directory where Reminder is. If you know that the
  176. ReqTools.library coming with this distribution is newer than yours
  177. (You can always check with Version command.} or you don't have
  178. ReqTools.library, copy it to correct place with
  179.  
  180. copy ReqTools.library LIBS:
  181.  
  182. It is recommended that you always get the whole ReqTools distribution,
  183. however. It can be found on Fish-disks and on most ftp sites.
  184.  
  185. Then copy the executables to appropriate places with
  186.  
  187. copy Reminder Reminder.info your_directory
  188. copy ReminderCheck ReminderCheck.info SYS:WBStartup
  189.  
  190. Finally copy the documentation and ARexx example files to appropriate
  191. places.
  192.  
  193.  
  194.  
  195.                    REMINDER
  196.  
  197. With Reminder you enter the events you want to be reminded about to
  198. the database  which ReminderCheck reads on every boot.
  199.  
  200.  
  201.  
  202.                Workbench usage
  203.  
  204. Reminder can be started from Workbench simply by double clicking its
  205. icon. In the icon you can define the database file (Default name is
  206. ``S:Reminder.data''.) used by Reminder with tooltype
  207.  
  208. FILE=filename
  209.  
  210.  
  211.  
  212.                  Shell usage
  213.  
  214. Reminder can be started from shell simply by typing Reminder and
  215. pressing Enter. You can also type ``FILE=filename'' as a command line
  216. argument to specify the database file (Default name is
  217. ``S:Reminder.data'') to be used.
  218.  
  219.  
  220.  
  221.              Entering and Editing Events
  222.  
  223. After starting Reminder a window opens, presenting a list of existing
  224. events and gadgets needed to add and edit events.
  225.  
  226. The events are sorted in chronological order, repeating events in
  227. order they occur next (this is new in V1.10). Clicking on an event in
  228. event list copies information for that event to appropriate gadgets,
  229. in which you can edit them (don't forget to Update the event
  230. after editing).
  231.  
  232. If you have edited the information in the gadgets and try to perform
  233. an action which would make you lose the information (you click on
  234. event in event list, or click New, Quit, no save or Quit and save),
  235. Reminder asks you to confirm that you wish to abandon the current
  236. values of gagdets.
  237.  
  238. Use Add to add the event in gadgets to e