home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / lambda / soundpot / a / cpmhlp.lbr / HELP.HZP / HELP.HLP
Encoding:
Text File  |  1993-10-26  |  6.5 KB  |  126 lines
  1. Welcome to the HELP Command
  2. How to use the HELP Command
  3. How to write .HLP Files
  4. Help on CP/M in general
  5. :HELP: Welcome to the HELP Command
  6.      Welcome  to the HELP Command!   The HELP Command is designed to assist
  7. you,  the  CP/M  user,  in  the use of CP/M in general  and  specific  CP/M
  8. commands  in  particular.   It  is  designed  as  an  interactive,  on-line
  9. assistance system.
  10.      HELP pulls in files named <FILENAME>.HLP from disk and displays  these
  11. to the user in a paged mode.  These files are of two basic types -- indexed
  12. and non-indexed.
  13.  
  14.      Indexed files are those .HLP files which start with an index.  This is
  15. an  example  of  an indexed file.   When HELP loads  an  indexed  file,  it
  16. displays  this index to the user and allows him to select entries from  it.
  17. The  user may select as many entries as he desires in any order he  desires
  18. by  simply typing the letter of his selection.   Once the user has made his
  19. selection, help will look up the body of text he selected and display it to
  20. him  in a paged mode.   When the user has finished reading  his  selection,
  21. HELP  then returns him to the index menu.   Typing a Control-C  will return
  22. the user to CP/M.
  23.      Non-indexed  files  are  those .HLP files which do not start  with  an
  24. index.   In such cases,  HELP will immediately display the contents of  the
  25. file to the user and,  when the user has finished looking at it,  HELP will
  26. return to CP/M.
  27.      HELP is menu-driven, and all the commands available to the user at any
  28. given time are displayed to him.
  29.  
  30.      HELP can be a very useful tool for on-line reference to the user.  It,
  31. in conjunction with the many HLP files now available, has already proven to
  32. be of significant value.
  33.                                              Richard Conn
  34. :HELP: How to use the HELP Command
  35.      The HELP Command is executed in one of three ways:
  36.           (1) by just typing 'HELP'
  37.           (2) by typing 'HELP FILENAME', where FILENAME
  38.               is the name of a disk file named FILENAME.HLP
  39.           (3) by typing 'HELP FILENAME.EXT', where
  40.               FILENAME.EXT is the name of a file created in
  41.               the format of a help file
  42.  
  43.      If the user types just 'HELP',  he will receive the HELP.HLP help file
  44. (now being displayed to you).  For all other forms of the HELP command, the
  45. user will see the specified help file information.  Generally speaking, the
  46. name  of the help file should be indicative of its  subject,  like  CPM.HLP
  47. should contain help information on CP/M.
  48. :HELP: How to write .HLP files
  49.      Files  used by the HELP program are either simple CP/M-standard  files
  50. of   ASCII   text  or  ASCII  files  generated  by  the  Word   Star   text
  51. editor/formatter.  These files, as mentioned above, are of two basic types:
  52. indexed  and non-indexed,  and each type is related to the other and is  of
  53. the same basic format.
  54.  
  55.  
  56.                           Grouping of Information
  57.  
  58.      Information  displayed to the user is grouped by the index in  indexed
  59. HLP  files  and may also be grouped by lines beginning with Form Feed  (^L)
  60. characters.  Grouping is an effective way to logically organize information
  61. so  that  meaning will be more clear to the user and units  of  information
  62. will not pass between screen displays.
  63.  
  64.  
  65.                           Non-Indexed .HLP Files
  66.  
  67.      Non-indexed .HLP files are simple ASCII files which start with a colon
  68. (:) as the first character of the file and consist of ASCII text (with each
  69. line terminated by a carriage return/line feed character combination).  The
  70. information  in  such  a help file consists of all text after  the  leading
  71. colon  up to either the terminating end-of-file mark (control-Z) or  a  new
  72. line which starts with a colon.
  73.  
  74.  
  75.                             Indexed .HLP Files
  76.  
  77.      Indexed  .HLP  files are simple ASCII files which do not start with  a
  78. colon  (:)  as the first character of the file.   This type  of  .HLP  file
  79. consists  of one or more normal ASCII text lines as the first lines of  the
  80. file  followed by information sections which begin with a line whose  first
  81. character  is  a  colon  and end with either the first  line  of  the  next
  82. information section or the end of the file.
  83. :HELP: General Information on CP/M
  84.      CP/M is a monitor control program for microcomputer system development
  85. which  uses IBM-compatible flexible disks (floppy disks) for mass  storage.
  86. Using  a  microcomputer  mainframe  based on Intel's 8080  or  Zilog's  Z80
  87. microprocessor,   CP/M   provides   a  general  environment   for   program
  88. construction,  storage,  and editing, along with assembly and program debug
  89. facilities.   An important feature of CP/M is that it can be easily altered
  90. to  execute  with any computer configuration which uses an  Intel  8080  or
  91. Zilog  Z80 Microprocessor and has at least 16K bytes of main memory with up
  92. to four IBM-compatable diskette drives.
  93.      The  CP/M monitor provides access to programs through a  comprehensive
  94. file  management  system.    The  file  subsystem  supports  a  named  file
  95. structure,  allowing dynamic allocation of file space as well as sequential
  96. and  random  file access.   Using this file system,  a up  to  64  distinct
  97. programs can be stored in both source and machine-executable form.
  98.      Digital  Research,  the  designer of CP/M,  has provided a set of  six
  99. manuals which describe the use and operation of CP/M in detail.
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.      These manuals are:
  107.           1.  An Introduction to CP/M Features and Facilities
  108.           2.  ED:  A Context Editor for the CP/M Disk System
  109.           3.  ASM:  CP/M Assembler User's Manual
  110.           4.  DDT:  CP/M Dynamic Debugging Tool User's Manual
  111.           5.  CP/M Interface Guide
  112.           6.  CP/M System Alteration Guide
  113.  
  114.      As the reader can see,  CP/M supports a context editor,  an  assembler
  115. (Intel-compatable),  and  a  debugger system.   These are available in  the
  116. basic CP/M package.   There is a large variety of other software  available
  117. which  can  run under CP/M with little or no modification.   Such  software
  118. includes  several  assemblers (both 8080 and  Z80),  a  symbolic  debugger,
  119. several  high-level  languages (including FORTRAN  IV  {compiler},  BASIC-E
  120. {translator},  CBASIC {translator}, many interpretive BASICs, ALGOL, FOCAL,
  121. and  C),  and  several special-purpose applications programs (such as  text
  122. formatting systems and accounting systems).
  123.  
  124.      Refer  to the indicated manuals and/or the CP/M help file for  further
  125. information.
  126.