home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 053.lha / help.doc < prev    next >
Text File  |  1986-11-20  |  5KB  |  127 lines
  1.              Help -- an online help facility for the Amiga computer.
  2.                                  version 1.0
  3. -----------------------------------------------------------------------------
  4.  
  5.                    * Copyright 1987 by 4th Works, Inc. *
  6.                 * written by Steve Ahlstrom and Dan Moore *
  7.      * Support for this program to be found on CompuServe's AmigaForum *
  8.     
  9. -----------------------------------------------------------------------------
  10.  
  11.     This program is not public domain.  It is a freely distributable
  12.     program with the following conditions:
  13.  
  14.     1)  The program and data files must be distributed in the exact
  15.         form and content as they were found on the original source of
  16.         distribution (AmigaForum on CompuServe).
  17.  
  18.     2)  A seperate file, meant to be incorporated into the manual file,
  19.         may be included in the distribution ARC file.
  20.         
  21.     3)  Any form of commercial sales of this program is specifically 
  22.         denied with the exception of those user groups or entities
  23.         selling "Public Domain Program Disks".  If this program is
  24.         included in such a collection, the disk containing this 
  25.         program may not sell for more than $8.00 (US currency).
  26.         
  27. -----------------------------------------------------------------------------
  28.  
  29. So what is HELP?
  30.  
  31.     Help is an online help facility for the Amiga.  Included in this
  32.     distribution are all of the 1.2 AmigaDOS commands.  You can edit,
  33.     add to, or otherwise customize the data file.  By typing "HELP <text>" 
  34.     a screen full of information will be displayed.
  35.  
  36. -----------------------------------------------------------------------------
  37.  
  38. Syntax:
  39.     Help command-name
  40.  
  41. Inputs:
  42.     command_name   Name of the command or function for which you are
  43.                    seeking help.  Example:  HELP ARC  
  44.                    Since AmigaDOS is case insensitive, Help is also
  45.                    case insensitive.
  46.  
  47. -----------------------------------------------------------------------------
  48.  
  49. As distributed, HELP.ARC contains 3 files:
  50.  
  51.     HELP     --        the driver program
  52.     HELP.DOC --        this file
  53.     MANUAL   --        the text file containing the text for HELP
  54.     
  55.          MANUAL includes entries for all AmigaDOS functions as 
  56.          distributed on the AmigaDOS 1.2 disks.
  57.  
  58. You can easily add entries to the MANUAL file.  Simply follow the existing
  59. entries as a guide.  Simply put, a # is the start of an entry, the following
  60. # is both the end of the entry and the start of another one.  Style indicates
  61. that no single entry, when displayed, be larger than a fully opened window.
  62. (i.e. no informational lines should scroll off the screen).
  63.  
  64. Caution:  Do not modify any text before the first # in MANUAL.  Doing so will
  65. cause the program to cease functioning except for the HELP ? command.
  66.  
  67. -----------------------------------------------------------------------------
  68.  
  69. What to put in your MANUAL file?  
  70.  
  71. In my MANUAL file, besides the AmigaDOS commands, I have all of the Amiga
  72. specific C routines (i.e.  HELP AddGadget), all of the Amiga specific 
  73. structure definitions (ie. HELP "struct BitMap"), compiler information 
  74. (ie. HELP cc), and some phone numbers and addresses (ie. HELP "Bo Derek"). 
  75. Use your imagination and your needs.
  76.  
  77. -----------------------------------------------------------------------------
  78.  
  79. Installation
  80.  
  81. The driver program, HELP, should be put in your c: directory.
  82.  
  83. The text file, MANUAL, MUST go into your s: directory.
  84.  
  85. -----------------------------------------------------------------------------
  86.  
  87. System requirements
  88.  
  89. Any Amiga computer (A500, A1000, A2000)
  90. 512K or more RAM
  91. 1 floppy disk drive
  92.  
  93. Use of a hard disk is HIGHLY recommended.  This program will work from
  94. floppy, but is exceedly slow once the MANUAL file is customized and grows.
  95.  
  96. -----------------------------------------------------------------------------
  97.  
  98. Future versions
  99.  
  100. An automatic indexing facility will be added.  As it is now, the MANUAL
  101. file is sequentially searched until the entry is found.  In the future,
  102. an index file will be generated, the match done against the index, then
  103. the text pulled directly from the MANUAL file and displayed to the screen.
  104. This index will be regenerated whenever the index file has an older date
  105. stamp than the MANUAL file.
  106.  
  107. HELP * may be supported.  This command will give you a formatted listing
  108. of all of the indexed entries currently in your MANUAL file.  Not terribly
  109. high on the priority list since all you need to do to find if the entry
  110. exists is to type HELP command_name.  If it shows up, it's in your file!
  111.  
  112. Partial string search.  A HELP CO* will match any entry beginning with
  113. "CO"  If there seems to be any interest or need in a *CO or a *CO*, 
  114. that will also be included.
  115.  
  116. Anything else I come up with in the meantime that will make the program
  117. more functional.
  118.  
  119. -----------------------------------------------------------------------------
  120.  
  121. Information
  122.  
  123. Steve Ahlstrom
  124. 10204 W. Powers Avenue
  125. Littleton, CO  80127
  126. CIS: 76703,2006
  127.