home *** CD-ROM | disk | FTP | other *** search
/ Black Box 4 / BlackBox.cdr / editors / hypsh40a.arj / READ.ME < prev   
Text File  |  1991-05-02  |  22KB  |  452 lines

  1.       HyperShell Release 4.0 - April 1991
  2.       --------------------------------------
  3.  
  4.       HyperShell  is a general purpose hypertext control system. Standard
  5.       hypertext features provided include a text frame based presentation
  6.       style with highlighted references permitting  navigation  to  other
  7.       frames  in  the same or another file, to popup notes which can have
  8.       further  references,  and  allowing  backtracking  through  visited
  9.       frames, and marking of frames and references for later perusal. The
  10.       program also supports graphic screen displays with nested selection
  11.       zones,  using  the  common BLOAD format screen files for monochrome
  12.       images and Microsoft Paintbrush (.PCX) files for  colour  and  some
  13.       monochrome  images.  CGA,EGA,VGA and Hercules graphics adaptors are
  14.       supported.
  15.  
  16.       Special features offered include popup  menus,  paged  displays  of
  17.       menus  or text files, DOS management facilities, scripting language
  18.       with programming  capability,  variables,  macros,  formfill  input
  19.       fields  and numerous features such as program invocation permitting
  20.       the use of HyperShell for menuing systems, help  systems,  computer
  21.       aided  instruction,  simple  databases,  DOS directory managers and
  22.       numerous other applications. Alternative hypertext  structures  are
  23.       also  supported,  permitting adhoc creation of supporting text. The
  24.       hypertext files and supporting files can be compressed and  can  be
  25.       directly accessed in compressed form.
  26.  
  27.       HyperShell  has  been  designed  to  be  fast, small, and powerful,
  28.       supporting files larger than available memory  whilst  occupying  a
  29.       fixed  amount  of  memory itself (128k currently) so that it can be
  30.       used for controlling other applications. It is designed to  run  on
  31.       the  widest  range of equipment, and the components do not need any
  32.       more than a minimal 256k twin floppy mono system (or just a  single
  33.       floppy  system  for the reader component to be used), although they
  34.       will benefit from the use of colour, a mouse, and a hard disk.  The
  35.       system   is   very  configurable,  including  colour  schemes,  key
  36.       mappings, all text strings, control menu and presentation 'look and
  37.       feel'. The supporting files are of textual content, permitting easy
  38.       production and maintenance.
  39.  
  40.       The   system   provided  as  shareware  is  the  full  4.0  release
  41.       incorporating   the   runtime   control   program,    introduction,
  42.       demonstration,   and   reference   hyperdocuments,   and  the  full
  43.       development system, including a set of cooperating authoring  tools
  44.       and  full  documentation  on disk.  The tools include an integrated
  45.       development environment for producing and  maintaining  hyperfiles,
  46.       as  well  as  for  use  as a freetext database system, an extensive
  47.       syntax and  consistency  checking  program,  a  hyperfile  printout
  48.       utility, compression and expansion utilities and TSR screen capture
  49.       and  graphic  preparation  facilities.  Also  provided  is  a popup
  50.       context sensitive hypertext  system  which  utilises  a  subset  of
  51.       HyperShell syntax, and is ideal for help systems and similar uses.
  52.  
  53.       Documentation includes a full authoring guide and a quick reference
  54.       guide.  Also there is a hypertext reference guide and a popup quick
  55.       reference guide.
  56.  
  57.       RUNNING HYPERSHELL
  58.       ==================
  59.       ************************ IMPORTANT ****************************
  60.       * MAKE A COPY OF THE DISTRIBUTION DISKS & WORK USING THE COPY *
  61.       ***************************************************************
  62.  
  63.       The disks contain a number  of  archives,  each  of  which  can  be
  64.       extracted to a floppy disk, or to the hard disk.
  65.  
  66.       HYPMAIN.LZH          Main programs and demonstrations
  67.       HYPDEVEL.LZH         Development tools etc.
  68.       HYPOP.LZH            HyperShell popup subset
  69.       HYPDOC.LZH           Documentation files (shareware version only)
  70.  
  71.       The dearchiving program is on disk2 (and disk3), and is called
  72.       LHARC.EXE (NB. This is the original LHARC, and not the latest version,
  73.       so if you have the new version called LHA, remember to add the 'old'
  74.       command line switch).
  75.  
  76.       This is not on disk1, so this has to be copied to a place where
  77.       it may be run, such as the disk you are expanding the archive to,
  78.       before you can dearchive the archives on Disk1.
  79.  
  80.       To Floppy disk
  81.       --------------
  82.  
  83.       To  extract  onto  a  floppy disk, place a freshly formatted floppy
  84.       disk in drive B, make drive B the default by typing 'B:'  and  then
  85.       type the following:-
  86.  
  87.       A:lharc x A:filename
  88.  
  89.       where  'filename'  is  the  name  of  the  archive  without the LZH
  90.       extension.
  91.  
  92.       For disk 1 to floppy
  93.       --------------------
  94.       Place disk 2 in drive A: and a fresh disk in drive B:, type
  95.  
  96.     COPY A:LHARC.EXE B:
  97.  
  98.       Place disk 1 in drive A:, make B: the default drive, and type
  99.  
  100.         LHARC x A:HYPMAIN
  101.  
  102.       Hard disk
  103.       ---------
  104.  
  105.       Create a directory to contain all the files:-
  106.  
  107.       C: MKDIR HYPSHELL
  108.  
  109.       Change to the directory
  110.  
  111.       C: CD HYPSHELL
  112.  
  113.       Now type the following:-
  114.  
  115.       A:lharc x A:filename
  116.  
  117.       Where filename is one of the archive names with a  .LZH  extension.
  118.       You  can  extract  each archive onto a separate floppy, or all into
  119.       the same directory on a hard disk.
  120.  
  121.       FOR DISK 1, COPY LHARC.EXE FROM DISK 2 TO HARD DISK FIRST.
  122.  
  123.       RUNNING THE DEMONSTRATIONS
  124.       ==========================
  125.  
  126.       Before  you run the demonstrations, you must check that the COMSPEC
  127.       environment variable points to a  location  where  the  COMMAND.COM
  128.       program  is  held, and the PATH environment variable must be set up
  129.       to include the drive/directory containing  the  programs,  for  the
  130.       HOME  hyperfile  and the DOS EXIT to work, but are not essential to
  131.       try out HS against a hyperfile directly.
  132.  
  133.       Using the files extracted
  134.       from the HYPMAIN archive, adjust contrast on your monitor  to  show
  135.       colours or intensity levels correctly, and type :-
  136.  
  137.         HS
  138.  
  139.       This will present a menu of options.  To  start  with,  select  the
  140.       Introduction   option   to   display  the  HyperShell  introductory
  141.       hyperfile to get you started on how to use  HyperShell.  Hyperfiles
  142.       with an extension of .HYP can be run using the command
  143.  
  144.         HS filename
  145.  
  146.       Some of the examples require extra space to save changes or edits.
  147.       If you are using a floppy system,
  148.       copy the files to a fresh floppy before use.
  149.  
  150.       If  you  have a Microsoft compatible mouse, the system will use the
  151.       mouse driver directly, otherwise a 'mouse emulation' mode  will  be
  152.       used  whereby  the  cursor  keys are used to position the selection
  153.       cursor, but this will not allow you to use  a  mouse  pointer  with
  154.       graphic displays.
  155.  
  156.       IMPORTANT:  Some software, such as the GEM desktop environment, may
  157.       leave certain mouse drivers in an antisocial state, such  that  any
  158.       program  attempting  to  use  the  mouse  interface  will  hang the
  159.       computer, requiring a hard reset.  If  this  happens  when  running
  160.       HyperShell,  try  rebooting before running the program, and if this
  161.       fails, try using the -m command line flag, or  not  installing  the
  162.       mouse driver.
  163.  
  164.       SHAREWARE DETAILS
  165.       =================
  166.  
  167.       HyperShell is a trademark of Text Technology.
  168.  
  169.       The   HyperShell  system,  including  supporting  utilities,  is  a
  170.       shareware product.  This means the following:-
  171.  
  172.       HyperShell Copyright (c) 1988,1989,1990,1991 Text Technology
  173.                        All Rights Reserved
  174.  
  175.       HyperShell  is  NOT  FREE. It is a commercial product for which you
  176.       must pay if you are to use it, and  is  subject  to  the  copyright
  177.       laws.
  178.  
  179.       You  are  encouraged  to  make  copies  of the HyperShell shareware
  180.       distribution, without any alterations to the files in it, and  give
  181.       these  to  others  for  evaluation.  This  READ.ME file must not be
  182.       altered and must accompany all copies. The system  may  be  offered
  183.       for   download   via  Bulletin  Boards,  and  may  be  offered  for
  184.       distribution by shareware distributors, provided unduly high  rates
  185.       are not charged for such distribution.
  186.  
  187.       You are permitted to make unlimited use of  the  HyperShell  reader
  188.       program  (HS.EXE)  with  any  hyperfiles  supplied  to you, without
  189.       further registration, provided you do  not  alter  the  content  of
  190.       these  files.  A contribution would be welcome to the author if you
  191.       feel you are gaining benefit from the system.
  192.  
  193.       You  are  permitted  to  evaluate the system for producing your own
  194.       hyperfiles for a period not exceeding three (3) calendar months. If
  195.       you produce your own  hyperfiles  for  your  own  use  beyond  that
  196.       period,  you are required to pay for a HyperShell personal licence.
  197.       A  personal  licence  allows  one  person  to  use  HyperShell  for
  198.       producing  hyperfiles for his own use and for distribution with the
  199.       reader program (HS.EXE or HL.EXE) WITHOUT CHARGE  to  others,  with
  200.       the exception that where this is done in a commercial environment a
  201.       developers  licence  is  payable  (see  below).   Also the personal
  202.       licence allows the sale of  your  own  material,  with  the  reader
  203.       program  (HS.EXE  or  HL.EXE), AS SHAREWARE over bulletin boards or
  204.       via shareware distribution channels, PROVIDED it is made  clear  to
  205.       the  purchaser that the material must not be altered, and a copy of
  206.       the material as distributed is  sent  to  Text  Technology  on  the
  207.       understanding  that  unaltered  copies  may  be  sent to interested
  208.       parties or further distributed.
  209.  
  210.       If you produce hyperfiles for use by others, where a charge is made
  211.       for the material or for your services in  the  production  of  that
  212.       material,  you  are  required to pay for a developers licence. This
  213.       applies whether the material forms part of a  package,  or  is  the
  214.       whole  package.   The  developers  licence  entitles  one person to
  215.       produce hyperfiles for any number of 'end' users to read using  the
  216.       HS.EXE  or  HL.EXE  reader program. Note that a licence is required
  217.       for EACH person developing such material.  Site licence  terms  are
  218.       available  on  request.   Corporate  licence rates are available if
  219.       more than one person is to produce hyperfiles.  In  certain  cases,
  220.       subject  to  specific  agreement with Text Technology, applications
  221.       built using the Integrated Environment features may be  distributed
  222.       under   the  developers  licence  at  no  additional  charge.  Text
  223.       Technology reserves the right to apply a runtime  royalty  rate  in
  224.       other cases, which is subject to negotiation on a per case basis.
  225.  
  226.       Under the personal or developers licence terms, you may  provide  a
  227.       copy  of the HyperShell reader component (HS.EXE or HL.EXE) and the
  228.       printer component (HP.EXE) with any material that you distribute to
  229.       others.   You  must  also  provide  an  acknowledgement, visible on
  230.       screen or in printed documentation, indicating that HyperShell  has
  231.       been used and giving the name and address of Text Technology.
  232.  
  233.       If  you feel that your use of the system is only occasional, and is
  234.       not sufficient to merit full  registration,  a  'lite'  licence  is
  235.       available.  This  will  not  entitle  you  to  the latest update or
  236.       documentation, or give you permission to distribute to others,  but
  237.       will entitle you to use the system as distributed through shareware
  238.       for  your  own  purposes. You will also be notified of updates, and
  239.       given the chance to upgrade at a later date for the  difference  in
  240.       cost.
  241.  
  242.       If  HyperShell  is to be used by others within an academic or other
  243.       non profit making establishment, and no charge is to be levied  for
  244.       the  use  of  the  system,  a  reduced rate is applicable, which is
  245.       avilable  on  application.  Also  special  academic  licences   are
  246.       available  for teaching or classwork purposes. If such use is to be
  247.       made in a commercial establishment, the full developers licence  is
  248.       applicable.
  249.  
  250.       The HyPop program is provided as part of the HyperShell system, but
  251.       may  be  separately  licenced  if  you  just require a simple popup
  252.       hypertext system. The development licence for this is  required  if
  253.       you want ot distribute the system with your own software.
  254.  
  255.       If you decide not to register after the evaluation period you  must
  256.       destroy  all  copies  of any hyperfiles which you have used in that
  257.       time. YOU MUST NOT GIVE COPIES OF ANY  HYPERFILES  YOU  PRODUCE  TO
  258.       ANYONE, WITHOUT FIRST OBTAINING A SUITABLE LICENCE.
  259.  
  260.       THIS SOFTWARE IS PROVIDED 'AS IS' AND TEXT TECHNOLOGY DISCLAIMS ALL
  261.       WARRANTIES  RELATING TO THESE SOFTWARE PRODUCTS, WHETHER EXPRESS OR
  262.       IMPLIED, INCLUDING BUT NOT LIMITED TO  ANY  IMPLIED  WARRANTIES  OF
  263.       MERCHANTABILITY  AND FITNESS FOR A PARTICULAR PURPOSE, AND ALL SUCH
  264.       WARRANTIES ARE EXPRESSLY AND SPECIFICALLY DISCLAIMED. NEITHER  TEXT
  265.       TECHNOLOGY  NOR  ITS  AGENTS  SHALL  BE  LIABLE  FOR  ANY INDIRECT,
  266.       CONSEQUENTIAL, OR INCIDENTAL DAMAGES ARISING  OUT  OF  THE  USE  OR
  267.       INABILITY  TO  USE  SUCH  SOFTWARE EVEN IF TEXT TECHNOLOGY HAS BEEN
  268.       ADVISED OF THE POSSIBILITY OF SUCH DAMAGES OR CLAIMS. IN  NO  EVENT
  269.       SHALL  TEXT  TECHNOLOGY'S LIABILITY FOR ANY DAMAGES EVER EXCEED THE
  270.       PRICE PAID FOR THE LICENCE TO USE THE SOFTWARE, REGARDLESS  OF  THE
  271.       FORM  OF  CLAIM. THE PERSON USING THE SOFTWARE BEARS ALL RISK AS TO
  272.       THE QUALITY AND PERFORMANCE OF THE SOFTWARE.
  273.  
  274.       ASA-UK
  275.       ------
  276.  
  277.       Text  Technology  is a full member of the Association of  Shareware
  278.       Authors - U.K.
  279.  
  280.       The ASA-UK has been set up  with  similar  goals  in  mind  to  the
  281.       Association  of Shareware Professionals (ASP), but with an emphasis
  282.       on raising the standard of shareware produced by U.K. authors. With
  283.       this in mind, a number of exacting qualifications must  be  met  by
  284.       the  software  and  documentation  before an author is accepted for
  285.       membership.  Some  of  the  most  respected  names in shareware are
  286.       members of ASA-UK, and if you are a  shareware  author  you  should
  287.       consider applying for membership at the address below.
  288.  
  289.       If you are unable to resolve a shareware related problem with  Text
  290.       Technology,  you  may  refer  the  problem  to the Ombudsman at the
  291.       following address:-
  292.  
  293.       Association  of  Shareware  Authors  -  U.K. P.O.Box 26, Bracknell,
  294.       Berkshire, RG12 4WA, ENGLAND.
  295.  
  296.       REGISTRATION
  297.       ============
  298.  
  299.       The  following scale of charges are applicable to version 4.0 only,
  300.       and  supersedes  all  previous  scales  with  immediate effect. The
  301.       quoted prices are subject to change without further notice.
  302.  
  303.       HyPop/HCX only - single user licence - 10 pounds
  304.  
  305.       HyPop/HCX only - Developers licence - 30 pounds
  306.  
  307.       HyperShell Lite licence - 20 pounds
  308.  
  309.       HyperShell Personal licence - 50 pounds
  310.  
  311.       HyperShell Developers licence - 100  pounds  (no  runtime  per-copy
  312.       royalties)
  313.  
  314.       HSRES program, registered through Text Technology - 10 pounds
  315.  
  316.       Also  available  are  some  supplementary  disks.  These are Public
  317.       Domain or Shareware programs which can be used with HyperShell,  or
  318.       by  themselves.  These  can  be obtained from Text Technology for 3
  319.       pounds each (plus postage of 1 pound for 1 or more disks if outside
  320.       U.K.  and not sent with HyperShell)
  321.  
  322.       Disk 1 - General utilities, mainly  text  file  processing  (Mostly
  323.       public domain or freeware).
  324.  
  325.       Disk  2 - MicroEmacs multi-window text editor plus MicroSpell spell
  326.       checker, which integrates with MicroEmacs (Freeware).
  327.  
  328.       Disk 3 - Folding (outlining) text editor, supports 43/50 line mode,
  329.       and can be configured to produce hyperfiles (Freeware). Plus a
  330.       further text processing program.
  331.  
  332.       Disk 4 - Graphics Preparation (Shareware).
  333.  
  334.       (Send for full details of these)
  335.  
  336.       Upgrades  of  HyperShell  licences  are  chargeable  at  difference
  337.       between price paid and current price of required licence.
  338.  
  339.       Special educational rates available on application.
  340.  
  341.       Personal  and  Developers registration for the full system includes
  342.       the latest copy of version 4 together  with  printed  documentation
  343.       and  low cost updates to this version.  It also includes postal and
  344.       off-peak telephone support for problems of use and for bug reports,
  345.       until the next major version release.
  346.  
  347.       If you wish to receive the shareware version  for  distribution  to
  348.       friends, please indicate this when you register.
  349.  
  350.       Registration  is  a  one  off  charge,  and  entitles  you  to  use
  351.       HyperShell under the terms of your licence for as long as you like.
  352.  
  353.       Additional  support,  for  instance in the design and production of
  354.       hyperfiles, is chargeable on a time and materials basis at mutually
  355.       agreed rates.
  356.  
  357.       Custom modifications will  be  charged  on  a  sliding  scale  from
  358.       nothing  for  a  generally  useful  feature  up  to  full  time and
  359.       expenses for a special purpose modification.
  360.  
  361.       The above figures apply to registration in  the  British  Isles  in
  362.       pounds   sterling.    Sorry   we  can't  handle  credit  cards,  so
  363.       cheques/postal orders only please (or hard cash if you prefer).
  364.  
  365.       Outside the British Isles there is an additional postage charge  of
  366.       5  pounds.  Payment in a currency other than pounds sterling should
  367.       also have the equivalent  of  6  pounds  added  to  cover  currency
  368.       conversion costs. Some European customers can send a bank giro or a
  369.       Eurocheque  in  pounds,  in  which case no extra is payable. Please
  370.       note that EXTRA IMPORT DUTY MAY BE PAYABLE BY YOU ON RECEIPT.
  371.  
  372.       However, registration and documentation may be provided by a  local
  373.       distributor at better rates, so check first.
  374.  
  375.       There  are  no guarantees with the supplied product, other than for
  376.       the replacement of defective media. Registration  means  acceptance
  377.       of  the  product  and any money paid will not be refundable, unless
  378.       you have registered without seeing the product, in which  case  you
  379.       may  return  the complete package in a saleable condition within 30
  380.       days for a refund of your licence fee.
  381.  
  382.       Bug  reports and suggestions for improvements are welcomed from all
  383.       users,  including  unregistered  users  evaluating   the   product.
  384.       Important,  previously  unreported, bugs will be rewarded with cash
  385.       or credit against registrations or other services.
  386.  
  387.       All  bug  reports  and  problems  from  registered  users  will  be
  388.       responded to.  All  problems  should  be  posted  to  the  provided
  389.       address  of  Text Technology or the agent you have registered with.
  390.       Full details of problems should be included, along with any related
  391.       hyperfile if this would be of assistance in solving a problem.  Bug
  392.       reports  should  indicate  the  full  circumstances  of  the   bug,
  393.       including   the   machine   type,  monitor  type,  the  version  of
  394.       HyperShell, the memory size,  the  version  of  MSDOS  (or  DRDOS),
  395.       details of resident programs, and any other relevant information.
  396.  
  397.       The following address should be used for registration  and  support
  398.       in  the  United  Kingdom,  Europe, certain parts of Birkenhead, and
  399.       parts of the world not covered by the agents listed below:-
  400.  
  401.       Nick Taylor
  402.          66 Kennedy Avenue
  403.          Macclesfield
  404.          Cheshire
  405.          England
  406.          SK10 3DE
  407.  
  408.       Enquiries: 0625 431357 after 6 P.M. GMT/BST or Weekends.
  409.  
  410.       Cheques should be made payable to N.G.Taylor.
  411.  
  412.       In Denmark, please contact the following agent:-
  413.  
  414.       Werner Knudsen
  415.       Tulipanvej 5
  416.       DK-2600 Glostrup
  417.       Denmark
  418.  
  419.       In Australasia and Malaysia, please contact the following agent for
  420.       details of local registration.
  421.  
  422.       Heinz Dreher
  423.         Hyperware Research Laboratory
  424.         School of Information Systems
  425.         Curtin University of Technology
  426.         GPO Box U1987
  427.         Perth 6001
  428.         Western Australia
  429.  
  430.         Enquiries: (09) 351 2000
  431.         Fax:       (09) 351 2255
  432.  
  433.       When ordering, please state which version you have.  Also it  would
  434.       be  useful  if  you  could  give  an  indication  of  what  type of
  435.       application  you  are  using  HyperShell  for.  Also  please  state
  436.       whether  you  want  the  system  on  5.25" 360k or 3.5" 720k disks.
  437.       (Arrangements for ordering via agents will differ - please refer to
  438.       agent for details).
  439.  
  440.       If  you  evaluate  HyperShell  and  find  it  unsuitable  for  your
  441.       requirements,  please  consider  sending  a  copy of any evaluation
  442.       report you produce.
  443.  
  444.       I hope you  will  enjoy  HyperShell  as  much  as  I  have  enjoyed
  445.       producing  it.   Please  don't  hesitate  to  send  suggestions for
  446.       improvements, bug reports etc.  Good luck.
  447.  
  448.            Nick Taylor
  449.  
  450.                 Text Technology
  451.  
  452.