Order Number: SWRK-CRM-35
This manual provides reference information about the various DCL commands and interfaces to SysWorks.
Revision/Update Information: This manual supercedes the SysWorkstm V3.4-1 Command Reference Manual
Operation System and Version:
OpenVMS VAX V7.2 or higher;
OpenVMS Alpha V7.2 or higher;
DECwindows/Motif V1.2-3 or higher
Software Version: SysWorkstm V3.5
Printed in Australia
The following are trademarks of Compaq Computer Corporation: ACMS, ALL-IN-1, AXP, BASIC, Bookreader, CDA, CI, DATATRIEVE, DBMS, DDIF, DEC, DEC ACCESSWORKS, DEC Ada, DEC C, DEC Fortran, DEC Pascal, DECdecision, DECdesign, DECdirect, DECdns, DECdocument, DECdtm, DECforms, DECimage, DECintact, DECmigrate, DECnet, DECnet/OSI, DECset, DECsupport, DECtp, DECwindows, Digital, DTIF, EDT, HSC, MASSBUS, MicroVAX, MicroVAX II, MSCP, OpenVMS, OpenVMS Cluster, RA, StorageWorks, TA, TMSCP, TURBOchannel, ULTRIX, VAX, VAX C, VAX MACRO, VAX-11/780, VAXcluster, VAXELN, VAXft, VAXstation, VIDA, VMS, VMScluster, VT100, and the DIGITAL logo.
PostScript is a registered trademark of Adobe Systems Inc.
Motif is a registered trademark of Open Software Foundation, Inc.
Oracle is a registered trademark, and Oracle CDD/Repository, Oracle CODASYL DBMS, Oracle Expert, Oracle Rally, Oracle Rdb, Oracle Trace and Rdb7 are trademarks of Oracle Corporation.
OSI is a registered trademark of CA Management, Inc
All other trademarks and registered trademarks are the property of their respective holders.
This document was prepared using DECdocument V3.3.
| Contents | Index |
We welcome your comments on this manual or any SysWorks manual. If you have suggestions for improvements or find any errors, please indicate the chapter, section and page number (if available). Your input is valuable in improving future releases of our documentation.
You can send comments to us in the following ways:
SysWorks Corpita Pty Ltd 15 Bedford Street Collingwood VIC 3066 Australia |
This manual provides reference information about the various DCL commands and interfaces to SysWorkstm.
This manual is intended for SysWorkstm users who have a working knowledge of the underlying Digital products.
The following conventions are used in this document:
| Conventions | Description |
|---|---|
| [Ctrl/X] | A sequence such as [Ctrl/X] indicates that you must hold down the key labeled [Ctrl] while you press another key or a pointing device button. |
| [] |
In format descriptions, brackets indicate that whatever is enclosed is
optional; you can select none, one or all of the choices.
In system prompts indicates the default value which will be assumed if the Return key is pressed without first entering a value. |
| {} | In format descriptions, braces surround a required choice of options; you must choose one of the options listed. |
| | | In format descriptions, vertical bars separate the options. If the options are enclosed in brackets (i.e. []) you can select none, one or all of the choices. If the options are enclosed in braces (i.e. {}) you must choose one of the options listed. |
| () | In system prompts, parenthesis indicate the list of values one of which may be entered. The values are separated by a forward slash "/" |
| ... | An elipsis indicates that a value within a range may be chosen or a syntax repeated. A range may be indicated by a pair of end values, or an end value and an end keyword. For example Disk quota (0..unlimited) indicates that the keyword unlimited may be used to represent the highest possible disk quota. |
| italic text | Italicized words and letters indicate that you should substitute a word or value of your choice. |
| UPPERCASE TEXT | Uppercase letters indicate the name of a command or routine. |
| monospace text | Normal monospace text indicates system prompts and output. |
| bold monospace text | Bold monospace text indicates user responses to system prompts. |
| bold monospace italic text | Bold monospace italic text indicates user responses to system prompts which need approriate value substitution. |
| mouse | The term mouse is used to refer to any pointing device such as a mouse, a puck or a stylus. |
| MB1, MB2, MB3 | MB1 indicates the left mouse button, MB2 indicates the middle mouse button, and MB3 indicates the right mouse button. (The buttons can be redefined by the user.) |
Unless otherwise noted, all numeric values are represented in decimal notation.
This chapter provides the reference information for the DCL commands and interfaces provided by SysWorkstm.
Requests interactive assignment of a value for a local or global symbol during the execution of a command procedure.
ACCEPT symbol-name
symbol-name
Specifies a 1- through 255-alphanumeric character symbol to be given a value.
/CONVERT[=SHORT|LONG]
/NOCONVERT ( Default)
Specifies that the terminator symbol value be converted from its raw value into a symbolic value. The keyword of SHORT or LONG indicates which style of name to return. If neither is specified, SHORT is used by default. The symbolic values returned listed in Table 1-1. Where a LONG code is blank, the SHORT code is returned.
Table 1-1 Accept Terminator Conversion Codes Short Long Usage CR [Return] (Carriage Return) CTRLB UP_ARROW []^ (Up Arrow), [Ctrl/B] CTRLW REFRESH [Ctrl/W] (Refresh) CTRLZ EXIT [Exit], [Ctrl/Z] E1 FIND [Find] E2 INSERT_HERE [Insert Here] E3 REMOVE [Remove] E4 SELECT [Select] E5 PREV_SCREEN [Prev] E6 NEXT_SCREEN [Next] F6 - F20 Top row keys HELP [Help] DO [Help] PF1 - PF4 Top numeric keys By default, no conversion of the terminator symbol value occurs.
/DEFAULT_VALUE=string
/NODEFAULT_VALUE (Default)
Specifies an default value for the symbol. This is used if the resultant input string has a zero length.By default, no default value is used.
/DISPLAY_STATUS (Default)
/NODISPLAY_STATUS
Specifies whether an error status is displayed. If /NODISPLAY_STATUS is specified, the inhibit message modifier is set in the exit status, thus stopping DCL from displaying the messages associated with the status.By default, an error status is displayed.
/ECHO (Default)
/NOECHO
Specifies whether characters are echoed as they are entered at the keyboard.By default, characters are echoed.
/ERROR=label
Transfers control to the location specified by the label keyword (in the current command procedure) when an accept error occurs. If no error routine is specified and an error occurs during the accepting of the symbol, the current ON condition action is taken.Overrides any ON condition action specified.
If an error occurs and the target label is successfully given control, the reserved global symbol $STATUS retains the error code.
/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./HELP[=(keyword[,...])]
/NOHELP (Default)
Specifies help to be used when a user presses [Help] key. Any combination of the following keywords may be used:
Keyword Usage LIBRARY=library-file The HELP library in which to find the subject. If this keyword is not supplied, the default HELP library search list is used. [NO]LOOP Specifies whether the ACCEPT command keeps requesting a value after HELP has been supplied. By default, LOOP is assumed. SUBJECT=subject The subject on which help will be supplied. By default, no help is used.
/INITIAL_VALUE=string
/NOINITIAL_VALUE (Default)
Specifies an initial value for the symbol. This is used as though the user had already entered the text specified in the string.By default, no initial value is used.
/LOCAL (Default)
Specifies that the symbol be placed in the local symbol table for the current command procedure./PROMPT=string
/NOPROMPT
Specifies an alternate prompt string to be displayed when reading.By default, the prompt string "Data:#" is displayed.
/SIZE=n
Specifies the maximum size of the symbol value. If you enter the /SIZE qualifier, you must specify a value, and the value must be from 0 through 255.By default, a maximum symbol value size of 255 is used.
/TERMINATOR=term-symbol-name
/NOTERMINATOR (Default)
Specifies a symbol to be given the value of the terminator. The terminator symbol is placed in the same symbol table as the symbol-name parameter.By default, the terminator is not returned.
/TIME_OUT=n
/NOTIME_OUT (Default)
Specifies the number of seconds after which the ACCEPT command is terminated if no input is received. If you enter the /TIME_OUT qualifier, you must specify a value, and the value must be from 0 through 255.By default, no timeout will occur.
/TRMECHO (Default)
/NOTRMECHO
Specifies whether the terminator characters are echoed as they are entered at the keyboard.By default, the terminator characters are echoed.
/TRMKEYS=string
Specifies optional extra terminator characters. The string is a set of terminator characters which must have ASCII values in the range 0 through 31.By default, Control B (also Up-arrow), Return, Control W and Control Z are terminator characters.
Note that escape sequences are also terminators. All function keys (F6 - F20), extended function keys (E1 - E6), programmable function keys (PF1 - PF4), and the down-arrow key generate escape sequences.
/UPPERCASE
/NOUPPERCASE (Default)
Specifies whether lowercase characters entered at the keyboard are converted to uppercase.By default, lowercase characters are not converted to uppercase.
/WINDOW
/NOWINDOW (Default)
Specifies whether a character cell terminal or window method is used to accept the symbol value.By default, a character cell terminal method is used.
| #1 |
|---|
{system-prompt}
{user-response}
|
Build an MMS target. The BUILD command implements a multi-phase build.
BUILD[/qualifiers] [target-spec[,...]]
target-name
A list of one or more MMS style targets (i.e. no wildcards and explicit target file specifications).
Each phase of a build is controlled by a DCL command procedure and/or an MMS script. See the /PHASES qualifier for the default phases used. The following standard phases may be used in order of appearance:
The following list indicates the order in which applications are built on multiple platforms.
Table 1-2 Build Phases Phase BUILD Qualifier PRECLEAN /FROM[=location] UPDATE /UPDATE TIDY /TIDY FETCH /FETCH SETUP /PHASE=SETUP SCAN /PHASE=SCAN RULES /PHASE=RULES DESCRIP /PHASE=DESCRIP RELATED /RELATED KITBLD /KITBLD
- Build of current application on local platform. Actions relating to phases and qualifiers which only need to be executed once are taken (eg. /SYNCHRONIZE).
- Build of related applications on local platform (if /RELATED was specified). Actions relating to phases and qualifiers which only need to be executed once per application are taken (eg. /FETCH).
- Build of current then related applications on other platforms (if /COMBINED was specified). Each platform build is submitted as a separate batch job. The /RELATED qualifier is passed to these jobs, but once per application qualifiers such as /FETCH are not passed.
- Build installation kit (if /KITBLD was specified).
ALL
This is the equivalence of SETUP,SCAN,RULES,DESCRIP.DESCRIP
Create targets based on dependencies - i.e. traditional MMS build, which is achieved by including the generated MMS scripts from the RULES phase.Typically this is the fourth phase execeuted.
FETCH
Fetch new sources from the CMS library before doing the build. This phase is not generally explicitly included in a build, rather the /FETCH qualifier forces this phase to be executed as the first phase (i.e. before the PRECLEAN or SETUP phases). See the /FETCH qualifier for more details.KITBLD
Creates an installation kit. This phase is not generally explicitly included in a build, rather the /KITBLD qualifier forces this phase to be executed as the last phase (i.e. after the DESCRIP and RELATED phases). See the /KITBLD qualfier for more details.PRECLEAN
Clean out appropriate intermediate and target areas. This is achieved by deleting all files from the work, library and/or software directory trees (including the CDD repository), thus forcing the application to be built from sources in the CMS library.Note that the three files ENTER.COM, EXIT.COM and LOGICALS.COM are preserved in the software directory so that commands such as CONTEXT will continue to work.
This phase is not generally explicitly included in a build, rather the /FROM=location qualifier forces this phase to be executed before the SETUP phase.
The set of directories which will be emptied during the PRECLEAN phase is controlled by the location code specified with the /FROM qualifier. See the /FROM qualifier for details about the location codes, the directories which are emptied and the effect this has on building the application.
RELATED
Builds related applications. This phase is not generally explicitly included in a build, rather the /RELATED qualifier forces this phase to be executed after the last general phase (i.e. after the DESCRIP phase) and before any KITBLD phase. See the /RELATED quaifier for more details.RULES
Generate dependencies based on current sources - i.e. convert sources to MMS scripts.Typically this is the third phase executed.
SCAN
Generate dependency lists based on current sources - i.e. convert a list of sources (taken from the CMS library) into an MMS script which will generate the source based MMS scripts in the RULES phase.Typically this is the second phase executed.
SETUP
Generate build time structures and software. This allows build time executables (typically DCL command procedures and other scripts needed during the RULES phase) to be built prior to the main build phases.Typically this phase is the first phase executed.
TIDY
Deletes files from the developers specific library directory. This phase is not generally explicitly included in a build, rather the /TIDY qualifier forces this phase to be executed after any PRECLEAN phase (as specified by /FROM=location) and before any FETCH phase (as specified by /FETCH). See the /TIDY quaifier for more details.
/AFTER=time
Specifies that a /AFTER qualifier to be applied when submitting the BUILD command to batch.Use of the /AFTER qualifier is compatable only with the /BATCH qualifier.
/BATCH
Specifies that the BUILD command should be performed in the context of a batch job.Use of the /BATCH qualifier is incompatible with /DETACHED, /INTERACTIVE and /SUBPROCESS. /SUBPROCESS is the default.
/CLUSTER
Specifies that the action specified with the /SAVE or /UNSAVE qualifier be performed on the cluster wide save file.By default, /NODE is assumed.
/CMS
/NOCMS (Default)
Specifies whether the CMS library is to be searched for new versions of sources. This is the equivalent of the MMS /CMS qualifier.By default, /NOCMS is assumed.
/COMBINED=node
/NOCOMBINED (Default)
Specifies whether a combined multi-architecture BUILD is performed. This qualifier is only effective when an application is being managed in a multi-architecture environment and the command is executed on an Alpha.The combined operation causes any SETUP, SCAN, RULES or DESCRIP phases to be executed first on the Alpha which is executing the BUILD and then on the VAX specified with the qualifier.
This set of VAX phases can be controlled using the SWDEV_BUILD_VAX_PHASES logical name, the equivalence of which is a comma separated list of the phases which need to be run on the VAX.
The /COMBINED qualifier also affects the operation of the default FETCH phase. This phases normally uses DEVTOOLS commands to update the application work directory. These underlying DEVTOOLS commands have their /TIDY qualifier (which is different to the BUILD /TIDY qualifier) used. If the /COMBINED qualifier is used, it is also passed on to these underlying DEVTOOLS commands. This causes deletions of files and library modules to occur for both architectures.
Note also that the default name for the log file generated during a non combined build in a multi-architecture application has an architecture suffix. For example BUILD/NOCOMBINED executed on a VAX will generate a BUILD-VAX.LOG log file.
By default, /NOCOMBINED is assumed.
/COMMON
Specifies that the common scope is to be established for the BUILD command, independent of the current or default scope for this application environment.This qualifier is incompatible with the /SCOPE and /SPECIFIC qualifiers which also specify the scope under which the BUILD should be executed.
/CONDITIONALS[=(character,...)]
/NOCONDITIONALS (Default)
Controls whether the conditional compilation lines in a Cobol source program are compiled or treated as comments. Specifying /CONDITIONALS results in all conditional compilation lines being compiled.Specifying /CONDITIONALS=(selector,...), where a selector is a list of one or more characters from A to Z, results in the selected conditional compilation lines being compiled. If you specify more than one selector, separate them with commas and enclose the list in parentheses.
The default, /NOCONDITIONALS, results in all conditional compilation lines being treated as comments during compilation.
/COPY_LIST
/NOCOPY_LIST (Default)
Controls whether source statements included by COPY statements in Cobol are printed in the listing file.The /COPY_LIST qualifier has no effect unless you also specify the /LIST qualifier.
The default, /NOCOPY_LIST, suppresses the listing of text copied from library files; only the COPY statement appears in the listing file.
/CROSS_REFERENCE[=(options,...)]
/NOCROSS_REFERENCE (Default)
Specifies that a cross-refererence of symbols be generated in a listing or map file. See compiler and linker documentation for sepcific details. At this time, /CROSS_REFERERENCE is only applied to COBOL and LINK commands./DEBUG
/NODEBUG (Default)
Specifies whether targets will be built and sources compiled with the /DEBUG qualifier applied.By default, /NODEBUG is assumed.
If /DEBUG is specified and no /OPTIMIZE or /NOOPTIMIZE qualifier is specified, /NOOPTIMIZE is applied by default.
/DEFAULTS (Default)
/NODEFAULTS
Specifies whether the default BUILD command qualifiers (as saved by the /SAVE qualifier) are to be applied before processing explicit qualifiers.By default, /DEFAULTS is assumed.
/DESCRIP=mms-script-file
Specifies an alternative MMS description file.By default, DESCRIP.MMS ise used.
/DETACHED
Specifies that the BUILD command should be performed in the context of a detached process.Use of the /DETACHED qualifier is incompatible with /BATCH, /INTERACTIVE and /SUBPROCESS. /SUBPROCESS is the default.
/FETCH
Specifies that any newer sources in the CMS library should be fetched into the work directory before doing the build. Note that the /FETCH qualifier forces a /NOCMS qualifier, since if the new sources are fetched before the build, the build doesn't need to reference the CMS library./EXECUTE
/NOEXECUTE
Specifies whether the BUILD command and qualifiers should be executed. By default, if the /SAVE qualifier is used, /NOEXECUTE is assumed, otherwise /EXECUTE is assumed./FROM[=location]
/NOFROM (Default)
Specifies that the build should be performed from sources.Values permitted for location include:
Location Usage LIBRARY Build all new targets. Only the target directories are emptied during the PRECLEAN phase. This approach forces rebuilding of targets in the DESCRIP phase. SOURCE Build from sources in the CMS library. Work, generated, library and target directories are emptied during the PRECLEAN phase. This approach forces a rebuild of the entire application from scratch. All phases including FETCH and GENERATE are used to their fullest extent. WORK Build from source already present in the work directory. Library and targets directories are emptied during the PRECLEAN phase. This approach forces a rebuild of the application without the overhead of fetching all the source from the CMS library. All phases except PRECLEAN and FETCH are used to their fullest extent. By default, an incremental build is executed.
See the information about the preclean phase for additional details.
/GENERATION=cms-gen
Specifies which CMS generations should be used during the build.By default, the path specified by the logical name appl_CMS_PATH is used.
/HOLD
/NOHOLD (Default)
Specifies that a /HOLD qualifier to be applied when submitting the BUILD command to batch.Use of the /HOLD qualifier is compatable only with the /BATCH qualifier.
/IGNORE (Default)
/NOIGNORE
Specifies whether any MMS commands issued by the BUILD command will have the /IGNORE qualifier applied to stop the MMS command failing when errors are detected.By default, /IGNORE is assumed.
/INITIALIZE_HANDLES
/NOINITIALIZE_HANDLES (Default)
Specifies whether handle values in a SQLMOD module should be initialized to zero. You must initialize handles to build shared images. If you need to run RDBPRE and RDML applications in SQL, specify INITIALIZE_HANDLES.
Next Contents Index