Document revision date: 30 March 2001

## DEC Text Processing Utility Reference Manual

Order Number: AA--PWCCD--TE

## April 2001

This manual describes the elements of the DEC Text Processing Utility (DECTPU). It is intended as a reference manual for experienced programmers.

Revision/Update Information: This manual supersedes the DEC Text Processing Utility Reference Manual, Version 3.1 for OpenVMS Version 7.2.

Software Version: DEC Text Processing Utility Version 3.1 for OpenVMS Alpha Version 7.3 and OpenVMS VAX Version 7.3
The content of this document has not changed since OpenVMS Version 7.1.

Compaq Computer Corporation
Houston, Texas

© 2001 Compaq Computer Corporation

Compaq, VAX, VMS, and the Compaq logo Registered in U.S. Patent and Trademark Office.

OpenVMS is a trademark of Compaq Information Technologies Group, L.P. in the United States and other countries.

Motif is a trademark of The Open Group.

PostScript is a registered trademark of Adobe Systems Incorporated.

All other product names mentioned herein may be the trademarks or registered trademarks of their respective companies.

Confidential computer software. Valid license from Compaq or authorized sublicensor required for possession, use, or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under vendor's standard commercial license.

Compaq shall not be liable for technical or editorial errors or omissions contained herein. The information in this document is provided "as is" without warranty of any kind and is subject to change without notice. The warranties for Compaq products are set forth in the express limited warranty statements accompanying such products. Nothing herein should be construed as constituting an additional warranty.

ZK6020

The Compaq OpenVMS documentation set is available on CD-ROM.

Contents | Index

## Preface

## Intended Audience

This manual is a reference for experienced programmers who want to program in the DEC Text Processing Utility (DECTPU). Some features of DECTPU, for example, the callable interface and the built-in procedure FILE_PARSE, are intended for system programmers who have a good understanding of Compaq OpenVMS operating system concepts.

## Document Structure

This manual is organized as follows:

- Chapter 1 lists DECTPU built-in features according to their function.
- Chapter 2 contains complete descriptions of the DECTPU built-in functions.
- Appendix A contains sample procedures written in DECwindows DECTPU.
- Appendix B contains DECTPU messages.
- Appendix C discusses cursor behavior in DECTPU applications.

## Related Documents

For additional information information about OpenVMS products and services, access the following World Wide Web address:

    http://www.openvms.compaq.com/

## Reader's Comments

Compaq welcomes your comments on this manual. Please send comments to either of the following addresses:

Internet | openvmsdoc@compaq.com
Mail | Compaq Computer Corporation OSSG Documentation Group, ZKO3-4/U08 110 Spit Brook Rd. Nashua, NH 03062-2698

## How To Order Additional Documentation

Use the following World Wide Web address to order additional documentation:

    http://www.openvms.compaq.com/

If you need help deciding which documentation best meets your needs, call 800-282-6672.

## Conventions

The following conventions are used in this manual:

Ctrl/ x | A sequence such as Ctrl/ x indicates that you must hold down the key labeled Ctrl while you press another key or a pointing device button.
PF n | PF n indicates that you press the key labeled PF n on the numeric keypad, where n is 1, 2, 3, or 4.
x | A lowercase italic x indicates the generic use of a letter. For example, xxx indicates any combination of three alphabetic characters.
n | A lowercase italic n indicates the generic use of a number. For example, 19 nn indicates a 4-digit number in which the last 2 digits are unknown.
PF1 x | A sequence such as PF1 x indicates that you must first press and release the key labeled PF1 and then press and release another key or a pointing device button.
`[Return]` | In examples, a key name enclosed in a box indicates that you press a key on the keyboard. (In text, a key name is not enclosed in a box.) In the HTML version of this document, this convention appears as brackets, rather than a box.
{ } | In command format descriptions, braces indicate required elements; you must choose one of the options listed.
[ ] | In command format descriptions, brackets indicate optional elements. You can choose one, none, or all of the options. (Brackets are not optional, however, in the syntax of a directory name in an OpenVMS file specification or in the syntax of a substring specification in an assignment statement.)
[|] | In command format descriptions, vertical bars separating items inside brackets indicate that you choose one, none, or more than one of the options.
( ) | In command format descriptions, parentheses indicate that you must enclose the options in parentheses if you choose more than one.
" " | Quotation marks enclose system messages that are specified in text.
... | A horizontal ellipsis in examples indicates one of the following possibilities: Additional optional arguments in a statement have been omitted. The preceding item or items can be repeated one or more times. Additional parameters, values, or other information can be entered.
. . . | A vertical ellipsis indicates the omission of items from a code example or command format; the items are omitted because they are not important to the topic being discussed.
italic text | Italic text indicates important information, complete titles of manuals, or variables. Variables include information that varies in system output (Internal error number), in command lines (/PRODUCER= name), and in command parameters in text (where dd represents the predefined code for the device type).
bold text | This text style represents the introduction of a new term or the name of an argument, an attribute, or a reason. In the HTML version of this document, this convention appears as italic text.
UPPERCASE TEXT | Uppercase text indicates a command, the name of a routine, the name of a file, or the abbreviation for a system privilege.
lowercase | In format descriptions, words in lowercase indicate parameters or arguments to be specified by the user.
`Monospace text` | Monospace type indicates code examples and interactive screen displays. In the C programming language, monospace type in text identifies the following elements: keywords, the names of independently compiled external functions and files, syntax summaries, and references to variables or identifiers introduced in an example.
- | A hyphen at the end of a command format description, command line, or code line indicates that the command or statement continues on the following line.
numbers | All numbers in text are assumed to be decimal unless otherwise noted. Nondecimal radixes---binary, octal, or hexadecimal---are explicitly indicated.
mouse | The term mouse refers to any pointing device, such as a mouse, a puck, or a stylus.
MB1, MB2, MB3 | MB1 indicates the left mouse button. MB2 indicates the middle mouse button. MB3 indicates the right mouse button. (Users can redefine the mouse buttons.)

## Chapter 1
DECTPU Built-In Procedures Grouped According to Function

This chapter groups each of the DECTPU built-in procedures in a table according to the functions that they perform so you can see at a glance which built-in is related to what task.

When you want to perform editing tasks, use the following table to help you identify which built-in procedures are related to a particular task.

Chapter 2 lists the built-in procedures alphabetically and describes them in detail.

Some entries in this manual describe language elements or keywords that are not built-in procedures. These elements and keywords are included because they are used in the same way built-ins are used.

Table 1-1 lists all the DECTPU built-in procedures, grouped by the functions they perform (screen layout, moving the cursor, matching patterns, and so on).

Table 1-1 List of DECTPU Built-In Procedures by Function
| Screen Layout
--- | ---
ADJUST_WINDOW | SET (PAD) | SET (VIDEO)
CREATE_WINDOW | SET (PROMPT_AREA) | SET (WIDTH)
MAP | SET (SCREEN_UPDATE) | SHIFT
REFRESH | SET (SCROLLING) | UNMAP
SET (DISPLAY_VALUE) | SET (STATUS_LINE) | UPDATE
SET (HEIGHT) | SET (TEXT) |
| Moving the Cursor
CURSOR_HORIZONTAL | SET (COLUMN_MOVE_VERTICAL) | SET (DETACHED_ACTION)
CURSOR_VERTICAL | SET (CROSS_WINDOW_BOUNDS) | SET (MOVE_VERTICAL_CONTEXT)
SCROLL |  |
| Moving the Editing Position
MOVE_HORIZONTAL | MOVE_VERTICAL | POSITION
| Manipulating Text
APPEND_LINE | ERASE_LINE | SEARCH_QUIETLY
BEGINNING_OF | FILE_PARSE | SELECT
CHANGE_CASE | FILE_SEARCH | SELECT_RANGE
COPY_TEXT | FILL | SET (ERASE_UNMODIFIABLE)
CREATE_BUFFER | MARK | SET (MODIFIABLE)
CREATE_RANGE | MESSSAGE_TEXT | SET (MODIFIED)
EDIT | MODIFY_RANGE | SPLIT_LINE
END_OF | MOVE_TEXT | TRANSLATE
ERASE | READ_FILE | WRITE_FILE
ERASE_CHARACTER | SEARCH |
| Matching Patterns
ANCHOR | MATCH | SCANL
ANY | NOTANY | SPAN
ARB | PAGE_BREAK | SPANL
LINE_BEGIN | REMAIN | UNANCHOR
LINE_END | SCAN |
| Status of the Editing Context
CURRENT_BUFFER | SET (DEBUG) | SET (NO_WRITE)
CURRENT_CHARACTER | SET (DEFAULT_DIRECTORY) | SET (OUTPUT_FILE)
CURRENT_COLUMN | SET (FACILITY_NAME) | SET (OVERSTRIKE)
CURRENT_DIRECTION | SET (FORWARD) | SET (PAD_OVERSTRUCK_TABS)
CURRENT_LINE | SET (INFORMATIONAL) | SET (PERMANENT)
CURRENT_OFFSET | SET (INSERT) | SET (RECORD_ATTRIBUTE)
CURRENT_ROW | SET (JOURNALING) | SET (RECORD_MODE)
CURRENT_WINDOW | SET (KEYSTROKE_RECOVERY) | SET (REVERSE)
DEBUG_LINE | SET (LEFT_MARGIN) | SET (RIGHT_MARGIN)
ERROR | SET (LEFT_MARGIN_ACTION) | SET (RIGHT_MARGIN_ACTION)
ERROR_LINE | SET (LINE_NUMBER) | SET (SPECIAL_ERROR_SYMBOL)
ERROR_TEXT | SET (MARGINS) | SET (SUCCESS)
GET_INFO | SET (MAX_LINES) | SET (SYSTEM)
LOCATE_MOUSE | SET (MESSAGE_ACTION_LEVEL) | SET (TAB_STOPS)
RECOVER_BUFFER | SET (MESSAGE_ACTION_TYPE) | SET (TIMER)
SET (AUTO_REPEAT) | SET (MESSAGE_FLAGS) | SET (TRACEBACK)
SET (BELL) | SET (MOUSE) | SHOW
| Defining Keys
ADD_KEY_MAP | LAST KEY | SET (PRE_KEY_PROCEDURE)
CREATE_KEY_MAP | LOOKUP_KEY | SET (SELF_INSERT)
CREATE_KEY_MAP_LIST | REMOVE_KEY_MAP | SET (SHIFT_KEY)
DEFINE_KEY | SET (KEY_MAP_LIST) | SET (UNDEFINED_KEY)
KEY_NAME | SET (POST_KEY_PROCEDURE) | UNDEFINE_KEY
| Multiple Processing
ATTACH | SEND | SPAWN
CREATE_PROCESS | SEND_EOF |
| Executing Programs
ABORT | COMPILE | RETURN
BREAK | EXECUTE | SAVE
| Specific to DECwindows
CREATE_WIDGET | SET (DRM_HIERARCHY) | SET (MENU_POSITION)
DEFINE_WIDGET_CLASS | SET (ENABLE_RESIZE) | SET (RESIZE_ACTION)
GET_CLIPBOARD | SET (FIRST_INPUT_ACTION) | SET (SCREEN_LIMITS)
GET_DEFAULT | SET (GLOBAL_SELECT) | SET (SCROLL_BAR)
GET_GLOBAL_SELECT | SET (GLOBAL_SELECT_GRAB) | SET (SCROLL_BAR_AUTO_THUMB)
LOWER_WIDGET | SET (GLOBAL_SELECT_READ) | SET (UID)
MANAGE_WIDGET | SET (GLOBAL_SELECT_TIME) | SET (WIDGET)
RAISE_WIDGET | SET (GLOBAL_SELECT_UNGRAB) | SET (WIDGET_CALLBACK)
READ_CLIPBOARD | SET (ICON_NAME) | SET (WIDGET_CALL_DATA)
READ_GLOBAL_SELECT | SET (ICON_PIXMAP) | SET (WIDGET_CONTEXT_HELP)
REALIZE_WIDGET | SET (INPUT_FOCUS) | SET (WIDGET_RESOURCE_TYPES)
SEND_CLIENT_MESSAGE | SET (INPUT_FOCUS_GRAB) | UNMANAGE_WIDGET
SET (ACTIVE_AREA) | SET (INPUT_FOCUS_UNGRAB) | WRITE_CLIPBOARD
SET (CLIENT_MESSAGE) | SET (MAPPED_WHEN_MANAGED) | WRITE_GLOBAL_SELECT
SET (DEFAULT_FILE) |  |
| Miscellaneous
ASCII | INDEX | QUIT
CALL_USER | INT | READ_CHAR
CONVERT | JOURNAL_CLOSE | READ_KEY
CREATE_ARRAY | JOURNAL_OPEN | READ_LINE
DELETE | LEARN_ABORT | SET (EOB_TEXT)
EXIT | LEARN_BEGIN | SLEEP
EXPAND_NAME | LEARN_END | STR
FAO | LENGTH | SUBSTR
HELP_TEXT | MESSAGE |

Next | Contents | Index

| privacy and legal statement |
6020PRO.HTML