SysWorks©

SysWorks
Command Reference Manual


Previous Contents Index


DIRTOOLS DOCUMENTATION/REDUCE

Reduces the files in BNU and/or Bookreader shelves to unique file IDs.

Format

DIRTOOLS DOCUMENTATION/REDUCE input-file[,...]


Parameters

input-file

A list of files to reduce to unique file IDs. Normally a whole disk device is reduced, i.e. a file list of the form DISK$volume:[*...]*.*;* is used.

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 incompatible 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 absolute 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.

/CHECKSUM

/NOCHECKSUM (default)

Specifies whether to check the checksum of files when comparing files with different file IDs.

While use of this qualifier may slow down the reduection process, it greatly reduces the probability of two different files being considered the same.

By default, /NOCHECKSUM is assumed.

/CONFIRM

/NOCONFIRM (default)

Controls whether a request is issued before each ??? operation 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 abbreviated 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 entering 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.

/CRC

/NOCRC (default)

Specifies whether to check the CRC of files when comparing files with different file IDs.

While use of this qualifier may slow down the reduection process, it greatly reduces the probability of two different files being considered the same.

By default, /NOCRC is assumed.

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

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

Excludes the specified files from the ??? operation. You can include a directory but not a device in the file specification. 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.

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

/NOLOG (default)

Specifies whether diagnostic comments should be included in the output file.

By default, /NOLOG is assumed.

/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 qualifier 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 produced 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 associated ACL or files that do not (NOACL keyword).
ATTRIBUTES=(option[,...]) Selects files which have particular 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 organization. Valid organizations 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 specification for display purposes. The /SELECT=FILE qualifier 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 cannot 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 absolute 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.

/STATISTICS (default)

/NOSTATISTICS

Specifies whether a short summary report should be generated at the end of processing.

Examples

#1

$ DIRTOOLS DOCUMENTATION/REDUCE DISK$AXPDOCJAN971:[*...]*.*;*
      


DIRTOOLS DOCUMENTATION/REPLICATE

Replicates BNU and/or Bookreader shelves (indices) to allow faster access to documents and listings of unmounted contents.

Format

DIRTOOLS DOCUMENTATION/REPLICATE volume-name-list


Parameters

volume-name-list

A list of disk volume names which should be checked for replicatable contents.

Qualifiers

/CHECK (default)

/NOCHECK

Specifies whether to check for the existance of Bookreader or HTML files and change all references to them into direct file specifications.

While use of this qualifier may slow down the replication process, it greatly speeds up access by users to documents.

By default, /CHECK is assumed.

/DIRECTORY[=device-spec]

Specifies the device on which the directory used to hold the replicated shelves is created. A root directory rather than a device may be specified using a concealed logical name.

By default, /DIRECTORY=SWADM_DAT_ROOT: is assumed.

/LIBRARY (default)

/NOLIBRARY

Specifies whether the library files should be updated.

/LOG (default)

/NOLOG

Specifies whether successful replications should be logged.

/SHELVES (default)

/NOSHELVES

Specifies whether shelves should be replicated.

/STATISTICS (default)

/NOSTATISTICS

Specifies whether a short summary report should be generated at the end of processing.

Examples

#1

$ DIRTOOLS DOCUMENTATION/REPLICATE AXPDOCJAN971
      


DIRTOOLS EXIT

Exits the DIRTOOLS utility. You can also exit from DIRTOOLS by pressing [Ctrl/Z].

Format

DIRTOOLS EXIT


Parameters

None.

Qualifiers

None.

DIRTOOLS HELP

Enables you to obtain information about the DIRTOOLS utility.

To obtain information about all of the DIRTOOLS commands, enter the following command:


       DIRTOOLS> HELP 

To obtain information about individual commands or topics, enter the HELP command followed by the command or topic name.


Format

DIRTOOLS HELP topic


Parameters

topic

Indicates a topic about which you want information. To display the list of available topics, enter the HELP command at the DIRTOOLS> prompt.

Qualifiers

None.

DIRTOOLS SHOW VERSION

Display the DIRTOOLS utility version.

Format

DIRTOOLS SHOW VERSION


Examples

#1

$ DIRTOOLS SHOW VERSION
  SysWorks Version V3.4
      

Creates a subprocess of the current process. The context of the subprocess is copied from the current process. You can use the SPAWN command to leave the DIRTOOLS utility temporarily, perform other functions (such as displaying a directory listing or printing a file), and then return to DIRTOOLS.

Note that this command is only available for users with DCL access.


Format

DIRTOOLS SPAWN [command]


Parameters

command

Specifies the DCL command string that executes in the context of the created subprocess. When the command completes, the subprocess terminates and control is returned to the parent process. If this parameter is not specified, a subprocess is created that transfers control to DCL command level.

Qualifiers

/INPUT=file-spec

Specifies an input file containing one or more DCL command strings to be executed by the spawned subprocess. If you specify a command string along with an input file, the command string is processed before the commands in the input file. Once processing is complete, the subprocess is terminated.

/LOGICAL_NAMES

/NOLOGICAL_NAMES

Specifies that the logical names of the parent process are to be copied to the subprocess. When you do not want the subprocess to use the logical names of the parent process, enter the qualifier /NOLOGICAL_NAMES. The default is /LOGICAL_NAMES.

/OUTPUT=file-spec

Identifies the output file to which the results of the SPAWN operation are written. Whenever you use the /NOWAIT qualifier, you should also use the /OUTPUT qualifier to specify a new output destination. Doing so prevents output from being displayed while you are specifying new commands. If you omit the /OUTPUT qualifier, output is written by default to the current SYS$OUTPUT device.

/PROCESS=subprocess-name

Specifies the name of the subprocess to be created. The default name of the subprocess is USERNAME_n. If the subprocess name contains spaces or special characters, or is case-sensitive, then the subprocess name must be enclosed in quotation marks.

/SYMBOLS

/NOSYMBOLS

Determines whether the system passes DCL global and local symbols to the subprocess. The default is /SYMBOLS.

/WAIT/NOWAIT

Controls whether the system waits until the subprocess is completed before allowing more commands to be specified. The /NOWAIT qualifier allows you to specify new commands while the specified subprocess is running. If you specify /NOWAIT, you should also use the /OUTPUT qualifier to direct the output stream to a file, rather than displaying it on your terminal. Doing so prevents your terminal from being used by more than one process simultaneously.

Examples

#1

DIRTOOLS> SPAWN SHOW TIME
      

This example shows how to create a subprocess that executes the DCL command SHOW TIME while you are using DIRTOOLS utility.

#2

DIRTOOLS> SPAWN /NOLOGICAL_NAMES SET HOST
_Node: MARS 
   .
   .
   .
$ LOGOUT
CRAMMER logged out at ... 
 
%REM-S-END, control returned to node _BETA:: 
 
DIRTOOLS>
      

This example shows how to use the SPAWN command to create a subprocess in which you SET HOST to another node. When you want to leave node MARS and move back to node BETA, enter the DCL command LOGOUT. The /NOLOGICAL_NAMES qualifier prevents the logical names of the parent process from being copied to the subprocess.


DO

Executes a DCL command (including the "@" command) in a context other than the current process.

Format

DO/qualifiers] [dcl-command]


Convenience Commands

NETTERM

Creates a terminal window on specified nodes. This command is equivalent to


      DO/INTERACTIVE/TERMINAL/WINDOW/REMOTE= 


Format

NETTERM node-name[,...]

RW

Executes a command in a remote window context on the specified nodes. The remote process is a network process. This command is equivalent to


      DO/WINDOW/REMOTE= 

This command may be used to prefix a normal window startup command in order to have the window operate on another node. This other node would normally be a server node within a cluster.

The preferred way to start a remote window is to use the DO/INTERACTIVE/WINDOW/REMOTE= command which creates a remote interactive process.


Format

RW node-name[,...] command

RWI

Executes a command in a remote window context on the specified nodes. The remote process is an interactive process. This command is equivalent to


      DO/INTERACTIVE/WINDOW/REMOTE= 

This command is typically used to prefix a normal window startup command in order to have the window operate on another node. This other node would normally be a server node within a cluster.


Format

RWI node-name[,...] command

RWX

Executes a command in a remote window context on the specified nodes. The output from the remote execution is directed back to the command node. The remote process is a network process. This command is equivalent to


      DO/LOG/WINDOW/REMOTE= 

This command may be used to prefix a normal window startup command in order to have the window operate on another node. This other node would normally be a server node within a cluster.


Format

RWX node-name[,...] command

TELL

Executes a command in a remote context on the specified nodes. The output from the remote execution is directed back to the command node. The remote process is a network process. This command is equivalent to


      DO/LOG/REMOTE= 


Format

TELL node-name[,...] command


Parameters

dcl-command

The DCL command to be executed in the context of the resultant process.

Typical commands with the /WINDOW/REMOTE qualifier combination are of the form


      RUN SYS$SYSTEM:DECW$xxxx

where xxxx is a DECwindows application name.


Qualifiers

/AFTER=time

Specifies that a /AFTER qualifier to be applied when submitting the DO command to batch.

Use of the /AFTER qualifier is compatable only with the /BATCH qualifier.

/APPLICATION=app-cod

Specifies the application under which the command should be executed. This qualifier causes the /MOVE qualifier to be assumed by default.

/BATCH

Specifies that the DO command should be executed in the context of a batch job.

Use of the /BATCH qualifier is incompatible with /DETACHED, /INTERACTIVE, and /SUBPROCESS. /SUBPROCESS is the default.

/COMMAND=command

Specifies the command to be executed. By default the commandis specified after the qualifiers attached to the DO command. Use of this qualifier causes the DO command to interpret all qualifiers on the command line rather than just those following the DO command.

/DETACHED

Specifies that the DO command should be executed in the context of a detached process.

Use of the /DETACHED qualifier is incompatible with /BATCH, /INTERACTIVE, and /SUBPROCESS. /SUBPROCESS is the default.

/ENVIRONMENT=envr-cod

Specifies the environment under which the command should be executed. This qualifier causes the /MOVE qualifier to be assumed by default.

/GROUP=grp-cod

Specifies the group under which the command should be executed. This qualifier causes the /MOVE qualifier to be assumed by default.

/HOLD

Specifies that a /HOLD qualifier to be applied when submitting the DO command to batch.

Use of the /HOLD qualifier is compatable only with the /BATCH qualifier.

/INTERACTIVE

Specifies that the DO command should be executed in the context of an interactive process.

Use of the /INTERACTIVE qualifier is incompatible with /BATCH, /DETACHED, and /SUBPROCESS. If /REMOTE is present there is no default mode qualifier. If it is not present, then /SUBPROCESS is the default mode qualifier.

/KEEP (Default)

/NOKEEP

Specifies that a /KEEP qualifier to be applied when submitting the COMPILE command to batch.

Use of the /KEEP qualifier is compatable only with the /BATCH qualifier.

/LOG[=log-file]

/NOLOG

Specifies whether to produce a log file of the DO command execution, and optionally its file specification.

By default, if /REMOTE is present, /NOLOG is assumed, otherwise /LOG=SYS$DISK:[]DO.LOG is assumed.

If /REMOTE is present, the /LOG qualifier causes the DO command to keep the network link open for the duration of the command execution so that output can be forwarded to the command node. If /NOLOG is present or assumed, the output of the command on the target node(s) will only be present in the remote NETSERVER.LOG.

/MOVE[={CONTEXT|DEFAULT}]

/NOMOVE (Default)

Specifies that the command should be executed under the indicated context. This qualifier relates to the /APPLICATION, /ENVIRONMENT, /GROUP, /USERNAME, /VARIANT and /VERSION qualifiers.

The appropriate CONTEXT command is used to move to the required context and another appropriate CONTEXT command is used to restore the context after the command has executed.

If no explicit context is specified using the /APPLICATION, /ENVIRONMENT, /GROUP, /USERNAME, /VARIANT or /VERSION qualifiers, the value specified with the /MOVE qualifier controls how the context is determined. If no value is specified, the default value is DEFAULT.

If the value specified is CONTEXT, the context under which execution occurs is the same as the users current context.

If the value specified or defaulted to is DEFAULT, the users current device and directory are parsed to determine the context under which execution will take place. This value is useful in starting applications from underneath DECwindows views, since the session manager sets the default device and directory (but not the content) of the process it uses for starting an application to that of the view before executing the command associated with the application.

/NAME=job-name

Specifies that a /NAME qualifier to be applied when submitting the DO command to batch.

Use of the /NAME qualifier is compatable only with the /BATCH qualifier.

By default, /NAME=DO is assumed with the /BATCH qualifier.

/NOTIFY

/NONOTIFY

Specifies that a /NOTIFY qualifier to be applied when submitting the DO command to batch.

Use of the /NOTIFY qualifier is compatable only with the /BATCH qualifier.

/PRINT

/NOPRINT (Default)

Specifies that a /PRINT qualifier to be applied when submitting the DO command to batch.

Use of the /PRINT qualifier is compatable only with the /BATCH qualifier.

/PRODUCT=product-code

Specifies that qualifier defaults for the indicated DECwindows product should be used.

Table 1-4 lists the products currently supported.

/QUEUE=batch-queue-name

Specifies the name of the batch queue into which the DO command should be placed for execution.

By default, /QUEUE=SYS$BATCH is assumed with the /BATCH qualifier.

Use of the /QUEUE qualifier is compatable only with the /BATCH qualifier.

/REMOTE=node[,...]

Specifies that the DO command be executed on one or more remote nodes. Note that the behaviour of the /INTERACTIVE and /LOG qualifiers changes when this qualifier is used.

The following special keywords may be used in place of the node list:
Keyword Action to be perfomed on each
ALL Depends on the logical SWRK_TELL_ALL_TYPE which should have a value of one of the other special keywords.
CLUSTER Node within the cluster.
CLUSTERS Cluster within the network or security domain.
NODES Node within the network or security domain.

/SUBPROCESS

Specifies that the DO command should be executed in the context of a sub-process of the current process.

Use of the /SUBPROCESS qualifier is incompatible with /BATCH, /DETACHED, /INTERACTIVE and /REMOTE.

/SYNCHRONIZE=job-entry

Specifies that a SYNCHRONIZE command is to be used in the DO job before the DO command is executed, in order to wait until another batch job has finished.

Use of the /SYNCHRONIZE qualifier is compatable only with the /BATCH qualifier.

/TERMINAL

Specifies in conjunction with /REMOTE that the remote command execution should have a terminal window context. The /WINDOW qualifier should also be used.

/USERNAME=vms-username

When specified with the /BATCH qualifier the /USERNAME qualifier is applied when submitting the DO command to batch.


Previous Next Contents Index