SysWorks©

SysWorks
Command Reference Manual
Previous Contents Index

By default, /NODELETE is assumed.

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

Excludes the specified files from the differences by name 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.

/FILES

/NOFILES (Default)

Specifies ...

By default, /NOFILES is assumed.

/IF=option

/NOIF (Default)

Specifies ...

Option Usage
DIFFERENT A file needs to be processed if the source revision date and time is different to the target.
NEWER A file needs to be processed if the source revision date and time is newer than the target.

By default, /NOIF is assumed.

/FILES

/NOFILES (Default)

Specifies ...

By default, /NOFILES is assumed. The /FILES and /LISTS qualifiers cannot be used together.

/LISTS=option

/NOLISTS (Default)

Specifies ...

Option Usage
EXCLUDE=(file[,...]) Specifies files to exclude from the list.
INCLUDE=(file[,...]) Specifies files to include from the list.

By default, /NOLISTS is assumed. The combination /LISTS=EXCLUDE and /LISTS=INCLUDE cannot be used together. The /LISTS and /FILES qualifiers cannot be used together.

/LOG

/NOLOG (Default)

Specifies whether the generated commands should include a /LOG or a /NOLOG qualifier.

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.

/RETAIN

/NORETAIN (Default)

Specifies whether an appropriate /RETAIN qualifier is applied to generated commands such as UTLTOOLS COPY, UTLTOOLS MOVE and UTLTOOLS RENAME. The presence of the qualifier also causes the UTLTOOLS version of commands to be used rather than the DCL implementations.

By default, /NORETAIN is assumed.

/RLF (Default)

/NORLF

Specifies whether an appropriate /RLF qualifier is applied to generated commands such as UTLTOOLS COPY, UTLTOOLS MOVE and UTLTOOLS RENAME. The presence of the qualifier also causes the UTLTOOLS version of commands to be used rather than the DCL implementations.

By default, /RLF is assumed.

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

/SEGMENTED

/NOSEGMENTED (Default)

Specifies whether segments of the source file name (i.e. chunks between underscores) are used to check for a directory hierarchy in the output directory tree. This allows a flat directory structure (eg. that implemented by CMS) to be used with a hierarchical directory tree (eg. that used by a Web server).

By default, /NOSEGMENTED is assumed.

Examples

#1 

$ UTLTOOLS DIFFERENCES/NAMES

In this example...

UTLTOOLS EXIT

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

Format

UTLTOOLS EXIT

Parameters

None.

Qualifiers

None.

UTLTOOLS FETCH SUBCONTEXT

Fetch details about the current or specified context and subcontext into DCL symbols.

Format

UTLTOOLS FETCH SUBCONTEXT

Qualifiers

/CONTEXT=(keyword=value,,,)

Specifies the context in which the command should execute.

By default the current context is assumed.

Table 1-5 lists the items which may be specified for this qualifier.

Table 1-5 Context Keywords
Keyword Value Usage
APPLICATION Yes Specifies the context application.
COMMON No Specifies the common scope of an application environment context.
ENVIRONMENT Yes Specifies the context environment.
GROUP Yes Specifies the context group.
HOME No Specifies the home context.
OPENVMS_USERNAME Optional Specifies a specific OpenVMS username from which a context is inferred.
SCOPE Yes Specifies the scope for an application environment context.
SPECIFIC No Specifies the specific scope of an application environment context.
USER Yes Specifies the context user.
VARIANT Yes Specifies the context variant.
VERSION Yes Specifies the context version.

/SYMBOLS[=(keyword[,...])

Specifies the sets of symbols which should be fetched and/or whther they should be global or local. Choose any combination of the following keywords:
ALL Include all the symbols. Only local symbols are defined.
CLASSES Include the context user class symbols.
CODES Include the context directory code symbols.
CONTEXT Include the context miscellaneous symbols.
CURRENT[=scope] Include the current context symbols. If the scope value is included, it must be one of the following:
  • GLOBAL
  • LOCAL
DIRECTORIES Include the context directory symbols.
LIBRARIES Include the context library symbols.
LOGICALS Include the context directory logical name symbols.
ROOTS Include the context directory root symbols.

/SUBCONTEXT=(keyword=value,,,)

Specifies the various alternative directories which may be checked for files to be ???.

By default the directories are those associated with the application.

Specifies the subcontext in which the command or commands within a subcontext block should execute.

Table 1-6 lists the items which may be specified for this qualifier.

Table 1-6 Subcontext Keywords
Keyword Usage
CDD_DIRECTORY Specifies the directory in which application CDD repository is located.
DOCUMENTATION_DIRECTORY Specifies the directory in which application documentation is found or placed.
GENERATED_DIRECTORY Specifies the directory in which application sources files which are generated are found or placed.
GENERATED_FILES Specifies the file name template for sources which result in targets in the generated directory rather than the software directory.
HELP_LIBRARY Specifies the application help library file.
IMAGE_LIBRARY Specifies the application shareable image library file.
INDEPENDENT_LIBRARY_DIRECTORY Specifies the directory in which application architecture independent intermediate files such as help files are found or placed.
LIBRARY_DIRECTORY Specifies the directory in which application architecture dependent intermediate files such as object files are found or placed.
MACRO_LIBRARY Specifies the application macro library file.
MMS_LIBRARY Specifies the application MMS script library file.
RUNTIME_DIRECTORY Specifies the directory in which files created during execution of an application placed. These include report listings etc.
OBJECT_LIBRARY Specifies the application object library file.
SOFTWARE_DIRECTORY Specifies the directory in which application software files such as images are found or placed.
SYMBOL_LIBRARY Specifies the application symbol library file.
TESTING_DIRECTORY Specifies the directory in which application testing files are found or placed.
TESTING_FILES Specifies the file name template for sources which result in targets in the testing directory rather than the software directory.
TEXT_LIBRARY Specifies the application text library file.
WORK_DIRECTORY Specifies the directory in which application sources files which are managed in a source library are found or placed.

By default the directories are those associated with the application.

/TEMPLATE[=(keyword[,...])

Specifies how templates are to be handled. Choose any combination of the following keywords:
ALL Use templates for all directories.
PARSE Parse any directories which used a template.
MISSING Use templates for directories for which there is no current definition.

Examples

#1 

$ UTLTOOLS FETCH SUBCONTEXT
$ SHOW SYMBOL/LOCAL/ALL
  ARC_TYP = "ALPHA" 
  CLS_MGR = "MGR" 
  CLS_REP = "REP" 
  CLS_SET = "MGR,REP,USR" 
  CLS_USR = "USR" 
  CUR_ARC = "ALPHA" 
  CUR_PFX = "FIN" 
  DIR_AIB = "FIN_JNL_DIR:" 
  DIR_AIJ = "FIN_JNL_DIR:" 
  DIR_AIL = "FIN_AIL_DIR:" 
  DIR_ARC = "-ALPHA" 
  DIR_BCK = "" 
  DIR_CDD = "FIN_CDD_DIR:" 
  DIR_DAT = "FIN_DAT_DIR:" 
  DIR_DEV = "DISK_DEV:" 
  DIR_DIR = "DISK_DEV:[FIN.#D]" 
  DIR_DOC = "FIN_DOC_DIR:" 
  DIR_GEN = "FIN_GEN_DIR:" 
  DIR_JNL = "FIN_JNL_DIR:" 
  DIR_KIT = "FIN_KIT_DIR:" 
  DIR_LCL = "FIN_LCL_DIR:" 
  DIR_LIB = "FIN_LIB_DIR:" 
  DIR_RDA = "FIN_DAT_DIR:" 
  DIR_RDB = "FIN_DAT_DIR:" 
  DIR_ROT = "FIN" 
  DIR_RUJ = "FIN_SCR_DIR:" 
  DIR_RUN = "FIN_RUN_DIR:" 
  DIR_SCR = "FIN_SCR_DIR:" 
  DIR_SET = "AIL,CDD,DAT,DOC,GEN,JNL,KIT,LCL,LIB,RUN,SCR,SFT,SRC,TST,WRK" 
  DIR_SFT = "FIN_SFT_DIR:" 
  DIR_SNP = "FIN_DAT_DIR:" 
  DIR_SRC = "FIN_SRC_DIR:" 
  DIR_TPS = "" 
  DIR_TST = "FIN_TST_DIR:" 
  DIR_WRK = "FIN_WRK_DIR:" 
  DSC_CTX = "application FIN in environment DEV" 
  ID_MGR = "A_FIN_DEV_MGR" 
  ID_OWN = "R_FIN_DEV" 
  ID_REP = "A_FIN_DEV_REP" 
  ID_USR = "A_FIN_DEV_USR" 
  LNM_AIB = "FIN_AIB_DIR" 
  LNM_AIJ = "FIN_AIJ_DIR" 
  LNM_AIL = "FIN_AIL_DIR" 
  LNM_BCK = "FIN_BCK_DIR" 
  LNM_CDD = "FIN_CDD_DIR" 
  LNM_DAT = "FIN_DAT_DIR" 
  LNM_DIR = "FIN_#D_DIR" 
  LNM_DOC = "FIN_DOC_DIR" 
  LNM_GEN = "FIN_GEN_DIR" 
  LNM_JNL = "FIN_JNL_DIR" 
  LNM_KIT = "FIN_KIT_DIR" 
  LNM_LCL = "FIN_LCL_DIR" 
  LNM_LIB = "FIN_LIB_DIR" 
  LNM_RDA = "FIN_RDA_DIR" 
  LNM_RDB = "FIN_RDB_DIR" 
  LNM_ROT = "" 
  LNM_RUJ = "FIN_RUJ_DIR" 
  LNM_RUN = "FIN_RUN_DIR" 
  LNM_SCR = "FIN_SCR_DIR" 
  LNM_SFT = "FIN_SFT_DIR" 
  LNM_SNM = "FIN_SNP_DIR" 
  LNM_SRC = "FIN_SRC_DIR" 
  LNM_TPS = "FIN_TPS_DIR" 
  LNM_TST = "FIN_TST_DIR" 
  LNM_WRK = "FIN_WRK_DIR" 
  LNT_CTX = "LNM_FIN_DEV" 
  ROT_DAT = "" 
  ROT_LIB = "" 
  ROT_SRC = "" 
  ROT_TPS = "" 
  SDC_AIB = "AIB" 
  SDC_AIJ = "AIJ" 
  SDC_AIL = "AIL" 
  SDC_BCK = "BCK" 
  SDC_CDD = "CDD" 
  SDC_DAT = "DAT" 
  SDC_DOC = "DOC" 
  SDC_GEN = "GEN" 
  SDC_JNL = "JNL" 
  SDC_KIT = "KIT" 
  SDC_LCL = "LCL" 
  SDC_LIB = "LIB" 
  SDC_RDA = "RDA" 
  SDC_RDB = "RDB" 
  SDC_RUJ = "RUJ" 
  SDC_RUN = "RUN" 
  SDC_SCR = "SCR" 
  SDC_SFT = "SFT" 
  SDC_SNM = "SNP" 
  SDC_SRC = "SRC" 
  SDC_TPS = "TPS" 
  SDC_TST = "TST" 
  SDC_WRK = "WRK" 
  VMSU_CTX = "FIN_DEV"

UTLTOOLS FETCH TIME

Fetch the effective context date and time into a DCL symbol.

Format

UTLTOOLS FETCH TIME symbol-name

Parameters

symbol-name

Specifies a 1- through 255-alphanumeric character symbol to be given the resultant formatted value.

Qualifiers

/CONTEXT=(keyword=value,,,)

Specifies the context in which the command should execute.

By default the current context is assumed.

See the UTLTOOLS FETCH SUBCONTEXT command for more details about the keywords and their values.

/FORMAT[=(keyword[,...])

Specifies the format of the resultant date and/or time. Choose any combination of the following keywords:
FAO=fao-string Use the specified FAO string rather than the default of "!%D" to produce the result.
LOADING_ZERO Replace any leading space in the result with a zero.
MIXED_CASE Convert any uppercase words in the result to mixed case.
TRIM Trim any leading and/or trailing spaces from the result.

/GLOBAL

Specifies that the symbol be placed in the global symbol table. If you do not specify the /GLOBAL qualifier, the symbol is placed in the local symbol table.

/LOCAL (Default)

Specifies that the symbol be placed in the local symbol table for the current command procedure.

Examples

#1 

$ UTLTOOLS FETCH TIME TIM_NOW
$ SHOW SYMBOL TIM_NOW
  TIM_NOW = " 9-JAN-1999 18:22:05.12"

UTLTOOLS HELP

Enables you to obtain information about the UTLTOOLS utility.

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


       UTLTOOLS> HELP

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

Format

UTLTOOLS 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 UTLTOOLS> prompt.

Qualifiers

None.

UTLTOOLS MAIL

Sends a message to one or more other users.

Format

UTLTOOLS MAIL file-spec recipient-address[,...]

Parameters

file-spec

Specifies the file containing a message to be sent to the specified mail recipients. If you omit the file type, the default file type is TXT.

No wild card characters are allowed in the file specification.

recipient-address

Specifies one or more mail addresses to receive the message. A recipient-address may be the name that the user uses to log in, or any other valid mail address construction.

Valid address forms include:
NAME Use the name on the local node. The SWRK_MAIL_TEMPLATE logical name may be used to direct simple names to more explicit addresses. The value of this logical name is in a FAO format. For example, a value of SMTP%"!AS@OURCOMPANY.COM.AU" forces simple names to be sent to the default mail gateway for OURCOMPANY using the Internet SMTP protocol.
NODE::NAME Use the name on the specified node. The DECnet transport is assumed.
NAME@NODE Use the name on the specified node. The appropriate Internet product and TCP/IP transport is assumed.
PRODUCT%"ADDRESS" Use the specified product (eg. FAX, IN, MR, SMTP) and its associated transport and/or protocol in combination with the product specific address.

As an alternative to listing the mail addresses, you can specify a distribution list file containing mail addresses. Simply precede the distribution list file specification with an at sign (@). The file you specify should contain the mail addresses, entered one per line, in the format described above. If you omit the file type, the default file type is DIS. No wild card characters are allowed in the distribution list file specification.

Qualifiers

/SUBJECT="text"

Specifies the subject of the message for the heading. If the text consists of more than one word, any spaces, or nonalphanumeric characters, enclose the text in quotation marks.

Examples

#1 

$ UTLTOOLS MAIL MESSAGE.TXT JONESAB)

Previous Next Contents Index