.page size 64,70 .layout 2,2 .date .headers on .no autosubtitle .autoparagraph .paragraph 0,1,5 .no number .lm 10 .rm 70 .literal .end literal .center; TPUPlus Reference Manual .b .center; Operating System/version: VAX/VMS V5.2 .b7 .center; as implemented at .b1 .center; Arkansas Department of Pollution Control _& Ecology .center; 8001 National Drive .center; Little Rock, Arkansas 72209 .center; (501) 562-7444 .b2 .center; by .b1 .center; Rickey H. Stacks .center; Senior Programmer Analyst .page .center; Revision History .literal rev. 860626-RHS Ver. 1.0 rev. 870708-RHS Ver. 2.0 rev. 870810-RHS Ver. 3.0 rev. 870813-RHS Ver. 4.0 includes EVEPlus and Spell Checker documentation rev. 871002-RHS Ver. 4.1 rev. 880201-RHS Ver. 4.2 rev. 880203-RHS Ver. 4.3 rev. 880318-RHS Ver. 5.0 includes EDTPlus documentation (combined pkg) rev. 880407-RHS Ver. 5.1 rev. 880422-RHS Ver. 5.2 rev. 880715-RHS Ver. 5.3 minor changes in EVE keypad definitions rev. 881202-RHS Ver. 6.0 updated to VMS V5.0-02 rev. 881215-RHS Ver. 6.1 updated to include ALL EVE and TPUPlus commands rev. 890504-RHS Ver. 6.2 added documentation for EVE cmds: PAD LINES, COUNT, and SET CASE rev. 890705-RHS Ver. 6.3 upgraded to VMS V5.1 (DEC Windows version of TPU) rev. 891005-RHS Ver. 6.4 verified operation on VMS V5.2, includes bug fixes to DECUS submission VAX-387 rev. 891005-RHS Ver. 6.4-1 operation of PCE_CHANGE_WIDTH routine changed and documented rev. 891115-RHS Ver. 6.5 replaced DIRECTORY command with DIR (modified DIRED) rev. 900323-RHS Ver. 6.6 added line drawing routines, added SET_ENTITY_WORD routine .end literal .chapter Introduction .Title ##########TPUPlus Reference Manual .subtitle ##########Introduction .number page .lm 10 .rm 70 .header level 1 Acknowledgement .x Acknowledgement I wish to thank several people for their help, assistance, and contributions that have made this version of TPUPlus possible: Robert Gage of the Arkansas Department of Pollution Control _& Ecology (my supervisor) for putting up with me and my many, many compiles of TPUPlus and allowing me the time to work on this project. Tom Wolfe of the Jet Propulsion Lab in California for suppling the latest version of the Spelling Checker software and for spending the time and energy on the phone with me. Many thanks to Paul McIlfatrick and Steve Graham of British Telecom in Belfast, Northern Ireland for supplying the line drawing code. And to DECUS and the contributors that have supplied software -- Thanks and keep up the great work folks... Last, but definitely not the least, I thank the Lord that He has given me the ability to do some work that might help someone else in some small way. .header level 1 Intended Audience .x Intended Audience This guide is intended for users familiar with the VMS operating system and have a working knowledge of any of the TPU-based editors. This is not intended to be a teaching tool but rather a reference tool of what is available and how it is set up for use on the hardware available to users of the ADPC_&E VAXes. .page .header level 1 Introduction / General information .x Introduction This manual is an attempt to explain the various functions of the TPUPlus procedures and keypad as implemented at the Arkansas Department of Pollution Control and Ecology. As currently implemented TPUPlus will work on any VTxxx type of terminal (including Rainbows). A note to the users of Rainbows: This editor will work best if you are using the LCTERM communication program (available on another contribution to DECUS). If you do not use LCTERM, then the EVE keypad will not be available to you. .x EDT The EDT portion of this editor is an emulation of DEC's EDT editor with many special added features that increases the productivity of the user once the user becomes familiar with the editor commands. The user can become aquainted with these special functions and how to use them in the span of a couple hours. Most of the special functions share key definitions with the EVE version of the editor, increasing ease of use through similar key definitions. Also, there is on-line help available from the PF2 (HELP) key for the keypad and from the HELP key for general help. .x Disclaimer Please note that all features/macros/procedures as described in this and any other documentation are presented "as is". They have been tested as completely as possible but be advised that ^*NO WARRANTY, EITHER EXPRESSED OR IMPLIED, IS CONVEYED WITH THIS SOFTWARE. THIS SOFTWARE WAS WRITTEN AND SHOULD REMAIN IN THE PUBLIC DOMAIN, ALTHOUGH A MODEST REPRODUCTION FEE MAY BE CHARGED\*. I will attempt to answer all questions concerning this package and will attempt to correct all "bugs" found in my code. This means I will not attempt to correct problems arising from modified versions of this software. If modifications are sent to me I will be happy to consider including them in future releases. Please debug your submissions first before sending them. I can be reached at the following: .literal Rick Stacks Senior Programmer Analyst Arkansas Department of Pollution Control and Ecology 8001 National Dr. / POB 9583 Little Rock, AR. 72219 U.S.A. (501) 562-7444 .end literal In-house users may send comments/suggestions/gripes via VAX Mail to username RICK__SYS. .header level 2 Conventions used in this document .x Convention definitions .literal Ctrl-key indicates you must press the CTRL key while you simultaneously press another key [option] square brackets indicate that the enclosed item is optional {a/b/c/d} braces indicate that you must choose one of the enclosed items GOLD unless otherwise noted refers to the PF1 key indicates the key labeled as "key" e.g. = the return key whitespace a term that represents any amount of contiguous spaces, tabs, etc. (any 'blank' character) .end literal All commands, except TPU level commands, can be abbreviated to the least number of unique characters for that command. An example: SET REC for SET RECTANGULAR. A note to the implementers of this editor, this version of TPUPlus contains replacements to some of the DEC-supplied procedures (I know... DEC says this is a no-no). These procedures can be found in the file REPLACEMENTS.TPU. You should be aware that if DEC ever changes/deletes these routines you will need to take appropriate action. I will; but the revised software will probably not reach the DECUS library in time to help in the (un)likely event DEC does change the affected routines (as they did in VMS V5.0-02). Good luck... .page .header level 1 VT200 Keypad Diagram .x EVE > VT200 Keypad .x VT200 Keypad Please note: Unless otherwise stated on the following pages of this Guide all references to the GOLD key mean the PF1 key. For a complete description and diagram of the current EVE (TPUPlus) keypad press while in the editor. The editor will build a diagram of the current keypad definitions. Additionally, the definitions shown on the next page are subject to change, please use the GOLD keystroke to list the current key definitions. .page .header level 1 Control / GOLD / GOLD-Control key sequences .x EVE > defined keys .x defined keys .literal key | plain | ctrl-key | GOLD+key | GOLD+ctrl-key --------+------------+------------+------------+--------------- A | A | | APPEND FILE| B | B | RECALL | | SHOW BUFFERS C | C | ABORT CMD | | D | D | | | DCL WINDOW E | E | MOVE TO EOL| | F | F | | | G | G | | GET FILE | H | H | MOVE TO BOL| | I | I | TAB | INCL. FILE | INS. PG MKS J | J | | | K | K | LEARN | AUTO SHIFT | L | L | GO TO LINE#| SHOW LINE #| M | M | RETURN | | N | N | NEXT LINE | | O | O | DISP OFF/ON| | P | P | PREV. EOL | | Q | Q | SCROLL ON | | R | R | REMEMBER | REPEAT CMD | REM. PG MKS S | S | SCROLL OFF | CHG SCROLL | T | T | PROC STATUS| | U | U | BOL ERASE | | V | V | QUOTE | | W | W | REFRESH | WRITE FILE | CHG WIDTH Y | Y | INTERRUPT | | Z | Z | EXIT | | | | | | < | CURSOR L | | SHFT L 25 | > | CURSOR R | | SHFT R 25 | | | | | F6 | | | | F7 | | | | F8 | CAP. WORD | | FILL | F9 | LEARN | | | F10 | EXIT | | | F11 | FWD/REV | | | F12 | RECT/NOREC | | | F13 | CHG WIDTH | | CHG SHIFT | F14 | INS/OVR | | CHG SCROLL | HELP | HELP | | LIST KEYS | DO | EVE COMMAND| | TPU COMMAND| F17 | BOL ERASE | | BOB ERASE | F18 | EOL ERASE | | EOB ERASE | F19 | BUFR TOGGLE| | SPLT/UNSPLT| F20 | QUIT | | | --------+------------+------------+------------+--------------- BOB = Beginning of buffer BOL = Beginning of line EOB = End of buffer EOL = End of line .end literal .page .header level 1 EDT VT200 Keypad Diagram .x EDT > VT200 Keypad .x VT200 Keypad For a complete description of the EDT keypad please refer to the VAX Text Processing Utility Manual. All EDT keys that do not conflict with a TPUPlus key definition will use the TPUPlus key definition shown on the previous pages. .page .chapter EVE commands .Title ##########TPUPlus Reference Manual .subtitle ##########EVE commands .lm 10 .rm 70 .header level 1 EVE commands .x EVE > commands On the following pages are descriptions of the macros utilized as EVE commands as contained in the TPUPlus package as written and implemented at the Arkansas Department of Pollution Control and Ecology. All EVE commands may be accessed by the EDT emulator by first pressing the key or by pressing . There are certain edt line mode commands that are available by using GOLD that are not available otherwise. These commands are SET ENTITY WORD, SET SEARCH EXACT, SET SEARCH GENERAL, SET SEARCH OFF, line #, SET WRAP, SET NOWRAP, CONTINUE, DELETE BEFORE, DELETE REST, DELETE WHOLE, SUBSTITUTE, _& TYPE. These commands function the same as their EDIT counterparts. All key definitions listed on the following pages refer to the EVE keypad and to the EDT keypad when there is no conflict with an already existing EDT key definition. Some of the commands listed in this manual are what I refer to as 'dependant' commands. They are dependant upon the setting of other commands (e.g. the CENTER LINE command is dependant upon the setting of the right margin, SET RIGHT MARGIN nnn). Should a command do wierd things or not act quite like you would expect, check the settings of the editor to see if a condition such as described above exists. If such a condition does not exist, contact the Computer Section for assistance. Please note: Unless otherwise stated on the following pages of this chapter all references to the GOLD key mean the PF1 key. Additionally, all commands listed in this chapter are accessed by first pressing followed by the command, unless otherwise stated. .page .header level 2 @ .x @ .x EVE > commands > @ @ file__name The @ command executes a file containing EVE commands during your editing session. This lets you set or change the values of several editing attributes at the same time. See Chapter 5 of the VAX Text Processing Manual and also the Guide to VMS Text Processing for more information concerning command files. .header level 2 APPEND FILE .x APPEND .x EVE > commands > APPEND FILE APPEND FILE file__name This command is accessed by pressing the key and typing APPEND file__name__specs or APPEND or if the PCE defined VT200 keypad is being used hit GOLD . This command will append the specified file to the end of the current buffer, regardless of where the cursor is currently positioned. .header level 2 ASCII REPLACE .x ASCII REPLACE .x EVE > commands > ASCII REPLACE ASCII REPLACE Replaces a symbolic string representing any of the control characters (ASCII 0 thru 31) with its actual value. See also CONTROL REPLACE. .header level 2 ATTACH .x ATTACH .x EVE > commands > ATTACH ATTACH process-name Suspends the current editing session and connects the terminal to another process or sub-process that already exists. .header level 2 BOTTOM .x BOTTOM .x EVE > commands > BOTTOM BOTTOM Moves the cursor to the bottom of the current editing buffer. .header level 2 BUFFER .x BUFFER .x EVE > commands > BUFFER BUFFER buffer-name Puts the named buffer in the current window and positions the cursor to your last position in that buffer. If the buffer does not exist, EVE creates a new buffer and puts the cursor at the top of that buffer. .header level 2 BULLET .x BULLET .x EVE > commands > BULLET BULLET [[[arg1] arg2] arg3] This command formats a paragraph into bulleted type form. The first non-blank word is the bullet item. All other text makes up the bullet text. .lit BULLET Format a bullet using the defined margins. BULLET x Display the bullet margins that are currently set (x is any non-numeric string). BULLET 10 Redefine the bullet item space to 10 and then format a bullet. BULLET 2 4 60 Redefine the item left margin to 2, the text margins to 4 and 60, and then format a bullet. .end literal .header level 2 CAPITALIZE WORD .x CAPITALIZE WORD .x EVE > commands > CAPITALIZE WORD CAPITALIZE WORD Capitalizes each word in the currently selected text, or capitalizes the current word, making the first letter uppercase and the remaining letters lowercase. .header level 2 CENTER LINE .x CENTER LINE .x EVE > commands > CENTER LINE CENTER LINE Centers the current line between the left and right margins of the current buffer. .header level 2 CHANGE CASE .x CHANGE CASE .x EVE > commands > CHANGE CASE CHANGE CASE [{CHARACTER/LINE/range/buffer}] Changes the case of every character in the current select range, the character the cursor is currently on (default), the line the cursor is currently on, or the entire current buffer. CHANGE CASE [CHARACTER] Inverts the case of the current character and the cursor will be moved to the next character on the line. If you are currently positioned at the end of a line then the cursor will move to the beginning of the following line. CHANGE CASE LINE Changes the case of every character on the line the cursor is currently positioned on (current__line). For example, let's suppose you are positioned on the following line: tHIS iS a tEST! tRY iT yOU'LL lIKE iT. test TEST test ... Press (GOLD ) The line now appears as: This Is A Test! Try It You'll Like It. TEST test TEST ... CHANGE CASE range Changes the case of every character in the cut/paste buffer. Use , , and keys are redefined to perform rectangular cut and paste operations. Rectangles are formed by positioning the cursor to where the upper-left corner of the rectangle will be and pressing