Display the INTTOOLS utility version.

Format

INTTOOLS SHOW VERSION

Examples

$ INTTOOLS 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 INTTOOLS utility temporarily, perform other functions (such as displaying a directory listing or printing a file), and then return to INTTOOLS.

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

Format

INTTOOLS 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

INTTOOLS> SPAWN SHOW TIME
      

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

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

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.

Defines a library logical name, and ensures uniqueness within an appropriate context. Library logical names have the format of HLP$LIBRARY[_seq] and LNK$LIBRARY[_seq], where the search order is controlled by the sequence number. Note that the first sequence number is blank, the second is _1, the third _2 and so on.

Format

LIBRINS file-spec[/qualifiers]

Parameters

file-spec

File-spec Specifies the file specification of the library to define a logical name for.

Qualifiers

/APPLICATION

Specifies that the logical name should be placed into the current application environment logical name table. Uniqueness is ensured across the LNM$GROUP logical name table search list.

/GROUP

Specifies that the logical name should be placed into the current group logical name table. Uniqueness is ensured across the LNM$GROUP logical name table search list.

/HELP

Specifies that the default file type is .HLB and hence the default logical name prefix is HLP$LIBRARY.

/IMAGE

Specifies that the default file type is .OLB and hence the default logical name prefix is LNK$LIBRARY.

/JOB

Specifies that the logical name should be placed into the job logical name table. Uniqueness is ensured across the LNM$JOB logical name table search list.

/LINK

Specifies that the default file type is .OLB and hence the default logical name prefix is LNK$LIBRARY.

/OBJECT

Specifies that the default file type is .OLB and hence the default logical name prefix is LNK$LIBRARY.

/PROCESS

Specifies that the logical name should be placed into the process logical name table. Uniqueness is ensured across the LNM$PROCESS logical name table search list.

/SYSTEM

Specifies that the logical name should be placed into the system logical name table. Uniqueness is ensured across the LNM$SYSTEM logical name table search list.

/TABLE

Specifies that the logical name should be placed into the indicated logical name table. Uniqueness is ensured across the LNM$GROUP logical name table search list.

/USER

Specifies that the logical name should be placed into the users logical name table. Uniqueness is ensured across the LNM$GROUP logical name table search list.

Examples

{system-prompt}
{user-response}
      

Invokes the MAILBOX utility command.

The MAILBOX commands perform the following functions:

• Create a mailbox (see /CREATE).
• Delete a mailbox (see /DELETE).
• Read a message form a mailbox (see /READ).
• Rewrite existing messages in a mailbox (see /REWRITE).
• Write a message to a mailbox (see /WRITE).

Format

MAILBOX/qualifier mbx-spec

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

Create a mailbox.

Format

MAILBOX/CREATE logical-name

Parameters

logical-name

Specifies the logical name to be defined with an equivalence of the mailbox device name.

Qualifiers

/ERROR=label

Transfers control to the location specified by the label keyword (in the current command procedure) when a create error occurs. If no error routine is specified and an error occurs during the creation of the mailbox, the current ON condition action is taken.

Overrides any ON condition action specified.

If an error occurs and the target label is successfully given control, the reserved global symbol $STATUS retains the error code.

/EXECUTIVE_MODE

Creates an executive-mode mailbox and logical name.

Requires SYSNAM (system logical name) privilege to create an executive-mode mailbox.

/SUPERVISOR_MODE

Creates a supervisor-mode mailbox and logical name.

/USER_MODE (default)

Creates a user-mode mailbox and logical name.

Examples

$ MAILBOX/CREATE CMD_MBX
      

Delete a mailbox.

Format

MAILBOX/DELETE mailbox

Parameters

mailbox

Specifies the mailbox which will be deleted.

Qualifiers

/ERROR=label

Transfers control to the location specified by the label keyword (in the current command procedure) when a delete error occurs. If no error routine is specified and an error occurs during the deletion of the mailbox, the current ON condition action is taken.

Overrides any ON condition action specified.

If an error occurs and the target label is successfully given control, the reserved global symbol $STATUS retains the error code.

Examples

$ MAILBOX/DELETE CMD_MBX
      

Read a message form a mailbox.

Format

MAILBOX/READ mailbox symbol-name

Parameters

mailbox

Specifies the mailbox from which a message will be read.

symbol-name

Specifies a 1- through 255-alphanumeric character symbol name to be equated to the contents of the message being read. A symbol name must start with an alphabetic letter, underscore, or dollar sign.

By default, the MAILBOX/READ command places the symbol name in the local symbol table for the current command level. See the /GLOBAL and /LOCAL qualifiers for more details.

If the symbol is already defined, the MAILBOX/READ command redefines it to the new value being read.

Qualifiers

/ERROR=label

Transfers control to the location specified by the label keyword (in the current command procedure) when a read error occurs. If no error routine is specified and an error occurs during the reading of the mailbox, the current ON condition action is taken.

Overrides any ON condition action specified.

If an error occurs and the target label is successfully given control, the reserved global symbol $STATUS retains the error code.

/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.

/WAIT

Specifies that MAILBOX/READ waits until there is something to read in the mailbox.

Examples

$ MAILBOX/READ CMD_MBX CMD_LIN
      

Write an expression and then rewrite existing messages in a mailbox.

To write a symbol value, see MAILBOX/REWRITE/SYMBOL.

Format

MAILBOX/REWRITE mailbox expression

Parameters

mailbox

Specifies the mailbox from which messages will be read and rewritten to.

expression

Qualifiers

/ERROR=label

Transfers control to the location specified by the label keyword (in the current command procedure) when a rewrite error occurs. If no error routine is specified and an error occurs during the rewriting of the mailbox, the current ON condition action is taken.

Overrides any ON condition action specified.

If an error occurs and the target label is successfully given control, the reserved global symbol $STATUS retains the error code.

Examples

$ MAILBOX/REWRITE CMD_MBX "$ DIRECTORY"
      

Write a symbol value and then rewrite existing messages in a mailbox.

Format

MAILBOX/REWRITE/SYMBOL mailbox symbol

Parameters

mailbox

Specifies the mailbox from which messages will be read and rewritten to.

symbol

Specifies the name of a symbol whose value is to be written to the mailbox before the rewritten records.

Qualifiers

/ERROR=label

Transfers control to the location specified by the label keyword (in the current command procedure) when a rewrite error occurs. If no error routine is specified and an error occurs during the rewriting of the mailbox, the current ON condition action is taken.

Overrides any ON condition action specified.

If an error occurs and the target label is successfully given control, the reserved global symbol $STATUS retains the error code.

Examples

$ MAILBOX/REWRITE/SYMBOL CMD_MBX CMD_LIN
      

Write an expression to a mailbox.

To write a symbol value, see MAILBOX/WRITE/SYMBOL.

Format

MAILBOX/WRITE mailbox expression...

Parameters

mailbox

Specifies the mailbox to which the value of the expression will be written.

expression

Qualifiers

/ERROR=label

Transfers control to the location specified by the label keyword (in the current command procedure) when a write error occurs. If no error routine is specified and an error occurs during the writing of the mailbox, the current ON condition action is taken.

Overrides any ON condition action specified.

If an error occurs and the target label is successfully given control, the reserved global symbol $STATUS retains the error code.

/WAIT

Examples

$ MAILBOX/WRITE CMD_MBX "$ DIRECTORY"
      

Write a symbol value to a mailbox.

Format

MAILBOX/WRITE/SYMBOL mailbox expression...

Parameters

mailbox

Specifies the mailbox to which the value of the symbol will be written.

symbol

Specifies the name of the symbol whose value is to be written to the mailbox.

Qualifiers

/ERROR=label

Transfers control to the location specified by the label keyword (in the current command procedure) when a write error occurs. If no error routine is specified and an error occurs during the writing of the mailbox, the current ON condition action is taken.

Overrides any ON condition action specified.

If an error occurs and the target label is successfully given control, the reserved global symbol $STATUS retains the error code.

/WAIT

Examples

$ MAILBOX/WRITE/SYMBOL CMD_MBX CMD_LIN
      

Invokes the SysWorks menu system.

Format

MENU [sub-command [...]]

Description

The MENU command invokes the SysWorks menu system in context sensitive mode.

If no context menu can be found, this command has the same effect as the TOOLS command.

See Also

TOOLS , TOOLS Commands

The NETTERM convenience command is equivalent to:

DO/INTERACTIVE/TERMINAL/WINDOW/REMOTE=

See DO for more details.

Reduces the size of a log file by creating an error file which contains only lines related to errors in the log file.

Format

REDUCE log-file-spec[,...] error-file-spec

Parameters

log-file-spec

The file specification of the log file to reduce.

error-file-spec

The optional file specification of the error file to produce. By default, SYS$DISK:[].ERR is assumed.

Examples

$ REDUCE BUILD
      

This command reduces the text in BUILD.LOG to only errors in BUILD.ERR.

The RW convenience command is equivalent to:

DO/WINDOW/REMOTE=

See DO for more details.

The RWI convenience command is equivalent to:

DO/INTERACTIVE/WINDOW/REMOTE=

See DO for more details.

The RWX convenience command is equivalent to:

DO/LOG/WINDOW/REMOTE=

See DO for more details.

Invokes the Server Control Utility (SCU).

Format

SCU [sub-command]

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

Exits the server control utility.

Format

SCU EXIT

Provides help from the server control utility.

Format

SCU HELP [server-command]

Parameters

server-command

The SCU command on which help is required.

Resumes a suspended server.

Format

SCU RESUME SERVER server-name

Parameters

server-name

The name of the server on which to perform the operation. Valid server names are from 1 to 31 characters from the symbol name character set.

Examples

$ SCU RESUME SERVER SWRK_NET_SERVER
      

This SCU RESUME SERVER command resumes operation of the SWRK_NET_SERVER server process.

Sets details about a running or suspended server.

Format

SCU SET SERVER server-name

Parameters

server-name

The name of the server on which to perform the operation. Valid server names are from 1 to 31 characters from the symbol name character set.

Examples

$ SCU SET SERVER SWRK_NET_SERVER
      

This SCU SET SERVER command sets details of the SWRK_NET_SERVER server process.

Shows details about one or more servers.

Format

SCU SHOW SERVER server-name

Parameters

server-name

The name of the server on which to perform the operation. Valid server names are from 1 to 31 characters from the symbol name character set.

Examples

$ SCU SHOW SERVER SWRK_NET_SERVER
      

This SCU SHOW SERVER command shows details about the SWRK_NET_SERVER server process.