home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 5 Edit / 05-Edit.zip / ked216.zip / README.DOC < prev    next >
Text File  |  1995-07-24  |  24KB  |  661 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.                             KEd   v2.16
  13.  
  14.                            The Kudzu Editor
  15.  
  16.                       OS/2 character mode Text editor
  17.  
  18.                      (C) Copyright 1993-1995  Kudzu Software
  19.  
  20.  
  21.  
  22.                           Don Radick
  23.                           Kudzu Software
  24.                           1452 North Ave. NE
  25.                           Atlanta, GA 30307
  26.  
  27.                           Compuserve ID:76254,764
  28.  
  29.                             July 24, 1995
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.                           
  48.                           
  49.                           
  50.                           
  51.  
  52.                           
  53.                           
  54.                                                     
  55.  
  56.  
  57.                     TABLE OF CONTENTS                           PAGE
  58. ===========================================================================
  59.                                                              
  60.             Introduction______________________________________  1
  61.                 Legal notice                                    1
  62.                 Marketing Blurb                                 1
  63.  
  64.             Installation
  65.                 Desktop installation___________________________ 2
  66.                 Manual Installation
  67.  
  68.             WPS Integration_____________________________________2
  69.                 Drag and Drop
  70.                 File Assocations
  71.  
  72.     OVERVIEW OF FEATURES
  73.             
  74.             General Text Editing______________________________  3
  75.                 Moving around a file                            3
  76.                 Insert/Overstrike modes                         3
  77.                 Inserting and Deleting text                     3
  78.                 Delete Beginning of line/End of line            3
  79.                 Movement by word                                3
  80.                 Tab Options                                     3
  81.  
  82.             Files_____________________________________________  4
  83.                 File loading                                    4
  84.                 Wildcard Support                                4
  85.                 Safe Save                                       4
  86.                 Backup File                                     4
  87.                 Backup Path                                     4
  88.                 HPFS support                                    4
  89.                                                                 
  90.             Help______________________________________________  5
  91.                 Hypertext on-line help                         
  92.  
  93.             Search____________________________________________  5
  94.                 Search and Replace                             
  95.  
  96.             Block Functions___________________________________  5
  97.                 Block Cut and Paste                             5
  98.                 Block Quoting                                   5
  99.                 Pasting in a PM window                          6
  100.  
  101.             Settings__________________________________________  6
  102.                 Setting Save and Load                           6
  103.                 KED.INI settings file                           6
  104.                 KED.INI version compatibility                   6
  105.  
  106.  
  107.  
  108.  
  109.                             i
  110.                                                            
  111.                       
  112.                     TABLE OF CONTENTS    continued              PAGE
  113. ===========================================================================
  114.                                                              
  115.             Miscellaneous Functions___________________________  6
  116.                 Ascii Chart                                     6
  117.                 OS/2 shell                                      7
  118.                 Windowing System                                7
  119.                 Exception Handling                              7
  120.  
  121.            General product information_________________________ 8
  122.                 Registration Information                        8
  123.                 Future directions                               9
  124.                 KEd specifications                              9
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.  
  140.  
  141.  
  142.  
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.                              ii
  165.  
  166.  
  167.                                                                                                                              
  168. Welcome to the newest release of KEd!  User support has been growing,
  169. there are new capabilities in this release, and more planned.
  170. First, the LEGAL TEXT:
  171.  
  172.  
  173. KEd is the sole property of Kudzu Software.  KEd is not free or public 
  174. domain software.  If you use this product on a regular basis then you 
  175. are required to register the product. You may install this program on
  176. more than one computer if only you operate each computer.  The program is 
  177. licensed to YOU, not to a computer - treat it like a book.  
  178. Kudzu Software will not be liable for any use, or inability to use 
  179. this program. This program may be distributed freely only if all files
  180. are included and not more than a nominal fee is charged for disk
  181. duplication.
  182.  
  183. All companies and products mentioned here own their respective trademarks.
  184.  
  185.  
  186. KEd is a character-mode editor. Why another text editor for OS/2?  
  187. I first became disenchanted with editors while using the Microsoft C 6.0 PWB 
  188. editor for OS/2 v 1.x several years ago, and no editor really suited me. 
  189. I wanted an editor with the ease of use of Qedit or the Norton Editor, but 
  190. I wanted to be able to customize it.  By the way, KEd is produced with 
  191. Borland C++ for OS/2. 
  192.  
  193. I think I've come up with some fairly natural key assignments.  A future
  194. major version of KEd will allow keyboard remapping.  For now, KEd loosely 
  195. emulates SideKick.
  196.  
  197.  
  198. What does KEd do?
  199.  
  200. KEd is a general purpose text editor; you won't find a GUI or fancy font 
  201. support, but you will find a lot of speed and ease of use.  If you need to 
  202. "punch out" a lot of text or need a fast, inexpensive programmer's editor I 
  203. think you'll like it. KEd was designed for OS/2, and uses such OS/2 features 
  204. as multiple threads and HPFS support.  New with v2.15 is the capability to
  205. have multiple text windows on screen.  KEd will run fine in an OS/2 windowed
  206. command session, but it's quite a bit slower. 
  207.  
  208.  
  209. KEd was designed to be fast and friendly.  File sizes are practically
  210. unlimited, and scrolling is much faster than PM editors. In addition, because
  211. KEd is a text mode application, you can use it when PM is not running.
  212.  
  213. Checkout BYTE "OS/2 Programmer's Cookbook" ISBN 0-07-882039-1
  214. They reviewed KEd v2.03.
  215. Quote: "blazingly fast", "lots of open files", "powerful search and replace".
  216.  
  217. Many thanks to all the registered users, and special thanks to the Germans.
  218.  
  219.                              Page 1
  220.  
  221.  
  222.  
  223. Desktop Installation                             
  224.  
  225. You can install KEd directly on your Desktop with a REXX file, INSTALL.CMD
  226. Just unzip KEd in any subdirectory, and type "install". The Workplace Shell
  227. will create an object on your Desktop with default settings of:
  228.     Windowed Session
  229.     Close window on exit
  230.  
  231. If you want to change any of the settings, the easiest way is to open the
  232. settings notebook and go for it. You can set KEd to open fullscreen, or 
  233. stay open on exit, or associate file types or extensions with KEd.
  234. After installation, if you'd like KEd in a folder instead of the Desktop,
  235. just drag it where you want it. 
  236. NOTE: OS/2 uses a default icon for a running copy of KEd when it is 
  237. when it is setup as a WPS object and running fullscreen, AND you have
  238. your desktop set for "Minimize to Desktop" when running.
  239.  
  240.  
  241. Manual Installation
  242.  
  243. KEd can be setup manually, if you wish. Just choose a subdirectory in
  244. your PATH, and unzip the distribution .ZIP there. You will probably want
  245. to create a program object in some folder.
  246.  
  247.  
  248. WPS Integration
  249.  
  250. KEd will accept files dropped from another application on the Desktop.
  251. If it is not running, WPS will launch it, and load the file you
  252. dropped onto the icon.  Depending on how KEd is configured in the 
  253. WPS Settings notebook, KEd will either exit when you exit the file, or
  254. stay active. NOTE: WPS will not let you drop a file onto a running copy
  255. of KEd (you will get the "NO" symbol).  Although you can drop binary
  256. files on KEd, it won't do you much good, since KEd does not support
  257. editting of binary files at this time.
  258.  
  259.  
  260. File Associations
  261.  
  262. You can set File Associations in the Setting Notebook, and KEd will launch
  263. and load the file that you double-clicked in the Drives application or
  264. other file manager application such as MrFilePM, FileStar or FM/2.
  265. If there are other applications with the same association, (for instance,
  266. you might have *.DOC set up in the OS/2 System Editor) WPS will decide
  267. which one to launch. If you prefer that KEd open a double-clicked file,
  268. instead of the System Editor, go the System Editor Settings Notebook,
  269. remove the association, and add that file association to KEd's Settings
  270. Notebook.
  271.  
  272.  
  273.  
  274.                              Page 2
  275.  
  276. Moving around a file
  277.  
  278. Standard keyboard mapping is used: The arrow keys (either on the "grey" 
  279. keypad or numeric keypad move up, down, left or right. PageUp and PageDown by
  280. default move either to the same position on the next page, but can be set to
  281. move to the bottom or top of the screen (see settings). Control-PageUp and 
  282. Control-PageDown move to the beginning or end of file, respectively.
  283.  
  284.  
  285. Insert/Overstrike modes
  286.  
  287. KEd will execute in Insert mode by default. You will see an 'I' in the lower
  288. right corner of the status line. If you press the "Insert" key, you will
  289. toggle into Overstrike mode, and 'O' will show in the lower right corner of
  290. the status line.  Any text you enter will overwrite existing text on the 
  291. current line.
  292.  
  293.  
  294. Inserting and Deleting text
  295.  
  296. To insert text, just begin typing, or you can paste into KEd from the system
  297. menu if you are running in an OS/2 command window. The BackSpace key will 
  298. delete the character immediately to the left of the cursor. The Delete key
  299. will delete the character under the cursor.  Control-Y will delete the 
  300. current line. 
  301.  
  302. Delete Beginning of line/End of line
  303.  
  304. Control - E will delete to the end of the current line.
  305. Control - B will delete to the beginning of the current line.
  306.  
  307.  
  308. Movement by word
  309.  
  310. Control - Left Arrow will move to the beginning of the word to the left
  311. of the current position.  Control - Right Arrow will move the beginning
  312. of the word to the right of the current position.
  313.  
  314.  
  315. Tab Options                                    
  316.  
  317. KEd default is to expand tabs into spaces when loading a file, and 
  318. save the file with spaces NOT converted into tabs.  Tabs can be unambiguously
  319. expanded into spaces, but when saving the file, it can't be certain about
  320. lines that originally contained mixed spaces and tabs, and will occasionally
  321. insert an extra tab or drop one. If you usually edit files with tabs, I 
  322. suggest you leave the default settings as they are.  Your files will retain 
  323. their orginal tab settings, and they will look correct on screen.  Pressing
  324. the tab key while editting will either:
  325.      insert spaces up to the next tab stop ("editor use tabs ON")
  326.      insert spaces to align with the next word above ("editor use tabs OFF")
  327. The latter option is sometimes called "smart tabs".
  328.  
  329.                              Page 3
  330.      
  331.  
  332. Load multiple files
  333.  
  334. You can load multiple files from the command line. Just specify:
  335. ked file1 file2 file3 .....
  336.  
  337.  
  338. Wildcard Support
  339.  
  340. If you use a wildcard on the command line, ie: "ked.exe *.doc"
  341. KEd will display a file directory window containing all "*.doc" files in 
  342. the current directory. You can scroll up or down and choose one file to load.
  343.  
  344.  
  345. Safe_Save
  346.  
  347. A primary design goal was the safety of your files.  By default, Safe_Save 
  348. is active.  This works by saving your current file to a temporary name, and
  349. once that is safe, renaming the temporary file to the correct file name.
  350. The only problem is if you run out of disk space. In this case KEd will
  351. give you an error dialog, and let you continue.  You can turn off 
  352. Safe_Save in the "Options" "Editor" menu, and save your file again.
  353.  
  354.  
  355. Backup File
  356.  
  357. You can choose to always create a backup file when you save. 
  358. (see Options - Editor - Backup File)
  359. Saving "myfile.doc" will create "myfile.bak" also. The next time you edit
  360. "myfile.doc", if you need to abort the edit, you can exit without saving 
  361. your changes, and revert to the .BAK file if you wish.  
  362. Default is Backup_File = OFF.
  363.  
  364.  
  365. Backup Path
  366.  
  367. You can specify a separate directory to hold your backup files. See
  368. "Options - Path" to set this. Default is the current directory.
  369.  
  370.  
  371. HPFS (long filenames) support
  372.  
  373. Since this is an OS/2 product, long filenames are supported. The OS/2 
  374. standard is to enclose a name with spaces with quotes. IE:
  375. KED "This is a long file"
  376. will load the file called: This is a long file
  377. If there are no spaces in the name you do not need to use quotes.
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.                              Page 4
  385.  
  386.  
  387. Hypertext online help
  388.  
  389. You will find a wealth of information here. Instead of writing a lengthy
  390. manual, you can find an answer to almost any question while on-line. 
  391. As the status line shows, press F1 to get to help.  KED.HLP must be in 
  392. your current directory, your PATH, or any directory in your HELP path.  
  393. I suggest putting KED.EXE and KED.HLP in your \UTIL subdirectory if that 
  394. is in the PATH. Some users prefer to put KED.HLP in their drive:\OS2\HELP
  395. subdirectory, and it works fine from there.
  396.  
  397.  
  398. Search and Replace
  399.  
  400. KEd has powerful search and replace facilities. You can toggle case 
  401. sensitivity (IE: find "House" rather than "house"), search backwards,
  402. find only whole words, and choose to confirm each replace if you wish,
  403. or do a global replace in one file.  Default search is not case sensitive,
  404. search forward.
  405.  
  406.  
  407. Cut and Paste by lines or columns
  408.  
  409. If you just need to block copy and paste lines, press F5 to mark the
  410. beginning of the block and press F6 to mark the end of the block. The 
  411. text between the marks will be highlighted to show the selection.
  412. Press F7 to get the block menu, and then "C" (no quotes) to Copy the
  413. block to the buffer.  The text highlighting will change back to a normal
  414. color to show that the block is no longer selected.  Once you have some 
  415. text in the buffer, you can press F7, then "P" to Paste the block. Detailed 
  416. help is available on-line from the "Function Key" screens.
  417.  
  418. There is 1 scrap buffer in version 2.15. If you "cut"  or "copy" a block 
  419. from your source file, it will replace whatever is in the scrap block. You 
  420. can "paste" that block as many times as you want, however.  If you have
  421. copied or cut a block into the scrap buffer, you can press F7 and "view"
  422. to view or edit the buffer.  Pressing "Alt-N" will toggle the view back
  423. to other loaded source files, or press "Alt-Q" to quit the buffer view.
  424. Unlike a normal file, pressing Alt-Q does not unload the scrap buffer.
  425. It will remain as is until your next Copy or Cut. It is automatically
  426. wiped when you exit KEd.
  427.  
  428. You can also mark blocks of text by columns.  Press F7 for the buffer menu
  429. and choose "mode" to change to column mode.  Use F5 and F6 as usual to mark
  430. the block.  Default is stream block mode.
  431.  
  432.  
  433.  
  434.  
  435.  
  436.  
  437.  
  438.  
  439.                              Page 5
  440.  
  441. Block Quoting
  442.  
  443. New with version 2.07 is an option to insert user-configurable quote
  444. characters at the beginning of the line when you paste a block.
  445. This can be useful in replying to mail messages. 
  446. IE:      
  447. When will Yoyodyne fix their spreadsheet
  448. and provide an OS/2 beeper module?
  449.  
  450. becomes:
  451. >>When will Yoyodyne fix their spreadsheet
  452. >>and provide an OS/2 beeper module?
  453.  
  454.  
  455. Pasting into KEd in an OS/2 Window
  456.  
  457. KEd (new with v2.07) fully supports Cut and Paste to and from OS/2 Windows,
  458. but the default setting for "auto_indent" can cause problems if any of the 
  459. pasted text is indented from the left margin.  It is suggested that you
  460. turn off "auto_indent" if you experience column spacing irregularities.
  461. (Options - Editor - Auto_Indent menu choices).
  462. Default Auto_Indent = ON.
  463.  
  464.  
  465. Settings save
  466.  
  467. You can change the color sets that various elements have, including 5 separate
  468. sets of colors for the edit window, the borders, dialog boxes, warning
  469. boxes, help and menus.  You can change a number of options for the editor
  470. including Insert/Overstrike, write End_Of_File, safe save, 2 different forms
  471. of PageUP/PageDown, and initial Numlock setting.  The options will be saved 
  472. in KED.INI, which must be in your current directory or PATH.  In other words,
  473. if your path contains C:\UTIL, and you store KEd.exe and KEd.hlp there, you
  474. can access the executable and help from anywhere on your system.
  475.  
  476.  
  477. KED.INI version compatibility
  478.  
  479. Currently, KEd.INI (which stores the user configuration) is not upwardly
  480. compatible between versions. While there are many user options, it should
  481. only take 5 minutes to recreate your settings. KEd will refuse to load an
  482. INI file from a later or earlier version.
  483.  
  484.  
  485. Ascii Chart
  486.  
  487. Press ALT-A, and the current character under the cursor will be highlighted
  488. in a table of all the ASCII characters. You can use the "arrow" keys to move 
  489. to a non-printable character or a PC ASCII graphic character, press Return, 
  490. and that character will be inserted in your file.  An alternative input 
  491. method is to press and hold Alt, and type the ASCII code of the character
  492. on the numeric keypad. 
  493.  
  494.                              Page 6
  495.  
  496.  
  497. Shell to a new session
  498.  
  499. Press Shift-F2, and you can get to a command prompt easily. Initially,
  500. you will find a reminder to type <exit> to get back to the editor, but
  501. this will scroll off the screen, and you will need to remember this.
  502. Behavior is "undefined" if you invoke KED.EXE while shelled.
  503. Shift-F4 will popup a "Shell" menu where you can define your own command
  504. to shell and run.
  505.  
  506.  
  507. Windowing System
  508.  
  509. Ked supported all OS/2 video modes with version 2.07, and version 2.15
  510. now supports multiple windows on screen. To see more than one file, you
  511. will need to move or resize the current window.  Press CTRL-W to enter
  512. SIZE mode.  The upper left corner position is fixed, and you can change the 
  513. width or length of the window by pressing the cursor arrow keys.
  514. Press ESC to exit the window SIZE mode. Similarly, you can MOVE a window
  515. by pressing ALT-W to enter MOVE mode, use the arrow keys to move the window,
  516. and press ESC to exit MOVE mode. This is how you change the position of the 
  517. upper left corner.  The window will not stop at the edge of the screen, 
  518. you can actually move it off the screen. If this happens, just reverse 
  519. direction and bring it back.
  520.  
  521. The current active window (the one that receives input) will always have 
  522. a double border and be on top.  As usual, pressing Alt-N or Alt-M will 
  523. move you to the next or previous file. If the file windows have been sized or
  524. moved when you do this, this will also pop the window to the top and make it
  525. active.
  526.  
  527. As part of the new window implementation, the STATUS line has been "attached"
  528. to the bottom of the window. Each window will have it's own STATUS line.
  529.  
  530. The standard menus and help window will always popup on top of whatever
  531. windows you have active.
  532.  
  533.  
  534. Exception Handling
  535.  
  536. KEd now has exception handling.  If an unrecoverable error happens, you
  537. should not see the default OS/2 error popup screen. You should see a 
  538. "friendly" KEd window with some of the same information, and the editor 
  539. will prompt you to hit any key, and then exit.  If you see this, make a 
  540. note of what the numbers are and what you were doing when it happened, 
  541. and report it please.
  542.  
  543.  
  544.  
  545.  
  546.  
  547.  
  548.  
  549.                              Page 7
  550.  
  551.  
  552. A WORD ABOUT COMPILERS
  553.  
  554. I'm very happy with the Borland C++ OS/2 compiler version 1.5, but they 
  555. are tracking the ANSI C++ standard, which seems somewhat bloated. KEd version
  556. 2.07 was 115kb, but the new compiler insists on linking in exception 
  557. handling (for the run-time lib), Run-Time-Type-Identification, and
  558. the Strings class. None of which I need or use, but it added 25kb to the
  559. EXE. I am considering producing a "KEd Lite" in the 80kb range without
  560. some of the advanced features. Send me mail if you think that version
  561. would be useful.
  562.  
  563.  
  564. So what does KEd cost?
  565.  
  566. Currently, KEd costs $20 for a 1 user registration.  Continued development 
  567. is ONLY possible with your support. I pledge to be very responsive to any 
  568. comments regarding feature set and bug fixes, and at this time I
  569. will offer support to unregistered users.  Any comments are welcome - send
  570. USPS "snail mail" to the Atlanta address, or send electronic mail to the
  571. Compuserve ID. Registered users will retain their license through the next 
  572. major version change.  IE: if you register any v2.x, you will retain your 
  573. license up to and including v3.0x
  574.  
  575. There are three ways to register:
  576.  
  577. 1   US Mail
  578.     Print out the REGISTER.DOC, and send a check or money order.
  579.  
  580. 2   Compuserve
  581.     Go SWREG ID# 4065. Follow the prompts.
  582.  
  583. 3   OS2 SHAREWARE BBS
  584.     Look at the startup bulletin on the BBS if you want to use this method.
  585.  
  586.  
  587. PLEASE send your address! I've gotten a few registrations without.
  588. Corporations can purchase a multiple copy license or site license
  589. at very attractive rates. Contact Kudzu Software for details.
  590.  
  591. NOTE: 
  592. Since the cost of registration is very low, you will receive nothing
  593. in return, except a clean conscience.  When macros and keyboard
  594. remapping are fully implemented, I will activate those features
  595. only to registered users.  Along with that version will come an
  596. external setup program and "branding" of the EXE with your name and
  597. serial number.
  598. There are no "begware" messages or "crippleware" disabled features.
  599. Everyone is treated as a responsible person.
  600.  
  601.  
  602.  
  603.                              Page 8
  604.  
  605.  
  606.                         FUTURE DIRECTIONS
  607.  
  608. Here are a few ideas for future development, most suggested by registered
  609. users.  Feel free to send email feedback on any item you would like to 
  610. see (or not!).  The list is in no particular order, see WHATS.NEW for
  611. a list of scheduled features for upcoming versions.
  612.  
  613.         word wrap mode
  614.         run OS/2 commands in KEd window
  615.         Dos version 
  616.         Undo/Redo support
  617.         mouse support
  618.         OS/2 extended attribute support
  619.         <your favorite> editor key bindings
  620.         Microsoft block commands
  621.         Rexx macro support
  622.         highlight complete word in search mode
  623.         change video mode within KEd 
  624.         hexadecimal edit mode
  625.         search and replace strings in files not loaded
  626.         regular expression search/replace support
  627.         line drawing mode
  628.         user-extendable help
  629.         user-readable/modifiable KEd.ini
  630.         support to save/recall "fileset" lists
  631.  
  632.  
  633. What are the limits?
  634.  
  635. Since KEd was designed for speed, some compromises had to be made.
  636. These limits can be changed, depending on response from registered users.
  637. 94 maximum files
  638. 256,000 lines per file
  639. 32MB total files capacity
  640.  
  641. I hope you like KEd, and look forward to talking to you soon.
  642. Don Radick
  643. Kudzu Software
  644.  
  645.  
  646.  
  647.  
  648.  
  649.  
  650.  
  651.  
  652.  
  653.  
  654.  
  655.  
  656.  
  657.  
  658.  
  659.                              Page 9
  660.  
  661.