/sys$common/syshlp/DEFRAGMENT.HLB
DEFRAGMENT, VOLUME, Qualifiers

 *Conan The Librarian

1 - /BRIEF

       /BRIEF (default)
       /NOBRIEF

          The /BRIEF qualifier has meaning only when the /LOG
          qualifier is also present. The /BRIEF qualifier
          requests a brief log of all actions taken by the
          defragmentation process. This log includes beginning
          and ending volume status information. The /BRIEF
          and /FULL qualifiers are mutually exclusive, and
          /NOBRIEF produces the same result as /FULL. The
          /BRIEF qualifier is the default.

2 - /CONSOLIDATE_FREESPACE

       /CONSOLIDATE_FREESPACE (default)
       /NOCONSOLIDATE_FREESPACE

          The /CONSOLIDATE_FREESPACE qualifier tells the Disk
          File Optimizer to use its free space consolidation
          algorithm.

3 - /CPU_LIMIT

       /CPU_LIMIT=n
       /NOCPU_LIMIT

          The /CPU_LIMIT qualifier specifies the percent of
          CPU resources to be used for any one defragmentation
          process. If this percentage is exceeded, the priority
          for the process drops to the minimum, as specified by
          the /PRIORITY qualifier, or defaults to three.

4 - /DORMANT

       /DORMANT=(file-spec[,...])
       /NODORMANT (default)

          The /DORMANT qualifier indicates files to be
          considered dormant when final file placement
          decisions are made. Dormant files are placed at the
          high end of the volume.

          If a file is indicated in both the DORMANT and
          FREQUENT lists, it is considered dormant. If a file
          is indicated in both the EXCLUDE and DORMANT lists,
          it is excluded.

                                      NOTE

             The amount of free space on the volume, the
             number of files currently being accessed, and
             other factors influence file placement. The
             Disk File Optimizer does not guarantee file
             placement, but makes every effort to place files
             as described.

5 - /EPILOGUE

       /EPILOGUE={file-name}
       /NOEPILOGUE (default)

          The /EPILOGUE qualifier identifies a DCL command file
          which DFO executes upon completion of the DEFRAGMENT
          operation.

6 - /EXCLUDE

       /EXCLUDE=(file-spec[,...])
       /NOEXCLUDE (default)

          The /EXCLUDE qualifier specifies files to be excluded
          from processing. The defragmentation process ignores
          files matching the listed file specifications. Any
          file indicated in the EXCLUDE list and in either
          the FREQUENT or DORMANT lists is excluded from
          processing.

                                      NOTE

             The defragmentation process always excludes
             system files, open files, files excluded in an
             options file (/OPTIONS qualifier), and files
             excluded using the /IGNORE qualifier.

7 - /FREQUENT

       /FREQUENT=(file-spec[,...])
       /NOFREQUENT (default)

          The /FREQUENT qualifier indicates files to be
          considered frequently accessed when final file
          placement decisions are made. Frequent files are
          placed toward the center of the volume.

          If a file is indicated in both the FREQUENT and
          DORMANT lists, it is considered dormant. If a file
          is indicated in both the FREQUENT and EXCLUDE lists,
          it is excluded.

                                      NOTE

             The amount of free space on the volume, the
             number of files currently being accessed, and
             other factors influence file placement. The
             Disk File Optimizer does not guarantee file
             placement, but makes every effort to place files
             as described.

8 - /FULL

       /FULL
       /NOFULL (default)

          The /FULL qualifier requests a full log of all
          actions taken by the defragmentation process.
          The /FULL qualifier must be used with the /LOG
          qualifier. The /FULL and /BRIEF qualifiers are
          mutually exclusive, and /NOFULL provides the same
          functionality as /BRIEF.

9 - /HOTFILE_DATABASE

       /HOTFILE_DATABASE
       /NOHOTFILE_DATABASE (default)

          The /HOTFILE_DATABASE qualifier causes the
          defragmenter to query the appropriate hotfile
          database and append the list of hotfiles to the
          defragmenter's /FREQUENT file list.

10 - /IGNORE

       /IGNORE=(keyword[,...])
       /IGNORE=(PLACED) (default)
       /NOIGNORE

          The /IGNORE qualifier requests that the
          defragmentation process ignore certain types of files
          as specified by the following keywords:

          o  INDEXED-Ignores all RMS indexed files

          o  NOINDEXED-May defragment RMS indexed files

          o  PLACED-Ignores all files with explicit placement
             flags set in their headers

          o  NOPLACED-May defragment files with explicit
             placement flags

          Files indicated by the /IGNORE qualifier are added to
          the EXCLUDE list.

          The default value (/IGNORE=PLACED) indicates that
          files with explicit placement control should be
          ignored, and that RMS indexed files should be
          defragmented and placed in appropriate locations
          on the volume.

11 - /IO_LIMIT

       /IO_LIMIT=n
       /NOIO_LIMIT

          The /IO_LIMIT qualifier specifies the maximum direct
          I/O rate (per second) of any one defragmentation
          process. If the I/O rate is exceeded, the priority
          for the process drops to the minimum priority as
          specified by the /PRIORITY qualifier or defaults to
          three.

12 - /LEVEL

       /LEVEL={n}
       /LEVEL=2 (default)

          The defragmentation process selects files for
          defragmentation (from among those not excluded) based
          on the /LEVEL qualifier. Once a file is selected as
          a candidate, the defragmentation process attempts
          to fully defragment that file (make it 100 percent
          contiguous). Specify the level number as an integer
          ranging from one to five:

          o  /LEVEL=1

             Any file that is not 100 percent contiguous, or
             that can be selected using levels two and three,
             is a candidate for defragmentation.

          o  /LEVEL=2 (default)

             Any file whose extents cannot be completely
             mapped by the mapping window, or that can be
             selected using level three, is a candidate for
             defragmentation. The default window value is seven
             and can be set for a given volume using:

             $ SET VOLUME {device-spec}/WINDOWS=[n]

          o  /LEVEL=3

             Any file with retrieval pointers in more than one
             file header is a candidate for defragmentation.

          o  /LEVEL=4

             The defragmentation process for level four
             processing performs only free space consolidation.
             This level is used with the /CONSOLIDATE_FREESPACE
             qualifier.

          o  /LEVEL=5

             This level requests a volume analysis only;
             no defragmentation occurs. The statistical
             results are available in the log file, which is
             required when /LEVEL=5 is selected (see the /LOG
             qualifier). If level 5 is selected, the /LEVEL=2
             candidate file specifications are listed in the
             full log file.

13 - /LOG

       /LOG={file-spec}
       /NOLOG (default)

          The /LOG qualifier causes the defragmentation process
          to create a file containing a list of all its
          operations. The information in the log file varies
          with the presence of the /FULL or /BRIEF qualifiers.
          The /FULL qualifier lists all files analyzed by the
          defragmentation process and reports their status
          during each phase of defragmentation. The /BRIEF
          qualifier lists only the statistics of each phase,
          such as number of files analyzed, and number of files
          defragmented.

14 - /OPCOM_NOTIFICATION

       /OPCOM_NOTIFICATION (default)
       /NOOPCOM_NOTIFICATION

          The /OPCOM_NOTIFICATION qualifier requests that
          brief status and termination messages regarding
          defragmentation processes be sent to OPCOM.

15 - /OPTIONS

       /OPTIONS={file-spec}
       /NOOPTIONS (default)

          The /OPTIONS qualifier provides an alternate method
          for associating files with the /DORMANT, /EXCLUDE, or
          /FREQUENT qualifiers. If the list of files for any of
          these qualifiers is long, you can create a separate
          file that contains this information. Each record in
          the options file consists of a file name followed by
          one of the following keywords:

          o  /EXCLUDE-File to be excluded

          o  /FREQUENT-File to be considered frequently
             accessed

          o  /DORMANT-File to be considered dormant

          The following example shows the contents of an
          options file called MYOPTFILE.OPT. This file
          specifies that all files on the target device called
          FILE1.EXE are frequent files, all files in the
          [ARCHIVE] directory are to be excluded, and all files
          in the [OLDSTUFF] directory and its subdirectories
          are dormant.

          FILE1.EXE/FREQUENT
          [ARCHIVE]*.*;*/EXCLUDE
          [OLDSTUFF...]*.*;*/DORMANT

          Files indicated by the /EXCLUDE qualifier and by
          either the /DORMANT or /FREQUENT qualifier are
          excluded. Files indicated by the /DORMANT and
          /FREQUENT qualifiers are considered dormant. This
          rule is applied equally across all files specified in
          the /OPTIONS file on the command line.

16 - /PRIORITY

       /PRIORITY=(DEFAULT=n, MINIMUM=n)
       /NOPRIORITY (default)

          The /PRIORITY qualifier specifies priorities for the
          defragment process. The minimum priority setting is
          used when the defragmentation process exceeds the
          value specified by either /CPU_LIMIT or /IO_LIMIT.

17 - /PROLOGUE

       /PROLOGUE={file-name}
       /NOPROLOGUE (default)

          The /PROLOGUE qualifier identifies a DCL command
          file which DFO executes just before the Defragment
          operation starts.

18 - /RVN

       /RVN=n
       /RVN=0 (default)

          When you have a bound volume set, use this qualifier
          to identify a disk from the volume set or all disks
          in the volume set. The default of zero tells the Disk
          File Optimizer to defragment all disks in the bound
          volume set. Specify a relative volume number (RVN)
          to defragment a specific disk that belongs to a bound
          volume set.

19 - /TIME_LIMIT

       /TIME_LIMIT={delta-time}
       /NOTIME_LIMIT (default)

          The /TIME_LIMIT qualifier specifies the maximum
          elapsed time allowed for a given defragmentation
          operation. If the time limit is exceeded, the
          defragmentation process is aborted.

          Specify time as a delta time. Refer to the OpenVMS
          User's Manual for more information on specifying
          times.

          If the time limit is set unreasonably low, the
          defragmentation process may not accomplish useful
          defragmentation.

20 - /WAIT

       /WAIT (default)
       /NOWAIT

          The /WAIT qualifier causes the input device to wait
          until the defragmentation process finishes before
          returning control to the user.

21 - /WRITE_CHECK

       /WRITE_CHECK
       /NOWRITE_CHECK (default)

          The /WRITE_CHECK qualifier requests that a read-
          after-write check be performed on all defragmented
          or placed files. This qualifier significantly extends
          the execution time of a defragmentation process.
  Close     Help