Without the /BATCH qualifier the /USERNAME qualifier specifies the user under which the command should be executed. This qualifier (without /BATCH) causes the /MOVE qualifier to be assumed by default.

Note that the use of this qualifier requires the CMKRNL privilege.

/VERIFY

/NOVERIFY (Default)

By default, the command is not verified.

/VARIANT=var-ltr

/VERSION=vsn-cod

/WAIT/NOWAIT

Used in conjunction with the /SUBPROCESS qualifier, this qualifier is similar to using the DCL SPAWN/WAIT qualifier.

Used in conjunction with the /BATCH qualifier, this qualifier is similar to using the DCL SYNCHRONIZE command.

This qualifier is ignored when used with the /INTERACTIVE and /DETACHED qualifiers.

/WINDOW

Examples

$ HOME
  DISK_USER5:[JONES_AB] 
$ DO/APPLICATION=FIN/ENVIRONMENT=DEV SHOW LOGICAL CMS$LIB
  DISK_DEV7:[FIN.WRK.JONES_AB] 
  Executing application FIN in DEV's ENTER.COM 
   "CMS$LIB" = "FIN_SRC_ROOT:[CMSLIB]" (LNM_FIN_DEV) 
  Executing application FIN in DEV's EXIT.COM 
  DISK_USER5:[JONES_AB] 
  Executing user JONES_AB's HOME.COM 
$
      

Note that the /MOVE qualifier was not explicitly used. It was assumed by default because of the presence of the /APPLICATION and /ENVIRONMENT qualifiers.

Converts multiple spaces in the source file into the appropriate number of tabs and spaces in the destination file.

Format

ENTAB source-file-spec[,...] dest-file-spec

Parameters

source-file-spec

The file specification of the source file from which to remove spaces.

dest-file-spec

The optional file specification of the destination file to produce. By default, the a new version of the source file is generated.

See Also

• DETAB

Examples

$ ENTAB EXAMPLE.TXT EXAMPLE.SRC
      

This command generates a file EXAMPLE.SRC which is the same as EXAMPLE.TXT except that multiple spaces are converted into tabes.

Changes the process context to the users home area including executing appropriate DCL procedures.

Description

The HOME convenience command is equivalent to:

CONTEXT HOME

See CONTEXT for more details.

Invokes the INTTOOLS utility.

Format

INTTOOLS [sub-command]

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

Adds a new object.

Format

INTTOOLS ADD OBJECT object-code

Parameters

object-code

Specifies the name or other unique identification of an object.

If the object code starts with the hash symbol (#), the remaining characters are interpreted as the object unqiue ID in hexadecimal form.

If the object code starts with the caret symbol (^), the remaining characters are interpreted as the object unique ID in decimal check-digit form.

Qualifiers

/CLASS=class-name

Specifies the class which the object is a member of.

By default, the class name is empty, and no objects will be added. Consequentially, the /CLASS qualifier should be specified.

/CONTEXT=(keyword=value,,,)

Specifies the context in which the command should execute.

By default the current context is assumed.

See the UTLTOOLS FETCH SUBCONTEXT command for more details about the keywords and their values.

/DESCRIPTION=text

Specifies the description to be used in any messages generated.

By default, the description is empty, and messages will have less meaning.

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

/ID=object-id

Specifies the unique ID of the object.

By default, a unique ID is automatically generated and associated with the new object.

/LOG (default)

/NOLOG

Specifies whether to log problems when adding the objects.

By default, /LOG is assumed.

/OCCLUDE (default)

/NOOCCLUDE

Specifies whether scope occlusion should be used when search for objects.

By default, occlusion is applied.

/PROPERTIES=(property-name[,...])

/NOPROPERTIES

Specifies which properties should be added when adding the object.

By default, the property list is taken from the class_FLD symbol. If neither of the /PRPOERTIES or /NOPROPERTIES qualifiers are specified, and the class_FLD symbol is not defined, an error will be generated.

/SCOPE=scope-name

Specifies the scope of the object.

The scope name is one of:

• CLUSTER
• COMPUTER_NODE
• CONTEXT
• GROUP
• IMAGE
• JOB
• NETWORK
• PROCEDURE
• PROCESS
• SECURITY_DOMAIN
• SCRIPT
• SITE
• SWDATABASE
• SYSTEM
• THREAD
• TUNING_DOMAIN
• USER

By default, the natural or occluded scope is used.

If the /CONTEXT qualifier is used, /SCOPE=CONTEXT must also be applied. If the /SCOPE=SWDATABASE qualifier is used, /SWDATABASE qualifier must also be applied.

/SWDATABASE=file-spec

Specifies the INFO file of an alternative SysWorks database.

By default, the system SysWorks database is used.

Description

The INTTOOLS ADD OBJECT command adds a new object.

Examples

$ INTTOOLS ADD OBJECT JONES_AB/CLASS=USER/DESCRIPTION="application"
      

Adds a new USER object.

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

The INTTOOLS ATTACH and INTTOOLS 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

INTTOOLS 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 INTTOOLS 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

$ INTTOOLS ATTACH JONES_2
      

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

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

Defines a key to execute a command. This enables you to press a key to enter a command instead of typing the command name.

Format

INTTOOLS DEFINE/KEY key-name "string"

Parameters

key-name

Specifies the name of the key you are defining. Use the following key names when defining keys:

Key Name	VT100	VT52	LK201
PF1	PF1	red key	PF1
PF2	PF2	blue key	PF2
PF3	PF3	black key	PF3
PF4	PF4	-	PF4
KP0, KP1-KP9	keypad 0-9	keypad 0-9	keypad 0-9
Period	period key	period key	period key
Comma	comma key	comma key	comma key
Minus	minus key	minus key	minus key
Enter	ENTER key	ENTER key	ENTER key
E1,E2	-	-	Find,Insert Here
E3,E4	-	-	Remove,Select
E5	-	-	Previous Screen
E6	-	-	Next Screen
Help,Do	-	-	Help(15), Do(16)
F17-F20	-	-	Function Keys

Note You cannot redefine the arrow keys or the function keys F1 to F14.

"string"

Specifies the string you want entered when you press the defined key. "String" can be a INTTOOLS command, for example, DIRECTORY or SET FILE.

Qualifiers

/ECHO

/NOECHO

Specifies whether the command line is visible on the screen after you press the defined key. You cannot define a key specifying both the /NOECHO and /NOTERMINATE qualifiers. The default qualifier is /ECHO.

/IF_STATE=state_list

/NOIF_STATE

Specifies a list of states, any one of which must be set in order to enable the specified key definition. If you omit or negate this qualifier, the current state prevails.

States are used to increase the number of key definitions available on your terminal. The same key can be assigned any number of definitions as long as each definition is associated with a different state. State names can be any alphanumeric string.

/LOCK_STATE

/NOLOCK_STATE

Retains the state specified by the /SET_STATE qualifier until you use the /SET_STATE qualifier again to change it. The default qualifier is /NOLOCK_STATE.

States are used to increase the number of key definitions available on your terminal. The same key can be assigned any number of definitions as long as each definition is associated with a different state. State names can be any alphanumeric string.

/LOG

/NOLOG

Specifies whether informational messages are displayed. These messages signal successfully created key definitions. The default qualifier is /LOG.

/SET_STATE=state

/NOSET_STATE

Associates a state with the key you are defining. A state name can be any alphanumeric string. If you omit or negate this qualifier, the current state remains unchanged. You cannot define a key specifying both the /SET_STATE and /TERMINATE qualifiers.

States are used to increase the number of key definitions available on your terminal. The same key can be assigned any number of definitions as long as each definition is associated with a different state.

/TERMINATE

/NOTERMINATE (default)

Determines whether the specified command string executes when you press the key. When you use the /NOTERMINATE qualifier, you must press the Return key to execute the command string. You cannot define a key specifying both the /SET_STATE and /TERMINATE qualifiers.

Examples

INTTOOLS> DEFINE/KEY PF1 "DIRECTORY"
      

This example shows how to define the keypad key PF1 as the DIRECTORY command. To enter the DIRECTORY command, press PF1 followed by the Return key.

INTTOOLS> DEFINE/KEY KP6 "EDIT" /TERMINATE
      

This example shows how to define the keypad key 6 (KP6) as the EDIT command. The /TERMINATE qualifier causes the EDIT command to execute when you press KP6; you do not have to press the Return key.

INTTOOLS> DEFINE/KEY PF2 "SET "/SET_STATE=ALTERED
INTTOOLS> DEFINE/KEY PF3 "FILE" /IF_STATE=ALTERED /TERMINATE
      

In this example, the PF2 key is defined as the SET command, with the state name ALTERED. Then, the PF3 key is defined to output the string FILE when the state ALTERED is specified.

The /TERMINATE qualifier is used to end the command line. When you specify the /TERMINATE qualifier, you can avoid pressing the Return key to execute the command line. After you define PF2 and PF3, you can use them together. Press PF2 to produce the first half of the command line (SET) and press PF3 to finish the command line (FILE).

INTTOOLS> DEFINE/KEY PF4 "SET " /SET_STATE=ALTERED
INTTOOLS> DEFINE/KEY KP7 "FILE" /TERMINATE /IF_STATE=ALTERED
INTTOOLS> DEFINE/KEY KP8 "FORWARD" /TERMINATE /IF_STATE=ALTERED
INTTOOLS> DEFINE/KEY KP9 "WASTEBASKET" /TERMINATE /IF_STATE=ALTERED
      

This example shows how to define four different keys and associate them with a state named ALTERED:

1. The first definition defines the key PF4 as the SET command and associates this key with a state named ALTERED.
2. The second definition defines the keypad key 7 as "FILE" and makes it dependent on a state named ALTERED. When you press PF4 followed by keypad key 7, INTTOOLS executes the SET FILE command.
3. The third definition defines keypad key 8 as "FORWARD" and also makes it dependent on the ALTERED state. When you press PF4 followed by keypad key 8, INTTOOLS executes the SET FORWARD command.
4. The fourth definition defines keypad key 9 as "WASTEBASKET" and also makes it dependent on the ALTERED state. When you press PF4 followed by keypad key 9, INTTOOLS executes the SET WASTEBASKET command.

Exits the INTTOOLS utility. You can also exit from INTTOOLS by pressing [Ctrl/Z].

Format

INTTOOLS EXIT

Parameters

None.

Qualifiers

None.

Enables you to obtain information about the INTTOOLS utility.

To obtain information about all of the INTTOOLS commands, enter the following command:

INTTOOLS> HELP

To obtain information about individual commands or topics, enter the HELP command followed by the command or topic name.

Format

INTTOOLS HELP topic

Parameters

topic

Indicates a topic about which you want information. To display the list of available topics, enter the HELP command at the INTTOOLS> prompt.

Qualifiers

None.

Generates a list of names.

Format

INTTOOLS LIST OBJECT [object-code]

Parameters

object-code

Specifies the name or other unique identification of an object.

If the object code starts with the hash symbol (#), the remaining characters are interpreted as the object unqiue ID in hexadecimal form.

If the object code starts with the caret symbol (^), the remaining characters are interpreted as the object unique ID in decimal check-digit form.

If a name is specified, it is treated as an abbreviation.

Qualifiers

/CLASS=class-name

Specifies the class which the object is a member of.

By default, the class name is empty, and no objects will be listed. Consequentially, the /CLASS qualifier should be specified.

/CONTEXT=(keyword=value,,,)

Specifies the context in which the command should execute.

By default the current context is assumed.

See the UTLTOOLS FETCH SUBCONTEXT command for more details about the keywords and their values.

/CONVERT=option

/NOCONVERT (default)

Specifies that the object name listed should have a conversion applied.

Option	Usage
PREFIX	Prefix the object name with its parent's name and an underscore.
SUFFIX	Suffix the object name with a period and its parent's name.

By default, no conversion is applied to the object name.

/DESCRIPTION=text

Specifies the description to be used in any messages generated.

By default, the description is empty, and messages will have less meaning.

/FORMAT=option

Specifies the format of the generated output. See the examples below for more details.

Option	Usage
C_HEADER	Generate a complete C header file with the calss name, object name and internal ID.
MENU	Generate a simple list of object names with a simple heading.

By default, /FORMAT=MENU is assumed.

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

/HEADING (default)

/NOHEADING

Specifies whether a heading should be included in the list.

By default, a heading is includes.

/LOCAL (Default)

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

/LOG (default)

/NOLOG

Specifies whether to log problems when listing the objects.

By default, /LOG is assumed.

/OCCLUDE (default)

/NOOCCLUDE

Specifies whether scope occlusion should be used when search for objects.

By default, occlusion is applied.

/OUTPUT[=output-file-spec]

/NOOUTPUT

Specifies the output file specification for the command.

By default, /OUTPUT=SYS$OUTPUT is assumed. The /NOOUTPUT qualifier means that no output will be produced by the command.

/SCOPE=scope-name

Specifies the scope of the object.

The scope name is one of:

• CLUSTER
• COMPUTER_NODE
• CONTEXT
• GROUP
• IMAGE
• JOB
• NETWORK
• PROCEDURE
• PROCESS
• SECURITY_DOMAIN
• SCRIPT
• SITE
• SWDATABASE
• SYSTEM
• THREAD
• TUNING_DOMAIN
• USER

By default, the natural or occluded scope is used.

If the /CONTEXT qualifier is used, /SCOPE=CONTEXT must also be applied. If the /SCOPE=SWDATABASE qualifier is used, /SWDATABASE qualifier must also be applied.

/STATUS=symbol-name

/NOSTATUS (default)

Specifies an alternative status symbol.

By default, the status of the command is logged and returned to DCL in the $STATUS symbol, and any DCL error handling is applied.

If an alternative status symbol is specified, the status is returned in that symbol and a success is returned to DCL in the $STATUS symbol, an no DCL error habndling will occur.

The scope of the alternative status symbol is controlled by the /GLOBAL and /LOCAL qualifiers.

/SWDATABASE=file-spec

Specifies the INFO file of an alternative SysWorks database.

By default, the system SysWorks database is used.

/SYMBOL=symbol-name

/NOSYMBOL (default)

Specifies that the object names should be placed as a comma separated list in a symbol of the indicated name.

By default, the object names are listed in the generated report.

The /SYMBOL qualifier effectively makes the /OUTPUT and /FORMAT qualifiers unnecessary, as no output will be generated.

Description

The INTTOOLS LIST OBJECT command generates a simple list of objects.

This commands is used in menus in response to the [Find] key.

Examples

$ INTTOOLS LIST OBJECT SW/CLASS=APPL/DESCRIPTION="application"
List for application 
SWADM 
SWDBA 
SWDEV 
SWDOC 
SWEXA 
SWINT 
SWPUB 
SWRK 
SWWWW 
      

Generates a list of application objects matching the abbreviation SW.

$ INTTOOLS LIST OBJECT/CLASS=MCIM/FORMAT=C_HEADER-
_$ /DESCRIPTION="meta class implementation"
/* 
**++ 
** 
**  Include source: 
**      SWRK_MCIM_DEF.H 
** 
**  Purpose: 
**      Definitions for meta class implementation static meta class 
** 
**  Copyright: 
**      Copyright © 2004 Corpita Pty Ltd 
**      15 Bedford Street, Collingwood 3066, Australia 
** 
**  History: 
**      24-APR-2004 by SLJ 
**          Generated version 
** 
**-- 
*/ 
 
#ifndef __swrk_MCIM_def 
 
#define MCIM$C_DUAL                            0x00003311 
#define MCIM$C_EXTERNAL                        0x0000330E 
#define MCIM$C_INTERNAL                        0x0000330F 
#define MCIM$C_SCOPE                           0x00003310 
 
#define __swrk_MCIM_def 1 
 
#endif
      

Generates a C header file which defines the objects of the MCIM class.