home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / jsage / znode3 / uploads / z-4-at11.arc / TOOLS.HLP next >
Encoding:
Text File  |  1992-08-24  |  19.6 KB  |  530 lines

  1. ;                    Bringing Up The Key Z-System Tools 
  2.  
  3.      To take full advantage of this new operating     Press ^C To 
  4. system environment, you'll need some basic tools.      Exit HELP  
  5.  
  6. A.  MYZ80.Z3T     B.  SALIAS.COM   C.  ARUNZ.COM     D.  ZDE.COM 
  7. E.  ALIAS.CMD     F.  NAME.COM     G.  SAVENDR.COM   H.  PATH.COM 
  8. I.  NZBLITZ.COM   J.  IF.COM       K.  ZFILER.COM    K.  ZFILER.CMD 
  9. L.  SDZ.COM       M.  HELP.COM     N.  CRUNCH.COM    N.  UNCRUNCH.COM 
  10. O.  LPUT.COM      O.  LBREXT.COM   O.  ZLT.COM       P.  ZERR.COM 
  11. Q.  Z-4-AT.HLP    Q.  TOOLS.HLP 
  12.  
  13.      What follows is a tutorial on the files listed above and on how they 
  14. illustrate Z-System capabilities. If you know nothing about CP/M or Z- 
  15. System, you should read what follows. If you are familiar with both, you 
  16. might want to skim the rest. Who knows, after reading this, you may never 
  17. want to use Microsoft Windows again! Personally, I'd reformat my hard disk, 
  18. put the DOS hidden files on it, bring up MYZ80, then Z-System and be up and 
  19. running. Why waste valuable hard disk space on 16-bit software ; >
  20.  
  21. :A
  22.  
  23.                 MYZ80.Z3T - A "Terminal Capabilities File" 
  24.  
  25.      In "user area 1" of "drive A" we find the "terminal capabilities 
  26. segment" file MYZ80.Z3T. To activate this file, load it into the Z-System 
  27. environment via
  28.  
  29.      A0:COMMANDS> nzcom 1:myz80.z3t
  30.  
  31. [Note: I am putting a space between the prompt and the command to make this 
  32. more readable. You should *not* use a space in front of your commands when 
  33. you issue them. Doing so has a special meaning under Z-System and in the 
  34. examples discussed here, we do not want this special meaning to be active.  
  35. End of note.]
  36.  
  37.      Now type
  38.  
  39.      A0:COMMANDS> cls
  40.  
  41. Your screen should clear. CLS is one of the "resident commands" you loaded 
  42. when you brought up Z-System. If you had tried CLS *before* loading the 
  43. .Z3T file, it would have had no effect. The .Z3T file supports clear 
  44. screen, clear to end of line, cursor positioning, hi/lo lighting and other 
  45. terminal dependent functions.
  46.  
  47.      Let's bring the key tools we'll be using and discussing into the CP/M 
  48. environment at this point with IMPORT.
  49.  
  50.      A0:COMMANDS> import salias.com
  51.      A0:COMMANDS> import arunz.com
  52.  
  53.      etc.
  54.  
  55.      A0:COMMANDS> import lbrext.com
  56.      A0:COMMANDS> import zlt.com
  57.  
  58. [Note: For the commands above to work, copy these files from your 
  59. distribution disk to the MYZ80 subdirectory on your hard disk first. End of 
  60. note.]
  61.  
  62. The hilighting effect of the .Z3T file can be seen by running SDZ.  
  63. Similary, ZFILER will show hilighting.
  64.  
  65.      A0:COMMANDS> sdz
  66.      A0:COMMANDS> zfiler
  67.  
  68. [Note: IMPORT supports "wildcards" and full DOS path name prefixes. The 
  69. above IMPORTs could be simplified to one command and the need to copy these 
  70. files to the hard disk eliminated via:
  71.  
  72.      A0:COMMANDS> import a:*.com
  73.  
  74. Also, NZCOM will automatically load system segment files found in A0: if 
  75. they have a filename of NZCOM, so if a copy of MYZ80.Z3T were placed in A0 
  76. and named NZCOM.Z3T, when you bring up Z-System, after the segments in 
  77. NZCOM.LBR are loaded, the .Z3T file will load, eliminating the need for the 
  78. load from user area 1 of MYZ80.Z3T shown above. ZFILER could be used to do 
  79. the copy and the rename. End of note.]
  80.  
  81. :B
  82.  
  83.          SALIAS.COM - A Screen-Oriented Standalone "Alias" Editor 
  84.  
  85.      The error message
  86.  
  87.      STARTZCM?
  88.  
  89. mentioned elsewhere can be fixed by creating what's called (a standalone) 
  90. "alias" named STARTZCM.COM. Do this with SALIAS (pronounced "S-ALIAS.")
  91.  
  92.      A0:COMMANDS> salias startzcm
  93.  
  94. Type in the following script:
  95.  
  96.      echo s%>ystem loaded.
  97.  
  98. Exit "edit mode" by pressing ESC and save the result by pressing S. Quit 
  99. SALIAS by typing X.
  100.  
  101.      When you brought up Z-System (by typing NZCOM), several files got 
  102. created. One of them is named NZCPM.COM. This is what you use to leave Z- 
  103. System and return to CP/M. To see the effect of the existence of 
  104. STARTZCM.COM, leave and then reenter Z-System via:
  105.  
  106.      A0:COMMANDS> nzcpm
  107.      A0> nzcom
  108.  
  109. The message "System loaded." followed by the A0:COMMANDS> prompt should 
  110. appear at the end of the load sequence now.
  111.  
  112.      SALIAS may be used to define any "alias" you want. Another simple 
  113. example of an alias will be presented when we discuss IF.COM elsewhere.
  114.  
  115.      NZCOM is "hard-coded" to run the command STARTZCM after it does its 
  116. segment loading. STARTZCM may be anything you want. We chose to define a 
  117. simple standalone alias that emits a brief message.
  118.  
  119.      If you type CLS now, to clear the screen, or SDZ, to display a sorted 
  120. file directory, the screen won't clear and hilighting will no longer occur 
  121. (because the "terminal capabilities segment" no longer contains the "fancy 
  122. stuff" held in MYZ80.Z3T). To further automate things, we could beef up the 
  123. STARTZCM alias by adding a line to it. Reexecute SALIAS on STARTZCM, press 
  124. ctrl-N to insert a line in front of the echo etc. line and enter:
  125.  
  126.      nzcom 1:myz80.z3t
  127.      echo s%>ystem loaded.
  128.  
  129. Now, when you bring up Z-System from CP/M (by typing NZCOM), you should see 
  130. hilighting with SDZ, ZFILER etc. and CLS will work.
  131.  
  132. [Note: Of course, if a copy of MYZ80.Z3T, named NZCOM.Z3T, were in A0:, as 
  133. mentioned elsewhere, this extra line in the STARTZCM standalone alias would 
  134. not be necessary, since NZCOM automatically loads segments with names 
  135. starting with NZCOM. We show it here only to illustrate how SALIAS and 
  136. STARTZCM may be used. End of note.]
  137.  
  138. :C
  139.  
  140.                  ARUNZ.COM - An Extended Command Processor 
  141.  
  142.      The first thing you should do with this file is rename it to 
  143. CMDRUN.COM. CP/M has 6 builtin (resident) commands. They are DIR, ERA, REN, 
  144. SAVE, USER and TYPE. REN's command syntax is:
  145.  
  146.      A0> ren newname.typ=oldname.typ
  147.  
  148. If you try:
  149.  
  150.      A0:COMMANDS> ren cmdrun.com=arunz.com
  151.  
  152. it will fail, because REN is not a resident command under Z-System (to list 
  153. the resident commands available, type H (help) at the A0:COMMANDS prompt). 
  154. The "stock" resident command processor has ERA and TYPE and several others, 
  155. but no REN. There are two ways to get around this problem. One way would be 
  156. to leave Z-System and return to CP/M and use its REN command.
  157.  
  158.      A0:COMMANDS> nzcpm
  159.      A0> ren cmdrun.com=arunz.com
  160.  
  161. and then return to Z-System:
  162.  
  163.      A0> nzcom
  164.  
  165. The other way is to run ZFILER, press the space bar til the file pointer is 
  166. on ARUNZ.COM, then press R (to rename) and type in CMDRUN.COM. Exit ZFILER 
  167. by pressing X.
  168.  
  169.      ARUNZ is what is known as an "extended command processor." A well- 
  170. defined series of steps are taken by the command processor segment of Z- 
  171. System as it tries to figure out how to resolve any command it's given at 
  172. the "A prompt." If the command you enter is not one of the "resident" ones, 
  173. or a "transient" one (a .COM file), your command is fed to an "extended 
  174. command processor" named CMDRUN.COM. In ARUNZ's case, the command is 
  175. resolved by searching for it in a text file named ALIAS.CMD.
  176.  
  177.      Here is a simple illustration of an ARUNZ type "alias." Use the full- 
  178. screen text editor ZDE to create the file ALIAS.CMD.
  179.  
  180.      A0:COMMANDS> zde alias.cmd
  181.  
  182. Enter the following definition for the alias DIR.
  183.  
  184.      DIR sdz $*
  185.  
  186. Save the file (ESC S) and quit the editor (ESC Q).
  187.  
  188. If you had typed
  189.  
  190.      A0:COMMANDS> dir
  191.  
  192. before renaming ARUNZ.COM to CMDRUN.COM and running ZDE and creating the 
  193. ALIAS.CMD file, Z-System would come back with the error
  194.  
  195.      DIR?
  196.  
  197. Why? Because, the "stock" resident command processor doesn't include a DIR 
  198. and there is no "transient" DIR.COM.
  199.  
  200.      But now that we have an extended command processor and a definition 
  201. for an alias DIR, the effect of the command
  202.  
  203.      A0:COMMANDS> dir
  204.  
  205. is the same as the effect of 
  206.  
  207.      A0:COMMANDS> sdz
  208.  
  209. The $* in the definition for the DIR alias means "the command tail", so 
  210.  
  211.      A0:COMMANDS> dir *.com
  212.  
  213. would resolve to
  214.  
  215.      A0:COMMANDS> sdz *.com
  216.  
  217. ARUNZ is a mature command processor, supporting many powerful parameters.  
  218. As this document is only a primer, only one other parameter ($1) will be 
  219. discussed (under IF.COM). Full documentation on ARUNZ is provided when you 
  220. purchase Z-System.
  221.  
  222. :D
  223.  
  224.                       ZDE - A Full-Screen Text Editor 
  225.  
  226.      ZDE (Z-System Display Editor) is the most popular full-screen text 
  227. editor for CP/M. Its use is mentioned briefly elsewhere as the tool to use 
  228. to update the ARUNZ alias definition file ALIAS.CMD. ZDE is very similar to 
  229. WordStar. You may use the "WordStar diamond" to move the cursor around 
  230. (ctrl-S, -D, -E, -X).  Online help is available via ESC H. It is good for 
  231. under 40k files. Full documentation is available.
  232.  
  233. :E
  234.  
  235.                   ALIAS.CMD - ARUNZ Alias Definition File 
  236.  
  237.      We touch on the role this text file plays under ARUNZ.COM. More 
  238. information on ARUNZ and example ALIAS.CMD scripts are provided when you 
  239. buy Z-System.
  240.  
  241. :F
  242.  
  243.                     NAME.COM - A Drive/User Area Namer 
  244.  
  245.      When you bring up Z-System, two "drive/user areas" are automatically 
  246. given suggestive *names*. Drive A user 0 is named COMMANDS and drive B user 
  247. 0 is named WORK. To change directories, you may type the drive letter, then 
  248. the user area number, then a colon (:) and finally the enter (return) key. 
  249. Alternatively, if a name has been given to a drive/user area, you may type 
  250. the name, the colon and the return key.
  251.  
  252.      A0:COMMANDS> work:
  253.      B0:WORK>
  254.  
  255. NAME is a drive/user area namer. You might want to name Simeon's drive A 
  256. user area 1, the one with MYZ80.Z3T in it. Although only one file has to do 
  257. with terminal capabilities, let's name it TCAP.
  258.  
  259.      A0:COMMANDS> name 1:tcap
  260.  
  261. You may now type:
  262.      
  263.      A0:COMMANDS> tcap:
  264.  
  265. and you'll see
  266.  
  267.      A1:TCAP>
  268.  
  269. To make this association permanent, you could use the utility SAVENDR to 
  270. create the file NZCOM.NDR.
  271.  
  272.      A0:COMMANDS> savendr nzcom
  273.  
  274. Files saved by SAVENDR have a default filetype of .NDR. Since we chose the 
  275. filename NZCOM, when we bring up Z-System from CP/M, this segment will 
  276. automatically load, along with NZCOM.Z3T (discussed elsewhere).
  277.   
  278. Named directories are a good idea because you no longer have to remember 
  279. the drive/user they correspond to. Just the meaningful name *you* choose. 
  280. You might for example want to call C0 PROJECTS and C1 DATABASE.
  281.  
  282. :G
  283.  
  284.                SAVENDR.COM - A Named Directory Segment Saver 
  285.  
  286.      This program simply saves the currently defined named directory 
  287. segment names into a file named SAVED.NDR, if no command tail is given, or 
  288. filename.NDR, if a filename is provided in the command tail. It's a good 
  289. idea to use NZCOM as the filename, because NZCOM automatically loads 
  290. segments with NZCOM filenames. I envision A.DSK files created by one person 
  291. and distributed to others. These .DSK files will have a *logical* structure 
  292. which an included .NDR file will help reveal.
  293.  
  294. :H
  295.  
  296.                  PATH.COM - A Command Search Path Utility 
  297.  
  298.      Stock Z-System comes with a command search path of A0 $$ A0. $$ means 
  299. "currently logged drive, currently logged user area." This path is searched 
  300. to find .COM files. Say you are logged into drive B, user 2, and you type
  301.  
  302.      B2> zfiler
  303.  
  304. Since ZFILER.COM is in drive A, user 0, the command will work. If 
  305. ZFILER.COM had for some reason been moved to drive B user 0, the command 
  306. above would fail. You may use the PATH utility to establish the search path 
  307. you want. For example
  308.  
  309.      A0:COMMANDS> path c0 b0 $$ a0
  310.  
  311. If this path were active, and ZFILER.COM were in B0, the ZFILER command 
  312. above would work.
  313.  
  314. :I
  315.  
  316.                    NZBLITZ.COM - A Z-System Image Saver 
  317.  
  318.      This utility will help speed up the transition from CP/M to Z-System.  
  319. Instead of running NZCOM and waiting while all the segments load, you may 
  320. use NZBLITZ to save a complete image of a loaded Z-System into a .COM file. 
  321. For example:
  322.  
  323.      A0:COMMANDS> nzblitz image
  324.  
  325. A file named IMAGE.COM will be created. It will contain the named directory 
  326. names, the terminal capabilites segment, the command search path etc. If 
  327. you leave Z-System and return to MSDOS/DRDOS via QUIT), you may quickly 
  328. regenerate this Z-System environment via:
  329.  
  330.      A0:COMMANDS> quit
  331.      C:\MYZ80> cpm
  332.      A0> image
  333.      A0:COMMANDS>
  334.  
  335. It might be noted that with this approach, STARTZCM will no longer be 
  336. automatically run (this only happens when you go from CP/M to Z-System with 
  337. NZCOM). NZBLITZ does have a nice feature you may want to use, however. If 
  338. you invoke NZBLITZ as follows
  339.  
  340.      A0:COMMANDS> nzblitz image;echo s%>ystem created 08/24/92
  341.  
  342. then, when you go from CP/M to Z-System, via
  343.  
  344.      A0> image
  345.  
  346. the message
  347.      
  348.      System created 08/24/92
  349.  
  350. will be displayed.
  351.  
  352. [Note: For those of you out there that will will accept nothing less than a 
  353. "fully automatic" implementation, try this: MYZ80 is coded to automatically 
  354. run a program named MYZ80GO.COM at startup. So, if the name you choose when 
  355. you create your system image with NZBLITZ is MYZ80GO, then you can go 
  356. directly from DOS to Z-System with one command!
  357.  
  358.      C:\MYZ80> cpm
  359.      A0:COMMANDS>
  360.      
  361. End of note.]
  362.  
  363. :J
  364.  
  365.              IF.COM - A Powerful Conditional Command Processor 
  366.  
  367.      Z-System supports both a "resident command processor" and a "flow 
  368. control command processor." Typical flow control commands are IF, ELSE and 
  369. FI. These commands are frequently used in aliases to support conditional 
  370. command invocation. Here's a simple example. Say you defined the following 
  371. ARUNZ (or standalone) alias and called it MYTYPE:
  372.  
  373.      if exist $1;type $1;else;echo $1 %>doesn't exist;fi
  374.  
  375. Z-System uses semicolons (;'s) to separate commands in a multiple command 
  376. line. Say the file MYZ80.DOC were in A0 and you were logged into A0 and you 
  377. issued the command
  378.  
  379.      A0:COMMANDS> mytype myz80.doc
  380.  
  381. The "stock" flow control processor supports an IF which only supports a few 
  382. testable conditions (ERROR and NULL). EXIST is not an included testable 
  383. condition. The transient IF.COM, if available, will automatically load if 
  384. the resident IF is insufficient. IF.COM supports a host of conditions, 
  385. including EXIST. The command above would result in the typing out of 
  386. MYZ80.DOC. Notice the role of the $1 argument. It gets replaced everywhere 
  387. it occurs by the first argument in the command tail.  
  388.  
  389.      To see the testable conditions IF.COM supports, invoke IF using the 
  390. standard Z-System help tail, //.
  391.  
  392.      A0:COMMANDS> if //
  393.  
  394. :K
  395.  
  396.                          ZFILER.COM And ZFILER.CMD 
  397.  
  398.        A Point And Shoot File Manager And Its Macro Definition File 
  399.  
  400.      ZFILER is a powerful "point and shoot" file manager. With it, you may 
  401. view, rename, delete, copy, etc. files. It has online help which may be 
  402. seen by typing / in response to its prompt. Typing / again will bring you 
  403. back to the file name display.
  404.  
  405.      If you issue the command Z, ZFILER will provide a new prompt at which 
  406. you may issue *any* Z-System command. For example, you might want to run 
  407. the ZDE editor on the file TOOLS.HLP. Just type Z, and at the new prompt, 
  408. type ZDE TOOLS.HLP. After you have finished your edit session and quit the 
  409. editor, you will see the message "Strike Any Key --." Upon hitting a key, 
  410. ZFILER's file name display will appear. ZFILER is a "front end" or "shell", 
  411. a program which isolates a user from direct use of the operating system.
  412.  
  413.      ZFILER has a powerful feature worth mentioning at this point. If a 
  414. file named ZFILER.CMD is available, and it contains the following:
  415.  
  416.      1! zde $p
  417.      2! echo 08/24/92
  418.      #
  419.         1. edit currently pointed at file
  420.         2. show version date
  421.  
  422. then, if the file pointer is on the file TOOLS.HLP and you press the 1 key, 
  423. the ZDE editor will automatically run and you will be editing the file 
  424. TOOLS.HLP! The structure and meaning of ZFILER.CMD files will not be 
  425. discussed further here. Again, this information is well covered with the 
  426. manual you get when you purchase Z-System.
  427.  
  428. :L
  429.  
  430.                    SDZ.COM - A Sorted Directory Utility 
  431.  
  432.      This program has been mentioned elsewhere as one that could be used to 
  433. make the command
  434.  
  435.      A0:COMMANDS> dir
  436.  
  437. do something useful (via an ARUNZ alias). SDZ has many options. Type SDZ // 
  438. to see what they are. 
  439.  
  440.      A0:COMMANDS> sdz *.hlp /da
  441.  
  442. would display the names of all .HLP files on all drives and in all user 
  443. areas.
  444.  
  445. :M
  446.  
  447.                          HELP.COM - A Help Utility 
  448.  
  449.      One of the nicest things about Z-System is the extensive help 
  450. available. Help comes in many forms. We've mentioned using the // as a 
  451. command tail elsewhere. This shows you syntax and usage. This information 
  452. is hardcoded in the executable (.COM) file. Another form of help is found 
  453. in external .HLP files. These files are most effectively browsed with the 
  454. HELP utility, HELP.COM. The files Z-4-AT.HLP and this file, TOOLS.HLP, are 
  455. .HLP files.
  456.  
  457.      A0:COMMANDS> help a:z-4-at
  458.  
  459. would invoke the main help file, Z-4-AT.HLP. The file TOOLS.HLP, this file, 
  460. is a "limb" or "branch" of this main file. .HLP files may be nested in a 
  461. tree-like structure.
  462.  
  463. :N
  464.  
  465.                         CRUNCH.COM And UNCRUNCH.COM 
  466.  
  467.                   A Compression And A Decompression Tool 
  468.  
  469.      To save disk space, these two programs are used to compress and 
  470. uncompress files. When a file is compressed, a much smaller file with the 
  471. same first name and a filetype with a Z replacing the middle letter of the 
  472. file's filetype is created. Other compression and packaging tools are 
  473. available, but the tendency for CP/M material is to use CRUNCH followed by 
  474. library packaging. See below for library tools.
  475.  
  476. :O
  477.  
  478.                     LPUT.COM And LBREXT.COM And ZLT.COM 
  479.  
  480.     A Library Building, A Library Extracting And A Library Typing Tool
  481.  
  482.      LPUT (Library PUT) is used to create and add members to library files 
  483. (.LBR files). NZCOM.LBR is a library file. Other packaging techniques are 
  484. popular (.ZIP, .ARC etc.) but .LBR's are the most common CP/M packaging 
  485. method. LBREXT is used to extract files from libraries. It supports options 
  486. to "inspect" (ie. say yes or no to the extraction) and "decompress", and 
  487. all popular compression methods, including the latest, LZH, are supported.  
  488. Finally, ZLT, Z Library Typer, lets you view (type out) a member of a 
  489. library, compressed or not.
  490.  
  491. :P
  492.  
  493.                           ZERR - An Error Handler 
  494.  
  495.      When all else fails (the Z-System command processor can't find a 
  496. flow control, resident, transient or extended command, or something else is 
  497. wrong), if an "error handler" is installed and available, it will run it. 
  498. ZERR is a popular one. It announces the nature of the error, presents you 
  499. with the command in error and lets you edit the command and reissue it. 
  500. This sure beats what most operating systems do. CP/M, for example, just 
  501. echos the command in error followed by a ?.
  502.  
  503.      ZERR is "installed" by typing:
  504.  
  505.      A0:COMMANDS> zerr
  506.  
  507. :Q
  508.  
  509.                         Z-4-AT.HLP And TOOLS.HLP 
  510.  
  511.            The Main .HLP File And A Limb Off The Main .HLP File 
  512.  
  513.      If you got to TOOLS from Z-4-AT, you must have typed:
  514.  
  515.      A0:COMMANDS> help a:z-4-at
  516.  
  517. To return to the main .HLP file, Z-4-AT, type a period (.) or a caret <^>.
  518.  
  519.      A0:COMMANDS> help a:tools
  520.  
  521. would be the way to browse the TOOLS help file without accessing its 
  522. "parent."
  523.  
  524.      .HLP files come in several flavors. These two are "user-indexed." 
  525. There is a way to create "HELP-indexed" .HLP files as well. .HLP files are 
  526. text files which may be viewed with an editor or simply TYPEd. The best way 
  527. to browse them is with HELP.COM. Notice how you get hilighting by 
  528. bracketing phrases with ctrl-A and ctrl-B.
  529.  
  530.