Document revision date: 30 March 2001

## OpenVMS DCL Dictionary

Previous | Contents | Index

## DUMP

> Displays the contents of a file, a directory, a disk volume, a magnetic tape volume, or a CD-ROM volume in decimal, hexadecimal, octal format, ASCII, or formatted data structures. This command can be used to generate process dumps.

### Format

> DUMP filespec [,...]

### Parameter

> #### filespec [,...]

> Specifies the file or name of the device being dumped.

> If the specified device is not a disk, a tape, or a network device, or if the device is mounted with the /FOREIGN qualifier, the file specification must contain only the device name.

> If the specified device is a network device, a disk device, or a tape device that is mounted without the /FOREIGN qualifier, the file specification can contain the asterisk (*) and the percent sign (%) wildcard characters.

> Files-11 C/D format standards have been implemented on mounted and foreign mounted volumes.

### Description

> By default, the DUMP command formats the output both in ASCII characters and in hexadecimal longwords. You can specify another format for the dump by using a radix qualifier (/OCTAL, /DECIMAL, or /HEXADECIMAL) or a length qualifier (/BYTE, /WORD, or /LONGWORD).

> Dumping Files

> If the input medium is a network device, a disk device, or a tape device that is mounted without the /FOREIGN qualifier, the DUMP command operates on files. You can dump files by either records or blocks. The asterisk (*) and the percent sign (%) wildcard character specifications can be used to select a group of files for processing.

> Dumping Volumes

> If the input medium is not a disk or a tape device, or if it is mounted with the /FOREIGN qualifier, the DUMP command operates on the input device as a non-file-structured (NFS) medium. Disk devices are dumped by 512-byte logical blocks. Other devices are dumped by physical blocks. No repositioning of the input medium occurs; therefore, consecutive blocks on a tape can be dumped by a single DUMP command.

> If you have LOG_IO (logical I/O) privilege, you can dump random blocks on a Files-11 volume. For example, by using the /BLOCKS qualifier, you could dump block 100 on the system disk.

> Dumping Processes

> If you use the /PROCESS qualifier, the DUMP command attempts to generate a process dump file.

> Reading Dumps

> The ASCII representation is read left to right. The hexadecimal, decimal, and octal representations are read right to left.

> Specifying Numeric Qualifier Values

> The numeric values for the /BLOCKS, /RECORDS, and /NUMBER qualifiers can be specified either as decimal numbers or with a leading %X, %O, or %D to signify hexadecimal, octal, or decimal numbers respectively. For example, the following are all valid ways to specify decimal value 24:

> > 24
> > %X18
> > %O30
> > %D24

### Qualifiers

> #### /ALLOCATED

> Includes in the dump all blocks allocated to the file. (By default, the dump does not include blocks following the end-of-file [EOF].)

> You can specify the /ALLOCATED qualifier if the input is a disk that is mounted without the /FOREIGN qualifier. The /ALLOCATED and /RECORDS qualifiers are mutually exclusive.

> #### /BLOCKS[=(option[,...])]

> Dumps the specified blocks one block at a time, which is the default method for all devices except network devices.

> Block numbers are specified as integers relative to the beginning of the file. Typically, blocks are numbered beginning with 1. If a disk device is mounted using the /FOREIGN qualifier, blocks are numbered beginning with zero. Select a range of blocks to be dumped by specifying one of the following options:

> START: n | Specifies the number of the first block to be dumped; the default is the first block.
> END: n | Specifies the number of the last block to be dumped; the default is the last block or the end-of-file (EOF) block, depending on whether you have specified the /ALLOCATED qualifier.
> COUNT: n | Specifies the number of blocks to be dumped. The COUNT option provides an alternative to the END option; you cannot specify both.

> If you specify only one option, you can omit the parentheses.

> The /BLOCKS and /RECORDS qualifiers are mutually exclusive.

> Use the /BLOCKS qualifier to dump random blocks from Files-11 volumes. This procedure requires LOG-IO (logical I/O) privilege.

> #### /BYTE

> Formats the dump in bytes. The /BYTE, /LONGWORD, and /WORD qualifiers are mutually exclusive. The default format is composed of longwords.

> #### /DECIMAL

> Dumps the file in decimal radix. The /DECIMAL, /HEXADECIMAL (default), and /OCTAL qualifiers are mutually exclusive.

> #### /DESCRIPTOR[=(option[,...])]

> Dumps the specified ISO 9660 volume descriptors in a formatted manner. If /NOFORMATTED is specified, block mode format is used.

> The descriptor options that you can specify are as follows:

> BOOT: n | Searches for the nth occurrence of a Boot Record.
> PVD: n | Searches for the nth occurrence of a Primary Volume Descriptor.
> SVD: n | Searches for the nth occurrence of a Supplementary Volume Descriptor.
> VPD: n | Searches for the nth occurrence of a Volume Partition Descriptor.
> VDST: n | Searches for the nth occurrence of a Volume Descriptor Set Terminator.

> If you specify only one option, you can omit the parentheses.

> ISO 9660 descriptors are specified by their ordinal position from the start of the volume, defaulting to 1 if they are not specified. The ISO 9660 volume is sequentially searched from the beginning of the volume descriptor set sequence to the end to find the specified descriptor and output it in a formatted manner.

> #### /DIRECTORY

> Dumps data blocks of the specified file as formatted on-disk structures for Files-11 On-Disk Structure Level 1, 2, or 5 directory records, ISO 9660, or High Sierra directory records.

> #### /EXACT

> Use with the /PAGE=SAVE and /SEARCH qualifiers to specify a search string that must match the search string exactly and must be enclosed with quotation marks (" ").

> If you specify the /EXACT qualifier without the /SEARCH qualifier, exact search mode is enabled when you set the search string with the Find (E1) key.

> #### /FILE_HEADER

> Dumps each data block that is a valid Files-11 header in Files-11 header format rather than in the selected radix and length formats.

> #### /FORMATTED (default)

> #### /NOFORMATTED

> Dumps the file header in Files-11 format; the /NOFORMATTED qualifier dumps the file header in octal format. This qualifier is useful only when the /HEADER qualifier is specified.

> #### /HEADER

> Dumps the file header and access control list (ACL). To dump only the file header, and not the file contents, also specify /BLOCK=(COUNT:0). The /HEADER qualifier is invalid for devices mounted using the /FOREIGN qualifier.

> Use the /FORMATTED qualifier to control the format of the display.

> You can use the /FILE_HEADER qualifier with the /HEADER qualifier to have Files-11 file headers printed in an interpreted representation.

> By default, the file header is not displayed.

> #### /HEXADECIMAL (default)

> Dumps the file in hexadecimal radix. The /DECIMAL, /HEXADECIMAL (default), and /OCTAL qualifiers are mutually exclusive.

> #### /HIGHLIGHT[=keyword]

> Use with the /PAGE=SAVE and /SEARCH qualifiers to specify the type of highlighting you want when a search string is found. When a string is found, the entire line is highlighted. You can use the following keywords: BOLD, BLINK, REVERSE, and UNDERLINE. BOLD is the default highlighting.

> #### /IDENTIFIER=file-id

> Dumps the file selected by the file identification (FID) number from the specified volume. For further information, see the /FILE_ID qualifier from the DCL command, DIRECTORY.

> #### /LONGWORD (default)

> Formats the dump in longwords. The /BYTE, /LONGWORD, and /WORD qualifiers are mutually exclusive.

> #### /MEDIA_FORMAT=keyword

> Specifies the format in which a data structure is to be dumped. If you specify this qualifier, you must use one of the following keywords:

> CDROM | Specifies ISO 9660 media format. This format is the default if you do not specify the /MEDIA_FORMAT qualifier.
> CDROM_HS | Specifies High Sierra media format.

> #### /NUMBER[=n]

> Specifies how byte offsets are assigned to the lines of output. If you specify the /NUMBER qualifier, the byte offsets increase continuously through the dump, beginning with n; if you omit the /NUMBER qualifier, the first byte offset is zero. By default, the byte offset is reset to zero at the beginning of each block or record.

> #### /OCTAL

> Dumps the file in octal radix. The /DECIMAL, /HEXADECIMAL (default), and /OCTAL qualifiers are mutually exclusive.

> #### /OUTPUT[=filespec]

> Specifies the output file for the dump. If you do not specify a file specification, the default is the file name of the file being dumped and the file type .DMP. If the /OUTPUT qualifier is not specified, the dump goes to SYS$OUTPUT. The /OUTPUT and /PRINTER qualifiers are mutually exclusive.

> #### /PAGE[=keyword]

> #### /NOPAGE (default)

> Controls the display of dump information on the screen.

> You can use the following keywords with the /PAGE qualifier:

> CLEAR_SCREEN | Clears the screen before each page is displayed.
> SCROLL | Displays information one line at a time.
> SAVE[= n] | Enables screen navigation of information, where n is the number of pages to store.

> The /PAGE=SAVE qualifier allows you to navigate through screens of information. The /PAGE=SAVE qualifier stores up to 5 screens of up to 255 columns of information. When you use the /PAGE=SAVE qualifier, you can use the following keys to navigate through the information:

> Key Sequence | Description
> --- | ---
> Up arrow key, Ctrl/B | Scroll up one line.
> Down arrow key | Scroll down one line.
> Left arrow key | Scroll left one column.
> Right arrow key | Scroll right one column.
> Find (E1) | Specify a string to find when the information is displayed.
> Insert Here (E2) | Scroll right one half screen.
> Remove (E3) | Scroll left one half screen.
> Select (E4) | Toggle 80/132 column mode.
> Prev Screen (E5) | Get the previous page of information.
> Next Screen (E6), Return, Enter, Space | Get the next page of information.
> F10, Ctrl/Z | Exit. (Some utilities define these differently.)
> Help (F15) | Display utility help text.
> Do (F16) | Toggle the display to oldest/newest page.
> Ctrl/W | Refresh the display.

> The /PAGE qualifier is not compatible with the /OUTPUT qualifier.

> #### /PATH_TABLE

> Dumps data blocks in ISO 9660 Path Table format.

> #### /PRINTER

> Queues the dump to SYS$PRINT in a file named with the file name of the file being dumped and the file type .DMP. If the /PRINTER qualifier is not specified, the dump goes to SYS$OUTPUT. The asterisk (*) and the percent sign (%) wildcard characters are not allowed. The /OUTPUT and /PRINTER qualifiers are mutually exclusive.

> #### /PROCESS [/ID=pid] [process-name]

> Attempts to generate a process dump. The default process is the current process. To generate a target process dump, specify either the process ID or the process name.

> #### /RECORDS[=(option[,...])]

> Dumps the file a record at a time rather than a block at a time. (By default, input is dumped one block at a time for all devices except network devices.)

> Records are numbered beginning with 1.

> Select a range of records to be dumped by specifying one of the following options:

> START: n | Specifies the number of the first record to be dumped; the default is the first record.
> END: n | Specifies the number of the last record to be dumped; the default is the last record of the file.
> COUNT: n | Specifies the number of records to be dumped. The COUNT option provides an alternative to the END option; you cannot specify both.

> If you specify only one option, you can omit the parentheses.

> If you specify the /RECORDS qualifier, you cannot specify the /ALLOCATED or the /BLOCKS qualifier.

> #### /SEARCH="string"

> Use with the /PAGE=SAVE qualifier to specify a string that you want to find in the information being displayed. Quotation marks are required for the /SEARCH qualifier, if you include spaces in the text string.

> You can also dynamically change the search string by pressing the Find key (E1) while the information is being displayed. Quotation marks are not required for a dynamic search.

> #### /STYLE=keyword

> Specifies the file name format for display purposes while performing a file dump.

> The valid keywords for this qualifier are CONDENSED and EXPANDED. Descriptions are as follows:

> Keyword | Explanation
> --- | ---
> CONDENSED (default) | Displays the file name representation of what is generated to fit into a 255-length character string. This file name may contain a DID or FID abbreviation in the file specification.
> EXPANDED | Displays the file name representation of what is stored on disk. This file name does not contain any DID or FID abbreviations.

> The keywords CONDENSED and EXPANDED are mutually exclusive. This qualifier specifies which file name format is displayed in the output header.

> File errors are displayed with the CONDENSED file specification unless the EXPANDED keyword is specified.

> Refer to the OpenVMS Guide to Extended File Specifications for more information.

> #### /VALIDATE_HEADER

> Verifies /DIRECTORY records for Files-11.

> #### /WIDTH=n

> Formats the dump output into 80 or 132 columns by specifying n as either 80 or 132.

> #### /WORD

> Formats the dump in words. The /BYTE, /LONGWORD, and /WORD qualifiers are mutually exclusive.

> #### /WRAP

> #### /NOWRAP (default)

> Use with the /PAGE=SAVE qualifier to limit the number of columns to the width of the screen and to wrap lines that extend beyond the width of the screen to the next line.

> The /NOWRAP qualifier extends lines beyond the width of the screen and can be seen when you use the scrolling (left and right) features provided by the /PAGE=SAVE qualifier.

###

#### Examples

#1
    $ DUMP TEST.DAT
    Dump of file DISK0:[MOORE]TEST.DAT;1 on 14-DEC-2001 15:43:26.08
    File ID (3134,818,2)   End of file block 1 / Allocated 3
    Virtual block number 1 (00000001), 512 (0200) bytes
     706D6173 20612073 69207369 68540033 3.This is a samp 000000
     73752065 62206F74 20656C69 6620656C le file to be us 000010
     61786520 504D5544 2061206E 69206465 ed in a DUMP exa 000020
     00000000 00000000 0000002E 656C706D mple............ 000030
     00000000 00000000 00000000 00000000 ................ 000040
     00000000 00000000 00000000 00000000 ................ 000050
     00000000 00000000 00000000 00000000 ................ 000060
              .
              .
              .
     00000000 00000000 00000000 00000000 ................ 0001E0
     00000000 00000000 00000000 00000000 ................ 0001F0

> The DUMP command displays the contents of TEST.DAT both in hexadecimal longword format and in ASCII beginning with the first block in the file.

#2
    $ DUMP TEST.DAT/OCTAL/BYTE
    Dump of file DISK0:[SCHELL]TEST.DAT;1 on 14-DEC-2001 15:45:33.58
    File ID (74931,2,1)   End of file block 1 / Allocated 3
    Virtual block number 1 (00000001), 512 (0200) bytes
     151 040 163 151 150 124 000 063 3.This i 000000
     160 155 141 163 040 141 040 163 s a samp 000010
     040 145 154 151 146 040 145 154 le file  000020
     163 165 040 145 142 040 157 164 to be us 000030
     040 141 040 156 151 040 144 145 ed in a  000040
     141 170 145 040 120 115 125 104 DUMP exa 000050
     377 377 000 056 145 154 160 155 mple.... 000060
     000 000 000 000 000 000 000 000 ........ 000070
     000 000 000 000 000 000 000 000 ........ 000100
     000 000 000 000 000 000 000 000 ........ 000110
              .
              .
              .
     000 000 000 000 000 000 000 000 ........ 000760
     000 000 000 000 000 000 000 000 ........ 000770

> The DUMP command displays the image of the file TEST.DAT, formatted both in octal bytes and in ASCII characters beginning with the first block.

#3
    $ DUMP NODE3::DISK2:[STATISTICS]RUN1.DAT

> This command line dumps the file RUN1.DAT that is located at remote node NODE3. The default DUMP format will be used.

#4
    $ DUMP/HEADER/BLOCK=COUNT=0 SYS$SYSTEM:DATASHARE.EXE
    Dump of file SYS$SYSTEM:DATASHARE.EXE on  12-NOV-2001 16:06:46.75
    File ID (16706,59,0)   End of file block 410 / Allocated 411

                                 File Header

    Header area
        Identification area offset:           40
        Map area offset:                      100
        Access control area offset:           255
        Reserved area offset:                 255
        Extension segment number:             0
        Structure level and version:          2, 1
        File identification:                  (16706,59,0)
        Extension file identification:        (0,0,0)
        VAX RMS attributes
            Record type:                      Fixed
            File organization:                Sequential
            Record attributes:                <none specified>
            Record size:                      512
            Highest block:                    411
            End of file block:                410
            End of file byte:                 414
            Bucket size:                      0
            Fixed control area size:          0
            Maximum record size:              512
            Default extension size:           0
            Global buffer count:              0
            Directory version limit:          0
        File characteristics:                 Contiguous best try
        Caching attribute:                    Writethrough
        Map area words in use:                3
        Access mode:                          0
        File owner UIC:                       [1,4]
        File protection:                      S:RWED, O:RWED, G:RE, W:
        Back link file identification:        (7149,80,0)
        Journal control flags:                <none specified>
        Active recovery units:                None
        Highest block written:                411
        Client attributes:                    None

    Identification area
        File name:                            DATASHARE.EXE
        Revision number:                      1
        Creation date:                        12-AUG-2001 14:06:49.84
        Revision date:                        12-AUG-2001 14:06:53.20
        Expiration date:                      <none specified>
        Backup date:                          <none specified>

    Map area
        Retrieval pointers
            Count:        411        LBN:    1297155

    Checksum:                                 30710

> In this example, the DUMP command dumps the file header of the specified file. Because this file is recorded on Files-11 ODS-2 9660 media, the file header is displayed in a Files-11 File Header format. Imbedded on the Files-11 Header is a VAX RMS attributes block.

#5
    $ DUMP/HEADER/BLOCK=COUNT=0 DISK$GRIPS_2:[000000]AAREADME.TXT;
    Dump of file DISK$GRIPS_2:[000000]AAREADME.TXT;1 on 15-DEC-2001
    10:07:29.70
       File ID (4,6,0)   End of file block 29 / Allocated 29

                                ISO 9660 File Header

       Length of Directory Record:              48
       Extended Attribute Length:               1
       Location of Extent (LSB/MSB):            312/312
       Data Length of File Section (LSB/MSB):   14640/14640
       Recording Date and Time                  10-DEC-2001 16:22:30 GMT(0)
       File Flags                               RECORD, PROTECTION
       Interleave File Unit size:               0
       Interleave Gap size:                     0
       Volume Sequence # of extent (LSB/MSB):   1/1
       File Identifier Field Length:            14
       File Identifier:                         AAREADME.TXT;1
       System Use
    5458542E 454D4441 45524141 0E010000 01000018 001E1610 100B5930 39000000
    ...90Y..............AAREADME.TXT 000000
                                                                     00313B
    ;1.............................. 000020

    Extended Attribute record
       Owner Identification (LSB/MSB):        7/7
       Group Identification (LSB/MSB):        246/246
       Access permission for classes of users S:R, O:R, G:RE, W:RE
       File Creation Date/Time:               5-OCT-2001 14:17:49.29 GMT(0)
       File Modification Date/Time:           6-NOV-2001 16:22:30.96 GMT(0)
       File Expiration Date/Time:             00-00-0000 00:00:00.00 GMT(0)
       File Effective Date/Time:              00-00-0000 00:00:00.00 GMT(0)
       Record Format                          Fixed
       Record Attributes                      CRLF
       Record Length (LSB/MSB):               80/80
       System Identifier:
       System Use
       Extended Attribute Version:            1
       Escape Sequence record length:         0
       Application Use Length (LSB/MSB):      0/0
       Application Use

       VAX RMS attributes
           Record type:                      Fixed
           File organization:                Sequential
           Record attributes:                Implied carriage control
           Record size:                      80
           Highest block:                    29
           End of file block:                29
           End of file byte:                 304
           Bucket size:                      0
           Fixed control area size:          0
           Maximum record size:              80
           Default extension size:           0
           Global buffer count:              0
           Directory version limit:          0

> The DUMP/HEADER command dumps the file header of the specified file. Because this file is recorded on ISO 9660 media, the file header is displayed in the format of an ISO 9660 File Header and, since this file contains an optional ISO 9660 Extended Attribute Record (XAR), it is also displayed. Finally, as with all DUMP/HEADER requests, VAX RMS attributes are displayed.

Previous | Next | Contents | Index

| privacy and legal statement |
9996PRO_017.HTML