/sys$common/syshlp/HELPLIB.HLB  —  ANALYZE  /RMS_FILE, Qualifiers

1    /CHECK

    Checks the integrity of the file and generates a report of any
    errors in its structure. The report produced by the /CHECK
    qualifier includes a list of any errors and a summary of the
    file's structure. If you do not specify an output file, the
    report is written to the current SYS$OUTPUT device, which is
    generally your terminal. You can use wildcards and multiple file
    specifications. If you specify /NOOUTPUT, you only get a message
    indicating whether the file has errors.

    The check function is active by default when you use the ANALYZE
    /RMS_FILE command without any qualifiers. The /CHECK qualifier
    is not compatible with the /FDL qualifier, the /INTERACTIVE
    qualifier, the /STATISTICS qualifier, or the /SUMMARY qualifier.
    If /CHECK is used with any of the other qualifiers, /FDL takes
    precedence, next is /INTERACTIVE, then /STATISTICS, and lastly
    /SUMMARY.

2    /FDL

    Generates an FDL file describing the RMS data file being
    analyzed. By default, the /FDL qualifier creates a file with the
    file type .FDL and the same file name as the input data file. To
    assign a different type or name to the FDL file, use the /OUTPUT
    qualifier. If the data file is corrupted, the FDL file contains
    the Analyze/RMS_File utility error messages.

    For indexed files, the FDL file contains special analysis
    sections you can use with the EDIT/FDL Optimize script to make
    better design decisions when you reorganize the file.

    You cannot use wildcards or multiple file specifications with
    the /FDL qualifier. The /FDL qualifier is not compatible with the
    /CHECK qualifier, the /INTERACTIVE qualifier, the /STATISTICS
    qualifier, the /SUMMARY qualifier, or the /UPDATE_HEADER
    qualifier.  The /FDL qualifier takes precedence over all other
    qualifiers.

3    /INTERACTIVE

    Begins an interactive examination of the file's structure. You
    cannot use wildcards or multiple file specifications. For help
    with the interactive commands, enter the HELP command at the
    ANALYZE> prompt.

    Do not use this qualifier with the /CHECK, /FDL, /STATISTICS,
    /SUMMARY, or /UPDATE_HEADER qualifiers.  If used with the /FDL
    qualifier, the /FDL takes precedence.  All other qualifiers are
    ignored when used with /INTERACTIVE.

4    /OUTPUT

    /OUTPUT=filesspec
    /NOOUTPUT

    Identifies the destination file for the results of the analysis.
    The /NOOUTPUT qualifier specifies that no output file is to be
    created. In all cases, the Analyze/RMS_File utility displays a
    message indicating whether the data file has errors.

    /CHECK          Places the integrity report in the output file.
                    The default file type is .ANL, and the default
                    file name is ANALYZE. If you omit the output-
                    filespec parameter, output is written to the
                    current SYS$OUTPUT device, which is generally
                    your terminal.
    /FDL            Places the resulting FDL specification in the
                    output file. The default file type is .FDL, and
                    the default file name is that of the input file.
    /INTERACTIVE    Places a transcript of the interactive session in
                    the output file. The default file type is .ANL,
                    and the default file name is ANALYZE. If you omit
                    the output-filespec parameter, no transcript of
                    your interactive session is produced.
    /RU_JOURNAL     Places the recovery-unit journal information in
                    the output file. The default file type is .ANL,
                    and the default file name is ANALYZE. If you
                    omit the output-filespec parameter, output is
                    written to the current SYS$OUTPUT device, which
                    is generally your terminal.
    /STATISTICS     Places the statistics report in the output file.
                    The default file type is .ANL, and the default
                    file name is ANALYZE. If you omit the output-
                    filespec parameter, output is written to the
                    current SYS$OUTPUT device, which is generally
                    your terminal.
    /SUMMARY        Places the summary report in the output file.
                    The default file type is .ANL, and the default
                    file name is ANALYZE. If you omit the output-
                    filespec parameter, output is written to the
                    current SYS$OUTPUT device, which is generally
                    your terminal.

5    /RU_JOURNAL

    Provides information about recovery-unit journaling where
    applicable. You can use the /RU_JOURNAL qualifier on any file,
    but it is inoperative on files not marked for recovery-unit
    journaling.

    This qualifier provides the only way of accessing a file that
    would otherwise be inaccessible because of unresolved recovery
    units. This situation might be the result of an unavailable
    recovery-unit journal file or of unavailable data files that
    were included in the recovery unit.

    To use the /RU_JOURNAL qualifier, your process must have both
    CMEXEC privilege and access to the [SYSJNL] directory (either
    SYSPRV privilege or access for UIC [1,4]).

    This qualifier is compatible with all of the ANALYZE/RMS_FILE
    qualifiers, and you can use it with wildcards and multiple file
    specifications.

    When you specify the /RU_JOURNAL qualifier, the Analyze/RMS_File
    utility provides you with the following data for each active
    recovery unit:

    o  The journal file specification and the journal creation date

    o  The recovery-unit identification, recovery-unit start time,
       cluster system identification number (CSID), and process
       identification (PID)

    o  Information about the files involved in the recovery unit,
       including the file specification, the name of the volume where
       the file resides, the file identification, the date and time
       the file was created, and the current status of the file

    o  The state of the recovery unit - active, none, started,
       committed, or not available (for more information, see the
       RMS Journaling for OpenVMS Manual)

    o  An error statement

6    /STATISTICS

    Specifies that a report is to be produced containing statistics
    about the file. The /STATISTICS qualifier is used mainly on
    indexed files.

    By default, if you do not specify an output file with the /OUTPUT
    qualifier, the statistics report is written to the current
    SYS$OUTPUT device, which is generally your terminal.

    The /STATISTICS qualifier is not compatible with the /CHECK
    qualifier, the /FDL qualifier, the /INTERACTIVE qualifier, or
    the /SUMMARY qualifier.  If /STATISTICS is used with any other
    qualifiers, /FDL takes precedence, and then /INTERACTIVE.  All
    other qualifiers are ignored.  The /STATISTICS qualifier does an
    implicit check.

7    /SUMMARY

    Specifies that a summary report is to be produced containing
    information about the file's structure and use. The /SUMMARY
    qualifier generates a summary report containing information about
    the file's structure and use.

    If the file has no errors, the output generated from the /SUMMARY
    qualifier is identical to that produced by the /CHECK qualifier.
    Unlike the /CHECK qualifier, however, the /SUMMARY qualifier does
    not check the structure of your file, so output is generated more
    quickly.

    Do not use this qualifier with the /CHECK qualifier, the /FDL
    qualifier, the /INTERACTIVE qualifier, the /STATISTICS qualifier,
    or the /UPDATE_HEADER qualifier.  If /SUMMARY is used with any
    other qualifiers, /FDL takes precedence, next is /INTERACTIVE,
    and then /STATISTICS.

8    /UPDATE_HEADER

    Attempts to update the following attributes in the header of
    the file: longest record length (LRL) and/or file length hint
    attribute.

    You must use this qualifier in combination with either
    /STATISTICS or /CHECK (the default).

    This qualifier only applies to sequential file organizations and
    is ignored for any other file organization. The /UPDATE_HEADER
    qualifier attempts to update the LRL and/or file hint attribute
    in the file header if the calculated value(s) differ from the
    current value(s) in the file header. The /UPDATE_HEADER qualifier
    applies to:

    o  An LRL request - if the file is sequential and has a record
       format other than undefined (UDF).

    o  A HINT request - if the file is sequential, the record format
       is either variable (VAR) or variable with fixed control (VFC),
       and the file is located on an ODS-5 disk device.

    It is not supported for remote accesses; requests are ignored.

    The /UPDATE_HEADER qualifier requires either the STATISTICS or
    CHECK (default) functions since calculating new values for the
    LRL and/or file length hint presumes that all the records in the
    sequential file are processed. It is not compatible with the /FDL
    qualifier, the /INTERACTIVE qualifier, or the /SUMMARY qualifier.

    Any errors returned by the file system when an attempt to update
    the file header fails are ignored. If the update succeeds, the
    updated values are displayed at the end of the report.
Close Help