HELPLIB.HLB  —  DUMP  Qualifiers

1    /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.

2    /BLOCKS

       /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.

3    /BYTE

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

4    /DECIMAL

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

5    /DESCRIPTOR

       /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.

6    /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.

7    /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.

8    /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.

9    /FORMATTED

       /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.

10    /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.

11    /HEXADECIMAL

       /HEXADECIMAL (default)

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

12    /HIGHLIGHT

       /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.

13    /IDENTIFIER

       /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.

14    /LONGWORD

       /LONGWORD (default)

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

15    /MEDIA_FORMAT

       /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.

16    /NUMBER

       /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.

17    /OCTAL

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

18    /OUTPUT

       /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.

19    /PAGE

       /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),         Get the next page of information.
    Return, Enter, Space
    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.

20    /PATH_TABLE

    Dumps data blocks in ISO 9660 Path Table format.

21    /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.

22    /PROCESS

    Attempts to generate a process dump.

23    /RECORDS

       /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.

24    /SEARCH

       /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.

25    /STYLE

       /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   Displays the file name representation of what is
    (default)   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.

    See the OpenVMS User's Manual for more information.

26    /SYMLINK

       /SYMLINK=keyword
       /NOSYMLINK (default)

    If an input file is a symbolic link, the file referred to by the
    symbolic link is the file that is dumped.

    The /SYMLINK qualifier indicates that any input symbolic link is
    dumped.

    The valid keywords for this qualifier are [NO]WILDCARD,
    [NO]ELLIPSIS, and [NO]TARGET. Descriptions are as follows:

    Keyword     Explanation

    NOWILDCARD  Indicates that symlinks are disabled during directory
                wildcard searches.
    WILDCARD    Indicates that symlinks are enabled during wildcard
                searches.
    NOELLIPSIS  Indicates that symlinks are matched for all wildcard
                fields except for ellipsis.
    ELLIPSIS    Equivalent to WILDCARD (included for command
                symmetry).
    TARGET      Indicates that if the target file of the file
                specification is a symlink, then the target file
                is followed.
    NOTARGET    Indicates that the command operates on the target
                file even if it is a symlink.

    If the file named in the DUMP command is a symlink, the command
    by default operates on the symlink target.

27    /VALIDATE_HEADER

    Verifies /DIRECTORY records for Files-11.

28    /WIDTH

       /WIDTH=n

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

29    /WORD

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

30    /WRAP

       /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.
Close Help