HELP LIBRARY — MicroVMS 4.6
Creates, modifies, and examines libraries. Format LIBRARY library-file-spec [input-file-spec,...]
Additional information available:
Parameters
library-file-spec Specification of the library file. The file type defaults to OLB for object and shareable image libraries, MLB for macro libraries, HLB for help libraries, and TLB for text libraries. No wildcard characters are allowed. input-file-spec,... Specification(s) of file(s) containing modules to be added, inserted, or replaced in the library. The file type defaults to OBJ for object files, EXE for shareable image files, MAR for macro files, HLP for help files, and TXT for text files. Wildcard characters are allowed. This parameter is required with /INSERT and /REPLACE, optional with /CREATE, and otherwise invalid. You can specify SYS$INPUT to input one text module from the terminal: name the module with /MODULE; type the text of the module on lines following the command; terminate the terminal input with CTRL/Z.
Qualifiers
Additional information available:
/BEFORE/COMPRESS/CREATE/CROSS_REFERENCE/DATA
/DELETE/EXTRACT/FULL/GLOBALS/HELP/HISTORY/INSERT
/LIST/LOG/MACRO/MODULE/NAMES/OBJECT/ONLY
/OUTPUT/REMOVE/REPLACE/SELECTIVE_SEARCH/SHARE/SINCE
/SQUEEZE/TEXT/WIDTH
/BEFORE[=time]
Used with the /LIST qualifier to list only those modules with dates (creation, modification, expiration, or backup) that precede the specified time. You can specify time as an absolute time or a combination of absolute and delta times.
/COMPRESS[=(option,...)]
Creates a new library file from the current library file, recovering any space left by modules deleted from the library. The name of the new file is as specified in /OUTPUT or defaults to the next version of the current library file. The options are as follows with defaults the same as for the current library file: +-----------------+--------------------------------------------------+ | BLOCKS:blocks | Number of 512-byte blocks allocated to the new | | | library. | +-----------------+--------------------------------------------------+ | GLOBALS:symbols | Maximum number of global symbols allowed in an | | | object or shareable image library. | +-----------------+--------------------------------------------------+ | HISTORY:records | Maximum number of history records allowed in the | | | library. If this value is less than the | | | current number in the library, the oldest | | | records are deleted (only applies if KEEP is | | | specified). | +-----------------+--------------------------------------------------+ | KEEP | Saves update history records and additional | | | information in module headers. | +-----------------+--------------------------------------------------+ | KEYSIZE:size | Maximum number of characters allowed in any | | | module or global symbol name. | +-----------------+--------------------------------------------------+ | MODULES:modules | Maximum number of modules allowed in library. | +-----------------+--------------------------------------------------+
/CREATE[=(option,...)]
Creates a library file. If input-file-spec is specified (second parameter), the modules in the input file are added to the library. The options are as follows: +-----------------+--------------------------------------------------+ | BLOCKS:blocks | Number of blocks allocated to the new library. | | | Defaults to 100. | +-----------------+--------------------------------------------------+ | GLOBALS:symbols | Maximum number of global symbols allowed in an | | | object or shareable image library. Defaults to | | | 128. | +-----------------+--------------------------------------------------+ | HISTORY:records | Maximum number of history records allowed in the | | | library. Defaults to 20. | +-----------------+--------------------------------------------------+ | KEYSIZE:n | Maximum name length of modules or global | | | symbols. Defaults to 31 for object, and text | | | libraries and 15 for help modules. Maximum | | | size possible is 128. | +-----------------+--------------------------------------------------+ | MODULES:modules | Maximum number of modules allowed in the | | | library. Defaults to 512 for an object or | | | shareable image library, and 256 for all | | | others. | +-----------------+--------------------------------------------------+
/CROSS_REFERENCE[=(option,...)]
Generates a cross-reference listing file for object libraries. Name the file with /OUTPUT. The options are as follows: +---------+------------------------------------------------+ | ALL | Equivalent to (MODULE, SYMBOL, VALUE) | +---------+------------------------------------------------+ | MODULE | Lists global symbol references and | | | definitions | +---------+------------------------------------------------+ | NONE | Equivalent to not specifying /CROSS_REFERENCE | +---------+------------------------------------------------+ | SYMBOL | Lists the symbols by name; the default | +---------+------------------------------------------------+ | VALUE | Lists the symbols by value; the default | +---------+------------------------------------------------+
/DATA=keyword
Determines whether data is reduced or expanded, depending upon the specified keyword. (Both forms of /DATA perform an implicit /COMPRESS; that is, while reducing or expanding the data format, the librarian also recovers space that had been occupied by modules deleted from the library.) +---------+------------------------------------------------+ | EXPAND | Expands a reduced library | +---------+------------------------------------------------+ | REDUCE | Stores data in reduced format, requiring less | | | disk space but taking longer to access | +---------+------------------------------------------------+
/DELETE=(module,...)
Deletes the specified modules from the library. Wildcard characters are allowed.
/EXTRACT=(module,...)
Copies the specified modules into a new file. Wildcard characters are allowed. The name of the new file is as specified by /OUTPUT with a default file type of OBJ, EXE, MAR, HLP, or TXT, depending on the type of library, or is, by default, the name of the library file with the default file type.
/FULL
Gives a full description of each module listed by /LIST. When used with /HISTORY/LIST, names the modules inserted or deleted.
/GLOBALS (default)
/NOGLOBALS Includes global symbols of object modules in the global symbol table.
/HELP
/MACRO /OBJECT (default) /SHARE /TEXT Identifies the type of library.
/HISTORY
Lists history records. Valid only with /LIST. When used with /LIST/FULL, additionally lists the names of updated modules.
/INSERT
Adds the modules in the specified input file to the library. If a module being added already exists in the library, the new module is not added and an error message is issued.
/LIST[=file-spec]
/NOLIST (default) Writes header information and lists the contents of the library. The information is written to the specified file, whose file type defaults to LIS. If the file specification is omitted, the information is written to SYS$OUTPUT. If specified with other operations (for example, /DELETE, /INSERT, or /REPLACE), the listing reflects the status of the library after the other operations are performed.
/LOG
/NOLOG (default) Writes a message to SYS$OUTPUT after each operation (for example, /DELETE, /INSERT, /REMOVE, or /REPLACE) occurs.
/MACRO
See /HELP.
/MODULE=module-name
Qualifies input-file-spec Names an incoming text module. This qualifier applies only to /INSERT and /REPLACE operations on text libraries. The module name defaults to the name of the file. Incompatible with /EXTRACT, /DELETE, and /REMOVE.
/NAMES
/NONAMES (default) Lists all the global symbol names and module names in an object module library. This qualifier applies only when /LIST is specified.
/OBJECT (default)
See /HELP.
/ONLY=(module,...)
Limits a /LIST or /CROSS_REFERENCE operation to the specified modules. Wildcards are allowed.
/OUTPUT=[file-spec]
Specifies the output file specification for a /COMPRESS, /EXTRACT, or /CROSS_REFERENCE operation. The file type defaults to OLB, MLB, HLB, or TLB for /COMPRESS operations; OBJ, EXE, MAR, HLP, or TXT for /EXTRACT operations; or LIS for /CROSS_REFERENCE operations. If /OUTPUT is not specified, the default is the name of the library with the default file type. Wildcard characters are not allowed.
/REMOVE=(symbol-name,...)
Deletes the specified global symbol names from the object library. Wildcard characters are allowed.
/REPLACE (default)
Adds the modules in the specified input file to the library. If a module being added already exists in the library, the new module replaces the current module. Replace is the default librarian operation.
/SELECTIVE_SEARCH
Applies only to individual modules in object libraries. When the library is used as input to a link operation, the linker excludes global symbols not referenced by other modules from the resultant image and (if applicable) symbol table.
/SHARE
See /HELP.
/SINCE[=time]
Prints only those modules dated (creation, modification, expiration, or backup) after the specified time when used with the /LIST command. You can specify time as an absolute time or a combination of absolute and delta times.
/SQUEEZE (default)
Compresses (deletes trailing blanks, trailing tabs, and comments) macros before putting them in a macro library. Use with /CREATE, /INSERT, and /REPLACE.
/TEXT
See /HELP.
/WIDTH=number-of-characters
Specifies the screen width for listing global symbol names with /NAMES. Defaults to the width of the listing device (usually 80 for terminals and 132 for printers). The maximum allowable width is 132.