home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / mbug / mbug001.arc / HELP.HLP < prev    next >
Text File  |  1979-12-31  |  7KB  |  125 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.      Welcomσá t∩ thσ HEL╨ Commandíá  Thσ HEL╨ CommanΣ i≤ designeΣ t∩ assis⌠ ì
  7. you¼á thσá CP/═á user¼á iεá thσ usσ oµ CP/═ iε genera∞á anΣá specifiπá CP/═ ì
  8. command≤á iεá particular«á  I⌠á i≤á designeΣá a≤á aεá interactive¼á on-linσ ì
  9. assistancσ system.
  10.      HEL╨ pull≤ iε file≤ nameΣ <FILENAME>.HL╨ froφ disδ anΣ display≤á thesσ ì
  11. t∩ thσ use≥ iε ß pageΣ mode«  Thesσ file≤ arσ oµ tw∩ basiπ type≤ -- indexeΣ ì
  12. anΣ non-indexed.
  13.  
  14.      IndexeΣ file≤ arσ thosσ .HL╨ file≤ whicΦ star⌠ witΦ aε index«  Thi≤ i≤ ì
  15. aεá examplσá oµá aε indexeΣ file«á  Wheε HEL╨ load≤á aεá indexeΣá file¼á i⌠ ì
  16. display≤á thi≤ inde° t∩ thσ use≥ anΣ allow≤ hiφ t∩ selec⌠ entrie≤ froφá it«  ì
  17. Thσá use≥ ma∙ selec⌠ a≤ man∙ entrie≤ a≤ hσ desire≤ iε an∙ orde≥ hσá desire≤ ì
  18. b∙á simpl∙ typinτ thσ lette≥ oµ hi≤ selection«á  Oncσ thσ use≥ ha≤ madσ hi≤ ì
  19. selection¼ hel≡ wil∞ looδ u≡ thσ bod∙ oµ tex⌠ hσ selecteΣ anΣ displa∙ i⌠ t∩ ì
  20. hiφá iε ß pageΣ mode«á  Wheε thσ use≥ ha≤ finisheΣ readinτá hi≤á selection¼ ì
  21. HEL╨á theε return≤ hiφ t∩ thσ inde° menu«á  Typinτ ß Control-├  wil∞ returε ì
  22. thσ use≥ t∩ CP/M.
  23.      Non-indexeΣá file≤á arσá thosσ .HL╨ file≤ whicΦ d∩ no⌠ star⌠á witΦá aε ì
  24. index«á  Iε sucΦ cases¼á HEL╨ wil∞ immediatel∙ displa∙ thσ content≤ oµá thσ ì
  25. filσ t∩ thσ use≥ and¼á wheε thσ use≥ ha≤ finisheΣ lookinτ a⌠ it¼á HEL╨ wil∞ ì
  26. returε t∩ CP/M.
  27.      HEL╨ i≤ menu-driven¼ anΣ al∞ thσ command≤ availablσ t∩ thσ use≥ a⌠ an∙ ì
  28. giveε timσ arσ displayeΣ t∩ him«  
  29.  
  30.      HEL╨ caε bσ ß ver∙ usefu∞ too∞ fo≥ on-linσ referencσ t∩ thσ user«  It¼ ì
  31. iε conjunctioε witΦ thσ man∙ HL╨ file≤ no≈ available¼ ha≤ alread∙ proveε t∩ ì
  32. be of significant value.
  33.                                              Richard Conn
  34. :HELP: How to use the HELP Command
  35.      Thσ HEL╨ CommanΣ i≤ executeΣ iε onσ oµ threσ 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.      Iµ thσ use≥ type≤ jus⌠ 'HELP'¼á hσ wil∞ receivσ thσ HELP.HL╨ hel≡ filσ ì
  44. (no≈ beinτ displayeΣ t∩ you)«  Fo≥ al∞ othe≥ form≤ oµ thσ HEL╨ command¼ thσ ì
  45. use≥ wil∞ seσ thσ specifieΣ hel≡ filσ information«  Generall∙ speaking¼ thσ ì
  46. namσá oµ thσ hel≡ filσ shoulΣ bσ indicativσ oµ it≤á subject¼á likσá CPM.HL╨ ì
  47. shoulΣ contaiε hel≡ informatioε oε CP/M.
  48. :HELP: How to write .HLP files
  49.      File≤á useΣ b∙ thσ HEL╨ prograφ arσ eithe≥ simplσ CP/M-standarΣá file≤ ì
  50. oµáá ASCI╔áá tex⌠á o≥á ASCI╔á file≤á generateΣá b∙á thσá WorΣáá Sta≥áá tex⌠ ì
  51. editor/formatter«  Thesσ files¼ a≤ mentioneΣ above¼ arσ oµ tw∩ basiπ types║ ì
  52. indexeΣá anΣ non-indexed¼á anΣ eacΦ typσ i≤ relateΣ t∩ thσ othe≥ anΣ i≤á oµ ì
  53. thσ samσ basiπ format«
  54.  
  55.  
  56.                           Grouping of Information
  57.  
  58.      Informatioεá displayeΣ t∩ thσ use≥ i≤ groupeΣ b∙ thσ inde° iεá indexeΣ ì
  59. HL╨á file≤á anΣ ma∙ als∩ bσ groupeΣ b∙ line≤ beginninτ witΦ Forφ FeeΣá (^L⌐ ì
  60. characters«  Groupinτ i≤ aε effectivσ wa∙ t∩ logicall∙ organizσ informatioε ì
  61. s∩á tha⌠á meaninτ wil∞ bσ morσ clea≥ t∩ thσ use≥ anΣ unit≤á oµá informatioε ì
  62. will not pass between screen displays.
  63.  
  64.  
  65.                           Non-Indexed .HLP Files
  66.  
  67.      Non-indexeΣ .HL╨ file≤ arσ simplσ ASCI╔ file≤ whicΦ star⌠ witΦ ß coloε ì
  68. (:⌐ a≤ thσ firs⌠ characte≥ oµ thσ filσ anΣ consis⌠ oµ ASCI╔ tex⌠ (witΦ eacΦ ì
  69. linσ terminateΣ b∙ ß carriagσ return/linσ feeΣ characte≥ combination)«  Thσ ì
  70. informatioεá iεá sucΦá ß hel≡ filσ consist≤ oµ al∞ tex⌠ afte≥á thσá leadinτ ì
  71. coloεá u≡ t∩ eithe≥ thσ terminatinτ end-of-filσ marδ (control-Z⌐ o≥á ßá ne≈ ì
  72. linσ whicΦ start≤ witΦ ß colon.
  73.  
  74.  
  75.                             Indexed .HLP Files
  76.  
  77.      IndexeΣá .HL╨á file≤ arσ simplσ ASCI╔ file≤ whicΦ d∩ no⌠ star⌠ witΦá ß ì
  78. coloεá (:⌐á a≤ thσ firs⌠ characte≥ oµ thσ file«á  Thi≤ typσá oµá .HL╨á filσ ì
  79. consist≤á oµ onσ o≥ morσ norma∞ ASCI╔ tex⌠ line≤ a≤ thσ firs⌠ line≤ oµá thσ ì
  80. filσá followeΣ b∙ informatioε section≤ whicΦ begiε witΦ ß linσ whosσá firs⌠ ì
  81. characte≥á i≤á ßá coloεá anΣ enΣ witΦ eithe≥ thσ firs⌠á linσá oµá thσá nex⌠ ì
  82. informatioε sectioε o≥ thσ enΣ oµ thσ file.
  83. :HELP: General Information on CP/M
  84.      CP/═ i≤ ß monito≥ contro∞ prograφ fo≥ microcompute≥ systeφ developmen⌠ ì
  85. whicΦá use≤ IBM-compatiblσ flexiblσ disk≤ (flopp∙ disks⌐ fo≥ mas≤á storage«  ì
  86. Usinτá ßá microcompute≥á mainframσá baseΣ oε Intel'≤ 808░á o≥á Zilog'≤á Z8░ ì
  87. microprocessor¼áá CP/═áá provide≤áá ßá genera∞á environmen⌠áá fo≥áá prograφ ì
  88. construction¼á storage¼á anΣ editing¼ alonτ witΦ assembl∙ anΣ prograφ debuτ ì
  89. facilities«á  Aε importan⌠ featurσ oµ CP/═ i≤ tha⌠ i⌠ caε bσ easil∙ altereΣ ì
  90. t∩á executσá witΦ an∙ compute≥ configuratioε whicΦ use≤ aεá Inte∞á 808░á o≥ ì
  91. Ziloτá Z8░ Microprocesso≥ anΣ ha≤ a⌠ leas⌠ 16╦ byte≤ oµ maiε memor∙ witΦ u≡ ì
  92. t∩ fou≥ IBM-compatablσ diskettσ drives.
  93.      Thσá CP/═ monito≥ provide≤ acces≤ t∩ program≤ througΦ ßá comprehensivσ ì
  94. filσá managemen⌠á system«áá  Thσá filσá subsysteφá support≤á ßá nameΣá filσ ì
  95. structure¼á allowinτ dynamiπ allocatioε oµ filσ spacσ a≤ wel∞ a≤ sequentia∞ ì
  96. anΣá randoφá filσ access«á  Usinτ thi≤ filσ system¼á ß u≡á t∩á 6┤á distinc⌠ ì
  97. program≤ caε bσ storeΣ iε botΦ sourcσ anΣ machine-executablσ form.
  98.      Digita∞á Research¼á thσá designe≥ oµ CP/M¼á ha≤ provideΣ ß se⌠ oµá si° ì
  99. manual≤ whicΦ describσ thσ usσ anΣ operatioε oµ CP/═ iε detail.
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.      These manuals are:
  107.           1«  Aε Introductioε t∩ CP/═ Feature≤ anΣ 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/═ Dynamiπ Debugginτ Too∞ User'≤ Manual
  111.           5.  CP/M Interface Guide
  112.           6.  CP/M System Alteration Guide
  113.  
  114.      A≤ thσ reade≥ caε see¼á CP/═ support≤ ß contex⌠ editor¼á aεá assemble≥ ì
  115. (Intel-compatable)¼á anΣá ßá debugge≥ system«á  Thesσ arσ availablσ iεá thσ ì
  116. basiπ CP/═ package«á  Therσ i≤ ß largσ variet∙ oµ othe≥ softwarσá availablσ ì
  117. whicΦá caεá ruε unde≥ CP/═ witΦ littlσ o≥ n∩ modification«á  SucΦá softwarσ ì
  118. include≤á severa∞á assembler≤ (botΦ 808░ anΣá Z80)¼á ßá symboliπá debugger¼ ìèsevera∞á high-leve∞á language≤ (includinτ FORTRA╬á I╓á {compiler}¼á BASIC-┼ ì
  119. {translator}¼á CBASI├ {translator}¼ man∙ interpretivσ BASICs¼ ALGOL¼ FOCAL¼ ì
  120. anΣá C)¼á anΣá severa∞ special-purposσ application≤ program≤ (sucΦ a≤á tex⌠ ì
  121. formattinτ system≤ anΣ accountinτ systems).
  122.  
  123.      Refe≥á t∩ thσ indicateΣ manual≤ and/o≥ thσ CP/═ hel≡ filσ fo≥á furthe≥ ì
  124. information.
  125.