The general format for GDE commands is:

command [/object-type] [object-name] [/qualifier]

where:

The format description for each individual command specifies required qualifiers for that command.

The @, EXIT, HELP, LOG, QUIT, SETGD, and SPAWN commands do not use this general format. For the applicable format, refer to the section explaining each of these commands.

Comments on the command line may be delimited by an exclamation mark (!).

	An exclamation mark not enclosed in quotation marks ("") causes GDE to ignore the rest of that input line.

Font/Capitalization Conventions Used in this Chapter

All GT.M and GDE commands and qualifiers may be entered in either upper or lower case at the command prompt. However, when you SHOW your current Global Directory, note that GDE abides by the following case conventions:

• Region and segment names always display in uppercase

• Name space object name-always appears in case in which it was entered.

• File-name-always appears in case in which it was entered.

	The .dat extension is appended to the file-name when the database file is created, but never appears in the Global Directory listing, unless you entered it that way.

The descriptions of these commands and qualifiers appear in various cases and fonts throughout this documentation. This section describes the conventions used in describing these commands and qualifiers.

• In text: all GT.M commands and qualifiers appear in uppercase.

• In examples: the entire command line is shown in lower case, and appears in bold typewriter font.

The @ command executes a GDE command file. Use the @ command to execute GDE commands stored in a text file.

The format of the @ command is:

@file-specification

The file-specification specifies the command file to execute. GDE provides the default file extension ".COM" in creating the file-specification.

GDE executes each line of the command file as if it were entered at the terminal.

Example:

GDE> @standard

This command transfers the GDE input to STANDARD.COM in the current default directory. STANDARD.COM should contain GDE commands; comments should start with an exclamation mark (!).

The ADD command inserts a new name, region, or segment into the Global Directory.

The format of the ADD command is one of the following:

A[DD]/N[AME] name-space /R[EGION]=region-name
A[DD]/R[EGION] region-name /D[YNAMIC]=segment-name [/REGION-qualifier...]
A[DD]/S[EGMENT] segment-name /F[ILE_NAME]=file-spec [/SEGMENT-qualifier...]

The ADD command requires specification of an object-type and object-name. GDE supplies default values from the templates for qualifiers not explicitly supplied in the command.

Name spaces and file-names are case-sensitive; other objects are not case-sensitive.

Example:

GDE> ADD/S TEMP/F=SCRATCH

This command creates a segment TEMP and maps it to the file SCRATCH.DAT in the current default directory. However, if SCRATCH is a logical name, GT.M finds the file using the translation of that logical name.

The CHANGE command alters the name-to-region or region-to-segment mapping and /or the environment for a region or segment.

The format of the CHANGE command is:

The CHANGE command requires specification of an object-type and object-name.

Once you exit GDE, mapping changes take effect for any subsequent image activation (for example, the next RUN or the MUMPS /DIRECT command). Changes to database parameters only take effect for new database files created with subsequent MUPIP CREATE commands that use the modified Global Directory. Use the MUPIP SET command (or in some cases DSE) to change characteristics of existing database files.

Example:

GDE> C /R MASTER /DYNAMIC=TEMP /KEY=100

This command changes the region MASTER to use dynamic segment TEMP and establishes a maximum KEY_SIZE of 100 characters for the next creation of a file for this region. The segment change takes effect the first time the system uses the Global Directory after the GDE session EXITs, while the KEY_SIZE change takes effect after the next MUPIP CREATE of the database.

The DELETE command removes a name, region, or segment from the Global Directory. The DELETE command does not delete any actual data. However, GT.M does not access database files that do not have mapped global variables except through extended references using an alternative global directory that does not map to them. Note that GT.M replication does not support global updates made with extended references, unless they actually map to the same file as they would with the master global directory of the instance.

The format of the DELETE command is:

D[ELETE]/N[AME] name-space
D[ELETE]/R[EGION] region-name
D[ELETE]/S[EGMENT] segment-name

The DELETE command requires specification of an object-type and object-name.

Deleting a name removes the name-to-region mapping. Deleting a region unmaps all names mapped to the region. Deleting a segment unmaps the region mapped to the segment.

You may map the deleted names to another region or the deleted region to another segment using the CHANGE command.

The default name-space (*) cannot be deleted.

Example:

GDE> DEL/NAME T*

This command deletes the explicit mapping of all global names starting with the letter "T." This command does not delete any global variables. However, it may make preexisting globals starting with the letter "T" invisible, at least while using this global directory, because the T* global names map to the default namespace going forward.

The EXIT command writes all changes made in the current GDE editing session to the Global Directory and terminates the current editing session.

The format of the EXIT command is:

E[XIT]

GDE performs a full verification test (VERIFY) on the data. If the verification succeeds, GDE writes the new Global Directory to file system and issues a verification message.

If the verification fails, GDE displays a listing of all unverifiable mappings and waits for corrections. Make appropriate corrections, or leave the Global Directory in its original, unedited state by using the QUIT command.

If you have not made any changes to the Global Directory, GDE does not save a new Global Directory unless the original global directory had an older format which GDE has automatically upgraded. Note that while GDE upgrades older global directories to the current version, there is no facility to downgrade global directories to prior versions, so you should always save copies of any global directories that might be needed to retrieve archival data.

The HELP command displays online information about GDE commands and qualifiers.

The format of the HELP command is:

H[ELP] [topic...]

where topic specifies the GDE command for which you want information. If you omit the topic, GDE prompts you for it.

The LOCKS command specifies the region into which GT.M maps locks on resource names not starting with a caret symbol (^). GDE maps locks on resource names, starting with a caret symbol (^), to the database region mapped for the global variable name matching the resource name.

The format of the LOCKS command is:

LOC[KS] /R[EGION]=region-name

The LOCKS /REGION= qualifier allows specification of a region for local locks. By default, GDE maps local locks to the default region $DEFAULT.

Example:

LOC[KS] /R[EGION]=region-name

This command maps all locks on resource names that do not start with a caret symbol (^) to region MAIN.

The LOG command creates a log file of all GDE commands and displays for the current editing session. Because the system places an exclamation point (!) (i.e., the comment symbol) before all display lines that are not entered by the user. In the log, the log can be used with the @ symbol as a command procedure.

The format of the LOG command is:

LOG
LOG /ON[=file-specification-]
LOG /OF[F]

The LOG command, without a qualifier, reports the current status of GDE logging. The LOG command displays a message showing whether logging is in effect and the specification of the current log file for the GDE session.

The log facility can be turned on and off using the /ON or /OFF qualifiers any time during a GDE session. However, GDE closes the log files only when the GDE session ends.

The /ON qualifier has an optional argument of a file, which must identify a legal RMS file. GDE uses the default .LOG file extension. If LOG /ON has no file-argument, GDE uses the previous log file for the editing session. If no log file is previously specified during this editing session, GDE uses the default GDELOG.LOG log file.

Example:

GDE> LOG/ON="STANDARD.COM"

This command turns on logging of the session and directs the output to standard.log.

The QUIT command ends the current editing session without saving any changes to the Global Directory. GDE does not update the Global Directory file.

The format of the QUIT command is:

Q[UIT]

If the session made changes to the Global Directory, GDE issues a message warning that the Global Directory has not been updated.

The RENAME command allows you to change a name-space, the name of a region, or the name of a segment.

The format of the RENAME command is:

R[ENAME]/N[AME] old-name new-name
R[ENAME]/R[EGION] old-region-name new-region-name
R[ENAME]/S[EGMENT] old-segment-name new-segment-name

The RENAME command requires specification of an object-type and two object-names.

When renaming a region, GDE transfers all name mappings to the new region. When renaming a segment, GDE transfers the region mapping to the new segment.

Example:

GDE> RENAME /S STABLE TABLE

This command renames segment STABLE to TABLE and shifts any regions currently mapped to STABLE so they are mapped to TABLE.

The SETGD command closes out edits on one Global Directory and opens edits on another.

The format of the SETGD command is:

SE[TGD] /F[ILE]=file-spec [/Q[UIT]]

The /FILE=file-spec specifies a different Global Directory file. When you provide a partial file-specification, GDE uses the current default directory and defaults the type to .GLD.

The /QUIT qualifier specifies that any changes made to the current Global Directory are not written and are lost when you change Global Directories.

SETGD changes the Global Directory that GDE is editing. If the current Global Directory has not been modified, or the /QUIT qualifier appears in the command, the change simply occurs. However, if the current Global Directory has been modified, GDE verifies the Global Directory, and if the verification is successful, writes that Global Directory. If the verification is not successful, the SETGD fails.

Example:

GDE> SETGD /F=TEMP

This changes the Global Directory being edited to TEMP.

The SHOW command displays information contained in the Global Directory about names, regions, and segments.

The format of the SHOW command is:

SH[OW] /N[AME] [name-space]
SH[OW] /R[EGION] [region-name]
SH[OW] /S[EGMENT] [segment-name]
SH[OW] /M[AP] [R[EGION]=region-name]
SH[OW] /T[EMPLATE] 
SH[OW] /A[LL]

The object-type is optional. /MAP, /TEMPLATE, and /ALL are special qualifiers that cause GDE to display selected portions of the Global Directory to be displayed as follows:

/MAP: Displays the current mapping of all names, regions, segments, and files. This qualifier corresponds to the section of the SHOW report titled ***MAP***. The output of a SHOW /MAP may be restricted to a particular region by specifying a /REGION qualifier with a region name argument.

/TEMPLATE: Displays the current region and segment templates. This qualifier corresponds to the section of the SHOW report titled:

***TEMPLATES***

/ALL: Displays the entire Global Directory. This qualifier corresponds to displaying "all" sections of the SHOW report:

***TEMPLATES***, ***NAMES***, ***REGIONS***, ***SEGMENTS***,  ***MAP***.

By default, SHOW displays /ALL.

If you want to print the Global Directory, create a log file by executing LOG /ON= before executing the SHOW command. The /LOG command captures all the commands entered and output. You can print the log file if you want a hard copy record.

Example:

GDE> SHOW /TEMPLATE

           *** TEMPLATES ***
                                             Def   Rec   Key Null       Standard
Region                                     Coll  Size  Size Subs       NullColl  Journaling
--------------------------------------------------------------------------------------------
<default>                                     0   256    64 NEVER      N         N
 
Segment          Active              Acc Typ Block      Alloc Exten Options
------------------------------------------------------------------------------
<default>          *                 BG  DYN  1024        100   100 GLOB =1024
                                                                     LOCK = 40
<default>                            MM  DYN  1024        100   100 DEFER
                                                                     LOCK = 4

This displays only the TEMPLATES section of the Global Directory.

The SPAWN command creates a subprocess for access to VMS CLI (usually DCL) without terminating the current GDE environment. Use the SPAWN command to suspend a session and issue DCL commands such as DIRECTORY or SHOW LOGICAL.

The format of the SPAWN command is:

SP[AWN] [DCL command]

When you include the optional DCL command, the SPAWN command spawns a sub-process, executes the DCL command, and returns the terminal to the GDE> prompt. If SPAWN has no DCL command to execute, it completes the spawning of the sub-process and leaves the terminal at the OpenVMS CLI prompt.

Example:

GDE> SPAWN "DIR *.DAT"

This command invokes a OpenVMS directory listing of all files in the current default directory with a .DAT extension.

The TEMPLATE command maintains a set of -REGION and -SEGMENT qualifier values for use as templates when ADDing regions and segments. When an ADD command omits qualifiers, GDE uses the template values as defaults.

GDE maintains a separate set of -SEGMENT qualifier values for each ACCESS_METHOD. When GDE modifies the ACCESS_METHOD, it activates the appropriate set of TEMPLATEs and sets all unspecified qualifiers to the template defaults for the new ACCESS_METHOD. Use the GDE SHOW command to display qualifier values for all ACCESS_METHODs.

The format of the TEMPLATE command is:

T[EMPLATE]/R[EGION] [/REGION-qualifier...]
T[EMPLATE]/S[EGMENT] [/SEGMENT-qualifier...]

The TEMPLATE command requires specification of an object-type.

Example:

GDE> T/S/AL=200000

This command modifies the segment template so that any segments ADDed after this time produce database files with an ALLOCATION of 200,000 GDS blocks.

The VERIFY command validates information entered into the current Global Directory. It checks the name-to-region mappings to ensure all names map to a region. The VERIFY command checks region-to-segment mappings to ensure each region maps to a segment, each segment maps to only one region, and the segment maps to a UNIX file. The EXIT command implicitly performs a VERIFY -ALL.

The format of the VERIFY command is:

V[ERIFY]
V[ERIFY] /N[AME] [name-space]
V[ERIFY] /R[EGION] [region-name]
V[ERIFY] /S[EGMENT] [segment-name]
V[ERIFY] /M[AP]
V[ERIFY] /T[EMPLATE]
V[ERIFY] /A[LL]

The object-type is optional. /MAP, /TEMPLATE, and /ALL are special qualifiers used as follows:

VERIFY with no qualifier, VERIFY /MAP, and VERIFY /ALL each check all current information.

Example:

GDE> VERIFY /R REGIS

This command verifies the region REGIS.