# Compaq ACMS for OpenVMS
Managing Applications

Previous | Contents | Index

# Chapter 24
SWLUP Commands

This chapter contains reference information and examples for the ACMS Software Event Log Utility Program (SWLUP) commands. See Chapter 13 for general information about SWLUP.

# @ (At sign) Command (SWLUP>)

> Runs an indirect command file that contains SWLUP commands.

## Format

> @file-spec

## Privileges Required

> None

## Parameters

> ### file-spec

> The name of a command file for SWLUP to run. Use a standard OpenVMS file specification. If you do not include the directory in the file specification, SWLUP searches your current directory by default. SWLUP uses SYS$DISK:[].COM as the default file type.

## Notes

> SWLUP runs all commands stored in the command file you specify. SWLUP sends your reports to the default output device SYS$OUTPUT.

> You must use the SET VERIFY command before SWLUP can display commands in the indirect command file. Errors are reported on SYS$OUTPUT and on SYS$ERROR if SYS$ERROR is different from SYS$OUTPUT.

## Example

    SWLUP> @REPORT

> SWLUP runs the file REPORT.COM, which contains the commands to list all today's events.

# EDIT Command (SWLUP>)

> Lets you edit the last SWLUP command you entered and lets you create an edit buffer into which you can enter SWLUP commands.

## Format

> EDIT

## Privileges Required

> None

## Notes

> You can use the EDIT command in two ways:
> - Within SWLUP, you can type the EDIT command after you type a SWLUP command (such as SET LOG, SET NOVERIFY). SWLUP places the command in the edit buffer. You can correct or change the SWLUP command using a text editor.
> - You can type the EDIT command at the SWLUP> prompt. SWLUP then provides an edit file into which you can enter SWLUP commands with a text editor.

> When you exit the editor, SWLUP runs the commands in the file and returns to the SWLUP> prompt. If you exit the editor without creating an output file, SWLUP prints the error message %SWLUP-E-ERREDIT, does not try to run the last command, and returns to the SWLUP> prompt.

> The ACMS system startup file, ACMSTART.COM defines the system logical SWLUP$EDIT to be ACMS$EDIT. As system manager, you can define ACMS$EDIT to be TDMSEDIT.COM (which runs the TDMS text editor), ACMSEDIT.COM (which runs the EDT text editor), or a personal command procedure that invokes another text editor or a particular set of editor startup commands. When you issue the EDIT command, ACMS executes the command file pointed to by ACMS$EDIT.

##

### Examples

#1
    SWLUP> EDIT
    LIST /PROCESS_NAME=JACK_SMITH
    [Ctrl/Z]
    DBA0:[SMITH]SWLUP_C20205018.COM;1 1 LINE
    SWLUP>

> The EDIT command typed at the SWLUP> prompt displays an edit buffer into which you can enter the SWLUP commands.

#2
    SWLUP> SET NOLOG
    SWLUP> SET VERIFY
    SWLUP> EDIT
    SET VERIFY
    [Ctrl/Z]
    DBA0:[SMITH]SWLUP_C_C20203098.COM;2 1 LINE
    SWLUP>

> If you enter SWLUP commands and type the EDIT command at the SWLUP prompt, the last command you entered is placed in the edit buffer.

# EXIT Command (SWLUP>)

> Causes SWLUP to exit or ends the execution of a command file.

## Format

> EXIT

## Privileges Required

> None

## Notes

> SWLUP exits from either the utility or a command file. You can also end a SWLUP session by pressing `[Ctrl/Z]`. `[Ctrl/Z]` signals the end of the file for data entered from the terminal. `[Ctrl/Z]` is displayed as EXIT.

##

### Examples

#1
    SWLUP> EXIT
    $

> The EXIT command ends the SWLUP session and returns control to the DCL prompt.

#2
    SWLUP> @LISTIT
    SET LOG  !These lines are in the file LISTIT.COM
    SET VERIFY
    EXIT

> This command ends the processing of commands from an indirect command file and returns to the SWLUP> prompt.

# HELP Command (SWLUP>)

> Displays information about SWLUP commands and qualifiers.

## Format

> HELP [ topic [...]]

> Command Qualifier | Default
> --- | ---
> /[NO]PROMPT | /PROMPT

## Privileges Required

> None

## Parameters

> ### topic

> The SWLUP command or topic that you want to display information about. If you use the HELP command without a topic, help provides a list of topics to choose from.

## Qualifiers

> ### /[NO]PROMPT

> Determines whether or not SWLUP displays help information and then displays a prompt for a topic or subtopic. The /PROMPT qualifier is the default.

## Notes

> None

## Example

    SWLUP> HELP SET
    SET
       Determines if commands are logged to a file or whether commands from an
       indirect command file are printed to the default output device.
       Format:
           SET [NO]LOG
           SET [NO]VERIFY
     Additional information available:
     [NO]LOG     [NO]VERIFY
    SET Subtopic?

> Type Help followed by the SET command to get information about SET [NO]LOG and SET [NO]VERIFY. If you type either [NO]LOG or [NO]VERIFY at the SET Subtopic? prompt, SWLUP displays information about the qualifier you requested.

# LIST Command (SWLUP>)

> Lists information selected by command qualifiers.

## Format

> LIST [ EVENTS ]

> Command Qualifiers | Default
> --- | ---
> /BEFORE[=time] | /BEFORE=TODAY
> /EVENT_CODE=event-code[,...] | All event codes
> /FACILITY=facility-name[,...] | All facilities
> /IMAGE=image-name[,...] | All images
> /INPUT=file-spec | SYS$ERRORLOG:SWL.LOG
> /OUTPUT=file-spec | SYS$OUTPUT
> /PRINT | Does not print
> /PROCESS_NAME=process-name[,...] | All processes
> /SEVERITY=severity-code[,...] | All severity codes
> /SINCE[=time] | /SINCE=TODAY
> /USER=user-name[,...] | All user names

## Privileges Required

> None

## Qualifiers

> ### /BEFORE[=time]

> Lists only those events dated before the time you name. This qualifier and the /SINCE qualifier let you select a range of time. You need not use the qualifiers together. The format for date and time is dd-mmm-yyyy:hh:mm, which allows you to omit any of the trailing fields. You can also use the keywords TODAY or YESTERDAY to specify a time. The default is /BEFORE=TODAY. If you specify a date without a time, the time defaults to 00:00.00 for the date you specify.

> ### /EVENT_CODE=event-code[,...]

> Selects events by return status code. For example, you can list all ACMSI-F-BUGLOG errors by typing /EVENT=BUGLOG or /EVENT=(BUGLOG). Logging all events to the current log file is the default.

> ### /FACILITY=facility-name[,...]

> Selects a list of events logged by one or more facility names you specify. The only facilities that log events in the Software Event Log are ACMS and SWL. ACMS software errors are logged under the name ACMSI. Logging all events to the current log file is the default.

> ### /IMAGE=image-name[,...]

> Selects the events associated with one or more image names you specify. Logging all events to the current log file is the default. If you specify only part of an image name, SWLUP lists all images whose names contain the specified characters.

> ### /INPUT=file-spec

> Names the input log file you want to read. If you do not use the /INPUT qualifier, SWLUP uses SYS$ERRORLOG:SWL.LOG by default.

> ### /OUTPUT=file-spec

> Stores SWLUP output in a file you specify. If you do not use the /OUTPUT qualifier, SWLUP sends output to the default output device SYS$OUTPUT.

> ### /PRINT

> Prints a listing file on the system printer. If you do not use the /OUTPUT qualifier with the /PRINT qualifier, SWLUP creates a temporary listing file (SWLUPLIS.LIS) and deletes it after the file is printed. If you do not specify the /PRINT qualifier, the file is not printed.

> ### /PROCESS_NAME=process-name[,...]

> Selects all events logged with one or more process names you specify. Logging all events to the current log file is the default.

> ### /SEVERITY=severity-code[,...]

> Selects the events for a SWLUP report by the OpenVMS severity code. You can use complete severity code names or abbreviate them to the first character:
> - Success
> - Informational
> - Warning
> - Error
> - Fatal

> Logging all events to the current log file is the default.

> ### /SINCE[=time]

> Identifies only those events dated after the date and time you specify. This qualifier and the /BEFORE qualifier let you define a range of time for the events logged. The format for time is dd-mmm-yyyy:hh:mm. You can also specify the keywords TODAY or YESTERDAY. If you specify any part of the date, you must specify the full date. You can omit the time field. The default is /SINCE=TODAY.

> ### /USER=user-name[,...]

> Selects all events logged with one or more user names. Logging all events in the current log file is the default.

## Notes

> ACMS logs ACMS internal software errors and some SWL events of varying severity. For example, you might want to look at just the ACMS errors; by using this command you can create a file of just those errors.

##

### Examples

#1
    SWLUP> LIST/USER=RICH

> This command lists all events in the log file associated with the user name RICH.

#2
    SWLUP> LIST EVENTS/FACILITY=TSS/SEVERITY=F/BEFORE=09-APR-1994

> This command lists all events in the log file that are ACMS events, with an F severity code, logged before April 9, 1994.

#3
    SWLUP> LIST/PROCESS_NAME=CPPROC/OUTPUT=SEPT21.LOG

> This command lists all events in the log file associated with the process name CPPROC and places them in the output file SEPT21.LOG.

# RENEW Command (SWLUP>)

> Starts a new systemwide SWL log file.

## Format

> RENEW

## Privileges Required

> Write access to the new log file and the OpenVMS privileges TMPMBX and SYSPRV.

## Notes

> The RENEW command closes the current log file and creates a new version. The log file is called SYS$ERRORLOG:SWL.LOG.

> If an SWL log file is not already opened and you use the RENEW command, you receive an error. You can determine whether SWL is currently logging information to a log file by using the SHOW LOG command.

## Example

    SWLUP> RENEW

> Creates a new version of SYS$ERRORLOG:SWL.LOG to log subsequent events.

# SAVE Command (SWLUP>)

> Writes to a file the last command you typed.

## Format

> SAVE file-spec

## Privileges Required

> None

## Parameters

> ### file-spec

> The name of the file in which you want to save the last command. If you supply an incomplete file specification, the default disk is SYS$DISK; the default directory is your current directory; and the default file type is .SAV.

## Notes

> If the command you save is @file-spec, the contents of the file specification are also available in the target file.

## Example

    SWLUP> LIST/SEVERITY=S
    SWLUP> SAVE
    SAVE TO FILE:KEEPIT
    previous command SAVEd to file DBA0:[SMITH]KEEPIT.SAV
    SWLUP>

> Type or print the file KEEPIT.SAV to see the command you entered with the SAVE command.

# SET [NO]LOG Command (SWLUP>)

> Enables or disables creation of a log file that records your SWLUP session.

## Format

> SET [NO]LOG [ file_spec ]

## Privileges Required

> None

## Parameters

> ### file-spec

> The file specification of the log file. If you do not specify a file specification, SWLUP creates a new version of the current log file. If a current log file does not exist, SWLUP stores the information in the file SYS$DISK:[]SWLUPLOG.LOG.

## Notes

> If you do not specify a file specification and a file was previously activated by the SET LOG command, SWLUP issues a warning message. If you specify a file that contains a version number and that file already exists, SWLUP stores all new information in that file.

> The SET LOG and SET NOLOG commands are valid only within the current session. Once you exit from SWLUP, all SET [NO]LOG commands are deleted.

> If you use SET NOLOG, SWLUP does not create a file.

##

### Examples

#1
    SWLUP> SET LOG

> SWLUP automatically enables logging of all commands you enter in the session to the SWLUPLOG.LOG file or to the logical translation of SWLUPLOG.

#2
    SWLUP> SET LOG SEPT21.LOG

> This command enables logging to the SEPT21.LOG file.

# SET [NO]VERIFY Command (SWLUP>)

> Enables or disables the printing of commands stored in an indirect command file. SWLUP sends output to the default output device SYS$OUTPUT.

## Format

> SET [NO]VERIFY

## Privileges Required

> None

## Note

> The default is SET NOVERIFY. To display the commands from an indirect command file to the default output device, SYS$OUTPUT, use the SET VERIFY command.

##

### Examples

#1
    SWLUP> SET VERIFY
    SWLUP> @FIRSTLOG

> This command places SWLUP in verify mode. When you pass the command file FIRSTLOG.COM to SWLUP, it displays the commands it runs from that file.

#2
    SWLUP> SET NOVERIFY
    SWLUP> @FIRSTLOG

> This command places SWLUP in noverify mode. When you pass the command file FIRSTLOG.COM to SWLUP, it does not display the commands it runs from that file.

# SHOW CURRENT Command (SWLUP>)

> Displays the name of the current log file opened by the SWL detached process.

## Format

> SHOW CURRENT

## Privileges Required

> OpenVMS TMPMBX privilege

## Notes

> SWLUP displays the name of the current log file on SYS$OUTPUT.

## Example

    SWLUP> SHOW CURRENT
    %ACMSSWL-S-CURLOGFIL, Current log file: SYS$ERRORLOG:SWL.LOG;1

> This command displays the name of the current log file.

# SHOW LOG Command (SWLUP>)

> Displays whether or not you are currently logging SWLUP commands and the name of the log file.

## Format

> SHOW LOG

## Privileges Required

> None

## Notes

> SWLUP displays the following information:
> - The current SWLUP mode: logging or not logging
> - The name of the file to which SWLUP is logging or not logging information. The default is NOLOG.

## Example

    SWLUP> SHOW LOG
    not logging to file SWLUPLOG.LOG

> The SHOW LOG command shows you that SWLUP is not logging to the default file.

# SHOW VERSION Command (SWLUP>)

> Displays the current version of SWLUP on the default output device SYS$OUTPUT.

## Format

> SHOW VERSION

## Privileges Required

> None

## Notes

> None

## Example

    SWLUP> SHOW VERSION
    ACMS SWLUP V4.0

> This command displays the SWLUP version number.

# STOP Command (SWLUP>)

> Stops the SWL detached process so that it can exit properly.

## Format

> STOP

## Privileges Required

> OpenVMS TMPMBX and SYSPRV privileges

## Notes

> None

## Example

    SWLUP> STOP

> This command stops the SWL detached process.

Previous | Next | Contents | Index