home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / cpmhelp / lzed.hlp < prev    next >
Text File  |  1994-07-27  |  18KB  |  514 lines
  1. LZED: THE MANUAL  Copyrights and Credits
  2. INTRODUCTION
  3. INSTALLING LZED
  4. INVOKING LZED
  5. SCREEN FORMAT
  6. COMMAND SET
  7. ERROR MESSAGES
  8. TERMINAL AND ENVIRONMENT DESCRIPTORS
  9. MODIFICATIONS
  10. POKE AND GO
  11. TXTTOWS
  12. :LZED Copyrights and Credits
  13.  
  14. LZED                               LZED: THE MANUAL
  15. Copyright 1986 by Zivio, Inc.      Copyright 1986 by Zivio, Inc.
  16. All Rights Reserved.               All Rights Reserved.
  17.  
  18. LZED is the creation of Paul Pomerleau,  working with Zivio, Inc. 
  19. to  bring Z-System users application programs and utilities truly 
  20. suitable to their operating system environment.  Inquiries should 
  21. be directed to Zivio,  Inc.,  P.O.  Box 803305, Chicago, Illinois 
  22. 60680-3305.   Modem  calls  at 312-649-1730 or  312-664-1730  (24 
  23. hours) or voice calls at 215-443-9031 (daily and evenings till 10 
  24. P.M. E.S.T.).
  25.  
  26. LZED, Zivio: trademarks of Zivio, Inc.
  27. WordStar: trademark of MicroPro International Corporation.
  28. NewWord: trademark of NewStar Software, Inc.
  29. Turbo Pascal: trademark of Borland International Inc.
  30. Z-System, ZCPR3: trademarks of Echelon, Inc. and Richard L. Conn.
  31.  
  32. :INTRODUCTION
  33.  
  34. LZED, the "Little Z EDitor", is a memory-based text editor for Z-
  35. System users. Occupying slightly less than 10k, LZED is a  highly 
  36. efficient text entry and alteration tool, requiring only a  Z80-, 
  37. NSC800-,  or  HD64180-based  computer  with  the  ZCPR3   command 
  38. processor installed. Its main advantages over conventional,  non-
  39. ZCPR3  programs  that  do similar  chores  include  extraordinary 
  40. speed, minimal disk space, full terminal independence without the 
  41. bother   of  elaborate  installation  programs  or  research   in 
  42. computer/terminal   manuals,  and  extreme  flexibility   through 
  43. sophisticated interaction with the Z-System environment.  
  44.  
  45.  
  46.  
  47. The  commands  of  LZED  are a large  subset  of  those  used  in 
  48. WordStar, NewWord, Turbo Pascal's editor, and many other  popular 
  49. text  handling programs - users experienced with such tools  will 
  50. have  little or no need for this manual beyond those points  that 
  51. are LZED- or ZCPR3-specific. Although not a true word  processor, 
  52. LZED is very likely to become your favorite tool for manipulating 
  53. text,  so be prepared.  LZED's only significant limitation  as  a 
  54. text  editor  is  that work file size may  not  exceed  available 
  55. memory  after  LZED itself is loaded. This is  seldom  a  problem 
  56. other than for large Assembly Language source files, where it can 
  57. be  readily overcome with any of several assembly and/or  linkage 
  58. techniques.  You've made a very wise purchase - enjoy!
  59.  
  60. :INSTALLING LZED
  61.  
  62. LZED is installed as a ZCPR3 utility.  There are no configuration 
  63. files or installation menus to fiddle with. Here is what you do:
  64.  
  65. A0:BASE>Z3INS SYS LZED.COM<cr>
  66.  
  67. Z3INS  Version 1.3
  68. ** Installing File LZED    .COM
  69.  
  70. Instead of the usual bulky installation files, you need only  the 
  71. ZCPR3  installation  utility, Z3INS, and your ENV  file,  usually 
  72. called SYS.ENV. That's all there is to it.  If LZED does not work 
  73. properly after installation, the most likely source of trouble is 
  74. a defective or incomplete TCAP (*.Z3T) or environment  descriptor 
  75. (*.ENV) file.  Consult a ZCPR3 reference book or help file.
  76.  
  77. :INVOKING LZED
  78.  
  79. LZED               Starts LZED with no specified work file
  80.  
  81. LZED //               Calls up a short, ZCPR3-style help message
  82.  
  83. LZED A7: or LZED WORDPROC:    
  84.  
  85.                    Logs into specified DU (drive/user) or DIR
  86.                    (named directory or NDR) before execution
  87.  
  88. LZED A7:MYFILE.TXT or LZED WORDPROC:MYFILE.TXT
  89.  
  90.                    Reads or opens specified file in 
  91.                    specified DU or DIR 
  92.  
  93. :LZED SCREEN FORMAT
  94.  
  95. LZED's screen has two sections, an information section  occupying 
  96. the  top  two  lines and a text  editing  section  occupying  the 
  97. remainder of your screen.  For example:
  98.  
  99. vvvvvvvvvvvvvvvvvvvvvv<top-of-screen>vvvvvvvvvvvvvvvvvvvvvvvvvvvv
  100. |DU=A0:  DIR=BASE      LIN=1       COL=1         FREE MEM=40000 |
  101. |XX:MYFILE.DOC                                   INSERT ON      |
  102. |---------------------------------------------------------------|
  103. |This is an LZED test file.  LZED is a very fast and terminal-  |
  104. |independent ASCII text editor for Z80, NSC800 and HD64180 based|
  105. |microcomputers running Z-System or ZCPR3.                      |
  106. |                       (more text)                             |
  107. |                                                               |
  108. |                                                               |
  109. |                                                               | 
  110. ^^^^^^^^^^^^^^^^^^^^^<bottom-of-screen>^^^^^^^^^^^^^^^^^^^^^^^^^^
  111.  
  112.  
  113.  
  114. Status Line Number 1:
  115.  
  116. DU               Shows logged drive and user followed by a colon
  117.  
  118. DIR              ZCPR3 NDR, shown only if NDR's are
  119.                  implemented in the ZCPR3 environment and 
  120.                  the logged DU corresponds to a valid NDR entry
  121.  
  122. LIN              Current line of text
  123.  
  124. COL              Current column of text, which may run beyond 
  125.                  right edge of screen to column 256, beyond which 
  126.                  the counter - and LZED's screen displays in 
  127.                  general - are not to be relied on, although the 
  128.                  accuracy and integrity of the text buffer itself 
  129.                  are not compromised
  130.  
  131. FREE MEM         Space (in bytes) remaining for additional text
  132.  
  133.  
  134.  
  135. Status Line Number 2:
  136.  
  137. XX:MYFILE.DOC    Shows DU and filename of working file if name
  138.                  of working file has been chosen.  If a filename
  139.                  has not been chosen shows "Unnamed File".
  140.  
  141. MISC INFO        Occupies same space as XX:MYFILE.DOC.  "Select 
  142.                  a Menu:" shows if ^J or linefeed is pressed.  
  143.                  Menu title appears if a menu is subsequently 
  144.                  selected. "Directory:" shows if ^KF is pressed.
  145.  
  146. INSERT           Shows status of the INSERT toggle (INSERT ON
  147.                  pushes text forward to make room for new text
  148.                  and INSERT OFF overwrites existing text).
  149.  
  150.  
  151.  
  152. Text Editing Section:
  153.  
  154. The text editing section (everything below the line of hyphens at 
  155. the top of your screen) contains the text you are working on, the 
  156. directory  of  the  logged  DU after  the  ^KF  "show  directory" 
  157. function  is invoked, and the LZED help screens, error  messages, 
  158. and prompts for user response.
  159.  
  160. :THE LZED COMMAND SET
  161.  
  162. Help Commands:
  163.  
  164. ^JM             Main (Single Key Commands)
  165. ^JQ             Quick (^Q Double Key Commands)
  166. ^JK             Block (^K Double Key Commands)
  167.  
  168. Single Key Commands:
  169.  
  170. ^S ^D ^E ^X     Cursor up, down, left, right
  171. <BS> ^H         Cursor left, same as ^S
  172. ^A ^D           Cursor one word left, right
  173. ^R ^C           Screen up, screen down
  174. ^G <DEL> ^T ^Y  Delete cursor char, delete char left, delete
  175.                  word right, delete line 
  176. ^N              Insert line, keep cursor in current position 
  177. ^L              Repeat last search or search and replace 
  178. ^V              Toggle insert mode
  179.  
  180.  
  181.  
  182. Quick (^Q) Double Key Commands:
  183.     
  184. ^QS ^QD               Cursor to far left, right
  185. ^QE ^QX                  Cursor to top of screen, bottom of screen
  186.  
  187. ^QR ^QC               Find top of file, bottom of file
  188. ^QB ^QK               Find beginning of block, end of block
  189.  
  190.  
  191.  
  192. ^QF                   Find text
  193. ^QA                   Find and replace text
  194.         
  195. ^QF and ^QA Options:
  196.  
  197. Ignore case?          Finds string, STRING, StrinG, etc.
  198. Backwards?            Search from cursor to beginning of file 
  199.                        instead of from cursor to end of file
  200.  
  201.  
  202. ** Note on ^QF AND ^QA:
  203.  
  204. The length of text to be searched for or replaced may not exceed 
  205. 32 characters.
  206.  
  207.  
  208.  
  209. ^QY                  Delete to end of line
  210. ^Q<DEL>                  Delete to beginning of line
  211. ^QZ                  Delete (zap) all text (with safety prompt)
  212. ^QT                   Change current TAB stop (with options)
  213.  
  214.  
  215.  
  216.  
  217. Block, File, and Miscellaneous (^K) Double Key Commands:
  218.  
  219. Block:
  220.  
  221. ^KB ^KK               Mark block beginning, end 
  222. ^KC                   Copy block to cursor position
  223.                        (if cursor is inside block, cursor moves 
  224.                        to beginning of block)
  225. ^KY                   Delete block
  226. ^KV                   Move block to cursor position
  227.                        (if cursor is inside block, cursor moves
  228.                        to beginning of block)
  229. ^KW                   Write block to file (prompts for filename) 
  230. ^KP                   Print block to list device
  231.                        (optional initialization string sent to 
  232.                        printer -- example :^[B^C)
  233. ^KH                   Hides block highlighting and destroys
  234.                        current block markers
  235.  
  236.  
  237.  
  238. File:
  239.  
  240. ^KR                   Read file from disk into current work 
  241.                        file at cursor position - inserts a file
  242.                        or, if in "Unnamed File" mode, opens that
  243.                        file for editing
  244. ^KN                   Change name of working file (shows on 
  245.                        information line)
  246.  
  247. Disk:
  248.  
  249. ^KF                   File listing (directory) of logged DU
  250. ^KL                   Log DU or DIR (omitting either drive
  251.                        or user preserves current drive or
  252.                        user)
  253.  
  254.  
  255.  
  256. Saving:
  257.  
  258. ^KS                   Save text to file using filename on
  259.                        information line and continue editing
  260.                        current text
  261. ^KX                   Save text to file using filename on
  262.                        information line and exit to system
  263. ^KD                   Save text to file using filename on
  264.                        information line, clear text from memory,
  265.                        and remain in edit mode
  266.  
  267. ** Note: ^KS, ^KX, and ^KD prompt for filename if no filename is
  268.          listed on the information line.  LZED uses an intermed-
  269.          iate file with the extension .T$P; for this reason, you
  270.          should never use .T$P as an extension for an LZED file.
  271.  
  272. ^KQ                   Exit to system without saving text to 
  273.                        file
  274.  
  275.  
  276.  
  277. ** Note on ^KN, ^KL, ^KW, ^KR, ^KD, and INSERT OFF:
  278.  
  279. ^KN  Change Filename/DU/DIR:
  280.  
  281. Allows you to change not only the name of the file, but its drive 
  282. and  user location as well.  This unique feature takes  advantage 
  283. of  the flexible storage facilities of ZCPR3, permitting  you  to 
  284. save text under multiple filenames and store the files in the  DU 
  285. or DIR of your choice.  
  286.  
  287. ^KL  Log DU or DIR:
  288.  
  289. By allowing you to log into a new DU or DIR LZED gives you access 
  290. to  ALL FILES ON DISK without exiting to ZCPR3.  LZED  will  even 
  291. log  in where ZCPR3 fears to tread, user areas 16 through 31,  so 
  292. long  as  your  environment descriptor  is  configured  for  such 
  293. access.
  294.  
  295.  
  296.  
  297. ^KW  Save Marked Block:
  298.  
  299. Allows  you to write a portion of your text to disk, possibly  to 
  300. be read into another file later on.   When programming,  this can 
  301. be used, in a limited fashion, to overcome the memory limitations 
  302. of LZED by marking a block,  writing it to an external file  with 
  303. ^KW,  and  replacing it with an INCLUDE or MACLIB  statement,  or 
  304. some functional equivalent. 
  305.  
  306. ^KR  Read File:
  307.  
  308. Allows  you  to insert a file from any DU or DIR  into  the  text 
  309. being  currently edited.  Because LZED allows access to files  in 
  310. all  drives  and users, it is excellent for  the  development  of 
  311. subroutines  or  standard header files.  Files may be  stored  in 
  312. any DU or DIR and read into  the current working file as needed.
  313.  
  314.  
  315.  
  316. ^KD  Done Editing File:
  317.  
  318. The  ^KD  command is used when you are finished  working  on  the 
  319. current  text.   It writes the text to a file,  clears  the  edit 
  320. buffer,  but does not exit LZED.  If you wish to start editing  a 
  321. new file, you can use ^KN to name the new file.  The ^KR  command 
  322. can  be used to read a new file into the edit buffer.  ^KN  could 
  323. then be used to rename the file. 
  324.  
  325.  
  326.  
  327. INSERT OFF:
  328.  
  329. The ^V command toggles INSERT ON/OFF.  With INSERT OFF, all newly 
  330. entered  text  will  overwrite existing text with  the  following 
  331. exceptions:
  332.  
  333. TABS and CARRIAGE RETURNS with INSERT OFF:
  334.  
  335. Even  with INSERT OFF, LZED still inserts characters before  TABS 
  336. and  CR's (carriage returns). If LZED is writing over a  TAB,  it 
  337. will insert characters before the TAB until the TAB is exhausted. 
  338. If  LZED  is  writing  at  the end of  a  line,  it  will  insert 
  339. characters before the CR. 
  340.  
  341. Pressing CR will cause the cursor to move to the beginning of the 
  342. next  line.   Pressing TAB will cause the cursor to move  to  the 
  343. next  TAB stop. Pressing either CR or TAB will insert  characters 
  344. as necessary to move the cursor to the beginning of the next line 
  345. or to the next TAB stop, respectively.
  346.  
  347.  
  348.  
  349. ^N with INSERT OFF:
  350.  
  351. The  ^N command inserts a CR just as with  INSERT ON.
  352.  
  353.  
  354.  
  355. ** Note on PASSWORDED DIRECTORIES:
  356.  
  357. The LZED commands that handle the DIR form respect passwording of 
  358. directories.   If you attempt an operation involving a passworded 
  359. directory,  you will be prompted for the password.  If you do not 
  360. give the correct password, LZED will ignore your command.
  361.  
  362. :ERROR MESSAGES
  363.  
  364. Out of Memory          Too much text
  365. File Not Found         ^KR's filename was not in DIR or DU
  366. String Not Found       ^QS, ^QA, or ^L have exhausted 
  367.                        occurrences of string in text
  368. Disk Full              No more room on disk to save files.
  369.                        CHANGE DISKS AND REPEAT THE SAVE COMMAND
  370. No Block Marked        Block function called when no block marked
  371. Block Too Large        Ran out of memory when extracting block
  372.  
  373. :ZCPR3 TCAP AND ENV REQUIREMENTS FOR RUNNING LZED
  374.  
  375. Clear screen
  376. Clear to end of line
  377. Cursor positioning
  378. Terminal width/height
  379.  
  380. TCAP FEATURE STRONGLY RECOMMENDED:
  381.  
  382. Highlighting on/off
  383.  
  384. :LZED MODIFICATION, POKE AND GO TECHNIQUES
  385.  
  386. Patch Points for Advanced Users:
  387.  
  388. Feature: SAVCCP
  389. Address: 10bh
  390. Values:  00h  = overwrite ZCPR3 and Warm Boot on exit
  391.          0ffh = preserve ZCPR3 and return to exit
  392.                 (2k less text buffer if CCP is preserved)
  393.  
  394. Feature: INVERSE
  395. Address: 10ch
  396. Values:  00h  = use dim video
  397.          0ffh = use inverse video, draw to end of
  398.                 screen when highlighting
  399. Note:    Dim video is significantly faster on most terminals.
  400.  
  401.  
  402.  
  403. Feature: USRPUNCT
  404. Address: 10dh..116h
  405. Values:  [see below]   
  406.  
  407. LZED  treats all characters in the USRPUNCT list  as  punctuation 
  408. marks.  All word-oriented commands - ^A, ^F, ^T - will cause  the 
  409. cursor to stop after any punctuation mark in this list.  You  may 
  410. want to change these settings.  For example, ()[] would be useful 
  411. in  Pascal  and  $  would be useful  in  assembler.   If  all  10 
  412. punctuation indicators are not needed, fill punctuation indicator 
  413. space  by  repeating one of the  punctuation  characters  already 
  414. listed, for example, '.,!().....'
  415.  
  416. Feature: INSERT (initial mode, toggled with ^V)
  417. Address: 117h
  418. Values:  0ffh = Insert On is default
  419.          00h  = Insert Off is default
  420.  
  421.  
  422.  
  423. Feature: TABSTOP (initial setting, adjusted with ^QT)
  424. Address: 118h
  425. Values:  Tab expansion minus one 
  426.          (valid values are 1, 3, 7 or 15 only)
  427.  
  428. Feature: BACKUP
  429. Address: 119h
  430. Values:  0ffh = Preserve backup (.BAK) file
  431.          00h  = Destroy .BAK file
  432.  
  433. :POKE and GO Aliases:
  434.  
  435. If  you  have  ZCPR3 implemented with the intrinsic  GET  and  GO 
  436. commands  and are using a Resident Command Package with the  POKE 
  437. command,  you will be able to create aliases  that  automatically 
  438. modify LZED in memory to run with the default values you need for 
  439. a particular task.
  440.  
  441.  
  442.  
  443. Example 1:
  444.     
  445. Alias: LZED-C
  446.  
  447. Purpose:  Load  LZED  to destroy CCP, Warm Boot  on  exit,  treat 
  448. specified characters as punctuation for C  language  programming,  
  449. and  edit file with name specified by first parameter on  command 
  450. line.
  451.  
  452. GET 100 LZED.COM;POKE 10B 00;POKE 10D "._,?!;:[]?;GO $1
  453.  
  454.  
  455.  
  456. Example 2:
  457.  
  458. Alias: LZED-I
  459.  
  460. Purpose:  Load LZED to run with reverse video highlighting.  Edit 
  461. file with name specified by first parameter on command line.
  462.     
  463. LDR REVERSE.Z3T;GET 100 LZED.COM;POKE 10C FF;GO $1
  464.  
  465. The  number  of  different  aliases  you  can  create  with  this 
  466. technique  is limited only by the permutations of LZED's  default 
  467. settings.
  468.  
  469.  
  470.  
  471. Source Code Listing of Patch Points:
  472.  
  473. ; User Patches
  474.  
  475.         org     10bh
  476.  
  477. SAVCCP:         db      0ffh
  478. INVERSE:        db      0ffh
  479. USRPUNCT:       db      ',.?!;:::::'
  480. INSERT:         db      0ffh
  481. TABSTOP:        db      7
  482. BACKUP:         db      0ffh
  483.  
  484.  
  485. :TEXT TO WORDSTAR OR NEWWORD
  486.  
  487. TXTTOWS.COM  is provided to LZED owners as a means of  converting 
  488. files  created  with LZED into WordStar/NewWord  document  files. 
  489. This allows you to use LZED to generate documents for  subsequent 
  490. formatting  and  printing with either of these  word  processors. 
  491. TXTTOWS.COM is included with LZED by virtue of the generosity  of 
  492. its  author, Sigi Kluger (ESKAY Software Service), who placed  it 
  493. in the public domain for such purposes.
  494.  
  495. TXTTOWS  is  invoked by typing its name followed by  a  filename, 
  496. which may contain wildcard characters. Examples:
  497.  
  498. B0:WORK>txttows *.doc            (process all DOC files)
  499. B0:WORK>txttows txttows.doc    (process one file only)
  500.  
  501.  
  502.  
  503. TXTTOWS will display the name of the file it is currently working 
  504. on. All modified data are written into a file TXTTOWS$.TMP. After 
  505. successful   completion,   the  original  file  is  deleted   and 
  506. TXTTOWS$.TMP is renamed to the original file's name. This insures 
  507. that  in case of failure the original file  remains  intact.  The 
  508. input  file  will only be deleted if TXTTOWS successfully  closes 
  509. the output file. 
  510.  
  511. :CREDITS 
  512.  
  513. emains  intact.  The 
  514. input  file  will only be delet