HPlogo MPE/iX Commands Reference Manual: HP 3000 MPE/iX Computer Systems > Chapter 7 Command Definitions S-SO

SETCATALOG

» 

Technical documentation

Complete book in PDF
» Feedback

 » Table of Contents

 » Index

Catalogs, or enables, the user-defined commands (UDCs) in a specified catalog file at the user, account, or system level. You can also use this command to disable all UDCs on the system. (Native Mode)

WARNING! If you do not specify a catfilename, all UDC's are disabled (deleted from the UDC directory) regardless of whether or not the ;DELETE option is used.

Use only MPE/iX flat files as UDC files. Issuing the SETCATALOG command for any other file type may cause unpredictable results.

Syntax

SETCATALOG [ catfilename[ ,catfilename, ...[ ,catfilename]]]
[ ;SHOW] [ ;SYSTEM] [ ;ACCOUNT]
[ ;USER=username[ .acctname]]
[ ;RESET][ ;APPEND][ ;DELETE]

Parameters

catfilename

The name of a file containing user-defined commands to be cataloged. Commands within the file must be separated from each other by a line whose first character is an asterisk (*).

SHOW

Specifies a listing of the user-defined commands as the UDC files are cataloged. Error messages are printed for command lines that contain any errors. This parameter is useful for locating errors in UDC files.

ACCOUNT

Specifies cataloging of the file at the account level. Using this parameter requires account manager (AM) capability.

SYSTEM

Specifies cataloging of the file at the system level. Using this parameter requires system manager (SM) capability.

USER

Allows users who have AM capability to change the UDC catalog set for users in their account. Users having SM capabilities can change the UDC catalog set for any user. USER does not rebuild an executing UDC directory, but becomes effective when the user logs off and then logs on after the command has been invoked.

RESET

Causes the file(s) being cataloged to replace all files that are already cataloged. RESET is the default if no option is specified.

APPEND

Permits the user to add UDCs to the directory. This option causes the file(s) being cataloged to be appended to the existing catalog. It also finds and makes adjustments for any logon UDCs if appropriate.

DELETE

Deletes the file(s) from the existing UDC directory. This permits the user to delete individual files from the catalog directory. The original order of the catalog is maintained. It also finds and makes adjustments for logon UDCs. The ACCOUNT and SYSTEM options allow the user to delete the cataloged file at the account or system levels. The default is user level.

Operation Notes

The SETCATALOG command allows you to catalog user-defined commands.

When you set your own UDCs, the change takes place in your UDC catalog immediately. If you specify the ACCOUNT or SYSTEM parameter, your UDC catalog is changed immediately, but other users in your account or system must log on again in order to have those changes available to them. If you set a UDC and specify another user (USER=), that user must log on again in order to have the changes available.

The ability to delete or append files is particularly useful because, although most UDC files do not change, new UDC commands are frequently added or modified. Using the DELETE or APPEND parameter allows you to make changes without incurring the overhead of recataloging the entire directory for every change. Grouping UDC files into functions further reduces the work involved in modifying UDCs.

The RECURSION option relieves the user of having to define a particular command more than once in a catalog set, and from having to maintain a particular order for commands within a catalog set. Refer to the discussion on options in "User Commands" in Using the HP 3000 Series 900: Advanced Skills.

If SETCATALOG is used in a UDC, all valid commands through and including the SETCATALOG command execute. But execution of the UDC terminates after the execution of the SETCATALOG command. Commands that follow do not execute. The SETCATALOG command does not have this effect when executed in a command file.

The SETCATALOG command may be invoked only from the logon command interpreter (user main), where it is passed through the scanner/parser. . It cannot be invoked from any other program (any child process).

Use

This command is available in a session, job, or in BREAK. It is not available from a program. Pressing Break has no effect on this command.

Examples

The following command sets the UDC directory for the user JOHN.WORKERS with the commands in the file named UDCA. The USER option cannot be specified with the ACCOUNT or SYSTEM options. Attempting to do so produces an error.

 SETCATALOG UDCA; USER=JOHN.WORKERS

The following two command sequences are equivalent:

 SETCATALOG UDCA, UDCB

SETCATALOG UDCA
SETCATALOG UDCB ;APPEND

In the first example, the command has an implied RESET, and thus overwrites the previous file set in the directory. In the second example, UDCA is entered into the directory, and then UDCB is appended to the directory without affecting UDCA. It also finds new logon commands if appropriate.

The following command deletes UDCA from the directory at the account level, provided it was cataloged at the account level. If other account-level UDCs reside in the directory along with UDCA, they remain undisturbed by this deletion. When appropriate, a new logon UDC is set up.

 SETCATALOG UDCA ;DELETE ;ACCOUNT
NOTE:

It is not a good practice to create UDC's which have the same name as other files, especially command files or any other files your users may confuse with UDC's.

If you enter a fully qualified file name that has the same name as an existing UDC, the group and account part of the fully qualified name are passed to the UDC as a parameter. For example, if COMM is a UDC, entering COMM.GROUP.ACCT will cause .GROUP.ACCT to be passed to COMM as a parameter even if COMM.GROUP.ACCT is a separate file.

Related Information

Commands

SHOWCATALOG, HELP <udcname>

Manuals

System Startup, Configuration, and Shutdown Reference Manual

Using the HP 3000 Series 900: Advanced Skills

Feedback to webmaster