Display the SYSTOOLS utility version.

Format

SYSTOOLS SHOW VERSION

Examples

$ SYSTOOLS SHOW VERSION
  SysWorks Version V3.4
      

Creates a subprocess of the current process. The context of the subprocess is copied from the current process. You can use the SPAWN command to leave the SYSTOOLS utility temporarily, perform other functions (such as displaying a directory listing or printing a file), and then return to SYSTOOLS.

Note that this command is only available for users with DCL access.

Format

SYSTOOLS SPAWN [command]

Parameters

command

Specifies the DCL command string that executes in the context of the created subprocess. When the command completes, the subprocess terminates and control is returned to the parent process. If this parameter is not specified, a subprocess is created that transfers control to DCL command level.

Qualifiers

/INPUT=file-spec

Specifies an input file containing one or more DCL command strings to be executed by the spawned subprocess. If you specify a command string along with an input file, the command string is processed before the commands in the input file. Once processing is complete, the subprocess is terminated.

/LOGICAL_NAMES

/NOLOGICAL_NAMES

Specifies that the logical names of the parent process are to be copied to the subprocess. When you do not want the subprocess to use the logical names of the parent process, enter the qualifier /NOLOGICAL_NAMES. The default is /LOGICAL_NAMES.

/OUTPUT=file-spec

Identifies the output file to which the results of the SPAWN operation are written. Whenever you use the /NOWAIT qualifier, you should also use the /OUTPUT qualifier to specify a new output destination. Doing so prevents output from being displayed while you are specifying new commands. If you omit the /OUTPUT qualifier, output is written by default to the current SYS$OUTPUT device.

/PROCESS=subprocess-name

Specifies the name of the subprocess to be created. The default name of the subprocess is USERNAME_n. If the subprocess name contains spaces or special characters, or is case-sensitive, then the subprocess name must be enclosed in quotation marks.

/SYMBOLS

/NOSYMBOLS

Determines whether the system passes DCL global and local symbols to the subprocess. The default is /SYMBOLS.

/WAIT/NOWAIT

Controls whether the system waits until the subprocess is completed before allowing more commands to be specified. The /NOWAIT qualifier allows you to specify new commands while the specified subprocess is running. If you specify /NOWAIT, you should also use the /OUTPUT qualifier to direct the output stream to a file, rather than displaying it on your terminal. Doing so prevents your terminal from being used by more than one process simultaneously.

Examples

SYSTOOLS> SPAWN SHOW TIME
      

This example shows how to create a subprocess that executes the DCL command SHOW TIME while you are using SYSTOOLS utility.

SYSTOOLS> SPAWN /NOLOGICAL_NAMES SET HOST
_Node: MARS 
   .
   .
   .
$ LOGOUT
CRAMMER logged out at ... 
 
%REM-S-END, control returned to node _BETA:: 
 
SYSTOOLS>
      

This example shows how to use the SPAWN command to create a subprocess in which you SET HOST to another node. When you want to leave node MARS and move back to node BETA, enter the DCL command LOGOUT. The /NOLOGICAL_NAMES qualifier prevents the logical names of the parent process from being copied to the subprocess.

Examples

$ SYSTOOLS FORCE/EXIT/IDENTIFICATION=%X20200123
      

This command forces an exit on the current image for the process with a PID of 20200123.

Executes a command in a network context on the specified nodes.

The TELL convenience command is equivalent to:

DO/LOG/REMOTE=

See DO for more details.

Invokes the SysWorks menu system.

Format

TOOLS [sub-command [...]]

At the menu selection prompt, special commands may be entered. Normally these special commands may be directly entered, but if a command being entered conflicts with any of the selection codes on the current menu, it needs to be preceded with a dollar ($) sign. Unambiguous abbreviations are permitted.

Additionally the following characters or keys may be used in place of some commands:

Key	Command
[F10]	EXIT
[Help]	HELP
[Prev]	UP or PREVIOUS
[Next]	DOWN
[Ctrl/W]	REFRESH
[Ctrl/Z]	EXIT
@	EXECUTE
0	TOP
-	PREVIOUS

The following sections provide information about each of the commands which can be selected from the SysWorks menu system.

Transfers control from your current process (which then hibernates) to the specified process.

The ATTACH and SPAWN commands cannot be used if your terminal has an associated mailbox.

Note that this command is only available for users with DCL access.

Format

ATTACH [process-name]

Parameters

process-name

Specifies the name of a parent process or spawned subprocess to which control passes. The process must already exist, be part of your current job, and share the same input stream as your current process. However, the process cannot be your current process or a subprocess created with the /NOWAIT qualifier.

Process names can contain from 1 to 15 alphanumeric characters. If a connection to the specified process cannot be made, an error message is displayed.

Exactly one of the process-name parameter or /IDENTIFICATION or /PARENT qualifiers must be specified. No combinations are allowed.

Qualifiers

/IDENTIFICATION=pid

Specifies the process identification (PID) of the process to which terminal control will be transferred. Leading zeros can be omitted.

Exactly one of the process-name parameter or /IDENTIFICATION or /PARENT qualifiers must be specified. No combinations are allowed.

/PARENT

Indicates that you want to attach to the parent process of your current process. If you did not access the utility by using the SPAWN command, an error message is displayed.

Exactly one of the process-name parameter or /IDENTIFICATION or /PARENT qualifiers must be specified. No combinations are allowed.

Examples

$  ATTACH JONES_2
      

The ATTACH command transfers the terminal's control to the subprocess JONES_2.

> ATTACH/IDENTIFICATION=30019
      

The ATTACH command switches control from the current process to a process having the PID 30019. Notice that because the /IDENTIFICATION qualifier is specified, the process-name parameter is omitted.

Execute the remainder of the command line as a DCL command.

Note that this command is only available for users with DCL access.

Display the next page of a multi-page menu. Note that the [Next] key may be used in place of the DOWN command.

Exit the current command level. If the current command level is the terminal then if we previously came from an EXECUTEd command level, then proceed as per the PREVIOUS command, otherwise proceed as per the EXIT command. If the current command level is an EXECUTEd command procedure, close the current command level, and proceed with task or menu selections. Note that if the current menu was entered with an entry selection (i.e. no selection has been made from the terminal, rather a selection was passed down from the previous menu level), then as per single command mode, the menu system will unwind back to the selection menu.

Execute the command procedure specified as an argument. Note that the "@" sign may be used in place of the EXECUTE command.

Exit the menu sub-system completely by unwinding through the previous menus and exiting back through all the command levels. Note that a numeric selection 0, the [Exit] key (i.e. [F10] or [Ctrl/Z] may be used in place of the EXIT command.

Invokes the help on menuing. Same as HELP TOOLS.

Turns off DCL verification on the menu sub-system.

Terminates your interactive terminal session.

Go back to the previous menu. Note that the "-" sign may be used in place of the PREVIOUS command. The [Prev] key may also be used if the menu page being displayed is the first or only page of the menu ([Prev] with the second or subsequent pages is interpreted as an UP command).

Re-display the current menu. Note that [Ctrl/W] may be used in place of the REFRESH command.

Creates a subprocess of the current process. The context of the subprocess is copied from the current process. You can use the SPAWN command to leave the utility temporarily, perform other functions (such as displaying a directory listing or printing a file), and then return to .

Note that this command is only available for users with DCL access.

Format

SPAWN [command]

Parameters

command

Specifies the DCL command string that executes in the context of the created subprocess. When the command completes, the subprocess terminates and control is returned to the parent process. If this parameter is not specified, a subprocess is created that transfers control to DCL command level.

Qualifiers

/INPUT=file-spec

Specifies an input file containing one or more DCL command strings to be executed by the spawned subprocess. If you specify a command string along with an input file, the command string is processed before the commands in the input file. Once processing is complete, the subprocess is terminated.

/LOGICAL_NAMES

/NOLOGICAL_NAMES

Specifies that the logical names of the parent process are to be copied to the subprocess. When you do not want the subprocess to use the logical names of the parent process, enter the qualifier /NOLOGICAL_NAMES. The default is /LOGICAL_NAMES.

/OUTPUT=file-spec

Identifies the output file to which the results of the SPAWN operation are written. Whenever you use the /NOWAIT qualifier, you should also use the /OUTPUT qualifier to specify a new output destination. Doing so prevents output from being displayed while you are specifying new commands. If you omit the /OUTPUT qualifier, output is written by default to the current SYS$OUTPUT device.

/PROCESS=subprocess-name

Specifies the name of the subprocess to be created. The default name of the subprocess is USERNAME_n. If the subprocess name contains spaces or special characters, or is case-sensitive, then the subprocess name must be enclosed in quotation marks.

/SYMBOLS

/NOSYMBOLS

Determines whether the system passes DCL global and local symbols to the subprocess. The default is /SYMBOLS.

/WAIT/NOWAIT

Controls whether the system waits until the subprocess is completed before allowing more commands to be specified. The /NOWAIT qualifier allows you to specify new commands while the specified subprocess is running. If you specify /NOWAIT, you should also use the /OUTPUT qualifier to direct the output stream to a file, rather than displaying it on your terminal. Doing so prevents your terminal from being used by more than one process simultaneously.

Examples

> SPAWN SHOW TIME
      

This example shows how to create a subprocess that executes the DCL command SHOW TIME while you are using utility.

> SPAWN /NOLOGICAL_NAMES SET HOST
_Node: MARS 
   .
   .
   .
$ LOGOUT
CRAMMER logged out at ... 
 
%REM-S-END, control returned to node _BETA:: 
 
>
      

This example shows how to use the SPAWN command to create a subprocess in which you SET HOST to another node. When you want to leave node MARS and move back to node BETA, enter the DCL command LOGOUT. The /NOLOGICAL_NAMES qualifier prevents the logical names of the parent process from being copied to the subprocess.

Go back to the entry menu. Note that numeric selection 0 may be used in place of the TOP command.

Go back to the previous menu, do not re-display the menu, and use the previous command line as the default selection line. This function is used to deal with invalid and ambiguous selections which were passed from a previous menu level.

Display the previous page of a multi-page menu. Note that the [Prev] key may be used in place of the UP command.

Turns on DCL verification on the menu sub-system. This is intended only as a development aid for the writers of the menu sub-system.

Show the current version of the utilities.

Set the terminal width to the indicated value. The value must be present and be 80 or 132.

Execute a DCL write command. This is useful in menu scripts to display messages to the output log file.

Note that this command is only available for users with DCL access.

Format

WIDTH { 80 | 132 }

Invokes the test control menu if DEC Test Manager (DTM) is present and licensed.

Format

TSTCTL [sub-command]

The following sections provide information about each of the tasks which can be selected from the test control menu.

Invokes the change control menu.

See CHGCTL for more details.

Format

TSTCTL CHGCTL

Create a test.

Delete an existing test.

Invoke the DCL DIRECTORY command.

Invokes DTM directly. This is used when there is no replacement TSTCTL command.

Playback a test.

Record an new test.

Rename an existing test.

Display a listing of tests.

Invokes the source control menu and CMS front end.

See SRCCTL for more details.

Format

TSTCTL SRCCTL

Invokes the version control menu.

See VSNCTL for more details.

Format

TSTCTL VSNCTL

Invokes the UTLTOOLS utility.

Format

UTLTOOLS [sub-command]

This section provides information about each of the subcommands you can use with the UTLTOOLS command.

Adds a check digit to a number.

Format

UTLTOOLS ADD/CHECK_DIGIT number

Parameters

number

The number for which to calculate and add a check digit.

Description

The UTLTOOLS ADD/CHECK_DIGIT command adds a check digit to a number and displays the original number and the new number with the added check digit.

Qualifiers

/GLOBAL

Specifies that the symbol be placed in the global symbol table. If you do not specify the /GLOBAL qualifier, the symbol is placed in the local symbol table.

/LOCAL (Default)

Specifies that the symbol be placed in the local symbol table for the current command procedure.

/SYMBOL=symbol-name

/NOSYMBOL (default)

Specifies the name of a symbol to which the resultant number with check digit is written.

By default, no symbol is written.

Examples

$ UTLTOOLS ADD/CHECK_DIGIT 19318
  Number = 19318, Number_CD = 193185 
      

Adds a maximum page number to one or more files.

Format

UTLTOOLS ADD/PAGE_NUMBER filespec[,...] max-page-number

Parameters

filespec[,...]

Specifies the names of one or more files to add a maximum page number to. The first file specification must contain an explicit or default directory specification plus an explicit file name, file type, and version number. Subsequent file specifications need contain only a version number; the defaults will come from the preceding specification. The asterisk (*) and the percent sign (%) wildcard characters can be used in any of the file specification fields.

If you omit the directory specification or device name, the current default device and directory are assumed.

If the file specification contains a null version number (a semicolon (;) followed by no file version number), a version number of 0, or one or more spaces in the version number, the maximum page number is added to the latest version of the file.

To generate the cheksum of more than one file, separate the file specifications with either commas (,) or plus signs (+).

max-page-number

Specifies the maximum page number to be added to the file.

Qualifiers

/BACKUP

Modifies the time value specified with the /BEFORE or /SINCE qualifier. /BACKUP selects files according to the dates of their most recent backups. This qualifier is incompatible with the other qualifiers that also allow you to select files according to time attributes: /CREATED, /EXPIRED and /MODIFIED. If you specify none of these four time qualifiers, the default is /CREATED.

/BEFORE[=time]

Selects only those files dated prior to the specified time. You can specify time as an absolute time, as a combination of absolute and delta times, or as one of the following keywords: TODAY (default), TOMORROW, or YESTERDAY. Specify one of the following qualifiers with /BEFORE to indicate the time attribute to be used as the basis for selection: /BACKUP, /CREATED (default), /EXPIRED or /MODIFIED.

See the OpenVMS DCL Concepts Manual for complete information on specifying time values.

/BY_OWNER[=uic]

Selects only those files whose owner user identification code (UIC) matches the specified owner UIC. The default UIC is that of the current process.

Specify the UIC using standard UIC format as described in the OpenVMS DCL Concepts Manual.

/CONFIRM

/NOCONFIRM (default)

Controls whether a request is issued before each add a maximum page number operation to confirm that the operation should be performed on that file. The following responses are valid:

YES NO QUIT TRUE FALSE [Ctrl/Z] 1 0 ALL [Return]

You can use any combination of uppercase and lowercase letters for word responses. Word responses can be abbreviated to one or more letters (for example, T, TR, or TRU for TRUE), but these abbreviations must be unique. Affirmative answers are YES, TRUE, and 1. Negative answers include: NO, FALSE, 0, and pressing the Return key. Entering QUIT or pressing Ctrl/Z indicates that you want to stop processing the command at that point. When you respond by entering ALL, the command continues to process, but no further prompts are given. If you type a response other than one of those in the list, DCL issues an error message and redisplays the prompt.

/CREATED

Modifies the time value specified with the /BEFORE or /SINCE qualifier. /CREATED selects files based on their dates of creation. This qualifier is incompatible with the other qualifiers that also allow you to select files according to time attributes: /BACKUP, /EXPIRED and /MODIFIED. If you specify none of these four time qualifiers, the default is /CREATED.

/EXCLUDE=(file-spec[,...])

Excludes the specified files from the add a maximum page number operation. You can include a directory but not a device in the file specification. Wildcard characters are allowed in the file specification. However, you cannot use relative version numbers to exclude a specific version. If you provide only one file specification, you can omit the parentheses.

/EXPIRED

Modifies the time value specified with the /BEFORE or /SINCE qualifier. /EXPIRED selects files according to their expiration dates. (The expiration date is set with the SET SECURITY/EXPIRED command.) The /EXPIRED qualifier is incompatible with the other qualifiers that also allow you to select files according to time attributes: /BACKUP, /CREATED and /MODIFIED. If you specify none of these four time qualifiers, the default is /CREATED.

/LOG[=(option[,...]) (default)

/NOLOG

Outputs messages to the output file depending upon the option(s) specified.

The following log options are available:

Option	Meaning
[NO]ALL	Log all information. This is the default action.
[NO]ERROR	Log errors.
[NO]NONE	Don't log any information. This is the equivalent to /NOLOG.
[NO]NOTFOUND	Log files that were not found.
[NO]SUCCESS	Log files that were added a maximum page number.

/MODIFIED

Modifies the time value specified with the /BEFORE or /SINCE qualifier. /MODIFIED selects files according to the dates on which they were last modified. This qualifier is incompatible with the other qualifiers that also allow you to select files according to time attributes: /BACKUP, /CREATED and /EXPIRED. If you specify none of these four time modifiers, the default is /CREATED.

/SELECT=(keyword[,...])

Allows you to select files based on a number of criteria. Choose one of the following keywords:

ACL NOACL	Selects files that have an associated ACL or files that do not (NOACL keyword).
ATTRIBUTES=(option[,...])	Selects files which have particular attributes. The following options are supported: Option Description [NO]BACKUP Selects files which have backups enabled (BACKUP) or disabled (NOBACKUP) LRL=MAXIMUM=size Selects files which have a longest record size less than or equal to the specified value. LRL=MINIMUM=size Selects files which have a longest record size greater than or equal to the specified value. ORG=type Selects files which have the specified organization. Valid organizations include: DIRECT INDEXED RELATIVE SEQUENTIAL RFM=type Selects files which have the specified record format. Valid record formats include: STREAM STREAMCR STREAMLF UNDEFINED VARIABLE VFC
FILE=(option[,...])	Selects portions of the file specification for display purposes. The /SELECT=FILE qualifier is used to turn off specific portions by explicit or implicit specification of the options. Possible options are: [NO]NODE [NO]DEVICE [NO]DIRECTORY [NO]NAME [NO]TYPE [NO]VERSION /SELECT=FILE qualifier cannot be used with the /FULL qualifier.
ONLINE NOONLINE	Selects files that are online or shelved.
PRESHELVED NOPRESHELVED	Selects files that are preshelved or not preshelved.
SHELVABLE NOSHELVABLE	Selects files that are shelvable or not shelvable.
SIZE=(option[,...])	Selects files according to their size. Possible options are: Option Description MAXIMUM=n Selects files that have fewer blocks than the value of n, which defaults to 1,073,741,823. Use with MINIMUM=n to specify a size range for files to be selected. MINIMUM=n Selects files that have blocks equal to or greater than the value of n. Use with MAXIMUM=n to specify a size range for files to be selected. (MINIMUM=n, MAXIMUM=n) Selects files whose block size falls within the specified MINIMUM and MAXIMUM range.

/SINCE=[time]

Selects only those files dated after the specified time. You can specify time as an absolute time, a combination of absolute and delta times, or as one of the following keywords: TODAY (default), TOMORROW, or YESTERDAY. Specify one of the following qualifiers with /BEFORE to indicate the time attribute to be used as the basis for selection: /BACKUP, /CREATED (default), /EXPIRED or /MODIFIED.

---

Previous

Next

Contents

Index