OpenVMS DCL Dictionary

Document revision date: 19 July 1999

OpenVMS DCL Dictionary

Contents

Index

In this example, the SHOW TERMINAL command displays the full terminal characteristics.

SHOW TIME

Displays the current date and time.

Format

SHOW [DAY]TIME

Parameters

None.

Example


$ SHOW TIME 14-DEC-1998 00:03:45

The SHOW TIME command in this example displays the current date and time.

SHOW TRANSLATION

Displays the first translation found for the specified logical name. You can specify the tables that are searched.
Requires read (R) access to a logical name table to display information about any logical name cataloged in that table.

Format

SHOW TRANSLATION logical-name

Parameter

logical-name
Specifies the logical name whose translation you want to display.

Description

The SHOW TRANSLATION command searches one or more logical name tables for a specified logical name and returns the equivalence name of the first match found. You can specify the tables you want to search. If you do not specify a table, SHOW TRANSLATION searches the tables defined by the logical name LNM$DCL_LOGICAL.
The logical name LNM$DCL_LOGICAL contains the list of logical name tables and the order in which they are searched. Unless LNM$DCL_LOGICAL has been redefined for your process, the process, job, group, and system logical name tables are searched, in that order. The first match found is displayed. (To see how LNM$DCL_LOGICAL is defined for your process, enter the command SHOW LOGICAL /TABLE=LNM$DIRECTORIES LNM$DCL_LOGICAL.)
If a table contains more than one entry with the same name, but each name has a different mode, then the translation for the name with the outermost (least privileged) mode is returned.
The SHOW TRANSLATION command is similar to the SHOW LOGICAL command. However, the SHOW TRANSLATION command is executed within the DCL command interpreter (the SHOW LOGICAL command calls an image). Therefore, the SHOW TRANSLATION command does not cause the current image to exit and does not deassign user mode logical names. Also, the SHOW TRANSLATION command does not display iterative translations of a name.

Qualifier

/TABLE=name
Searches the specified table. The default value for the name parameter is LNM$DCL_LOGICAL.
If you specify the table name by using a logical name that translates to more than one table, then each table is searched in the order specified until a match is found.

Examples

#1
$ SHOW TRANSLATION PAYROLL PAYROLL = DISK1:[ACCOUNTS.WORKING]FACTOR1.DAT;37 (LNM$PROCESS_TABLE)

The SHOW TRANSLATION command in this example displays the translation for the logical name PAYROLL and also displays the name of the table where the logical name was found. In this example, PAYROLL was found in LNM$PROCESS_TABLE, the process logical name table.

#2
$ DEFINE DISK DBA1: $ DEFINE/GROUP DISK DBA2: $ SHOW TRANSLATION DISK DISK = DBA1:(LNM$PROCESS_TABLE)

The DEFINE commands in this example place entries for the logical name DISK in both the process and group logical name tables. Then, the SHOW TRANSLATION command shows the translation associated with the logical name DISK. By default, the process, job, group, and system tables are searched (in that order). The first match found is displayed. The logical name DISK from the process table (LNM$PROCESS_TABLE) is displayed because it is found before the name DISK in the group table.

#3
$ RUN ORION `[Ctrl/Y]` $ SHOW TRANSLATION TERMINAL TERMINAL = _TTT3: (LNM$PROCESS_TABLE) $ CONTINUE

The RUN command in this example executes the image ORION.EXE. After the Ctrl/Y function interrupts the image, the SHOW TRANSLATION command displays a logical name assignment. The CONTINUE command resumes the execution of the image.

#4
$ SHOW TRANSLATION/TABLE=LNM$SYSTEM USER USER = "DBA2:" (LNM$SYSTEM_TABLE)

The SHOW TRANSLATION command in this example displays the translation for the logical name USER. Because a table name is specified, the SHOW TRANSLATION command does not use the default search order. Only the specified table, LNM$SYSTEM, is searched. LNM$SYSTEM is the system logical name table.

#5
$ DEFINE/TABLE=LNM$PROCESS_DIRECTORY MYPROC - _$ TEST_TABLE, LNM$PROCESS $ SHOW TRANSLATION/TABLE=MYPROC FILER FILER = "[SMITH.FILER]" (TEST_TABLE)

In this example, MYPROC defines a list of logical name tables that you want searched. It asks the system to first search TEST_TABLE (a user-defined table) and then to search LNM$PROCESS (the process logical name table). MYPROC is stored in LNM$PROCESS_DIRECTORY, the process directory table. When you enter the SHOW TRANSLATION command to find FILER in the MYPROC table, the tables TEST_TABLE and LNM$PROCESS are searched, in that order. The first match found is displayed.

SHOW USERS

Displays the user name and node name (in an OpenVMS Cluster environment) of interactive, subprocess, and batch users on the system.

Format

SHOW USERS [username]

Parameter

username
Specifies the user about whom you want information. The asterisk (*) and the percent sign (%) wildcard characters are allowed. If you specify a string, all users whose user names begin with the string are displayed. For example, if you specify the string MAR, all user names that begin with MAR are displayed. If no user exists whose name matches the specified string, an informational message tells you that no processes were found.
If you omit the username parameter, a list of all interactive, subprocess, and batch users is displayed.

Qualifiers

/BATCH

/NOBATCH
Displays all batch users in the OpenVMS Cluster environment. To restrict the display to users on specific nodes, use the /BATCH qualifier with the /NODE qualifier. When you use the /NOBATCH qualifier, all batch users are excluded from the display.
/CLUSTER
Displays the specified user names on all nodes in an OpenVMS Cluster environment.
/EXACT
Use with the /PAGE=SAVE and /SEARCH qualifiers to specify a search string that must match the search string exactly and must be enclosed with quotation marks (" ").
If you specify the /EXACT qualifier without the /SEARCH qualifier, exact search mode is enabled when you set the search string with the Find (E1) key.
/FULL
Displays the user name, the node name, the process name, the process identification (PID) code, terminal names (both virtual and physical), and port information of all interactive, subprocess, and batch users on the system.
/HEADING (default)

/NOHEADING
Displays a heading line above the system output. When you use the /NOHEADING qualifier, the heading line is excluded from the display.

/HIGHLIGHT[=keyword]
Use with the /PAGE=SAVE and /SEARCH qualifiers to specify the type of highlighting you want when a search string is found. When a string is found, the entire line is highlighted. You can use the following keywords: BOLD, BLINK, REVERSE, and UNDERLINE. BOLD is the default highlighting.
/INTERACTIVE

/NOINTERACTIVE
Displays all interactive processes held by users in the OpenVMS Cluster environment. To restrict the display to users on specific nodes, use the /INTERACTIVE qualifier with the /NODE qualifier. When you use the /NOINTERACTIVE qualifier, all interactive processes held by users in the OpenVMS Cluster environment are excluded from the display.
/NETWORK

/NONETWORK
Displays all network users in the OpenVMS Cluster environment. To restrict the display to users on specific nodes, use the /NETWORK qualifier with the /NODE qualifier. When you use the /NONETWORK qualifier, all network users in the OpenVMS Cluster environment are excluded from the display.
/NODE[=(name,...)]
Displays all interactive, subprocess, and batch users on the specified node or nodes. If you enter the /NODE qualifier without a value, the qualifier displays all the interactive, subprocess, and batch users on the local node.
/OUTPUT[=filespec]

/NOOUTPUT
Controls where the output of the command is sent. By default, the output of the SHOW USERS command is sent to the current SYS$OUTPUT device (usually your terminal). To send the output to a file, use the /OUTPUT qualifier followed by a file specification.
The asterisk (*) and the percent sign (%) wildcard characters are not allowed in the file specification. If you enter a partial file specification (for example, specifying only a directory), SHOW is the default file name and .LIS is the default file type.
If you enter the /NOOUTPUT qualifier, output is suppressed.
/PAGE[=keyword]

/NOPAGE (default)
Controls the display of user information on the screen.
You can use the following keywords with the /PAGE qualifier:

CLEAR_SCREEN Clears the screen before each page is displayed.

SCROLL Displays information one line at a time.

SAVE[= n] Enables screen navigation of information, where n is the number of pages to store.

The /PAGE=SAVE qualifier allows you to navigate through screens of information. The /PAGE=SAVE qualifier stores up to 5 screens of up to 255 columns of information. When you use the /PAGE=SAVE qualifier, you can use the following keys to navigate through the information:

Key Sequence Description

Up arrow key, Ctrl/B Scroll up one line.

Down arrow key Scroll down one line.

Left arrow key Scroll left one column.

Right arrow key Scroll right one column.

Find (E1) Specify a string to find when the information is displayed.

Insert Here (E2) Scroll right one half screen.

Remove (E3) Scroll left one half screen.

Select (E4) Toggle 80/132 column mode.

Prev Screen (E5) Get the previous page of information.

Next Screen (E6), Return, Enter, Space Get the next page of information.

F10, Ctrl/Z Exit. (Some utilities define these differently.)

Help (F15) Display utility help text.

Do (F16) Toggle the display to oldest/newest page.

Ctrl/W Refresh the display.

The /PAGE qualifier is not compatible with the /OUTPUT qualifier.
/SEARCH="string"
Use with the /PAGE=SAVE qualifier to specify a string that you want to find in the information being displayed. Quotation marks are required for the /SEARCH qualifier, if you include spaces in the text string.
You can also dynamically change the search string by pressing the Find key (E1) while the information is being displayed. Quotation marks are not required for a dynamic search.
/SUBPROCESS

/NOSUBPROCESS
Displays all subprocess users in the OpenVMS Cluster environment. To restrict the display to users on specific nodes, use the /SUBPROCESS qualifier with the /NODE qualifier. When you use the /NOSUBPROCESS qualifier, all subprocess users in the OpenVMS Cluster environment are excluded from the output.
/WRAP

/NOWRAP (default)
Use with the /PAGE=SAVE qualifier to limit the number of columns to the width of the screen and to wrap lines that extend beyond the width of the screen to the next line.
The /NOWRAP qualifier extends lines beyond the width of the screen and can be seen when you use the scrolling (left and right) features provided by the /PAGE=SAVE qualifier.

Key Sequence	Description
Up arrow key, Ctrl/B	Scroll up one line.
Down arrow key	Scroll down one line.
Left arrow key	Scroll left one column.
Right arrow key	Scroll right one column.
Find (E1)	Specify a string to find when the information is displayed.
Insert Here (E2)	Scroll right one half screen.
Remove (E3)	Scroll left one half screen.
Select (E4)	Toggle 80/132 column mode.
Prev Screen (E5)	Get the previous page of information.
Next Screen (E6), Return, Enter, Space	Get the next page of information.
F10, Ctrl/Z	Exit. (Some utilities define these differently.)
Help (F15)	Display utility help text.
Do (F16)	Toggle the display to oldest/newest page.
Ctrl/W	Refresh the display.

Examples

#1
$ SHOW USERS OpenVMS User Processes at MAY 12, 1998 10:37 AM Total number of users = 4, number of processes = 14 Username Node Interactive Subprocess Batch S_SKONETSKI BBBBBB 1 WISNIEWSKI XXXXXX 4 2 HIBBITS AAAAAA 1 4 VAXMAN AAAAAA 2

$ SHOW USERS
      OpenVMS User Processes at MAY 12, 1998 10:37 AM
    Total number of users = 4,  number of processes = 14
 Username     Node     Interactive  Subprocess   Batch
 S_SKONETSKI BBBBBB            1
 WISNIEWSKI  XXXXXX            4         2
 HIBBITS     AAAAAA            1         4
 VAXMAN      AAAAAA            2

The SHOW USERS command in this example displays the user names and node names of all current interactive, subprocess, and batch users on the system.

#2
$ SHOW USERS/NOHEADING/OUTPUT=SYSUSERS.DAT $ TYPE SYSUSERS.DAT S_SKONETSKI BBBBBB 1 WISNIEWSKI XXXXXX 4 2 HIBBITS AAAAAA 1 4 VAXMAN AAAAAA 2

The SHOW USERS command in this example displays the user names and node names of all current interactive, subprocess, and batch users on the system without the heading text using the /NOHEADING qualifier. Using the /OUTPUT qualifier, you can write the output to a file for processing or later review.

#3
$ SHOW USERS LES OpenVMS User Processes at MAY 12, 1998 10:41 AM Total number of users = 3, number of processes = 10 Username Node Interactive Subprocess Batch THALES MILETS - - 1 PRAXITELES LESBOS 5 2 PERICLES ISLAND 1

$ SHOW USERS *LES*
      OpenVMS User Processes at MAY 12, 1998 10:41 AM
    Total number of users = 3,  number of processes = 10
  
 Username     Node     Interactive  Subprocess   Batch
 THALES      MILETS            -         -          1
 PRAXITELES  LESBOS            5         2
 PERICLES    ISLAND            1

The SHOW USERS command in this example displays the user name and node names of all users whose user names contain the string LES.

#4
$ SHOW USERS/FULL/NODE=AAAAAA OpenVMS User Processes at JUNE 9, 1998 02:23 PM Total number of users = 3, number of processes = 3 Username Node Process Name PID Terminal DJONES AAAAAA Aaaaaa_fta2: 2180012D FTA2: MJOHNSON AAAAAA MJOHNSON 2180011E RTA1: (JJJJJ::MJOHNSON) SMITH AAAAAA SMITH 2180011A FTA1: <LOGIN> B4B4 _WSA1 3100009F

$ SHOW USERS/FULL/NODE=AAAAAA
      OpenVMS User Processes at JUNE 9, 1998 02:23 PM
    Total number of users = 3,  number of processes = 3
 Username    Node   Process Name    PID     Terminal
 DJONES     AAAAAA  Aaaaaa_fta2:  2180012D  FTA2:
 MJOHNSON   AAAAAA  MJOHNSON      2180011E  RTA1:   (JJJJJ::MJOHNSON)
 SMITH      AAAAAA  SMITH         2180011A  FTA1:
<LOGIN> B4B4    _WSA1         3100009F

The SHOW USERS command in this example displays the user name, the local node, the process name, the process identification (PID) number, the terminal names (both virtual and physical), and port information for all interactive, subprocess, and batch users on system AAAAAA. A user name of <LOGIN> indicates that someone is in the process of logging in.

#5
$ SHOW USERS /NODE=(AAAAAA,BBBBBB,MMMMMM) OpenVMS User Processes at JUNE 9, 1998 02:23 PM Total number of users = 5, number of processes = 7 Username Node Process Name PID Terminal BRICKLEY BBBBBB BRICKLEY 21E0009E RTA1: (CBREEZ::BRICKLEY) DCLDCT MMMMMM Mmmmmm_rta1: 2020015D RTA1: (MMMMMM::DJOHNSON) DJOHNSON AAAAAA Aaaaaa_fta2: 2180012D FTA2: DJOHNSON MMMMMM Mmmmmm_fta1: 2020013E FTA1: DJOHNSON MMMMMM Mmmmmm_rta3: 20200184 RTA3: (DDRSND::DJOHNSON) JONES AAAAAA JONES 2180011E RTA1: (IVOK::JONES) SMITH AAAAAA SMITH 2180011A FTA1:

$ SHOW USERS /NODE=(AAAAAA,BBBBBB,MMMMMM)
      OpenVMS User Processes at JUNE 9, 1998 02:23 PM
    Total number of users = 5,  number of processes = 7
 Username    Node   Process Name    PID     Terminal
 BRICKLEY   BBBBBB  BRICKLEY      21E0009E  RTA1:  (CBREEZ::BRICKLEY)
 DCLDCT     MMMMMM  Mmmmmm_rta1:  2020015D  RTA1:  (MMMMMM::DJOHNSON)
 DJOHNSON   AAAAAA  Aaaaaa_fta2:  2180012D  FTA2:                    
 DJOHNSON   MMMMMM  Mmmmmm_fta1:  2020013E  FTA1:                    
 DJOHNSON   MMMMMM  Mmmmmm_rta3:  20200184  RTA3:  (DDRSND::DJOHNSON)
 JONES      AAAAAA  JONES         2180011E  RTA1:  (IVOK::JONES)     
 SMITH      AAAAAA  SMITH         2180011A  FTA1:

The SHOW USERS command in this example displays the user name and node name for all interactive, batch, and subprocess users on the nodes AAAAAA, BBBBBB, and MMMMMM.

SHOW WORKING_SET

On Alpha, displays the working set limit, quota, and extent (in pagelets and CPU-specific pages) assigned to the current process.
On VAX, displays the working set limit, quota, and extent (in pages) assigned to the current process.

Format

SHOW WORKING_SET

Parameters

None.

Qualifier

/OUTPUT[=filespec]

/NOOUTPUT
Controls where the output of the command is sent. If you do not enter the qualifier, or if you enter the /OUTPUT qualifier without a file specification, the output is sent to the current process default output stream or device, identified by the logical name SYS$OUTPUT.
If you enter the /OUTPUT qualifier with a partial file specification (for example, specifying only a directory), SHOW is the default file name and LIS the default file type. The asterisk (*) and the percent sign (%) wildcard characters are not allowed in the file specification.
If you enter the /NOOUTPUT qualifier, output is suppressed.

Examples

#1
$ SHOW WORKING_SET Working Set (pagelets) /Limit= 2000 /Quota= 4000 /Extent= 6000 Adjustment enabled Authorized Quota= 4000 Authorized Extent= 6000 Working Set (8Kb pages) /Limit= 125 /Quota= 250 /Extent= 375 Authorized Quota= 250 Authorized Extent= 375

$ SHOW WORKING_SET
Working Set (pagelets)  /Limit= 2000  /Quota= 4000 /Extent= 6000
Adjustment enabled  Authorized Quota= 4000  Authorized Extent= 6000
 
Working Set (8Kb pages) /Limit= 125   /Quota= 250  /Extent= 375
                    Authorized Quota= 250  Authorized Extent= 375

This example shows the SHOW WORKING_SET command on Alpha. The process has a working set limit of 2000 pagelets (125 pages) and a quota of 4000 pagelets (250 pages) and that the current quota is equal to the authorized limit (4000 pagelets; 250 pages). It also shows that the current process has a working set extent of 6000 pagelets (375 pages) and that the current extent is equal to the authorized limit (6000 pagelets; 375 pages). A pagelet is 512 bytes.

#2
$ SHOW WORKING_SET Working Set /Limit= 180 /Quota= 350 /Extent=1200 Adjustment enabled Authorized Quota= 350 Authorized Extent=1200

This example shows the SHOW WORKING_SET command on VAX. The process has a working set limit of 180 pages, a quota of 350 pages and that the quota is equal to the authorized limit (350 pages). It also shows that the current process has a working set extent of 1200 and that the current extent is equal to the authorized limit (1200). Each page on a VAX is 512 bytes.

SHOW ZONE

Displays the current state of a VAXft system. For more information on the SHOW ZONE command, see VAXft systems documentation.
Applies only to a VAXft system.

Format

SHOW ZONE [zone-id]

SORT

Invokes the Sort/Merge utility, which reorders the records in a file into a defined sequence and creates either a new file of the reordered records or an address file by which the reordered records can be accessed.
For more information about the Sort/Merge utility, refer to the OpenVMS User's Manual or online help.

Format

SORT input-filespec[,...] output-filespec

SPAWN

Creates a subprocess of the current process. Portions of the current process context are copied to the subprocess.
The RESOURCE_WAIT state is required to spawn a process. Requires TMPMBX (temporary mailbox) or PRMMBX (permanent mailbox) privilege. The SPAWN command does not manage terminal characteristics. The SPAWN and ATTACH commands cannot be used if your terminal has an associated mailbox.

Format

SPAWN [command-string]

Parameter

command-string
Specifies a command string of less than 132 characters that is to be executed in the context of the created subprocess. When the command completes execution, the subprocess terminates and control returns to the parent process. If both a command string and the /INPUT qualifier are specified, the specified command string executes before additional commands are obtained from the /INPUT qualifier.

Description

The SPAWN command creates a subprocess of your current process with the following attributes copied from the parent process:

All global symbols except $RESTART, $SEVERITY, $STATUS
All local symbols defined for the current command procedure level
Key definitions
The current keypad state
The current prompt string
All process logical names and logical name tables except those explicitly marked CONFINE or those created in executive or kernel mode
Default disk and directory
Current SET MESSAGE settings
Current process privileges
Control and verification states

Note that some attributes, such as the process's current command tables, are not copied.
When the subprocess is created, the process-permanent open files and any image or procedure context are not copied from the parent process. The subprocess is set to command level 0 (DCL level with the current prompt).
If you do not specify the /PROCESS qualifier, the name of this subprocess is composed of the same base name as the parent process and a unique number. For example, if the parent process name is SKONETSKI, the subprocess name can be SKONETSKI_1, SKONETSKI_2, and so on.
The LOGIN.COM file of the parent process is not executed for the subprocess because the context is copied separately, allowing quicker initialization of the subprocess. When the /WAIT qualifier is in effect, the parent process remains in hibernation until the subprocess terminates or returns control to the parent by way of the ATTACH command.
More than one process simultaneously attempts to use the same input or output stream in the following circumstances:

When several processes share that stream and you terminate a subprocess to which you are not currently attached.
When you terminate a process that is not spawned from the process to which you are currently attached.

You should use the LOGOUT command to terminate the subprocess and return to the parent process. You can also use the ATTACH command to transfer control of the terminal to another process in the subprocess tree, including the parent process. (The SHOW PROCESS/SUBPROCESSES command displays the processes in the subprocess tree and points to the current process.)

Note
Because a tree of subprocesses can be established using the SPAWN command, you must be careful when terminating any process in the tree. When a process is terminated, all subprocesses below that point in the tree are terminated automatically.

Qualifiers used with the SPAWN command must directly follow the command verb. The command string parameter begins after the last qualifier and continues to the end of the command line.

Qualifiers

/CARRIAGE_CONTROL

/NOCARRIAGE_CONTROL
Determines whether carriage-return and line-feed characters are prefixed to the subprocess's prompt string. By default, SPAWN copies the current setting of the parent process.
/CLI=cli-filespec

/NOCLI
Specifies the name of a command language interpreter (CLI) to be used by the subprocess. The default CLI is the same as the parent process (defined in SYSUAF). If you specify the /CLI qualifier, the attributes of the parent process are copied to the subprocess.
The CLI you specify must be located in SYS$SYSTEM and have the file type EXE.
/INPUT=filespec
Specifies an input file containing one or more DCL commands to be executed by the spawned subprocess. The file type defaults to .COM. The asterisk (*) and the percent sign (%) wildcard characters are not allowed in the file specification. Once processing of the input file is complete, the subprocess is terminated. If both a command string and the /INPUT qualifier are specified, the specified command string executes before additional commands are obtained from the /INPUT qualifier. If neither is specified, SYS$INPUT is assumed (in which case a SPAWN/NOWAIT command is aborted if Ctrl/Y is pressed to abort something running in your parent process).
You cannot explicitly specify non-record-oriented, process-permanent files (NRO PPFs) with the /INPUT qualifier. The system displays an error message when it encounters such a file as the value for the /INPUT qualifier.
Note that when NRO PPFs are used as implicit input (that is, the /INPUT qualifier is not specified and SYS$INPUT is a NRO PPF), the SPAWN command can succeed, as shown in the following table:

Process Type SYS$INPUT Implicit Input

Interactive NRO PPF SYS$COMMAND

Noninteractive NRO PPF Null device

Any Any other SYS$INPUT

Previous Next Contents Index

privacy and legal statement

9996PRO_072.HTML

CLEAR_SCREEN	Clears the screen before each page is displayed.
SCROLL	Displays information one line at a time.
SAVE[= n]	Enables screen navigation of information, where n is the number of pages to store.

Process Type	SYS$INPUT	Implicit Input
Interactive	NRO PPF	SYS$COMMAND
Noninteractive	NRO PPF	Null device
Any	Any other	SYS$INPUT