User's Guide

CMLIST

List Cataloged Files

Function:

Lists the names of cataloged files and associated files on disk. Selected file attributes may also be listed.

Parameters:

INFILE(*)
Input name. A cataloged file name or list of names, optionally including wildcard characters or an alias name. A wildcard with no extension (*) whether preceded by a directory path or not denotes only an image and its associated files. A semi-colon with a wildcard extension (;*) denotes the specified filename with all extensions. A wildcard with a semi-colon wildcard extension (*;*) denotes all files of all extensions.

NLEVELS(1)
Number of levels. The number of directory levels for which files are to be listed. Specify 99 to list the entire directory tree.

LISTOPT(NO)
Attribute list option. Determines what level of attribute information will be listed. (Attributes may be listed without listing associated file names.)


  = NO:     No attribute listing.  No attribute 
            information is listed.
  = BRIEF:  Brief listing.  Lists size (nl,ns), nbands,
            and data type (for image files).
  = MED:    Medium listing.  Lists BRIEF attributes 
            (if applicable), plus creation date.
  = LONG:   Long listing.  Lists MED attributes, plus
            host name.

PRINT(TERM)
Output destination.


  = TERM:       Terminal.  Output is sent to the
                user's  terminal.
  = LP:         Line printer.  Output is sent to
                the printer defined by $PRINTER.
  = Filename:   User supplied filename.  Output
                is sent to the user supplied file
                with the extension ".prt".

Examples:

  1. LAS> cmlist infile=*;* listopt=no nlevels=3

    The names of all cataloged files on disk are listed for three directory levels beginning with the current directory.

        [SMITH.ALASKA.VALDEZ]
    
        File Name
        _________
    
        LANDSAT;DDR
        LANDSAT;HIS
        LANDSAT;IMG
        LANDSAT;MISC
        ELEVATION;DDR
        ELEVATION;HIS
        ELEVATION;IMG
        ATLARGE;GOF
    
        [SMITH.ALASKA.VALDEZ.LANDSAT.SPRING85]
    
        File Name
        _________
    
        NEWYORK;DDR
        NEWYORK;HIS
        NEWYORK;IMG
        NEWYORK;LUT
        RATIO;BAND4.5
        TEST.THIRTY.NINE.CHARACTER.FILENAME.AND;IMG
        TEST.THIRTY.NINE.CHARACTER.FILENAME.AND;VERY.LONG.EXTENSION
    
    
  2. LAS> cmlist infile=* listopt=brief nlevels=3

    The names and brief attributes of all cataloged images on disk are listed for three directory levels beginning with the current directory.

        [SMITH.ALASKA.VALDEZ]
    
        File Name                        NL,NS     Nbands  Data Type
        _________                        _____     ______  _________
    
        LANDSAT;IMG                 (11000,12000)    7      BYTE
        ELEVATION;IMG                     (20,20)    1      R*4
        ALGERIA;IMG		 	  (3221,3000)    3      I*2
    
    
        [SMITH.ALASKA.VALDEZ.LANDSAT.SPRING85]
    
        File Name                        NL,NS     Nbands  Data Type
        _________                        _____     ______  _________
                                                              
        NEWYORK;IMG                     (512,512)    1      I*4
        TEST.THIRTY.NI.FILENAME;IMG (11000,12000)    5      I*2
    
    

  3. LAS> cmlist infile=landsat;img listopt=med

    The names and medium attributes of disk file LANDSAT;IMG are listed.

        [SMITH.ALASKA.VALDEZ]
    
        File Name
        _________
    
        LANDSAT;IMG
         NL,NS           : (11000,12000)
         Nbands          : 7
         Data Type       : BYTE
         Creation Date   : 12/03/85 08:28:30
    

  4. LAS> cmlist infile=landsat listopt=long

    The names and long attributes of LANDSAT;IMG and its associated files are listed for disk files of any status.

        [SMITH.ALASKA.VALDEZ]
    
        File Name
        _________
    
        LANDSAT;IMG
         NL,NS           : (11000,12000)
         Nbands          : 7
         Data Type       : BYTE
         Creation Date   : 12/03/85 08:28:30
         Host Name       : /edc/smith/cm/alaska/valdez/landsat.img
        LANDSAT;DDR
         Creation Date   : 12/03/85 08:30:35
         Host Name       : /edc/smith/cm/alaska/valdez/landsat.ddr 
        LANDSAT;HIS
         Creation Date   : 12/03/85 08:35:25
         Host Name       : /edc/smith/cm/alaska/valdez/landsat.his 
        LANDSAT;MISC
         Creation Date   : 12/08/85 09:29:17
         Host Name       : /edc/smith/cm/alaska/valdez/landsat.misc
        LANDSAT;OLDSTUFF
         Creation Date   : 12/03/85 08:28:30
         Host Name       : /edc/smith/cm/alaska/valdez/landsat.oldstuff 
    

  5. LAS> cmlist infile=[butzer]* listopt=long

    The names and long attributes of all image and associated files under the BUTZER directory would be listed for disk files. For the sake of brevity, an example of each is given.

         [BUTZER.NY]
    
         File Name
         _________
    
         NY;IMG
            NL,NS         :  (512,512)
            Nbands        :  7
            Data Type     :  I*4
            Creation Date :  Thu Aug 11 02:49:11 1988
            Host Name     :  /edc/software/butzer/ny/ny.img
         NY;DDR
            Creation Date :  Thu Aug 11 02:50:30 1988
            Host Name     :  /edc/software/butzer/ny/ny.ddr
         NY;HIS
            Creation Date :  Thu Aug 11 02:52:49 1988
            Host Name     :  /edc/software/butzer/ny/ny.his
         [BUTZER.TONO] 
    
         File Name
         _________
    
         TONO;IMG
            NL,NS         :  (1000,1000)
            Nbands        :  3
            Data Type     :  I*2
            Creation Date :  Thu Aug  4 16:14:26 1988
            Host Name     :  /edc/software/butzer/tono/tono.img
         TONO;DDR
            Creation Date :  Thu Aug  4 16:17:48 1988
            Host Name     :  /edc/software/butzer/tono/tono.ddr
         TONO;HIS
            Creation Date :  Thu Aug  4 16:15:02 1988
            Host Name     :  /edc/software/butzer/tono/tono.his
    

Description/Algorithm:

CMLIST lists the names of cataloged files and associated files from disk. Selected file attributes may also be listed. CMLIST uses the disk file manager of the host file system and converts the name from a transportable name format (TAE name) to host name format.

Nonfatal Error Message:

  1. [cmlist-warn] Unable to get DDR information

    An image file was specified and the program could not open, could not find, or could not successfully read the associated data descriptor record (DDR) file. This message is followed by the file name in question.

Fatal Error Message:

  1. [cmlist-fatal] Fatal error encountered

    The error message that is displayed immediately preceding this message is the specific error that was encountered. Processing is terminated.

User Notes:

  1. When using the NO attribute option with a wildcard extension (*;*), image and associated files are listed without blank lines to break the report format. In this instance, the image and associated files are not conspicuously listed so that no image file checking is done, which greatly increases execution performance.