Museum

Home

Lab Overview

Retrotechnology Articles

⇒ Online Manual

Media Vault

Software Library

Restoration Projects

Artifacts Sought

Related Articles

PARAMETER

QUALIFIERS

EXAMPLES

/ACL

/BACKUP

/BEFORE

/BRIEF

/BY_OWNER

/COLUMNS

/CREATED

/DATE

/EXCLUDE

/EXPIRED

/FILE_ID

/FULL

/GRAND_TOTAL

/HEADING

/MODIFIED

/OUTPUT

/OWNER

/PRINTER

/PROTECTION

/SECURITY

/SELECT

/SINCE

/SIZE

/TOTAL

/TRAILING

/VERSIONS

/WIDTH

HELP DIRECTORY — VMS 5.4

   Provides a list of files or information about a file or group of
   files.

   Requires read (R) access to the directories to obtain any
   information. Requires read (R) access to the files to obtain
   information other than the file name.

   Format

     DIRECTORY  [filespec[,...]]

Additional information available:

PARAMETERQUALIFIERSEXAMPLES

PARAMETER

filespec[,...]
   Specifies one or more files to be listed. The syntax of a file
   specification determines which files will be listed, as follows:

   o  If you do not enter a file specification, the DIRECTORY
      command lists all versions of the files in the current default
      directory.

   o  If you specify only a device name, the DIRECTORY command uses
      your default directory specification.

   o  Whenever the file specification does not include a file name,
      a file type and a version number, all versions of all files in
      the specified directory are listed.

   o  If a file specification contains a file name or a file type, or
      both, and no version number, the DIRECTORY command lists all
      versions.

   o  If a file specification contains only a file name, the
      DIRECTORY command lists all files in the current default
      directory with that file type, regardless of file type and
      version number.

   o  If a file specification contains only a file type, the
      DIRECTORY command lists all files in the current default
      directory with that file type, regardless of file name and
      version number.

   Wildcard characters can be used in the directory specification,
   file name, file type, or version number fields of a file
   specification to list all files that satisfy the components you
   specify. If you specify more than one file, separate the file
   specifications with either commas (,)  or plus signs (+).

QUALIFIERS

Additional information available:

/ACL/BACKUP/BEFORE/BRIEF/BY_OWNER/COLUMNS
/CREATED/DATE/EXCLUDE/EXPIRED/FILE_ID/FULL/GRAND_TOTAL
/HEADING/MODIFIED/OUTPUT/OWNER/PRINTER/PROTECTION
/SECURITY/SELECT/SINCE/SIZE/TOTAL/TRAILING/VERSIONS
/WIDTH

/ACL

   Controls whether the access control list (ACL) is displayed for
   each file. By default, the DIRECTORY command does not display
   the ACL for each file. The /ACL qualifier overrides the /COLUMNS
   qualifier.

/BACKUP

   Modifies the time value specified with the /BEFORE or the /SINCE
   qualifier. The /BACKUP qualifier selects files according to the
   dates of their most recent backups. This qualifier is incompatible
   with the following qualifiers that also allow you to select files
   according to time attributes: /CREATED, /EXPIRED, and /MODIFIED.
   If you specify none of these four time qualifiers, the default is
   the /CREATED qualifier.

/BEFORE

      /BEFORE[=time]

   Selects only those files dated prior to the specified time.
   You can specify time as an absolute time, as a combination of
   absolute and delta times, or as one of the following keywords:
   TODAY (default), TOMORROW, or YESTERDAY. Specify one of the
   following qualifiers with the /BEFORE qualifier to indicate the
   time attribute to be used as the basis for selection: /BACKUP,
   /CREATED (default), /EXPIRED, or /MODIFIED.

   For complete information on specifying time values, see the VMS
   DCL Concepts Manual.

/BRIEF

      /BRIEF (default)

   Displays only a file's name, type, and version number. The brief
   format lists the files in alphabetical order from left to right
   on each line, in descending version number order. You can use the
   /ACL, /DATE, /FILE_ID, /FULL, /NOHEADING, /OWNER, /PROTECTION,
   /SECURITY, and /SIZE qualifiers to expand a brief display.

/BY_OWNER

      /BY_OWNER[=uic]

   Selects only those files whose owner user identification code
   (UIC) matches the specified owner UIC. The default UIC is that of
   the current process.

   Specify the UIC by using standard UIC format as described in the
   VMS DCL Concepts Manual.

/COLUMNS

      /COLUMNS=n

   Specifies the number of columns in a brief display. The default
   is four. However, you can request as many columns as you like,
   restricted by the value of the /WIDTH qualifier. The /COLUMNS
   qualifier is incompatible with the /ACL, /FULL, and /SECURITY
   qualifiers.

   The number of columns actually displayed depends on the amount of
   information requested for each column and the display value of the
   /WIDTH qualifier. The system displays only as many columns as can
   fit within the default or specified display width, regardless of
   how many columns you specify with the /COLUMNS qualifier.

   The DIRECTORY command truncates long file names only when you
   have asked for additional information to be included in each
   column. The default file name size is 19 characters. Use the
   /WIDTH qualifier to change the default. When a file name is
   truncated, the system displays one less character than the file
   name field size and inserts a vertical bar in the last position.
   For example, if the file name is SHOW_QUEUE_CHARACTERISTICS, and
   if you requested DIRECTORY to display both file name and size
   in each column, the display for that file would be SHOW_QUEUE_
   CHARACT| 120.

/CREATED

      /CREATED (default)

   Modifies the time value specified with the /BEFORE or the /SINCE
   qualifier. The /CREATED qualifier selects files based on their
   dates of creation. This qualifier is incompatible with the
   following qualifiers that also allow you to select files according
   to time attributes: /BACKUP, /EXPIRED, and /MODIFIED. If you
   specify none of these four time qualifiers, the default is the
   /CREATED qualifier.

/DATE

      /DATE[=option]
      /NODATE (default)

   Includes the backup, creation, expiration, or modification date
   for each specified file; the default is the /NODATE qualifier. If
   you use the /DATE qualifier without an option, the creation date
   is provided. Possible options are as follows:

   ALL        Specifies creation, expiration, backup, and last
              modification dates.

   BACKUP     Specifies the last backup date.

   CREATED    Specifies the reation date.

   EXPIRED    Specifies the expiration date.

   MODIFIED   Specifies the last modification date.

/EXCLUDE

      /EXCLUDE=(filespec[,...])

   Excludes the specified files from the DIRECTORY command.
   You can include a directory but not a device in the file
   specification. Wildcard characters (* and %) are allowed in the
   file specification. However, you cannot use relative version
   numbers to exclude a specific version. If you specify only one
   file, you can omit the parentheses.

/EXPIRED

   Modifies the time value specified with the /BEFORE or the /SINCE
   qualifier. The /EXPIRED qualifier selects files according to their
   expiration dates. (The expiration date is set with the SET FILE
   /EXPIRATION_DATE command.) The /EXPIRED qualifier is incompatible
   with the following qualifiers that also allow you to select files
   according to time attributes: /BACKUP, /CREATED, and /MODIFIED. If
   you specify none of these four time qualifiers, the default is the
   /CREATED qualifier.

/FILE_ID

   Controls whether the file identification number (FID) is
   displayed. By default, the FID is not displayed unless the /FULL
   qualifier is specified.

/FULL

   Displays the following information for each file:

      File name
      File type
      Version number
      Number of blocks used
      Number of blocks allocated
      Date of creation
      Date last modified and revision number
      Date of expiration
      Date of last backup
      File owner's user identification code (UIC)
      File protection
      File identification number (FID)
      File organization
      Journaling information
      Other file attributes
      Record attributes
      Record format
      Access control list (ACL)
      Value of the stored semantics tag (where applicable)

/GRAND_TOTAL

   Displays only the totals for all files and directories that have
   been specified. Suppresses both the per-directory total and
   individual file information. (See the /TRAILING qualifier for
   information on displaying directory totals.)

/HEADING

      /HEADING
      /NOHEADING

   Controls whether heading lines consisting of a device description
   and directory specification are printed. The default output
   format provides this heading. When the /NOHEADING qualifier
   is specified, the display is in single-column format and the
   device and directory information appears with each file name.
   The /NOHEADING qualifier overrides the /COLUMNS qualifier.

   The combination of the /NOHEADING and /NOTRAILING qualifiers is
   useful in command procedures where you want to create a list of
   complete file specifications for later operations.

/MODIFIED

   Modifies the time value specified with the /BEFORE or the /SINCE
   qualifier. The /MODIFIED qualifier selects files according to
   the dates on which they were last modified. This qualifier is
   incompatible with the following qualifiers that also allow you to
   select files according to time attributes: /BACKUP, /CREATED, and
   /EXPIRED. If you specify none of these four time modifiers, the
   default is the /CREATED qualifier.

/OUTPUT

      /OUTPUT[=filespec]
      /NOOUTPUT

   Controls where the output of the command is sent. By default, the
   display is written to the current SYS$OUTPUT device. No wildcard
   characters are allowed.

   If you enter the /OUTPUT qualifier with a partial file
   specification (for example, /OUTPUT=[JONES]), DIRECTORY is the
   default file name and LIS the default file type. If you enter the
   /NOOUTPUT qualifier, output is suppressed.

   If the output will be written to a file in the same directory, the
   output file name will appear in the directory listing.

/OWNER

      /OWNER
      /NOOWNER (default)

   Controls whether the file owner's user identification code (UIC)
   is listed.

   The default size of the owner field is 20 characters. If the file
   owner's UIC exceeds the length of the owner field, the information
   will be truncated. The size of this field can be altered by
   specifying /WIDTH=OWNER, along with a value for the owner field.
   For more information, see the description of the /WIDTH qualifier.

/PRINTER

   Puts the display in a file and queues the file to SYS$PRINT for
   printing under the name given by the /OUTPUT qualifier. If you
   do not specify the /OUTPUT qualifier, output is directed to a
   temporary file named DIRECTORY.LIS, which is queued for printing
   and then is deleted.

/PROTECTION

      /PROTECTION
      /NOPROTECTION (default)

   Controls whether the file protection for each file is listed.

/SECURITY

   Controls whether information about file security is displayed;
   using the /SECURITY qualifier is equivalent to using the /ACL,
   /OWNER, and /PROTECTION qualifiers together.

/SELECT

      /SELECT=(keyword[,...])

   Allows you to select files for display according to size. Choose
   one of the following keywords:

   SIZE=MAXIMUM=n             Displays files that have fewer blocks
                              than the value of n, which defaults to
                              1,073,741,823. Use with MINIMUM=n to
                              specify a size range for files to be
                              displayed.

   SIZE=MINIMUM=n             Displays files that have blocks equal
                              to or greater than the value of n,
                              which defaults to 0. Use with MAXIMUM=n
                              to specify a size range for files to be
                              displayed.

   SIZE=(MAXIMUM=n,MINIMUM=m) Displays files whose block size falls
                              within the specified MAXIMUM and
                              MINIMUM range.

   By default, file selection is based on other criteria.

/SINCE

      /SINCE[=time]

   Selects only those files dated after the specified time. You can
   specify time as an absolute time, a combination of absolute and
   delta times, or as one of the following keywords: TODAY (default),
   TOMORROW, or YESTERDAY. Specify one of the following qualifiers
   with the /SINCE qualifier to indicate the time attribute to be
   used as the basis for selection: /BACKUP, /CREATED (default),
   /EXPIRED, or /MODIFIED.

   For complete information on specifying time values, see the VMS
   DCL Concepts Manual.

/SIZE

      /SIZE[=option]
      /NOSIZE (default)

   Displays the size in blocks of each file. If you omit the option
   parameter, the default lists the file size in blocks used (USED).
   Specify one of the following options:

   ALL          Lists the file size both in blocks allocated and
                blocks used.

   ALLOCATION   Lists the file size in blocks allocated.

   USED         Lists the file size in blocks used.

   The size of this field can be altered by supplying the size value
   of the /WIDTH qualifier.

/TOTAL

   Displays only the directory name and total number of files.

   By default, the output format is determined by the /BRIEF
   qualifier, which gives this total, but also lists all the file
   names, file types, and their version numbers.

/TRAILING

      /TRAILING
      /NOTRAILING

   Controls whether trailing lines that provide the following summary
   information are displayed:

   o  Number of files listed

   o  Total number of blocks used per directory

   o  Total number of blocks allocated

   o  Total number of directories and total blocks used or allocated
      in all directories (only if more than one directory is listed)

   By default, the output format includes most of this summary
   information. The /SIZE and /FULL qualifiers determine more
   precisely what summary information is included.

   When used alone, the /TRAILING qualifier lists the number of
   files in the directory. When used with the /SIZE qualifier, the
   /TRAILING qualifier lists the number of files and the number of
   blocks (displayed according to the option of the /SIZE qualifier,
   FULL or ALLOCATION). Used with the /FULL qualifier, the /TRAILING
   qualifier lists the number of files as well as the number of
   blocks used and allocated. If more than one directory is listed,
   the summary includes the total number of directories, the total
   number of blocks used, and the total number of blocks allocated.

/VERSIONS

      /VERSIONS=n

   Specifies the number of versions of a file to be listed. The
   default is all versions of each file. A value less than 1 is not
   allowed.

/WIDTH

      /WIDTH=(keyword[,...])

   Formats the width of the display. If you specify only one keyword,
   you can omit the parentheses. Possible keywords are as follows:

   DISPLAY=n   Specifies the total width of the display as an integer
               in the range 1 to 256 and defaults to zero (setting
               the display width to the terminal width). If the total
               width of the display exceeds the terminal width, the
               information will be truncated.

   FILENAME=n  Specifies the width of the file name field; defaults
               to 19 characters. If you request another piece of
               information to be displayed along with the file name
               in each column, file names that exceed the n parameter
               cause the line to wrap, after the file name field.
               (See the /COLUMNS qualifier.)

   OWNER=n     Specifies the width of the owner field; defaults to
               20 characters. If the owner's user identification
               code (UIC) exceeds the length of the owner field, the
               information will be truncated.

   SIZE=n      Specifies the width of the size field; defaults to 6
               characters. If the file size exceeds the length of the
               size field, the information will be truncated.

EXAMPLES

   1.  $ DIRECTORY AVERAGE.*

    Directory DISK$DOCUMENT:[MALCOLM]

    AVERAGE.EXE;6      AVERAGE.FOR;6      AVERAGE.LIS;4     AVERAGE.OBJ;12

    Total of 4 files.

     In this example, the DIRECTORY command lists all files with the
     file name AVERAGE and any file type.

   2.  $ DIRECTORY/SIZE=USED/DATE=CREATED/VERSIONS=1/PROTECTION  AVERAGE

       Directory DISK$DOCUMENT:[MALCOLM]

       AVERAGE.EXE;6    6     19-APR-1990 15:43:02.10 (RWED,RWED,RWED,RE)
       AVERAGE.FOR;6    2     19-APR-1990 10:29:53.37 (RWED,RWED,RWED,RE)
       AVERAGE.LIS;4    5     19-APR-1990 16:27:27.19 (RWED,RWED,RWED,RE)
       AVERAGE.OBJ;6    2     19-APR-1990 16:27:44.23 (RWED,RWED,RWED,RE)

       Total of 4 files, 15 blocks.

     In this example, the DIRECTORY command lists the number of
     blocks used, the creation date, and the file protection code
     for the highest version number of all files named AVERAGE in
     the current directory.


   3.  $ DIRECTORY/FULL [JONES.ITALIA]PROJECTIONS.LIS

     Directory WORK:[JONES.ITALIA]

     PROJECTIONS.LIS;1           File ID:  (7449,36222,2)
     Size:           21/21         Owner:    [DOC,JONES]
     Created:   5-MAY-1988 15:49:03.11
     Revised:   5-MAY-1988 15:49:49.39 (2)
     Expires:   <None specified>
     Backup:    <No backup recorded>
     File organization:  Sequential
     File attributes:    Allocation: 21, Extend: 0, Global buffer count: 0,
                         No version limit
     Record format:      Variable length, maximum 80 bytes
     Record attributes:  Carriage return carriage control
     RMS attributes:     None
     Journaling enabled: None
     File protection:    System:RWED, Owner:RWED, Group:RE, World:
     Access Cntrl List:  None

     Total of 1 file, 21/21 blocks.

     The DIRECTORY command in this example shows the date/time
     format using the default language, English, and the default VMS
     format. You can also select other languages and formats that
     have been defined on your systems with international date/time
     formatting routines available in the run-time library. See the
     VMS RTL Library (LIB$) Manual.

   4.  $ DIRECTORY/VERSIONS=1/COLUMNS=1 AVERAGE.*

     The DIRECTORY command in this example lists only the highest
     version of each file named AVERAGE in the current default
     directory. The format is brief and restricted to one column.
     Heading and trailing lines are provided.


   5.  $ DIRECTORY BLOCK%%%

     The DIRECTORY command in this example locates all versions and
     types of files in the default device and directory whose names
     begin with the letters BLOCK and end with any three additional
     characters. The default output format is brief, four columns,
     with heading and trailing lines.

   6.  $ DIRECTORY/EXCLUDE=(AVER.DAT;*,AVER.EXE;*) [*...]AVER

     The DIRECTORY command in this example lists and totals all
     versions and types of files named AVER in all directories and
     subdirectories on the default disk, except any files named
     AVER.DAT and AVER.EXE.


   7.  $ DIRECTORY/SIZE=ALL FRESNO::DISK1:[TAYLOR]*.COM

     The DIRECTORY command in this example lists all versions of all
     files with the file type COM in the directory TAYLOR on node
     FRESNO and device DISK1. The listing includes the file size
     both in blocks used and in blocks allocated for each file.


   8.  $ DIRECTORY-
       _$ /MODIFIED/SINCE=19-APR-1990:01:30/SIZE=ALL/OWNER-
       _$ /PROTECTION/OUTPUT=UPDATE/PRINTER [A*]

     The DIRECTORY command in this example locates all files that
     have been modified since 1:30 A.M. on April 19, 1990 and
     that reside on the default disk in all directories whose
     names begin with the letter A. It formats the output to
     include all versions, the size used and size allocated, the
     date last modified, the owner, and the protection codes. The
     output is directed to a file named UPDATE.LIS that is queued
     automatically to the default printer queue and then is deleted.

Typewritten Software • bear@typewritten.org • Edmonds, WA 98026