Use FileLibrary to display directory information for a specified group of files.
FileLibrary may also be entered as FileLib[rary], LibraryFile, LibFile, Lib[rary], or Dir.
Optional Operands
FILE The format varies based upon the file type:
For BIM files, FILE is the directory and the initial characters of the files to be displayed. If no directory is specified (i.e., FILE does not contain a period) files in the currently attached BIM directory are displayed. If the directory is specified but the file is not (i.e., FILE ends in a period), all files in the specified directory are displayed. If FILE is not specified, all files in the current directory are displayed. FILE can contain * and ? characters, that will match as described in the Extended Search Pattern rules. If the directory name part of FILE has * or ? characters, you can display files in more than one directory.
For PDS files, FILE is the directory and the initial characters of the files to be displayed. If no directory is specified (i.e., FILE does not contain a period) files in the currently attached PDS directory are displayed. If the directory is specified but the file is not (i.e., FILE ends in a period), all files in the specified directory are displayed. If FILE is not specified, all files in the current directory are displayed. FILE can contain * and ? characters, that will match as described in the Extended Search Pattern rules.
For VSE files, FILE is the directory and the initial characters of the files to be displayed. If no directory is specified (i.e., FILE does not contain a period) files in the currently attached VSE directory are displayed. If the directory is specified but the file is not (i.e., FILE ends in a period), all files in the specified directory are displayed. If FILE is not specified, all files in the current VSE directory are displayed. FILE can contain * and ? characters, that will match as described in the Extended Search Pattern rules.
For workstation files, FILE is the directory and the initial characters of the files to be displayed. If no directory is specified (i.e., FILE does not contain a backslash (\)) files in the currently attached workstation directory are displayed. If the directory is specified and the file is specified as an asterisk (*), all files in the specified directory are displayed. If FILE is not specified or FILE is specified as an asterisk (*), all files in the current workstation directory are displayed. FILE can contain global file-name characters as defined in the workstation operating system documentation.
Default: *.
FMT is the format of the display. The following are provided:
NAME Only the NAME is shown. This format is handy when you need to create a list of files for use in a procedure.
DET The fields NAME, TYPE, ATTR, # text lines, # audit lines, audit status, stamp status, date created, and date updated are shown on a single line. This format also displays a line of totals for both text and audit lines.
FULL All of the fields specified in the DET format above are shown. In addition, the user ID and title are shown. FULL is most useful with a 132 character screen or when writing the output to a printer. Totals are provided as with the DET format.
CHECK A display designed for checkout / checkin management is created. The fields NAME, check-out status, check-out directory, check-out date, audit status, stamp status, date created, and date updated are shown.
SYS [Supported for workstation files only] A display similar to that created from a DOS or OS/2 command prompt is created. The creation and update date and times are shown, as well as the file size and file name.
If FMT is not specified, the default format shows NAME, TYPE, and TITLE on a single line.
TYPE If TYPE is specified, only files that match the specified TYPE are displayed. If the value of TYPE begins with a backslash character (\), matching will use Extended Search Pattern rules. See the FileDefine command for information about TYPE.
ATTR If ATTR is specified, only files that match the specified ATTR are displayed. If the value of ATTR begins with a backslash character (\), matching will use Extended Search Pattern rules. See the FileDefine command for information about ATTR.
CKUSER If CKUSER is specified, only files that have been checked out to the CKUSER user are displayed. If CKUSER is specified as an asterisk (*), all files that have been checked out are displayed. If the value of CKUSER begins with a backslash character (\), matching will use Extended Search Pattern rules.
TITLE If TITLE is specified, only files that contain its value in their TITLEs are displayed. If the value of TITLE begins with a backslash character (\), matching will use Extended Search Pattern rules.
DIR If DIR is specified as "On" or "Yes", in addition to file entries, directory entries within the specified directory will be displayed. If DIR is specified as "Off" or "No", only file entries will be displayed.
Default: Yes.
Normally files from the currently attached directory are listed. However, files from another directory can be listed by providing the directory name as part of FILE. For example, to display all files from BIM directory TM20 that start with the three characters BIC, enter:
=> lib tm20.bic
To display all TM20 files, enter.
=> lib tm20.
The following Context commands can be used with the FileLibrary display.
The created display has control information to the right of column 135 for use by the Context commands. If you use FileLibrary display lines in another context (i.e., as input to a procedure) you may need to remove the control information using the EditBlank or EditKeep commands.
When Valid
For Host files, the user must have EXEC access level for the FILE directory.
Return Codes
OK Successful.
NF Directory not found.
SC Inadequate access level.
Examples
Display the directory information for all files of the current workstation directory:
=> lib
Display the directory information for BIM files beginning with the three characters "BIR" in the current directory:
=> lib bir*