Previous Topic: Example 2Next Topic: LIB/TSO Messages

LIB/TSO Interface › LIB/TSO Options

LIB/TSO Options

This section lists and describes the LIB/TSO options.

ARC

Command: LIBADD.

Specifying ARC without date or level number on a LIBADD command adds the module to the master file as an archived module. Specifying ARC in this way on a LIBEXP or LIBSAVE command creates the module as an archived module from that execution forward.

If the master file was not initialized to accept archived modules, the add or update is rejected. If you omit the ARC option from the LIBADD command, the module is added as a standard (non-archived) CA Librarian module.

ARC[(date)|(Lx)|(-y)]

Commands:

ARC with a date, date and time, relative level number, or absolute level number selects a specific level of a module for processing.

If you omit the ARC option from x and y and the module is archived, the most recent level is selected for processing.

Updates (LIBSAVE, LIBEXP) with the ARC option used in this way applies to the specified level. Any existing levels created after the specified level are deleted. The updated level becomes the new current level.

ARC(date)

Selects a specific level by the date. The level that was current on the specified date is updated. The format of the date is:

yymmddhhmmss

You can omit an even number of digits from the right. CA Librarian assumes the highest possible values for omitted digits.

For example, if you specify ARC(95), CA Librarian selects the level that was current at the end of the year on 12/31/95 at 23:59:59, and not at the beginning of the year on 01/01/95 at 00:00:00.

ARC(Lx)

Specifies the absolute level, as reported on the module listing. You can specify the absolute level up to five digits. The level number must be prefixed with the letter L.

ARC(-y)

Specifies the relative level number. The level number can be specified up to three digits. The relative level number must be prefixed with a minus sign (-).

Relative Archiving Level is as follows:

  • Current Level -0
  • One Level Older -1
  • Two Levels Older -2
  • n Levels Older -n
ARCOFF

Commands:LIBEXP

ARCOFF terminates archiving of a module and deletes all levels except the current level. The module becomes a standard CA Librarian module. Once specified, ARCOFF remains in effect until ARC is specified at another time.

NOARC

Commands:

NOARC suspends the archiving of a module. When the module is updated while NOARC is in effect, the level selected for updating is replaced, more recently created levels (if any) are deleted, and older levels (if any) are maintained. Once specified, NOARC remains in effect for the module until ARC or ARCOFF is specified.

ARCLR

Commands:

ARCLR deletes every level of an archived module up to, but not including, the level that was current on the date that you specify. Archiving continues for updates made after an ARCLR operation. The full form of the date is:

yymmddhhmmss

You can omit an even number of digits from the right.CA Librarian assumes the highest possible value for the omitted digits. For example, if you specify ARCLR(95), all levels created before the level that was current on the last day of 1995 are deleted.

ARCINC{(date)|(Lx)|(-y)}

Command: LIBGET.

Provides an archiving level selection for all included modules. If you specify this option, every archived module included is expanded using the specified level. If you do not specify this option, the most recent level of any included archived module is selected. This option is ignored for any included module that has an archiving level selection on the -INC statement.

ARCINC(date)

Specifies date (or date and time) when the level was current. The full form of the date is:

yymmddhhmmss

You can omit an even number of digits from the right, but, if you do, CA Librarian assumes the highest possible values for those digits.

For example, if you specify ARCINC(95), CA Librarian selects the level that was current at the end of the year on 12/31/95 at 23:59:59, and not at the beginning of the year on 01/01/95 at 00:00:00.

ARCINC(Lx)

Specifies the absolute level, as reported on the module listing. You can specify the absolute level up to five digits. The level number must be prefixed with the letter L.

ARCINC(-y)

Specifies the relative level number. You can specify the level number up to three digits. The relative level number must be prefixed with a minus sign (-).

The Relative Archiving Level is as follows:

  • Current Level -B
  • One Level Older -1
  • Two Levels Older -2
  • ...
  • n Levels Older -n
[ARCINDEX|NOARCINDEX]

Command: LIBLIST

ARCINDEX gives an index of all archiving levels of the module. Information for each level includes the absolute level number, the relative level number, language, programmer name, and the date and time created.

[CHKINC|NOCHKINC]

Commands:

If you specify CHKINC, the LIBADD, LIBEXP, or LIBSAVE command searches for any comment statements identifying unexpanded -INC statements or included records. These comment statements might exist if the data set was retrieved from a master file through the LIBGET command or is a copy of another module that was originally retrieved through LIBGET. Any located comments are replaced with the appropriate -INC statement and any included records are deleted.

You can specify CHKINC, both to restore -INC statements and to prevent included records and the comment statements from being added to the master file. If you specify NOCHKINC, the search for comment statements is not initiated and any comment statements and included records remain in the module. Also, comments that identify unexpanded -INC statements are not converted back to the appropriate -INC statement.

If there are no included records or unexpanded -INC statements in the data set, specify NOCHKINC to save execution time.

This option is ignored when you specify NOTSO.

CLEARID

Commands:

Clears columns 73 through 80 (sequence numbers) of data records added to the master file to blanks. CLEARID does not affect records beginning with a slash (/). This option can reduce the amount of space required to store a module.

[DELETE|NODELETE]

Command: LIBCTL.

Deletes the module entry on the TLICD file and the corresponding TSO data set or PDS member. All outstanding modules are listed. You are prompted for any information needed. You can delete only one entry per command execution.

A single outstanding module on the TLICD file is deleted without the prompting message.

If a TLICD entry or the TSO data set is deleted, you cannot later update the module the entry references through the LIBSAVE command.

DESC('module-description')

Commands:

Provides a description of the module. The description can be 1 to 30 characters in length and must be enclosed in single quotes. If a module description is required for LIBADD but is not supplied, then LIBADD prompts for one. Quote marks are not needed when replying to a prompting message.

DSSOURCE[(master-file-name|('dsn-of-master')(dsn-of-master)]

Commands:

Identifies the master file the LIBLIST operation uses. If omitted, the site default master file is used. DSSOURCE('dsn-of-master') specifies the full data set name of a master file. If the data set name is not enclosed by single quotes, the name is prefixed with your user-prefix.

[GENLIST|NOGENLIST]

Command: LIBCTL.

Lists all the installation defaults and requirements for LIB/TSO.

GETVERS

Commands:

GETVERS is a special option that you can specify with any command to display a message indicating the CA Librarian release number of the version of that command that is installed in your system. GETVERS can be the only optional option specified. You can specify a dummy module-name as seen below. Any other options specified are ignored.

LIBADD X,GETVERS

In response, the following message displays:

COMMAND VERSION: release-number release-date

Note: GETVERS displays only the message. No other operation is performed.

HIST('history-information')

Commands:

Provides history information for the module. History information is limited to 75 characters and must be enclosed in single quotes.

Your site can require HIST information. In that case, you are prompted for it if you do not specify it.

[HIST|NOHIST]

Command: LIBLIST.

HIST displays all history entries for the named module and the history record date stamps. The date displays ahead of the history entries. If consecutive history records have the same date, the date displays on the first record only.

HSTD

Commands:

Deletes all history records from a module. You can add new history records during the current execution through the HIST option.

[INCLUDE|NOINCLUDE]

Command: LIBLIST.

INCLUDE expands all the -INC statements in the module. NOINCLUDE is the default. When expanding an -INC statement, the -INC statement itself is replaced with the included records. The sequence numbers of included records are listed as retrieved from the included module.

INCLUDE[(RESEQ)|(NORESEQ)]
NOINCLUDE
INCASIS

Command: LIBGET.

These options control the expansion of -INC statements and the sequencing of the records when a module is copied into a TSO data set. If not specified, the site default, usually NOINCLUDE, is assumed.

A module stored on a master file can contain CA Librarian embedded -INC statements that have the format:

-INC module-name[,options]

The INCLUDE(RESEQ) and the INCLUDE(NORESEQ) options expand all -INC statements contained in the module. These included modules are written in their entirety to the TSO data set. An included module is preceded by the following comment statements:

-INC modname MAKE NO CHANGES FROM HERE TO END OF INCLUDED MOD
-INC modname[,options]

The end of the included module is marked by the following message:

-INC modname END OF INCLUDED MODULE

The module type determines the format of the comment statement (the comment indicator and starting column). The type is derived from the type option specified on the command, the language code stored with the module, or the site default, in that order.

If you specify INCASIS, the module is copied to the data set completely unchanged. All -INC statements are copied exactly as they exist in the module without expansion and without identifying comment records.

Note the following:

[INFO|NOINFO]

Command: LIBLIST.

Lists or does not list all module control information including module name, number of records in the module, level number (if archived), password, language, programmer-name, description, date module added to the master file, date and time module last updated, sequence number option (s,l,i,v), status, date the module last copied from another master file through the -OPT UTILITY, the number of updates, and the COBOL syntax checker option (if specified).

[KEEPTSO|NOKEEPTSO]

Commands:

These options determine the disposition of the TSO data set after successful completion of processing.

KEEPTSO retains the originating TSO data set or member. If you specify NOKEEPTSO and the TSO data set is sequential, the data set is deleted and uncataloged. If the TSO data set is a PDS member, the member is deleted. If the command (LIBADD, LIBCTL) fails, the TSO data set or member is kept.

For LIBCTL, KEEPTSO prevents the TSO data set from being deleted when the DELETE option is specified.

LANG(lan)

Commands:

The value of lan is the one- to three-character language code identifying the language or contents of the module. The specfied language code is stored with the module (through a -LANG record). The entry can be one of the language codes or a user-defined value.

Note: This option is only used to change the language code of the module. Refer to the type option for other aspects of the CA Librarian language code.

[LIST|NOLIST]

Commands:

If you specify LIST and the module is successfully updated, batch CA Librarian writes the module update listing to a data set called user-prefix.$$$$$$LS.LIST. You can only save this information, which contains all updated records and control information, by printing or renaming the data set because the updated records and control information from the next execution overlay the current contents of user-prefix.$$$$$$LS.LIST.

If you specify NOLIST, then the module listing is suppressed.

In certain instances, the SYNCHK option can invokee the LIST option even if you specify NOLIST or it is the default.

If neither is specified, then LIST or NOLIST is selected according to the site default.

For LIBCTL, LIST (the default) lists all outstanding module information from previous LIBGET command executions, including:

[LIST[(s,e)]|NOLIST]

Command: LIBLIST.

LIST displays only the data records of the module. LIST(s,e) displays a range of records, where:

NEWPSWD(password)

Commands:

Specifies a new four-character, alphanumeric password. See the PASSWORD option for a description of the restrictions on passwords.

NOAUDIT

Commands:

Suppresses CA Librarian Auditing Facility (LIBAUDIT) processing. Specify this option only if LIBAUDIT is installed and there are more than 10,000 records either in the TSO data set or in the CA Librarian module you are updating.

Note: Take great care when using this option. NOAUDIT updates all the records of a module, not just the changed records. This is important with archived modules because NOAUDIT forces the archiving facility to retain an additional copy of every record in the module, changed or not.

NOCHK

Commands:

Suppresses COBOL syntax checking for the module being added. Specify this option only if you specified the SYNCHK option but you do not want to have the syntax checker process the module during the add. The values specified on the SYNCHK option are retained and applied to subsequent updates of the module.

NOTSO

Command: LIBEXP.

Specify this option if you are updating only the control information of a module and are not referencing a TSO data set.

Note: A new level is generated for archived modules even if only the module's control information is updated.

PASSWORD(pswd)

Command: LIBADD.

When you add a module, you can use this option to assign a four-character, alphanumeric password to the module. If you omit this option, the CA Librarian generates a four-character password, all consonants, for the module.

If you specify this option, you can assign as a password any four-character alphanumeric string (no special characters) except for the following CA Librarian reserved words: BYPP, EXEC, FULL, LIST, NONE, NOPC, NOPR, PERM, TEMP, and TEST.

Commands:

For these commands, use the PASSWORD option to specify the four‑character, alphanumeric password currently assigned to the module. The master file or your site can require password. If it is required but not supplied, you are prompted for a correct password.

To assign a new password to an existing module, see the NEWPSWD option.

PGMR(programmer-name)

Commands:

Specifies the name of the programmer responsible for the module. The name can be 1 to 15 characters long and must not contain blanks or commas. Your site can require PGMR.

If PGMR is not specified but is required, LIBADD and LIBEXP prompt for a programmer name. If it is not specified and not required, LIBADD uses the user-prefix as the programmer name. LIBEXP defaults to your user-prefix as the programmer name in that case, unless the module already has a PGMR field.

READONLY

Command: LIBGET.

When you specify this option, no entry is made on the TLICD file. The module is simply retrieved and copied into a TSO data set.

{RENAME|COPY}(module-name)

Commands:

RENAME renames the CA Librarian module when the module is returned to the master file.

COPY creates a copy of the selected module and gives it the new module name.

Note: If you are updating the module while at the same time making a copy, the changes are applied only to the copy; the original remains unchanged.

RENAME and COPY are mutually exclusive.

{RESEQ|NORESEQ}

Commands:

These options specify a module's RESEQ/NORESEQ attribute. The specified value has no effect on sequence numbers during LIBADD, although the RESEQ/NORESEQ attribute specified for LIBADD is active during all updates to the module. For information on sequence number formats, refer to the SEQ and SEQCHK options.

RESEQ renumbers the records of the module if any records are inserted or deleted. The renumbering is based on the sequence number attributes established through the SEQ or SEQCHK options.

If the module is not resequenced (NORESEQ), CA Librarian does not renumber the module’s records. It assigns sequence numbers to the inserted data records, beginning with one greater than the sequence number of the record after which the new records are inserted, and incrementing by one. When necessary, the sequence numbers of existing records are also incremented to prevent duplicate sequence numbers.

Note: Standard modules can have their RESEQ/NORESEQ attribute changed. Archived modules must keep the attribute specified for them when they were added.

{SEQ(s,l,i,v)|SEQCHK(s,l,i,v)}

Commands:

These options control the location, length, initial value, and increment of sequence numbers assigned to the module.

SEQ assigns sequence numbers to the module records based on the specified values.

SEQCHK does not assign sequence numbers to the data records, but rather verifies that sequence numbers are present in the specified columns and are in ascending numeric order. If an error is detected in the sequencing of the records, the module is not processed and an error message is written on the CA Librarian update message file.

The attributes specified through either option are used if the numbers are resequenced in subsequent updates. SEQ and SEQCHK are mutually exclusive.

The variables for SEQ and SEQCHK are:

s

The column where the sequence number starts. Acceptable values for SEQ are 1 to 81 and for SEQCHK 1 to 80. If you specify 81, the sequence number associated with each record is stored outside the record; all 80 bytes of the record are then available for data. Since SEQCHK cannot scan for sequence numbers outside of the record, you cannot specify 81 as the starting column for SEQCHK.

l

The length of the sequence number field. Acceptable values are 1 to 9. If you specify a starting column number of 81, you must specify a length of 6. If you do not specify the starting column number 81, the sum of the starting column and the length must not exceed 81.

i

The increment. Acceptable values are 1 through 9999.

v

The sequence number to assign to the first record of the module during addition of the module or during sequenced updating. Acceptable values are 0 through 9999.

When you do not specify SEQ or SEQCHK, the master file's default sequence parameters are used.

If you specify both SEQCHK and NORESEQ, the increment and starting values are not used while the module is added, but are retained to control the generation of sequence numbers during subsequent updates.

Note the following:

[SHIFT|NOSHIFT]

Command: LIBLIST.

If the sequence number ends in column 80 on a data record, SHIFT displays the sequence number in the leftmost position of a terminal line, and the rest of the data record displays one space past the sequence number. When displaying the sequence number, the first three leading zeros are suppressed. NOSHIFT displays the data records as retrieved from the module. SHIFT is the default.

[SHORT|LONG|LONGT]

Command: LIBINDEX.

Determines the format used for indexing the modules on the master file. Both SHORT and LONGT format can display at the terminal.

The SHORT format lists the module name, password, module description, date added, date and time last updated, number of records, module source language, and module status.

The LONG format, when selected with *, lists all information included in the short format and the programmer name, the number of accesses, number of updates, number of blocks, date last accessed, sequence number position and increment, number of archived levels, and current archived level number.

The LONGT format, when selected with programmer-name, lists all information included in the short format and Job Control Language procedures and sequence number positions and increments.

Batch CA Librarian is invoked when you specify the LONG format. Supplying programmer-name produces the Programmer Index listing. Supplying the * produces the Management Index listing.

If you specify LONG, the information gathered is written into a permanent data set, user-prefix.$$$$$$LI.INDEX. You can only save the information by printing or renaming the data set because the information from the next execution overlays the current contents of user-prefix.$$$$$$LI.INDEX.

If you specify LONGT, the information displays only on the terminal and is not written to the permanent data set.

Note: If you specify the SHORT option of LIBINDEX or it is assumed, the TERMMSG option is ignored and no Update Report is produced.

SOURCE(master-file-name)

Commands:

Identifies the master file the LIBLIST operation uses. If omitted, the site default master file is used.

SOURCE(master-file-name) specifies the low-order portion of the name of a master file. The high-order portion or prefix assumes the site default.

SYNCHK(l,a)

Commands:

CA Librarian verifies that the records of a module consist of syntactically valid COBOL statements. The syntax checker scans each record of the module and verifies that sentence structure, punctuation, and the use of reserved words conform to COBOL rules. The validity of data or procedure references is not checked.

The SYNCHK variables are:

l

Identifies the COBOL syntax level to apply. Specify one of the following:

  • CA for ANS COBOL
  • CD for COBOL D
  • CE for COBOL E
  • CF for COBOL F
  • CW for OS/VS2 COBOL (ANS COBOL 74)
a

Designates the action to take. Specify one of the following:

S

Suppresses writing of the module to the compilation file in the event of a syntax error. The LIST option is automatically invoked for the module. The module is still updated.

C

In the event of a syntax error, writing of the module to the compilation file is not suppressed nor is the LIST option invoked. The module is still updated.

SE

Functions the same as S. In addition, it expands the COBOL COPY verb for disk master files (for batch executions).

CE

Functions the same as C. In addition, it expands the COBOL COPY verb for disk master files (for batch executions).

Note: The wide record format does not support SYNCHK(l,a).

SYNCHK(D,X)

Commands:

Deactivates the syntax checker option for all future updates of the module. D is the delete option. X is a dummy option. D and X are not variables and must be used as illustrated.

[TERMMSG|PERMMSG|TEMPMSG]

Commands:

Parameters:

TERMMSG

The CA Librarian Update Report is written to the terminal.

PERMMSG

CA Librarian writes the Report to a data set, named:

  • user-prefix.$$$$$$LA.MSGS for a LIBADD execution
  • user-prefix.$$$$$$Lx.MSGS for a LIBxxx execution
  • user-prefix.$$$$$$LA.MSGS for a LIBxxx execution

You can save this information only by printing or renaming the data set because the Update Report from the next execution overlays it.

TEMPMSG

The Update Report is written to a temporary data set that is deleted at the end of command processing. If you omit this option, your site default is assumed.

TSODSN{('data-set-name')|(data-set-name)|('pds-name(member)')|(pds-name(member))}

Commands:

For LIBADD and LIBEXP, identifies the data set used to update the master file. Use this option if CA Librarian cannot determine the data set name from the module-name option and other specified or defaulted information.

Note: With LIBXP, this option is ignored if you specify NOTSO.

For LIBGET, specifies the name of the data set where the retrieved module is copied. You must identify the data set with the TSODSN option only if the LIBGET command cannot determine the data set name from the module name option and other supplied or default information.

Do not use this option if you specified the pds-name(member) option.

You can enter the data set or PDS name with or without single quotes. If you omit the quotes, LIBGET prefixes the name with your user-prefix. You must specify all other qualifiers whether you enter the name with or without your user prefix.

TSOSIZE(nnnnnn)

Commands:

If you specified CHKINC and the LIBAUDIT facility is not active, CA Librarian must allocate a temporary data set to hold the records of your module while restoring included modules back to their original -INC statements. If the allocated data set is not large enough to hold the module, LIBADD, LIBEXP, or LIBSAVE fails with a B37-04 abend.

If such an abend occurs, reenter the command with TSOSIZE and the size (in number of records) of the data set or member.

Note: TSOSIZE is ignored if you specify either NOTSO or NOCHKINC. Command: LIBGET

You can use TSOSIZE if needed to specify the size, in number of records, of a new sequential data set that the LIBGET command is to allocate to hold a retrieved module. The size must be the sum of the records currently in the module plus all records included as a result of expanded -INC statements.

If the default size is too small to hold the original module and all included records, LIBGET fails with a D37 or B37 abend.

If such an abend occurs, delete the data set and reenter the LIBGET command, specifying the estimated number of records in the data set with the TSOSIZE option.

Note: You cannot use TSOSIZE to specify the size of an existing data set. You cannot use TSOSIZE when copying a module into a member of a partitioned data set.

type

Commands:

Identifies the contents of the module. If you are allowing LIBADD or LIBEXP to construct the name of the data set to add or use to update the module, the specified type entry becomes the descriptive-qualifier of the constructed name. If you omit this option, the site default (usually COBOL) is assumed.

Note: During CA Librarian installation, types are set as part of per site customization. You can use the LIBCTL command to list the valid types allowed.

The valid entries for this option are:

Your site can change or add more at installation time.

The type also determines the format of any CA Librarian-generated comment statements that can be inserted into the module. The specified type is converted into a language code stored with the module (through a -LANG statement) unless the LANG option is specified or the module already has a -LANG parameter associated with it. If you specify the LANG option with a language code, that language code is stored with the module.

In building a data set name, CA Librarian determines the module data type and thus the descriptive-qualifier from:

[VAR|NOVAR]

Command: LIBGET

Invokes the Source-Load Audit Trail facility for the current execution if you also specified the READONLY option. Without the READONLY option, VAR is ignored. Entering NOVAR suppresses the processing of the facility for the current execution.

VERS(mmdd[hhmm])

Commands:

With LIBGET, terminates processing of a module if the specified date (in mmdd format) or date and time (in hhmm format) do not match that of the most recently applied update. Processing proceeds normally if the specified date or date and time matches that of the latest update.