Updated: 11 December 1998

OpenVMS DCL Dictionary

Terminates an interactive terminal session.

Format

LOGOUT

Description

You must use the LOGOUT command to end a terminal session. Under most circumstances, if you turn the power off at your terminal or hang up your telephone connection without using the LOGOUT command, you remain logged in.

When you use the SET HOST command to log in to a remote processor, you generally need to use the LOGOUT command to end the remote session.

Qualifiers

/BRIEF

Prints a brief logout message (process name, date, and time) or a full logout message (a brief message plus accounting statistics).

/FULL

Requests the long form of the logout message. When you specify the /FULL qualifier, the command interpreter displays a summary of accounting information for the terminal session. The default qualifier for a batch job is /FULL.

/HANGUP

/NOHANGUP

Determines, for dialup terminals, whether the phone hangs up whenever you log out. By default, the setting of the /HANGUP qualifier for your terminal port determines whether the line is disconnected. Your system manager determines whether you are permitted to use this qualifier.

Examples

$ LOGOUT
  MACKRILL    logged out at 14-DEC-1998 17:48:56.73
      

In this example, the LOGOUT command uses the default brief message form. No accounting information is displayed.

$ LOGOUT/FULL
  MACKRILL    logged out at 14-DEC-1998 14:23:45.30
Accounting information:
Buffered I/O count:       22     Peak working set size:     90
Direct I/O count:         10     Peak virtual size:         69
Page faults:              68     Mounted volumes:            0
Charged CPU time: 0 00:01:30.50  Elapsed time:      0 04:59:02.63
Charged vector CPU time: 0 00:00:21.62
 
      

In this example, the LOGOUT command with the /FULL qualifier displays a summary of accounting statistics for the terminal session.

Invokes the VAX MACRO assembler to assemble one or more assembly language source files (the default on VAX) or invokes the MACRO-32 compiler for OpenVMS Alpha to compile VAX assembly language source files into native OpenVMS Alpha object code (the default on Alpha).

The /ALPHA qualifier causes the MACRO command to invoke the MACRO-64 assembler if it is installed on Alpha.

The /MIGRATION qualifier causes the MACRO command to invoke the compiler on Alpha.

Format

MACRO filespec[,...]

Parameter

filespec[,...]

Specifies an assembly language source file to be assembled. If you specify more than one file, separate the file specifications with either commas (,) or plus signs (+). File specifications separated by commas cause the MACRO assembler to produce an object file (and, if indicated, a listing file) for each specified file. File specifications separated by plus signs are concatenated into one input file and produce a single object file (and listing file).

You cannot include the asterisk (*) and the percent sign (%) wildcard characters in a file specification. For each file specification, the MACRO command supplies a default file type .MAR or .MAR64. The MACRO assembler creates output files of one version higher than the highest version existing in the target directory.

Description

The MACRO command invokes the VAX MACRO assembler to assemble one or more assembly language source files (the default on VAX) or invokes the MACRO-32 compiler for OpenVMS Alpha to compile VAX assembly language source files into native OpenVMS Alpha object code (the default on Alpha).

The qualifiers to the MACRO command serve as either command (global) qualifiers or positional qualifiers. A command qualifier affects all the files specified in the MACRO command. A positional qualifier affects only the file that it qualifies. All MACRO qualifiers except the /LIBRARY and /UPDATE qualifiers are usable as either command or positional qualifiers. The /LIBRARY and /UPDATE qualifiers are positional qualifiers only.

See the qualifier descriptions for restrictions.

For a complete functional description of the VAX MACRO assembler directives, refer to the VAX MACRO and Instruction Set Reference Manual. For a complete functional description of the MACRO-32 compiler for OpenVMS Alpha, refer to Porting VAX MACRO Code to OpenVMS Alpha.

Qualifiers

/ALPHA

The /ALPHA qualifier cannot be used with the /UPDATE qualifier.

On Alpha, invokes the MACRO-64 assembler for OpenVMS Alpha (if installed on the system). For a description of the assembler, refer to the MACRO--64 Assembler for OpenVMS AXP Systems Reference Manual.

/ANALYSIS_DATA[=filespec]

/NOANALYSIS_DATA (default)

Controls whether the VAX MACRO assembler creates an analysis data file for the OpenVMS Source Code Analyzer (SCA), and optionally provides the file specification.

By default, the assembler does not create an analysis data file. If you specify the /ANALYSIS_DATA qualifier without a file specification, the assembler creates a file with the same file name as the first input file for the MACRO command. The default file type for analysis data files is .ANA. When you specify the /ANALYSIS_DATA qualifier, you can control the defaults applied to the output file specification by the placement of the qualifier in the command line.

/CROSS_REFERENCE[=(function[,...])]

/NOCROSS_REFERENCE (default)

Controls whether a listing is produced of the locations in the source file where the specified function (or functions) is defined or referenced. If you specify only one function, you can omit the parentheses.

You can specify the following functions:

ALL	Cross-references directives, macros, operation codes, registers, and symbols
DIRECTIVES	Cross-references directives
MACROS	Cross-references macros
OPCODES	Cross-references operation codes
REGISTERS	Cross-references registers
SYMBOLS	Cross-references symbols

Because the assembler writes the cross-references to the listing file, you must specify the /LIST qualifier with the /CROSS_REFERENCE qualifier. If you specify no functions in the /CROSS_REFERENCE qualifier, the assembler assumes the default value of /CROSS_REFERENCE=(MACROS,SYMBOLS). The /NOCROSS_REFERENCE qualifier excludes the cross-reference listing.

/DEBUG[=option]

/NODEBUG (default)

Includes or excludes local symbols in the symbol table or traceback information in the object module. You can replace the /ENABLE and /DISABLE qualifiers with the /DEBUG and /NODEBUG qualifiers when you use the appropriate DEBUG and TRACEBACK options. The /DEBUG or the /NODEBUG qualifier overrides debugging characteristics set with the .ENABLE or .DISABLE assembler directives.

You can specify one or more of the following options:

ALL	Includes in the object module all local symbols in the symbol table, and provides all traceback information for the debugger. This option is equivalent to /ENABLE=(DEBUG,TRACEBACK).
NONE	Makes local symbols and traceback information in the object module unavailable to the debugger. This option is equivalent to /DISABLE=(DEBUG,TRACEBACK).
SYMBOLS	Makes all local symbols in the object module available to the debugger. Makes traceback information unavailable to the debugger. This option is equivalent to /ENABLE=DEBUG and /DISABLE=TRACEBACK together.
TRACEBACK	Makes traceback information in the object module available to the debugger and local symbols unavailable to the debugger. This option is equivalent to /ENABLE=TRACEBACK and /DISABLE=DEBUG together.

If you specify no options to the /DEBUG qualifier, it assumes the default value of /DEBUG=ALL.

/DIAGNOSTICS[=filespec]

/NODIAGNOSTICS (default)

Creates a file containing assembler messages and diagnostic information. If you omit the file specification, the default file name is the same as the source program; the default file type is DIA.

The asterisk (*) and the percent sign (%) wildcard characters are not allowed in the file specification.

The diagnostics file is reserved for use with Compaq layered products, such as the VAX Language-Sensitive Editor (LSE).

/DISABLE=(function[,...])

/NODISABLE

Provides initial settings for the functions disabled by the .DISABLE assembler directive. You can specify one or more of the following functions:

ABSOLUTE	Assembles relative addresses as absolute addresses.
DEBUG	Includes local symbol table information in the object file for use with the debugger.
GLOBAL	Assumes undefined symbols to be external symbols.
SUPPRESSION	Suppresses listing of unreferenced symbols in the symbol table.
TRACEBACK	Provides traceback information to the debugger.
TRUNCATION	Truncates floating-point numbers (if truncation is disabled, numbers are rounded).
VECTOR	Enables the assembler to accept and correctly process vector code.

If you specify only one function, you can omit the parentheses. If you specify no functions in the /DISABLE qualifier, it assumes the default value of /DISABLE=(ABSOLUTE,DEBUG, TRUNCATION, VECTOR). The /NODISABLE qualifier has the same effect as not specifying the /DISABLE qualifier, or negates the effects of any /DISABLE qualifiers specified earlier in the command line.

/ENABLE=(function[,...])

/NOENABLE

Provides initial settings for the functions controlled by the .ENABLE assembler directive. You can specify one or more of the following functions:

ABSOLUTE	Assembles relative addresses as absolute addresses.
DEBUG	Includes local symbol table information in the object file for use with the debugger.
GLOBAL	Assumes undefined symbols to be external symbols.
SUPPRESSION	Suppresses listing of unreferenced symbols in the symbol table.
TRACEBACK	Provides traceback information to the debugger.
TRUNCATION	Truncates floating-point numbers (if truncation is disabled, numbers are rounded).
VECTOR	Enables the assembler to accept and correctly process vector code.

The /NOENABLE qualifier has the same effect as not specifying the /ENABLE qualifier, or negates the effects of any /ENABLE qualifiers specified earlier in the command line. You can specify one or more of the functions listed in the description of the /DISABLE qualifier. If you specify only one function, you can omit the parentheses. If you specify no functions in the /DISABLE qualifier, it assumes the default value of /ENABLE=(GLOBAL,TRACEBACK,SUPPRESSION).

/LIBRARY

/NOLIBRARY

Positional qualifier. The /LIBRARY qualifier cannot be used with the /UPDATE qualifier.

The associated input file to the /LIBRARY qualifier must be a macro library. The default file type is MLB. The /NOLIBRARY qualifier has the same effect as not specifying the /LIBRARY qualifier, or negates the effects of any /LIBRARY qualifiers specified earlier in the command line.

The assembler can search up to 16 libraries, one of which is always STARLET.MLB. This number applies to a particular assembly, not necessarily to a particular MACRO command. If you enter the MACRO command so that more than one source file is assembled, but the source files are assembled separately, you can specify up to 16 macro libraries for each separate assembly. More than one macro library in an assembly causes the libraries to be searched in reverse order of their specification.

A macro call in a source program causes the assembler to begin the following sequence of searches:

1. An initial search of the libraries specified with the .LIBRARY directive. The assembler searches these libraries in the reverse order of that in which they were declared.
2. If the macro definition is not found in any of the libraries specified with the .LIBRARY directive, a search of the libraries specified in the MACRO command line (in the reverse order in which they were specified).
3. If the macro definition is not found in any of the libraries specified in the command line, a search of STARLET.MLB.

/LIST[=filespec]

/NOLIST

Creates or omits an output listing, and optionally provides an output file specification for it. The default file type for the listing file is LIS. The asterisk (*) and the percent sign (%) wildcard characters are not allowed in the file specification.

An interactive MACRO command does not produce a listing file by default. The /NOLIST qualifier, present either explicitly or by default, causes errors to be reported on the current output device.

The /LIST qualifier is the default for a MACRO command in a batch job. The /LIST qualifier allows you to control the defaults applied to the output file specification by the placement of the qualifier in the command line. For more information on entering output file qualifiers, refer to the OpenVMS User's Manual.

/MIGRATION

The /MIGRATION qualifier cannot be used with the /UPDATE qualifier.

On Alpha, invokes the MACRO-32 compiler for OpenVMS Alpha to compile one or more VAX MACRO assembly language source files into native OpenVMS Alpha object code.

For a complete description of the MACRO-32 compiler for OpenVMS Alpha, refer to Porting VAX MACRO Code to OpenVMS Alpha.

/OBJECT[=filespec]

/NOOBJECT

Creates or omits an object module. It also defines the file specification. By default, the assembler creates an object module with the same file name as the first input file. The default file type for object files is OBJ. The asterisk (*) and the percent sign (%) wildcard characters are not allowed in the file specification.

The /OBJECT qualifier controls the defaults applied to the output file specification by the placement of the qualifier in the command line. For more information on entering output file qualifiers, refer to the OpenVMS User's Manual.

/PREPROCESS_ONLY[=filespec]

/NOPREPROCESS (D)

Causes the assembler to perform only the actions of the preprocessor phase and writes the resulting processed text out to a file.

The filespec defaults to the name of the primary source file. The default file type is .ASM.

/SHOW[=(function[,...])]

/NOSHOW[=(function[,...])]

Provides initial settings for the functions controlled by the assembler directives .SHOW and .NOSHOW.

You can specify one or more of the following functions:

CONDITIONALS	Lists unsatisfied conditional code associated with .IF and .ENDC MACRO directives.
CALLS	Lists macro calls and repeat range expansions.
DEFINITIONS	Lists macro definitions.
EXPANSIONS	Lists macro expansions.
BINARY	Lists binary code generated by the expansion of macro calls.

If you specify more than one function, separate each with a comma and enclose the list in parentheses. If you specify no functions in the /SHOW qualifier, it increments the listing level count; the /NOSHOW qualifier decrements the count in similar circumstances. Because these qualifiers contribute to the listing file, you must also specify the /LIST qualifier when you use them. If you do not specify the /SHOW qualifier, the MACRO command assumes a default of /SHOW=(CONDITIONALS,CALLS,DEFINITIONS). If you specify only one function, you can omit the parentheses.

/UPDATE[=(update-filespec[,...])]

/NOUPDATE

Positional qualifier. The /UPDATE qualifier cannot be used with the /ALPHA, the /LIBRARY, or the /MIGRATION qualifier.

Updates the input file it qualifies by using the SUMSLP batch editor and the specified update file or files. By default, the assembler assumes that the update file has the same file name as the input source file and a file type of UPD. You cannot include the asterisk (*) and the percent sign (%) wildcard characters in the file specifications. If it cannot find a specified update file, the assembler prints an informational message and continues the assembly.

If you specify only one update file, you can omit the parentheses. If you specify more than one update file, the assembler merges the contents into a single list of updates before applying the updates to the source file.

The /NOUPDATE qualifier has the same effect as not specifying the /UPDATE qualifier, or negates any /UPDATE qualifiers specified earlier in the command line. The input source file and update files are not changed by the update operation. The effects of the update appear in the compiled output. If you specify the /LIST qualifier with the /UPDATE qualifier, the assembler writes an audit trail of the changes to the listing file.

Examples

$ MACRO/LIST  CYGNUS, LYRA/OBJECT=LYRAN + MYLIB/LIBRARY
      

In this example, the MACRO command requests two separate assemblies. Using MAR as the default file type, MACRO assembles CYGNUS.MAR to produce CYGNUS.LIS and CYGNUS.OBJ. Then it assembles LYRA.MAR and creates a listing file named LYRA.LIS and an object module named LYRAN.OBJ. The default output file type for a listing is LIS.

The command requests the search of the MYLIB library file in the current directory for macro definitions.

$ MACRO  ORION
      

MACRO assembles the file ORION.MAR and creates an object file named ORION.OBJ. Executing the command in a batch job causes MACRO to create a listing file named ORION.LIS.

$ MACRO  ALPHA/LIST+MYLIB/LIBRARY-
_$ + [TEST]OLDLIB/LIBRARY + []BETA
$ PRINT ALPHA
      

MACRO concatenates the files ALPHA.MAR and BETA.MAR to produce an object file named ALPHA.OBJ and a listing file named ALPHA.LIS. The command line requests the search of libraries MYLIB.MLB (in the current default directory) and OLDLIB.MLB (in the directory [TEST]) for macro definitions. When macro calls are found in BETA.MAR, MACRO searches the libraries OLDLIB, MYLIB, and the system library STARLET.MLB, in that order, for the definitions.

The PRINT command prints the listing file ALPHA.LIS.

$ MACRO  DELTA+TESTLIB/LIBRARY, ALPHA+MYLIB/LIBRARY
      

MACRO requests two separate assemblies. MACRO searches TESTLIB.MLB and the system library STARLET.MLB for macro definitions when macro calls are found in DELTA.MAR, and searches MYLIB.MLB and the system library STARLET.MLB for macro definitions when macro calls are found in ALPHA.MAR.

Invokes the Mail utility, which is used to send messages to other users of the system.

For more information about the Mail utility, refer to the OpenVMS User's Manual or online help.

Format

MAIL [filespec] [recipient-name]

Invokes the Sort/Merge utility, which combines 2 to 10 similarly sorted input files and creates a single output file. Note that input files to be merged must be in sorted order.

For more information about the Sort/Merge utility, refer to the OpenVMS User's Manual or online help.

Format

MERGE input-filespec1,input-filespec2[,...] output-filespec

Invokes the Message utility, which compiles one or more files of message definitions.

For more information about the Message utility, refer to the OpenVMS Command Definition, Librarian, and Message Utilities Manual or online help.

Format

MESSAGE filespec[,...]

Invokes the Monitor utility, which monitors classes of systemwide performance data at a specified interval.

For more information about the Monitor utility, refer to the OpenVMS System Management Utilities Reference Manual or online help.

Format

MONITOR [/qualifier[,...]] classname[,...] [/qualifier[,...]]

Invokes the Mount utility, which makes a disk or magnetic tape volume available for processing.

For more information about the Mount utility, refer to the OpenVMS System Management Utilities Reference Manual or online help.

Format

MOUNT device-name[:][,...] [volume-label[,...]] [logical-name[:]]

Copyright © Compaq Computer Corporation 1998. All rights reserved. Legal

9996PRO_037.HTML