[next] [previous] [contents]

  DEVTOOLS SEARCH

  Searches one or more files for the specified string or strings.

  Format

  DEVTOOLS SEARCH file-spec[,...] search-string[,...]

  Parameters
  file-spec

  Specifies the names of one or more files to be searched. You
  must specify at least one file name. If you specify two or
  more file names, separate them with commas.
  Wildcard characters are allowed in the file specification.

  search-string
  Specifies the character string to be located in the specified
  files. Enclose strings containing lowercase letters, blanks,
  or other nonalphanumeric characters (including spaces) in
  quotation marks.

  You can use the /COMMENT, /EXACT and /SYMBOL qual-
  ifiers to alter the way that DEVTOOLS SEARCH matches
  search strings.

  Qualifiers
  /BACKUP

  Modifies the time value specified with the /BEFORE or
  /SINCE qualifier. /BACKUP selects files according to the
  dates of their most recent backups. This qualifier is incom-
  patible with the other qualifiers that also allow you to select
  files according to time attributes: /CREATED, /EXPIRED and
  /MODIFIED. If you specify none of these four time qualifiers,
  the default is /CREATED.

  /BEFORE[=time]
  Selects only those files dated prior to the specified time. You
  can specify time as an absolute time, as a combination of ab-
  solute and delta times, or as one of the following keywords:
  TODAY (default), TOMORROW, or YESTERDAY. Specify
  one of the following qualifiers with /BEFORE to indicate the
  time attribute to be used as the basis for selection: /BACKUP,
  /CREATED (default), /EXPIRED or /MODIFIED.

  See the OpenVMS DCL Concepts Manual for complete
  information on specifying time values.

  /BY_OWNER[=uic]
  Selects only those files whose owner user identification code
  (UIC) matches the specified owner UIC. The default UIC is
  that of the current process.

  Specify the UIC using standard UIC format as described in
  the OpenVMS DCL Concepts Manual.

  /COMMENT (default)
  /NOCOMMENT

  Determines whether DEVTOOLS SEARCH matches strings
  in comments. A comment is defined as a line starting with
  one of the following:
            ! ; # * -- $! // '

  Note that a dollar sign followed by white space and an
  exclamation mark is also consifered as a comment.

  By default, strings are matched whether they are in a com-
  ment or not.

  /CONFIRM
  /NOCONFIRM (default)

  Controls whether a request is issued before each search op-
  eration to confirm that the operation should be performed on
  that file. The following responses are valid:

          YES NO QUIT
          TRUE FALSE



                                      Ctrl/Z



          1 0 ALL



                        Return




  You can use any combination of uppercase and lowercase
  letters for word responses. Word responses can be abbrevi-
  ated to one or more letters (for example, T, TR, or TRU for
  TRUE), but these abbreviations must be unique. Affirmative
  answers are YES, TRUE, and 1. Negative answers include:
  NO, FALSE, 0, and pressing the Return key. Entering QUIT
  or pressing Ctrl/Z indicates that you want to stop processing
  the command at that point. When you respond by enter-
  ing ALL, the command continues to process, but no further
  prompts are given. If you type a response other than one of
  those in the list, DCL issues an error message and redisplays
  the prompt.

  /CREATED
  Modifies the time value specified with the /BEFORE or
  /SINCE qualifier. /CREATED selects files based on their
  dates of creation. This qualifier is incompatible with the
  other qualifiers that also allow you to select files according to
  time attributes: /BACKUP, /EXPIRED and /MODIFIED. If
  you specify none of these four time qualifiers, the default is
  /CREATED.

  /EXACT
  /NOEXACT (default)

  Controls whether the DEVTOOLS SEARCH command
  matches the search string exactly or treats uppercase and
  lowercase letters as equivalents. By default, DEVTOOLS
  SEARCH ignores case differences in letters.

  Specifying the /EXACT qualifier causes the system to use less
  CPU time. Therefore, if you are sure of the case of the letters
  in the string, it is more efficient to use /EXACT.

  /EXCLUDE=(file-spec[,...])
  Excludes the specified files from the search operation. You
  can include a directory but not a device in the file specifica-
  tion. Wildcard characters are allowed in the file specification.
  However, you cannot use relative version numbers to exclude
  a specific version. If you provide only one file specification,
  you can omit the parentheses.

  /EXECUTE=command-filespec
  /NOEXECUTE (default)

  Determines whether DEVTOOLS SEARCH uses a TPU com-
  mand file containing procedures and statements to perform
  changes to the selected files in addition to the standard search
  and replacment changes.

  When the DEVTOOLS SEARCH command initializes, the
  TPU command file specified is read and compiled. After each
  selected file has had the standard search and replace actions,
  the compiled TPU command file statements are executed.

  By default, no actions in addition to the standard search and
  replace are executed.

  /EXPIRED
  Modifies the time value specified with the /BEFORE or
  /SINCE qualifier. /EXPIRED selects files according to their
  expiration dates. (The expiration date is set with the SET
  SECURITY/EXPIRED command.) The /EXPIRED quali-
  fier is incompatible with the other qualifiers that also allow
  you to select files according to time attributes: /BACKUP,
  /CREATED and /MODIFIED. If you specify none of these
  four time qualifiers, the default is /CREATED.

  /LOG[=(option[,...]) (default)
  /NOLOG

  Outputs messages to the output file depending upon the
  option(s) specified.

  The following log options are available:



  Option Meaning

  [NO]ALL Log all information.
  [NO]CHECKED Log each file that was searched.
  NONE Log no information (equivalent to
                                    /NOLOG).
  [NO]FOUND Log each file in which a search
                                    succeded.
  [NO]SUMMARY Produce a summary line indicat-
                                    ing the number of files searched,
                                    the number of files with success-
                                    ful searches, and the number of
                                    successful searches.

  /MODIFIED
  Modifies the time value specified with the /BEFORE or
  /SINCE qualifier. /MODIFIED selects files according to
  the dates on which they were last modified. This quali-
  fier is incompatible with the other qualifiers that also allow
  you to select files according to time attributes: /BACKUP,
  /CREATED and /EXPIRED. If you specify none of these four
  time modifiers, the default is /CREATED.

  /OUTPUT[=output-file-spec]
  /NOOUTPUT

  Specifies the output file specification for the command.

  By default, /OUTPUT=SYS$OUTPUT is assumed. The
  /NOOUTPUT qualifier means that no output will be pro-
  duced by the command.

  /SELECT=(keyword[,...])
  Allows you to select files based on a number of criteria.
  Choose one of the following keywords:

  ACL
  NOACL

                                              Selects files that have an asso-
                                              ciated ACL or files that do not
                                              (NOACL keyword).
  ATTRIBUTES=(option[,...]) Selects files which have partic-
                                              ular attributes. The following
                                              options are supported:



                                              Option Description

                                              [NO]BACKUP Selects
                                                                          files which
                                                                          have
                                                                          backups
                                                                          enabled
                                                                          (BACKUP)
                                                                          or disabled
                                                                          (NOBACKUP)
                                              LRL=MAXIMUM=size Selects
                                                                          files which
                                                                          have a
                                                                          longest
                                                                          record size
                                                                          less than
                                                                          or equal
                                                                          to the
                                                                          specified
                                                                          value.
                                              LRL=MINIMUM=size Selects
                                                                          files which
                                                                          have a
                                                                          longest
                                                                          record size
                                                                          greater
                                                                          than or
                                                                          equal
                                                                          to the
                                                                          specified
                                                                          value.
                                              ORG=type Selects
                                                                          files which
                                                                          have the
                                                                          specified
                                                                          organiza-
                                                                          tion. Valid
                                                                          organi-
                                                                          zations
                                                                          include:

                                                                                DIRECT
                                                                                INDEXED
                                                                                RELATIVE
                                                                                SEQUENTIAL
                                              RFM=type Selects
                                                                          files which
                                                                          have the
                                                                          specified
                                                                          record
                                                                          format.
                                                                          Valid
                                                                          record
                                                                          formats
                                                                          include:

                                                                                STREAM
                                                                                STREAMCR
                                                                                STREAMLF
                                                                                UNDEFINED
                                                                                VARIABLE
                                                                                VFC



  FILE=(option[,...]) Selects portions of the file spec-
                                              ification for display purposes.
                                              The /SELECT=FILE quali-
                                              fier is used to turn off specific
                                              portions by explicit or implicit
                                              specification of the options.
                                              Possible options are:

                                                    [NO]NODE
                                                    [NO]DEVICE
                                                    [NO]DIRECTORY
                                                    [NO]NAME
                                                    [NO]TYPE
                                                    [NO]VERSION
                                              /SELECT=FILE qualifier can-
                                              not be used with the /FULL
                                              qualifier.
  ONLINE
  NOONLINE

                                              Selects files that are online or
                                              shelved.
  PRESHELVED
  NOPRESHELVED

                                              Selects files that are preshelved
                                              or not preshelved.
  SHELVABLE
  NOSHELVABLE

                                              Selects files that are shelvable
                                              or not shelvable.
  SIZE=(option[,...]) Selects files according to their
                                              size. Possible options are:



                                              Option Description

                                              MAXIMUM=n Selects
                                                                          files that
                                                                          have fewer
                                                                          blocks
                                                                          than the
                                                                          value of
                                                                          n, which
                                                                          defaults to
                                                                          1,073,741,823.
                                                                          Use with
                                                                          MINIMUM=n
                                                                          to specify a
                                                                          size range
                                                                          for files to
                                                                          be selected.
                                              MINIMUM=n Selects files
                                                                          that have
                                                                          blocks
                                                                          equal to
                                                                          or greater
                                                                          than the
                                                                          value of n.
                                                                          Use with
                                                                          MAXIMUM=n
                                                                          to specify a
                                                                          size range
                                                                          for files to
                                                                          be selected.
                                              (MINIMUM=n,
                                              MAXIMUM=n)

                                                                          Selects
                                                                          files whose
                                                                          block
                                                                          size falls
                                                                          within the
                                                                          specified
                                                                          MINIMUM
                                                                          and
                                                                          MAXIMUM
                                                                          range.



  /SINCE=[time]
  Selects only those files dated after the specified time. You
  can specify time as an absolute time, a combination of ab-
  solute and delta times, or as one of the following keywords:
  TODAY (default), TOMORROW, or YESTERDAY. Specify
  one of the following qualifiers with /BEFORE to indicate the
  time attribute to be used as the basis for selection: /BACKUP,
  /CREATED (default), /EXPIRED or /MODIFIED.

  See the OpenVMS DCL Concepts Manual for complete
  information on specifying time values.

  /PREFIX
  /NOPREFIX (default)

  Controls whether the DEVTOOLS SEARCH command in-
  terprets the search strings as symbol prefaces rather than
  simple text. If /PREFIX is specified, the search strings only
  match when the values inside the source files have non sym-
  bol constituent characters before the search string. This
  feature is useful when it is necessary to search for an explicit
  word prefix which may exist as a sub-string within other
  words.

  The /PREFIX qualifier cannot be used in conjunction with
  the /SUFFIX and /SYMBOL qualifiers.

  By default, search strings are interpreted as simple text.

  /SUFFIX
  /NOSUFFIX (default)

  Controls whether the DEVTOOLS SEARCH command inter-
  prets the search strings as symbol suffices rather than simple
  text. If /SUFFIX is specified, the search strings only match
  when the values inside the source files have non symbol con-
  stituent characters after the search string. This feature is
  useful when it is necessary to search for an explicit word
  suffix which may exist as a sub-string within other words.

  The /SUFFIX qualifier cannot be used in conjunction with
  the /PREFIX and /SYMBOL qualifiers.

  By default, search strings are interpreted as simple text.

  /SYMBOL
  /NOSYMBOL (default)

  Controls whether the DEVTOOLS SEARCH command inter-
  prets the search strings as symbol names rather than simple
  text. If /SYMBOL is specified, the search strings only match
  when the values inside the source files have non symbol con-
  stituent characters before and after the search string. This
  feature is useful when it is necessary to search for an explicit
  word which may exist as a sub-string within other words.

  The /SYMBOL qualifier cannot be used in conjunction with
  the /PREFIX and /SUFFIX qualifiers.

  By default, search strings are interpreted as simple text.

  /WILDCARDS=option
  /NOWILDCARDS (default)

  Indicates whether the search-string parameter values con-
  tain wildcards, and if so to what convention the wildcards
  conform.

  The following wildcards conventions are available:

        ULTRIX
        VMS

  See the OpenVMS EVE reference manual (SET WILDCARD
  ULTRIX and SET WILDCARD VMS) for complete infor-
  mation on wildcard searches.

  By default the search-strings are assumed to contain no
  wildcard characters.


  Examples
  1.

        $ DEVTOOLS SEARCH CABLE.MEM,JOYNER.MEM "Manual Title"
        This command searches the files CABLE.MEM and
        JOYNER.MEM for occurrences of the character string
        'Manual Title'. It is necessary to enclose the strings in
        quotation marks because it contains a space character.