Help -- an online help facility for the Amiga computer.
version 1.0
-----------------------------------------------------------------------------
* Copyright 1987 by 4th Works, Inc. *
* written by Steve Ahlstrom and Dan Moore *
* Support for this program to be found on CompuServe's AmigaForum *
-----------------------------------------------------------------------------
This program is not public domain. It is a freely distributable
program with the following conditions:
1) The program and data files must be distributed in the exact
form and content as they were found on the original source of
distribution (AmigaForum on CompuServe).
2) A seperate file, meant to be incorporated into the manual file,
may be included in the distribution ARC file.
3) Any form of commercial sales of this program is specifically
denied with the exception of those user groups or entities
selling "Public Domain Program Disks". If this program is
included in such a collection, the disk containing this
program may not sell for more than $8.00 (US currency).
-----------------------------------------------------------------------------
So what is HELP?
Help is an online help facility for the Amiga. Included in this
distribution are all of the 1.2 AmigaDOS commands. You can edit,
add to, or otherwise customize the data file. By typing "HELP <text>"
a screen full of information will be displayed.
-----------------------------------------------------------------------------
Syntax:
Help command-name
Inputs:
command_name Name of the command or function for which you are
seeking help. Example: HELP ARC
Since AmigaDOS is case insensitive, Help is also
case insensitive.
-----------------------------------------------------------------------------
As distributed, HELP.ARC contains 3 files:
HELP -- the driver program
HELP.DOC -- this file
MANUAL -- the text file containing the text for HELP
MANUAL includes entries for all AmigaDOS functions as
distributed on the AmigaDOS 1.2 disks.
You can easily add entries to the MANUAL file. Simply follow the existing
entries as a guide. Simply put, a # is the start of an entry, the following
# is both the end of the entry and the start of another one. Style indicates
that no single entry, when displayed, be larger than a fully opened window.
(i.e. no informational lines should scroll off the screen).
Caution: Do not modify any text before the first # in MANUAL. Doing so will
cause the program to cease functioning except for the HELP ? command.
-----------------------------------------------------------------------------
What to put in your MANUAL file?
In my MANUAL file, besides the AmigaDOS commands, I have all of the Amiga
specific C routines (i.e. HELP AddGadget), all of the Amiga specific
structure definitions (ie. HELP "struct BitMap"), compiler information
(ie. HELP cc), and some phone numbers and addresses (ie. HELP "Bo Derek").
Use your imagination and your needs.
-----------------------------------------------------------------------------
Installation
The driver program, HELP, should be put in your c: directory.
The text file, MANUAL, MUST go into your s: directory.
-----------------------------------------------------------------------------
System requirements
Any Amiga computer (A500, A1000, A2000)
512K or more RAM
1 floppy disk drive
Use of a hard disk is HIGHLY recommended. This program will work from
floppy, but is exceedly slow once the MANUAL file is customized and grows.
-----------------------------------------------------------------------------
Future versions
An automatic indexing facility will be added. As it is now, the MANUAL
file is sequentially searched until the entry is found. In the future,
an index file will be generated, the match done against the index, then
the text pulled directly from the MANUAL file and displayed to the screen.
This index will be regenerated whenever the index file has an older date
stamp than the MANUAL file.
HELP * may be supported. This command will give you a formatted listing
of all of the indexed entries currently in your MANUAL file. Not terribly
high on the priority list since all you need to do to find if the entry
exists is to type HELP command_name. If it shows up, it's in your file!
Partial string search. A HELP CO* will match any entry beginning with
"CO" If there seems to be any interest or need in a *CO or a *CO*,
that will also be included.
Anything else I come up with in the meantime that will make the program
more functional.
-----------------------------------------------------------------------------
Information
Steve Ahlstrom
10204 W. Powers Avenue
Littleton, CO 80127
CIS: 76703,2006
