HELP EDIT — VMS 5.0
The EDIT commands perform the following functions:
o Invoke the Access Control List Editor to create or modify an
access control list for an object (see /ACL).
o Invoke the EDT screen-oriented editor (see /EDT).
o Invoke the FDL editor to create and modify File Definition
Language files (see /FDL).
o Invoke the SUMSLP batch-oriented editor to update a single input
file with multiple files of edit commands (see /SUM).
o Invoke the TECO editor (see /TECO).
o Invoke the TPU editor (see /TPU).
Additional information available:
/ACL
Invokes the Access Control List (ACL) Editor to create or modify an
access control list for a specified object. For a complete
description of the VMS Access Control List Editor, including
information about the EDIT/ACL command and its qualifiers, see the
VMS Access Control List Editor Manual.
The /ACL qualifier is required.
Format:
EDIT/ACL file-spec
Additional information available:
ParametersCommand QualifiersExamples
Parameters
object-spec Specifies the object whose access control list is to be created or edited using the ACL editor. If the access control list does not exist, it is created. If the object is a file, the ACL editor does not provide a default file type. If you omit the file type, it is presumed to be null. The specified file must be a disk file on a Files-11 Structure Level 2 formatted volume. If the object is a directory, specify a file specification with the file type of DIR. If the object type is not a file, you must specify the object type with the /OBJECT=type qualifer. No wildcard characters are allowed in the object specification.
Command Qualifiers
Additional information available:
/JOURNAL/KEEP/MODE/OBJECT/RECOVER
/JOURNAL
/JOURNAL[=file-spec] /NOJOURNAL Controls whether a journal file is created for the editing session. By default, the ACL editor keeps a journal file that contains a copy of the ACL editor keypad actions made during the editing session. The /JOURNAL qualifier controls the creation of a journal file for the editing session. If you specify /NOJOURNAL, no journal file is generated. If you omit the qualifier or specify /JOURNAL, a journal file is created. If you omit the journal file-specification, by default, the journal file is named input-file-spec.JOU. No wildcard characters are allowed in the journal file specification. If your editing session ends abnormally, you can invoke the ACL editor again and recover the changes made during the aborted session by simply specifying the /RECOVER qualifier and, if necessary, providing the name of the journal file, should it differ from the default name.
/KEEP
/KEEP=(option[,...])
Controls whether or not the session's journal file or recovery
journal file will be deleted. By default the session's journal file
is deleted once an ACL editing session ends normally; by default,
the recovery journal file is deleted once the ACL editing session is
successfully restored. The /KEEP qualifier allows you to save
either the journal or the recovery journal file. You can specify
one or both of the following options:
JOURNAL Specifies that the journal file for this session is
not to be deleted when the editing session terminates
normally.
RECOVER Specifies that the journal file used for recovery is
not to be deleted when the editing session has been
successfully restored.
/MODE
/MODE=option
Specifies the level of prompting to be used during the editing
session. By default, the ACL editor selects the prompting mode.
Use the /MODE qualifier to specify one of these prompt options:
PROMPT Specifies that where possible the selected field
within the ACE is initially filled with the first of a
list of items that may apply to the field.
NOPROMPT Specifies that no prompting is used by the ACL editor.
/OBJECT
/OBJECT=type
/OBJECT=FILE
Specifies the type of the object whose ACL is being edited. By
default, the ACL editor assumes that the object whose ACL is being
edited is a file. If the object is not a file, you must specify the
object type with the /OBJECT qualifier. The following keywords may
be specified with /OBJECT:
FILE Specifies that the object type is a file or a
directory file.
DEVICE Specifies that the object type is a device.
SYSTEM_GLOBAL_SECTION Specifies that the object type is a system
global section.
GROUP_GLOBAL_SECTION Specifies that the object type is a group
global section.
LOGICAL_NAME_TABLE Specifies that the object type is a system
logical name table.
/RECOVER
/RECOVER[=file-spec] /NORECOVER Determines whether or not the ACL editor restores the file's ACL from a journal file prior to starting the editing session. The /RECOVER qualifier specifies that the ACL editor should restore the ACL from the journal file specified by input-file-spec.JOU. This operation restores the ACL to the state it was in when a previous ACL editing session ended abnormally. If the journal file has a file name other than input-file-spec.JOU, specify it with the /RECOVER qualifier.
Examples
1. $ EDIT/ACL/JOURNAL=SAVEACL MYFILE.DAT
.
.
.
User creates ACL until system crashes
.
.
.
$ EDIT/ACL/JOURNAL=SAVEACL/RECOVER=SAVEACL MYFILE.DAT
.
.
.
ACL is restored and user proceeds with editing until done
.
.
.
^Z
$
The user initiates the ACL editing session by specifying that the
journal file SAVEACL.JOU be saved if the session ends abnormally.
The session proceeds until aborted by a system crash. To recover
from the aborted editing session, and continue with additional
edits, the user issues the second EDIT/ACL command. This session
begins by restoring the session with the journal SAVEACL.JOU. Once
the editing session proceeds to a normal completion (with a CTRL/Z),
the journal file SAVEACL.JOU is deleted.
2. $ EDIT/ACL MYFILE.DAT
(IDENTIFIER=[360,7],ACCESS=NONE)
(IDENTIFIER=[360,*],ACCESS=READ+WRITE)
.
.
.
User edits the ACL.
.
.
.
^Z
$
In this example the owner of the file MYFILE.DAT wants to modify the
file's access control list. A journal file called MYFILE.JOU is
automatically created to record the ACL. By default the editor
enters prompt mode. The system displays the two existing ACEs in
this ACL.
The user wants to change the UIC from [360,7] to [360,17]. After
the user makes the correction, presses ENTER on the keypad, and then
exits with CTRL/Z. Since this is a normal exit, the journal file
MYFILE.JOU is automatically deleted.
/EDT
Invokes the VAX EDT interactive text editor. The /EDT qualifier is
not required, because EDT is the VMS default editor.
Format:
EDIT file-spec
Additional information available:
ParametersCommand QualifiersExamples
Parameters
file-spec Specifies the file to be created or edited using the EDT editor. If the file does not exist, it is created by EDT. The EDT editor does not provide a default file type when creating files; if you do not include a file type, it is null. The file must be a disk file on a Files-11 formatted volume. No wildcard characters are allowed in the file specification.
Command Qualifiers
Additional information available:
/COMMAND/CREATE/JOURNAL/OUTPUT/READ_ONLY
/RECOVER
/COMMAND
/COMMAND[=file-spec]
/NOCOMMAND
Determines whether or not EDT uses a startup command file. The
/COMMAND file qualifier should be followed by an equal sign and the
specification of the command file. The default file type for
command files is EDT.
The following command line invokes EDT to edit a file named MEMO.DAT
and specifies that EDT use a startup command file named XEDTINI.EDT:
$ EDIT/COMMAND=XEDTINI.EDT MEMO.DAT
If you do not include the /COMMAND=command file qualifier, EDT looks
for the EDTSYS logical name assignment. If EDTSYS is not defined,
EDT processes the systemwide startup command file
SYS$LIBRARY:EDTSYS.EDT. If this file does not exist, EDT looks for
the EDTINI logical name assignment. If EDTINI is not defined, EDT
looks for the file named EDTINI.EDT in your default directory. If
none of these files exists, EDT begins your editing session in the
default state.
To prevent EDT from processing either the systemwide startup command
file or the EDTINI.EDT file in your default directory, use the
/NOCOMMAND qualifier as follows:
$ EDIT/NOCOMMAND MEMO.DAT
No wildcard characters are allowed in the file specification.
/CREATE
/CREATE (default)
/NOCREATE
Controls whether EDT creates a new file when the specified input
file is not found. Normally, EDT creates a new file to match the
input file specification if it cannot find the requested file name
in the specified directory. When you use /NOCREATE in the EDT
command line and type a specification for a file that does not
exist, EDT prints an error message and returns you to the DCL
command level as follows:
$ EDIT/NOCREATE NEWFILE.DAT
Input file does not exist
$
/JOURNAL
/JOURNAL[=journal-file]
/NOJOURNAL
Determines whether EDT keeps a journal file during your editing
session. The default file name for the journal file is the same as
the input file name. The default file type is JOU. The /JOURNAL
qualifier enables you to use a different file specification for the
journal file.
The following command line invokes EDT to edit a file named MEMO.DAT
and specifies the name SAVE.JOU for the journal file:
$ EDIT/JOURNAL=SAVE MEMO.DAT
If you are editing a file from another directory and want the
journal file to be located in that directory, you must use the
/JOURNAL qualifier with a file specification that includes the
directory name. Otherwise, EDT creates the journal file in the
default directory.
The directory that is to contain the journal file should not be
write protected.
To prevent EDT from keeping a record of your editing session, use
the /NOJOURNAL qualifier in the EDT command line as follows:
$ EDIT/NOJOURNAL MEMO.DAT
Once you have created a journal file, use the /RECOVER qualifier to
have EDT process the commands contained in the journal file.
No wildcard characters are allowed in the file specification.
/OUTPUT
/OUTPUT=output-file
/NOOUTPUT
Determines whether EDT creates an output file at the end of your
editing session. The default file specification for both the input
file and the output file is the same. Use the /OUTPUT qualifier to
give the output file a different file specification from the input
file.
The following command line invokes EDT to edit a file named MEMO.DAT
and gives the resulting output file the name OUTMEM.DAT:
$ EDIT/OUTPUT=OUTMEM.DAT MEMO.DAT
You can include directory information as part of your output file
specification to send output to another directory as follows:
$ EDIT/OUTPUT=[BARRETT.MAIL]MEMO.DAT MEMO.DAT
The /NOOUTPUT qualifier suppresses the creation of an output file,
but not the creation of a journal file. If you are testing some
edits and are not sure you want an output file, you can use
/NOOUTPUT as follows:
$ EDIT/NOOUTPUT MEMO.DAT
A system interruption will not prevent you from recreating your
editing session because a journal file is still being maintained.
If you decide you want to save your editing session, you can do so,
even though you specified /NOOUTPUT, by using the line mode command
WRITE to put the text in an external file before you end the
session.
No wildcard characters are allowed in the file specification.
/READ_ONLY
/READ_ONLY
/NOREAD_ONLY (default)
Determines whether EDT keeps a journal file and creates an output
file. With the default /NOREAD_ONLY, EDT maintains the journal file
and creates an output file when it processes the line mode command
EXIT. Using the /READ_ONLY qualifier is like using both the
/NOJOURNAL and /NOOUTPUT qualifiers.
The following command line invokes EDT to edit a file named
CALENDAR.DAT, but does not create a journal file or an output file:
$ EDIT/READ_ONLY CALENDAR.DAT
Use /READ_ONLY when you are searching a file. If you then want to
modify the file, use the line mode command WRITE to save your
changes. Remember, however, that you have no journal file.
/RECOVER
/RECOVER
/NORECOVER (default)
Determines whether or not EDT reads a journal file at the start of
the editing session.
When you use the /RECOVER qualifier, EDT reads the appropriate
journal file and processes whatever commands it contains. The
appropriate syntax follows:
$ EDIT/RECOVER MEMO.DAT
If the journal file type is not JOU or the file name is not the same
as the input file name, you must include both the /JOURNAL qualifier
and the /RECOVER qualifier as follows:
$ EDIT/RECOVER/JOURNAL=SAVE.XXX MEMO.DAT
Because /NORECOVER is the default for EDT, you do not need to
specify it in a command line.
Examples
1. $ EDIT/OUTPUT=NEWFILE.TXT OLDFILE.TXT
1 This is the first line of the file OLDFILE.TXT.
*
This EDIT command invokes the EDT editor to edit the file
OLDFILE.TXT. EDT looks for the EDTSYS logical name assignment. If
EDTSYS is not defined, EDT processes the systemwide startup command
file SYS$LIBRARY:EDTSYS.EDT. If this file does not exist, EDT looks
for the EDTINI logical name assignment. If EDTINI is not defined,
EDT looks for the file named EDTINI.EDT in your default directory.
If none of these files exists, EDT begins your editing session in
the default state. When the session ends, the edited file has the
name NEWFILE.TXT.
2. $ EDIT/RECOVER OLDFILE.TXT
This EDIT command invokes the EDT editor to recover from an abnormal
exit during a previous editing session. EDT opens the file
OLDFILE.TXT, and then processes the journal file OLDFILE.JOU. Once
the journal file has been processed, you can resume interactive
editing.
/FDL
Invokes the VMS FDL Editor (EDIT/FDL) to create and modify File
Definition Language (FDL) files. The /FDL qualifier is required.
For a complete description of the FDL Utility, including more
information about the EDIT/FDL command and its qualifiers, see the
FDL Facility in the VMS File Definition Language Facility Manual.
Format:
EDIT/FDL file-spec
Additional information available:
ParametersCommand QualifiersExamples
Parameters
file-spec Specifies the FDL file to be created, modified, or optimized by the editing session. The default file type is FDL.
Command Qualifiers
Additional information available:
/ANALYSIS/CREATE/DISPLAY/EMPHASIS/GRANULARITY/NOINTERACTIVE
/NUMBER_KEYS/OUTPUT/PROMPTING/RESPONSES
/SCRIPT
/ANALYSIS
/ANALYSIS=fdl-file-spec Specifies the FDL file (generated by the Analyze/RMS_File Utility) to be used in the optimize script.
/CREATE
/CREATE Allows you to create an output FDL file that does not exist without receiving a message from EDIT/FDL stating that the file will be created.
/DISPLAY
/DISPLAY=graph-option
Specifies the type of graph you want displayed. Legal graph options
are:
LINE Produces a graph of bucket size versus index depth as a
two-dimensional plot.
FILL Produces a graph of bucket size versus load fill percent
versus index depth.
KEY Produces a graph of bucket size versus key length versus
index depth.
RECORD Produces a graph of bucket size versus record size versus
index depth.
INIT Produces a graph of bucket size versus initial load record
count versus index depth.
ADD Produces a graph of bucket size versus additional record
count versus index depth.
LINE is the default.
/EMPHASIS
/EMPHASIS=tuning-bias
Allows you to choose between smaller buffers and flatter files.
Legal options for the tuning-bias parameter are:
FLATTER_FILES Generally increases bucket size. The bucket size,
in turn, controls the number of levels in the index
structure. If a larger bucket size eliminates one
level, then you should use this option. At some
point, however, the benefit of having fewer levels
will be offset by the cost of scanning through the
larger buckets.
SMALLER_BUFFERS Generally decreases the amount of memory you have
to use. Sequential files usually require only two
buffers.
FLATTER_FILES is the default.
/GRANULARITY
/GRANULARITY=n Allows you to divide an indexed file into a specified number of areas. The default is three areas.
/NOINTERACTIVE
/NOINTERACTIVE Causes EDIT/FDL to execute the Optimize script without a terminal dialog. You must have previously issued the ANALYZE/RMS_FILE/FDL command, specifying your existing RMS data file as the target file. If data is missing, EDIT/FDL uses the defaults.
/NUMBER_KEYS
/NUMBER_KEYS=n Allows you to specify the number of keys in your indexed file. You can define up to 255 keys. The default is one key.
/OUTPUT
/OUTPUT=fdl-file-spec Identifies an output file for storing the results of the EDIT/FDL session. If you omit the /OUTPUT qualifier, the output FDL file will have the same name and file type as the input file with a version number one higher than the highest existing version of the file. The default file type is FDL.
/PROMPTING
/PROMPTING=prompt-option Specifies the level of menu prompting to be used during the terminal session. The valid prompt options are: BRIEF Selects a terse level of prompting. FULL Provides more detailed information about each menu question. By default, EDIT/FDL chooses either BRIEF or FULL prompting depending on the terminal class and line speed. High-speed video terminals will get FULL, while nonscope terminals and terminals operating at less than 2400 baud get BRIEF.
/RESPONSES
/RESPONSES=response-option
Allows you to select how you want to respond to script questions.
Legal options include:
AUTOMATIC Indicates that you automatically want all script default
responses to be used. If you select this option, you can
use the /NOINTERACTIVE qualifier to cause EDIT/FDL to be
executed automatically.
MANUAL Indicates that you want to provide all script responses.
No default responses are automatically used.
The default is AUTOMATIC.
/SCRIPT
/SCRIPT=script-title
/NOSCRIPT
Controls whether to select a logically grouped sequence of questions
for EDIT/FDL to ask. Valid script titles are:
ADD_KEY Allows you to model or add to the attributes of a new
index.
DELETE_KEY Allows you to remove attributes from the highest index
of your file.
INDEXED Begins a dialog in which you are prompted for
information about the indexed data file to be created
from the FDL file. EDIT/FDL supplies values for certain
attributes.
OPTIMIZE Requires that you use the analysis information from an
FDL file that was created with the Analyze/RMS_File
Utility. The FDL file itself is one of the inputs to
the Edit/FDL Utility. In other words, you may tune the
parameters of all your indexes using the file statistics
from ANALYZE/RMS_FILE.
RELATIVE Begins a dialog in which you are prompted for
information about the relative data file to be created
from the FDL file. EDIT/FDL supplies values for certain
attributes.
SEQUENTIAL Begins a dialog in which you are prompted for
information about the sequential data file to be created
from the FDL file. EDIT/FDL supplies values for certain
attributes.
TOUCHUP Begins a dialog in which you are prompted for
information about the changes you wish to make to an
existing index.
The default is /NOSCRIPT.
Examples
1. $ EDIT/FDL INDEX This command creates or modifies an FDL file named INDEX.FDL. 2. $ EDIT/FDL/OUTPUT=NEWINDEX INDEX This command begins a session in which the contents of INDEX.FDL are read into the FDL editor and can then be modified. A file named NEWINDEX.FDL is created, and INDEX.FDL is not changed.
/SUM
Invokes the SUMSLP batch-oriented editor to update source files. You enter text changes and editing commands in update files. SUMSLP merges the update files containing the changes with the source file that you specify, and gives you a record of the changes in the form of an audit trail. For more information, see the VMS SUMSLP Utility Manual. Format: EDIT/SUM file-spec
Additional information available:
ParametersCommand QualifiersPositional QualifierExample
Parameters
file-spec Specifies the source file to be edited.
Command Qualifiers
Additional information available:
/LISTING
/LISTING[=file-spec] Determines whether a sequence-numbered listing file, showing the original and inserted lines and an audit trail, is produced during editing process. If you do not include a file specification, the listing file takes the same name as the input file, with a file type of LIS. By default, no listing file is produced.
/OUTPUT
/OUTPUT[=file-spec] Specifies the output file to be used in the editing session. If you do not include a file specification, the output file has the same name and type as the input file, with a version number one higher than the highest existing version.
/HEADER
/HEADER/OUTPUT=file-spec Determines whether the output file is created as a VFC format sequential file with the line insert number and audit trail information in the record header block (RHB) for the records.
Positional Qualifier
Additional information available:
/UPDATE
/UPDATE[=(update-file-spec[,...])] Indicates the file or files containing the editing commands and changes to be applied to the input source file. The default file of these files is UPD.
Example
EDIT/SUM FILE1.MAR/UPDATE=(UPD1A,UPD1B.ENH) The input source file FILE1.MAR is updated with the merged contents of SUMSLP update files UPD1A.UPD and UPD1B.ENH.
/TECO
Invokes the TECO interactive text editor. The /TECO qualifier is
required.
Format:
EDIT/TECO [file-spec]
EDIT/TECO/EXECUTE=command-file [argument]
Additional information available:
Parameters
file-spec Specifies the file to be created or edited using the TECO editor. If the file does not exist, it is created by TECO, unless you specify /NOCREATE. No wildcard characters are allowed in the file specification. If you specify /MEMORY (default) without a file specification, TECO edits the file identified by the logical name TEC$MEMORY. If TEC$MEMORY has no equivalence string, or if /NOMEMORY is specified, TECO starts in command mode and does not edit an existing file. If you specify /MEMORY and a file specification, the file specification is equated to the logical name TEC$MEMORY.
Qualifiers
/COMMAND /COMMAND[=file-spec] /NOCOMMAND Controls whether a startup command file is used. The /COMMAND file qualifier may be followed by an equal sign and the specification of the command file. The default file type for command files is TEC. If you do not include the /COMMAND qualifier, or if you enter /COMMAND without specifying a command file, TECO looks for the TEC$INIT logical name assignment. If TEC$INIT is not defined, no startup commands are executed. No wildcards are allowed in the file specification. /CREATE /CREATE (default) /NOCREATE Creates a new file when the specified input file cannot be found. If /MEMORY is specified and no input file is specified, the file created is the one specified by the logical name TEC$MEMORY. Normally, TECO creates a new file to match the input file specification if it cannot find the requested file name in the specified directory. When you use /NOCREATE in the TECO command line and type a specifi- cation for a file that does not exist, TECO displays an error message and returns you to the DCL command level. /EXECUTE is not compatible with /CREATE and /NOCREATE. /EXECUTE /EXECUTE=command-file [argument] Invokes TECO and executes the TECO macro found in the command file. The argument, if specified, appears in the text buffer when macro execution starts. Blanks or special characters must be enclosed in quotes. For detailed information on the use of TECO macros, see the PDP-11 TECO Editor Reference Manual. /EXECUTE is incompatible with /CREATE and /MEMORY. /MEMORY /MEMORY (default) /NOMEMORY Specifies that the last file you edited with TECO, identified by the logical name TEC$MEMORY, will be the file edited if you omit the file specification to the EDIT/TECO command. /OUTPUT /OUTPUT=output-file /NOOUTPUT (default) Controls how the output file is named at the end of your editing session. By default, the output file has the same name as the input file but is given the next higher available version number. Use the /OUTPUT qualifier to give the output file a file specification different from the input file. No wildcard characters are allowed in the file specification. /READ_ONLY /READ_ONLY /NOREAD_ONLY (default) Controls whether or not an output file is created. By default, an output file is created; /READ ONLY supresses the creation of the output file.
Examples
1. $ EDIT/TECO/OUTPUT=NEWFILE.TXT OLDFILE.TXT This command invokes the TECO editor to edit the file OLDFILE.TXT. TECO looks for the TEC$INIT logical name assignment. If TEC$INIT is not defined, TECO begins the editing session without using a command file. When the session ends, the edited file has the name NEWFILE.TXT. 2. $ EDIT/TECO/EXECUTE=FIND_DUPS "TEMP, ARGS, BLANK" In this example, the /EXECUTE qualifier causes the TECO macro contained in the file FIND_DUPS.TEC to be executed, with the argument string "TEMP, ARGS, BLANK" located in the text buffer.
/TPU
Invokes the VAX Text Processing Utility (VAXTPU). By default, this
runs an editor called EVE (for Extensible VAX Editor).
The syntax of the command is:
EDIT/TPU[/qualifier...] [input-filespec]
For example, the following command invokes VAXTPU, running EVE, to
edit a file called JABBER.TXT in your current (default) directory:
$ EDIT/TPU jabber.txt
o If the input file exists, EVE copies that file into a buffer with
the same name as the input file and puts it into the main window.
When you exit, a new version of the file is created, unless you
make no changes to the buffer or unless you write out your edits
to a different file.
o If the file does not exist -- that is, if you are creating a new
file -- the buffer is empty.
If you do NOT specify an input file, EVE creates an empty buffer
named MAIN. You can then simply start editing and specify the output
file on exiting, or you can use the EVE command GET FILE to edit a
particular file.
NOTE: Beginning with VAXTPU Version 2.0, there is no longer an EDT
Keypad Emulator (EDTSECINI). Instead, with EVE, use the
command SET KEYPAD EDT. For more information, see the EVE
help topics called EDT CONVERSION and EDT DIFFERENCES.
Additional information available:
ExamplesParametersEVE EditorLogicalsQualifiers
/COMMAND/CREATE/DEBUG/DISPLAY/INITIALIZATION
/JOURNAL/MODIFY/OUTPUT/READ_ONLY/RECOVER/SECTION
/START_POSITION/WRITE
Examples
1. $ EDIT/TPU
Invokes VAXTPU, running EVE. EVE creates an empty buffer named
MAIN. You can then simply start typing and specify the output
file on exiting, or you can use the EVE command GET FILE to edit
a particular file.
2. $ EDIT/TPU jabber.txt
Invokes VAXTPU to edit a file called JABBER.TXT in your current
(default) directory. The main buffer has the same name as the
file. If the file exists, EVE displays the file in the main
window; if you are creating a new file, the main window is empty.
3. $ EDIT/TPU *.txt
Invokes VAXTPU to edit a file with the file type .TXT. You can
use logical names and wildcards in the input file specification.
If more than one file matches your request, EVE shows a list of
the matching files to choose from -- in this case, a list of
files with the type .TXT in your current (default) directory --
and prompts for more information. You can edit more than one
file in an editing session, but you can specify only one input
file on the command line.
4. $ EDIT/TPU/SECTION=sys$login:myeve
Invokes VAXTPU, using a section file called MYEVE.TPU$SECTION in
your top-level (login) directory, instead of the standard EVE
section file. The default file type is .TPU$SECTION. Use a
complete file specification for the section file, including the
disk (or device) and directory. Otherwise, VAXTPU assumes the
section file is in SYS$SHARE. See HELP on /SECTION.
5. $ EDIT/TPU jabber.txt/RECOVER
Invokes VAXTPU and recovers your edits, using the journal file
from a session interrupted by a system failure. (In this case,
the journal file is called JABBER.TJL.) Effectively, you reissue
the command for the aborted session, adding the qualifier
/RECOVER. Remember to reissue any special qualifiers used on the
original command line, such as /START_POSITION. When the
recovery is complete, you can resume editing. See HELP on
/RECOVER.
6. $ DEFINE EVE$INIT sys$login:myeve
$ EDIT/TPU
Defines EVE$INIT as MYEVE.EVE in your top-level (login)
directory, and invokes EVE, using that initialization file. The
default file type is .EVE. This is useful if you want to run
that initialization file for all or most sessions or if it is in
a directory different from the files you edit. An initialization
file contains EVE commands to set editing values or private
defaults, such as SET RIGHT MARGIN and SET TABS. See HELP on
/INITIALIZATION.
Parameters
input-filespec
Optionally specifies the file you want to edit or create.
If the input file exists, EVE copies that file into a buffer with the
same name as the file and puts it into the main window. When you
exit, a new version of the file is created, unless you make no
changes to the buffer or unless you write out your edits to a
different file. If the file does not exist (that is, if you are
creating a new file), the buffer is empty.
If you do NOT specify an input file, EVE creates an empty buffer
named MAIN. You can then simply start editing and specify the output
file on exiting, or you can use the EVE command GET FILE to edit a
particular file.
You can use logical names and wildcards in the file specification.
You can edit more than one file in an editing session, but you can
specify only one input file on the command line.
Examples:
1. $ EDIT/TPU jabber.txt
Invokes VAXTPU, running EVE, to edit a file called JABBER.TXT in
your current (default) directory. The main buffer has the same
name as the input file.
2. $ EDIT/TPU *.txt
You can use logical names and wildcards in the input file
specification. If more than one file matches your request, EVE
shows a list of the matching files to choose from -- in this
case, a list of files with the type .TXT in your current
(default) directory -- and prompts for more information.
EVE Editor
EVE (for Extensible VAX Editor) is the default VAXTPU editor. EVE is
a general-purpose, interactive, text editor. Using EVE, you can do
the following:
o Perform basic text-editing operations, using commands and keys
o Edit more than one file in an editing session
o Use multiple buffers and windows, and resize windows
o Define keys, create LEARN sequences, and set an EDT or WPS keypad
o Set editing preferences, such as bound or free cursor
o Use either VMS- or ULTRIX-style wildcards for searching text
o Run DECSPELL to check a selected range or an entire buffer
o Spawn subprocesses or attach to other processes
o Execute DCL commands from within the editor
o Compile and execute VAXTPU procedures to extend the editor
o Create section files to save key definitions and extensions
o Use initialization files at startup and during a session
o Recover your edits in case of a system failure
o Get HELP on EVE commands and keypad functions, VAXTPU built-ins,
and other topics
You may want to create a symbol for invoking EVE, by putting the
following line in your LOGIN.COM file:
$ eve :== EDIT/TPU ! my symbol to invoke EVE
For more information about EVE, see the Guide to Text Processing on
VMS or use the online HELP in EVE. In particular, you may want to
check the topic called NEW FEATURES.
NOTE: Beginning with VAXTPU Version 2.0, there is no longer an EDT
Keypad Emulator (EDTSECINI). Instead, with EVE, use the
command SET KEYPAD EDT. For more information, see the EVE
help topics called EDT CONVERSION and EDT DIFFERENCES.
Logicals
You can define the following logical names for VAXTPU and EVE startup
files:
Logical Name Purpose
---------------------------------------------------------------------
TPU$COMMAND Specifies a command file containing VAXTPU
procedures and statements, typically to extend the
editor or to define a special text-processing
environment. The default file type is .TPU. See
HELP on /COMMAND.
EVE$INIT Specifies an initialization file containing EVE
commands, typically to set editing values (such as
margins and tabs) or define keys. The default
file type is .EVE. See HELP on /INITIALIZATION.
TPU$SECTION Specifies a section file containing (in binary
form) key definitions and compiled procedures -- a
customized version of EVE or an application you
have created. The default section file is
SYS$SHARE:EVE$SECTION.TPU$SECTION. See HELP on
/SECTION.
TPU$DEBUG Specifies a VAXTPU debugger file. By default,
using /DEBUG runs a debugger file called
SYS$SHARE:TPU$DEBUG.TPU. See HELP on /DEBUG.
For example, if there is a section file you want to use for all or
most editing sessions, you can define TPU$SECTION in your LOGIN.COM
file. Similarly, defining EVE$INIT is useful if the initialization
file, with your private default settings, is in a directory different
from the files you edit.
Also, you can define the following logical names for VAXTPU and EVE
online HELP files. This is useful if you create your own HELP files
with topics for extensions you have added to EVE.
Logical Name Purpose
---------------------------------------------------------------------
EVE$HELP Specifies the HELP file for EVE commands and other
topics.
EVE$KEYHELP Specifies the HELP file for the EDT and WPS
keypads in EVE.
TPUHELP Specifies the HELP file for VAXTPU built-ins and
other topics.
By default, logicals for HELP are not defined. EVE uses .HLB files
in SYS$HELP.
Qualifiers
Qualifier Default -------------------------------------------------- /[NO]COMMAND[=filespec] /NOCOMMAND /[NO]CREATE /CREATE /[NO]DEBUG[=filespec] /NODEBUG /[NO]DISPLAY[=filespec] /DISPLAY /[NO]INITIALIZATION[=filespec] /INITIALIZATION /[NO]JOURNAL[=filespec] /JOURNAL /[NO]MODIFY /MODIFY (for EVE) /[NO]OUTPUT[=filespec] /OUTPUT /[NO]READ_ONLY /NOREAD_ONLY (for EVE) /[NO]RECOVER /NORECOVER /[NO]SECTION[=filespec] /SECTION /START_POSITION=(row[,column]) /START_POSITION=(1,1) /[NO]WRITE /WRITE (for EVE) For details on how VAXTPU handles these qualifiers and on how applications can get information on them, see the VAX Text Processing Utility Manual.
/COMMAND
/COMMAND=command-filespec
/NOCOMMAND (default)
Determines whether VAXTPU uses a command file containing procedures
and statements to extend or modify the application. For example, you
can use a command file to add commands to EVE, define keys, or set
margins and tab stops. You can also use a command file to define a
special text-processing environment for creating your own VAXTPU
application.
The default file type is .TPU. You cannot use wildcards in the
command file specification.
At startup, VAXTPU searches your current (default) directory for a
command file called TPU$COMMAND.TPU and if it is found, uses that
command file.
If there is a command file you want to use for all or most sessions,
define the logical name TPU$COMMAND to specify that file. You can
redefine the logical to specify different command files for
particular editing sessions. If you have defined TPU$COMMAND and
want to invoke the editor without using a command file, use
/NOCOMMAND.
NOTE: If the command file you specify on the command line is not
found, the editing session is aborted and you are returned to
the DCL (or system) level
A command file is executed after a section file (if any) and before
EVE executes an initialization file (if any). Thus, key definitions
and settings in a command file override those saved in a section
file.
If you use a VAXTPU command file when you invoke EVE, statements in
the command file for buffer settings, such as margins and tab stops,
affect the main buffer and a system buffer named $DEFAULTS$. Buffers
created during the session will have the same settings as $DEFAULTS$.
To check the defaults, use the EVE command SHOW DEFAULTS BUFFER.
You can also compile the procedures in a VAXTPU command file during
an editing session. See the EVE help topic called COMMAND FILES.
If there are extensions you want to use for all or most editing
sessions, you should save the extensions in a section file instead of
reusing the command file for each session. A section file is faster
because it is in binary form. (See HELP on /SECTION.) However,
buffer settings (such as margins and tab stops) and other editing
values (such as scroll margins and tab mode) are not usually saved in
a section file. You may want to use a command file or initialization
file for these settings.
Examples:
1. $ EDIT/TPU/COMMAND=myeve
Invokes VAXTPU, running EVE, using a command file called
MYEVE.TPU in your current (default) directory. This compiles any
procedures in that file, effectively adding them to the set of
built-ins, and executes any VAXTPU statements at the end of the
file.
2. $ DEFINE TPU$COMMAND sys$login:myeve
$ EDIT/TPU
Defines TPU$COMMAND as MYEVE.TPU in your top-level (login)
directory, and invokes VAXTPU, using that command file. This is
useful if you want to run that command file for all or most
sessions or if it is in a directory different from the files you
edit, such as in repeated testing of new procedures in a command
file.
3. $ EDIT/TPU/NOSECTION/COMMAND=myapplication
Invokes VAXTPU, without a section file, using a command file
called MYAPPLICATION.TPU. The command file defines a text-
processing environment without using EVE as a base.
/CREATE
/CREATE (default)
/NOCREATE
Processing this qualifier depends on the VAXTPU application you are
using. For EVE, the default is /CREATE, which creates a buffer for
editing the input file. If you do not specify an input file on the
command line, the buffer is named MAIN.
Use /NOCREATE when you want to avoid invoking the editor in case you
mistype the input file specification: If the input file is not
found, the editing session is aborted, and you are returned to the
DCL (or system) level, as in the following example:
$ EDIT/TPU jabber.txt/NOCREATE
Input file does not exist: disk$1:[user]jabber.txt;
$
/DEBUG
/DEBUG[=debug-filespec]
/NODEBUG (default)
Determines whether you run a VAXTPU debugger. This is useful in
testing VAXTPU procedures for an application you are creating.
VAXTPU reads, compiles, and executes the debug file -- before
executing TPU$INIT_PROCEDURE.
The default debug file specification is SYS$SHARE:TPU$DEBUG.TPU. You
can override this default on the command line to specify a debug file
of your own. For example, the following command invokes VAXTPU,
using a debug file called SYS$SHARE:MYDEBUG.TPU:
$ EDIT/TPU/DEBUG=mydebug
You can define the logical name TPU$DEBUG to specify a debug file of
your own. This is useful if you want to keep the debug file in a
directory other than SYS$SHARE. You cannot use wildcards in the
debug file specification.
The VAXTPU debugger provides commands to manipulate variables and
control program execution. To start editing the code in the file you
are debugging, use the debugger command GO. For more information
about TPU$DEBUG, read the comments in the source file in SYS$SHARE:
TPU$DEBUG.TPU or see the VAX Text Processing Utility Manual.
/DISPLAY
/DISPLAY[=display-filespec] (default)
/NODISPLAY
Determines whether the editing session is being run on a supported
terminal and is using terminal functions, such as the screen display
and keyboard.
By default, sessions are run with a screen management file called
TPU$CCTSHR.EXE, for ANSI terminals. For more information about
VAXTPU-supported terminals, see the VAX Text Processing Utility
Manual.
Use /NODISPLAY when you want to run VAXTPU in batch mode, or when you
are using an unsupported terminal -- that is, without using the
screen display and keyboard functions.
If you use /NODISPLAY, then window- and screen-manipulation built-ins
will cause errors. Statements for for screen and window manipulation
(such as ADJUST_WINDOW, CREATE_WINDOW, MAP) will run, but these
statements will be meaningless and may return error messages in the
batch log file or on your screen.
Therefore, with /NODISPLAY, you must specify a special startup file
for the session -- either a command file or a section file. This
startup file should follow these rules:
o The file should NOT include statements for screen manipulation,
except for READ_LINE, MESSAGE, and LAST_KEY, which work with some
restrictions.
o The file should contain a complete editing session, ending with
either EXIT or QUIT.
For example, the following command invokes VAXTPU without a section
file, using a command file called MYAPPLICATION.TPU:
$ EDIT/TPU/NODISPLAY/NOSECTION/COMMAND=myapplication
/INITIALIZATION
/INITIALIZATION[=init-filespec] (default)
/NOINITIALIZATION
Determines whether an application uses an initialization file. EVE
intialization files contain commands to set editing values or private
defaults, such as margins and tabs, or to define keys that you do not
otherwise save in your section file.
The default file type is .EVE. You cannot use wildcards in the
initialization file specification.
By default, EVE searches for a file called EVE$INIT.EVE, first in
your current (default) directory and then, if necessary, in
SYS$LOGIN. If the file is found, EVE uses that initialization file.
If you want to use a different initialization file, use
/INITIALIZATION= and specify the file.
If there is an EVE initialization file you want to use for all or
most sessions, define the logical name EVE$INIT to specify that file.
You may want to add the definition to your LOGIN.COM file. You can
redefine the logical to specify different initialization files for
particular editing sessions.
If you want to invoke the editor without using any initialization
file, use /NOINITIALIZATION.
NOTE: Each command in the initialization file must be on a separate
line (no continuations). Comments must be on lines separate
from commands and must begin with an exclamation point (!).
You cannot nest initialization files.
EVE executes an initialization file after a command file (if any) and
a section file. Thus, key definitions and settings in an
initialization file override those saved in a section file.
You can also execute an initialization file during an EVE session by
using the @ command (at sign) and specifying the file. This is
useful when you want to set or change several editing values or key
definitions for particular kinds of editing or to execute a series of
related commands (such as resetting the width of the window and the
margins of the buffer).
When you invoke EVE, commands in an initialization file for buffer
settings, such as margins and tab stops, affect the main buffer and a
system buffer named $DEFAULTS$. Buffers created during the session
will have the same settings as $DEFAULTS$. To check the defaults,
use the EVE command SHOW DEFAULTS BUFFER.
An initialization file may be somewhat slower than a command file or
section file, depending on the amount of information to be processed.
A section file is faster because it is binary encoded. If there are
key definitions you want for all or most editing sessions -- for
example, if you always want the EDT keypad enabled -- you should save
your definitions in a section file. (See HELP on /SECTION.) However,
you may want to use initialization files for settings that are not
usually saved in a section file, such as margins and tabs.
Examples:
1. $ EDIT/TPU/INITIALIZATION=myeve
Invokes VAXTPU, running EVE, using an initialization file called
MYEVE.EVE in your current (default) directory.
2. $ DEFINE EVE$INIT sys$login:myeve
$ EDIT/TPU
Defines EVE$INIT as MYEVE.EVE in your top-level (login)
directory, and invokes EVE, using that initialization file. This
is useful if you want to run that initialization file for all or
most sessions or if it is in a directory different from the files
you edit.
/JOURNAL
/JOURNAL[=journal-filespec] (default)
/NOJOURNAL
Determines whether VAXTPU creates a journal file as a record of your
edits in case a system failure interrupts the editing session.
By default, VAXTPU creates the journal file in your current (default)
directory, using the input file name and the file type .TJL.
If you invoke VAXTPU without specifying an input file, the journal
file is called TPU.TJL.
Use /JOURNAL= and specify a file if you want the journal file to be
created in a different directory or to have a particular name or file
type.
If you use /NOJOURNAL, VAXTPU does not create a journal file.
Typically, you use /NOJOURNAL with /NOMODIFY, /NOWRITE, or /READ_ONLY
for demonstration sessions or to examine the input file without
modifying it, for example, using cursor-movement commands without
editing any text.
Normally, the journal file is deleted automatically when you exit or
quit; it is saved if there is a system failure, such as a
communications break between your terminal and the computer.
Although it may be possible to edit journal files, this is NOT
recommended, because you may delete or modify data necessary for the
recovery to work. For information on recovering your edits, see HELP
on /RECOVER.
NOTE: Beginning with VAXTPU Version 2.0, using /READ_ONLY does not
imply /NOJOURNAL -- that is, by default VAXTPU keeps a journal
file even for a "read-only" session.
/MODIFY
/MODIFY (default) /NOMODIFY Determines whether you can modify the main buffer. It does not affect other buffers you create during the session. By default, VAXTPU allows the buffer to be modified -- that is, you can edit text in the buffer and, on exiting, VAXTPU writes out the buffer to a file. With EVE, using /MODIFY or /NOMODIFY overrides the effects of /NOREAD_ONLY or /WRITE, which are the defaults. In other words, if you do NOT specify /MODIFY or /NOMODIFY, the status of the main buffer is determined by /READ_ONLY or /WRITE. Typically, you use /NOMODIFY for demonstration sessions or to examine the input file without modifying it, for example, using cursor- movement commands without editing any text.
/OUTPUT
/OUTPUT[=output-filespec] (default)
/NOOUTPUT
Determines the output file specification used by an application. For
EVE, the qualifier determines whether, on exiting, EVE writes an
output file from the main buffer.
By default, the output file has the same specifications as the input
file with a version number one greater than the highest version of
the input file, or a version number of 1 if you are creating a new
file.
Use /OUTPUT= and specify a file if you want the output file to be
written in a different directory or to have a different name or file
type. You cannot use wildcards in the output file specification. If
you omit any parts of the output file specification, such as the
device or directory, VAXTPU uses the corresponding parts of the input
file specification (if any).
If you use /NOOUTPUT with EVE, the main buffer is set to NO_WRITE.
On exiting, EVE then does not try to write out the main buffer. This
is useful for demonstration sessions or to examine the input file
without modifying it, for example, using cursor-movement commands
without editing any text. However, you can write out a buffer during
your editing session by using the EVE command WRITE FILE or the
VAXTPU built-in WRITE_FILE.
Examples:
1. $ EDIT/TPU rough.txt/OUTPUT=final.txt
Invokes VAXTPU, running EVE, to edit the file ROUGH.TXT, and, on
exiting, writes the output file to FINAL.TXT in your current
(default) directory.
2. $ EDIT/TPU jabber.txt/OUTPUT=sys$login:
Invokes VAXTPU to edit a file called JABBER.TXT in your current
(default) directory and, on exiting, writes the output file in
your top-level (login) directory.
/READ_ONLY
/READ_ONLY
/NOREAD_ONLY (default)
Determines whether you can modify the main buffer and, on exiting,
create an output file from that buffer. It does not affect other
buffers you create during the session.
/READ_ONLY is the same as /NOWRITE. The main buffer is set to
NO_WRITE and unmodifiable. This is useful for demonstration sessions
or to examine the input file without modifying it, for example, using
cursor-movement commands without editing any text.
NOTE: Beginning with VAXTPU Version 2.0, using /READ_ONLY does not
imply /NOJOURNAL -- that is, by default VAXTPU keeps a journal
file even for a "read-only" session.
/RECOVER
/RECOVER
/NORECOVER (default)
Determines whether VAXTPU recovers your edits after a system failure,
by reading the journal file for the interrupted session.
To recover your edits, recall or re-issue the command for the
original, aborted editing session -- including all qualifiers -- and
add /RECOVER, as in the following example:
1. $ EDIT/TPU jabber.txt
Invokes VAXTPU, running EVE, to edit a file called JABBER.TXT
in your current (default) directory.
2. If the editing session is aborted or interrupted by a system
failure, the journal file is saved in your current (default)
directory or wherever you specified if you used /JOURNAL=. In
this case, the journal file is called JABBER.TJL.
3. $ EDIT/TPU jabber.txt/RECOVER
Recovers your edits to the point at which the system failed.
The last few keystrokes may be lost. You can then resume the
editing session. VAXTPU continues to journal the rest of your
editing session.
To recover your edits, all relevant files must be in the same state
as at the start of the session being recovered -- including any files
you may have written out before the system failure. Also, all
terminal settings must be the same as the start of that session.
Check especially the following terminal settings:
o Device_Type
o Edit_mode
o Eightbit
o Page
o Width
If you originally used /JOURNAL= and specified a different directory
or filename for the journal file, then when you use /RECOVER you must
also use /JOURNAL= and specify that journal file. See HELP on
/JOURNAL.
/SECTION
/SECTION=section-filespec (default)
/NOSECTION
Determines whether VAXTPU uses a section file. A section file
contains, in binary form, key definitions and other extensions, such
as VAXTPU procedures you have compiled.
The default file type is .TPU$SECTION. VAXTPU assumes the section
file is in SYS$SHARE. Use a complete file specification, including
the disk and directory, for a section file stored elsewhere. You
cannot use wildcards in the section file specification. You use one
section file at a time.
Instead of specifying a section file on the command line, you can
define the logical name TPU$SECTION to specify a section file of your
own -- either a customized version of EVE or an application you have
created. This logical name is defined on a system-wide basis as
SYS$SHARE:EVE$SECTION.TPU$SECTION. If you create a local definition,
VAXTPU will use your section file instead of the system-wide default.
You may want to add the definition to your LOGIN.COM file. A section
file specified with the /SECTION qualifier overrides any logical
names.
If you use /NOSECTION, VAXTPU does not use any section file. This
prevents even the default interface from being used. VAXTPU will be
virtually unusable unless you specify a VAXTPU command file with
procedures that define a text-processing environment. Use the
/NOSECTION qualifier to create your own VAXTPU application, without
using EVE as a base.
To create a section file, use the EVE command SAVE EXTENDED EVE or
the VAXTPU built-in SAVE. A section file is cumulative; it saves the
current key definitions and extensions and those already saved in the
section file you are using.
If a section file is available, it is executed first, followed by the
command file, if any. If you are running EVE, it then executes
commands from an initialization file, if one is available. Procedure
and key definitions in a command file or initialization file override
those saved in a section file. However, buffer settings (such as
margins, tab stops) and other editing values (such as scroll margins
and tab mode) are not usually saved in a section file. You may want
to use an initialization file or command file for these settings.
Examples:
1. $ EDIT/TPU/SECTION=sys$login:myeve
Invokes VAXTPU, using a section file called MYEVE.TPU$SECTION in
your top-level (login) directory, instead of the standard EVE
section file.
2. $ DEFINE TPU$SECTION sys$login:myeve
$ EDIT/TPU
Defines TPU$SECTION as MYEVE.TPU$SECTION in your top-level
(login) directory, and invokes VAXTPU, using that section file.
This is useful if you want to run that section file for all or
most sessions or if it is in a directory different from the files
you edit.
3. $ EDIT/TPU/NOSECTION/COMMAND=myapplication
Invokes VAXTPU, without a section file, using a command file
called MYAPPLICATION.TPU. The command file defines a text-
processing environment without using EVE as a base.
/START_POSITION
/START_POSITION=(row[,column])
Determines the initial editing position in the main buffer -- that
is, the row and column (line and character) where the text cursor
first appears.
The default start position is 1,1 -- the upper left corner of the
main buffer. Using /START_POSITION does not affect the initial
cursor position when you create another buffer during the session.
Typically, you use /START_POSITION to begin editing at a particular
line (or row) or at a particular character position (or column), such
as when you want to skip over a standard heading in a file.
Examples:
1. $ EDIT/TPU/START_POSITION=(10,5)
Invokes VAXTPU, running EVE, putting the text cursor in row 10,
column 5 of the main buffer (that is, 10 lines down and five
characters to right).
2. $ EDIT/TPU/START_POSITION=(5)
Invokes VAXTPU, putting the text cursor in row 5, column 1 of the
main buffer (that is, five lines down and at the default left
margin).
NOTE: Remember that in recovering your edits from an aborted
session, you reissue the DCL command line from the aborted
session -- including all qualifiers, such as /START_POSITION
-- and add /RECOVER.
/WRITE
/WRITE (default) /NOWRITE Determines whether you can modify the main buffer and, on exiting, create (write) an output file. It does not affect other buffers you create during the session. /NOWRITE is the same as /READ_ONLY. The main buffer is set to NO_WRITE and unmodifiable. This is useful for demonstration sessions or to examine the input file without modifying it, for example, using cursor-movement commands without editing any text.