Commands are classified as procedure-oriented and/or interactive-oriented ("P" or "I").
Square brackets, "[]", imbedded in a command indicate that the command may be abbreviated using at least all the characters prior to the brackets (i.e., COMPI[LE] indicates that both COMPILE or COMPI are valid). In the case of hyphenated commands, the abbreviation rule applies to both portions (i.e., SH[OW]-A[SYNC] indicates that both SHOW-ASYNC and SH-A are valid). Qualifiers completely enclosed by square brackets, [ ], are optional.
VICAR SYNTAX AND COMMAND CLASS FUNCTION A[BORT] I Terminates a proc or an asynchronous job. Default form is ABORT-SYNC. A[BORT]-A[SYNC] I VICAR>ABORT-ASYNC + VICAR>+ JOB=job_name_list Terminates an asynchronous job. A[BORT]-B[ATCH] I VICAR>ABORT-BATCH + VICAR>+ JOBID=job_number + VICAR>+ QUEUE=queue_name Terminates a batch job; same as BATCH-DELETE. Only available in VMS VICAR. A[BORT]-S[YNC] I VICAR-INTERRUPT>ABORT-SYNC Terminates the execution of the current proc. Only valid in "proc interrupt mode". Default subcommand for ABORT. ALLO[C] I,P VICAR>ALLOC DEVICE=device_name + VICAR>+ NAME=symbolic_name Allocates a device for exclusive use and associates a symbolic name with it. Only available in VMS VICAR. ASYNC-S[UBMIT] I VICAR>ASYNC-SUBMIT + VICAR>+ PROC=proc_name + VICAR>+ [SAVEFILE=save_file_name] + VICAR>+ [JOBNAME=job_name] + VICAR>+ [STDOUT=output_file_name] Submits a procedure for asynchronous execution. AT[TACH] I VICAR>ATTACH [process_name] Attaches a terminal to a subprocess. Only available in VMS VICAR. BATCH I Used for batch queue manipulation. Default is BATCH-STATUS. Only available in VMS VICAR. BATCH-D[ELETE] I VICAR>BATCH-DELETE + VICAR>+ JOBID=job_number + VICAR>+ QUEUE=queue_name Deletes the specified queue entry from the named queue; same as ABORT-BATCH. Only available in VMS VICAR. BATCH-R[ESUME] I VICAR>BATCH-RESUME + VICAR>+ QUEUE=queue_name Resumes the operation of the named queue. Need OPERATOR privileges. Only available in VMS VICAR. BATCH-ST[ATUS] I VICAR>BATCH-STATUS + VICAR>+ QUEUE=queue_name Shows the status of batch jobs for the specified queue. Default subcommand for BATCH. Same as SHOW-BATCH. Only available in VMS VICAR. BATCH-SUB[MIT] I VICAR>BATCH-SUBMIT PROC=name + VICAR>+ [SAVEFILE=save_file_name] + VICAR>+ [QUEUE=queue_name] + VICAR>+ [STDOUT=output_file] Aids in submitting a procedure for batch execution. Only available in VMS VICAR. BATCH-SUS[PEND] I VICAR>BATCH-SUSPEND + VICAR>+ QUEUE=queue_name Suspends operation of the named queue. Need OPERATOR privilege. Only available in VMS VICAR. BATCH-U[PDATE] I VICAR>BATCH-UPDATE + VICAR>+ JOBID =job_number + VICAR>+ PRIORITY=priority + VICAR>+ QUEUE=queue_name Modifies the priority of a job. Need OPERATOR privilege. Only available in VMS VICAR. BODY P PROCEDURE [HELP=help_location] declarations BODY procedure body END-PROC Signals the start of executable commands in a procedure. BREAK P Immediately exits the loop in a procedure. See LOOP for an example. COMPI[LE] I,P VICAR>COMPILE INPROC=source.pdf + VICAR>+ [OUTPROC=compiled.cpd] Compiles PDFs to improve execution speed of procs. CONT[INUE] I VICAR-INTERRUPT>CONTINUE Continues the executing task when in VICAR "proc interrupt mode". DAL I,P VICAR>DAL FILE=symbolic_name Causes the deallocation of a memory file, a file that resides in memory. Only available in VMS VICAR. DCL I,P VICAR>DCL + VICAR>+ [any_VMS/DCL_command] Takes all characters after "DCL" as the command to be executed by VMS/DCL. Control-C will cause VICAR to go into "proc interrupt mode". Only available in VMS VICAR. DCL-I[NTERRUPT] I VICAR>DCL-INTERRUPT + VICAR>+ [any_VMS/DCL_command] Same as DCL. Only available in VMS VICAR. DCL-N[OINTERRUPT] I VICAR>DCL-NOINTERRUPT + VICAR>+ [any_VMS/DCL_command] Takes all characters after "DCL" as the command to be executed by VMS/DCL. Control-C will be handled by the VMS utility itself. Only available in VMS VICAR. DEA[LLOC] I,P VICAR>DEALLOC [DEVICE=dev_name] + VICAR>+ NAME=name Deallocates a device that was previously allocated using the ALLOC command. Only available in VMS VICAR. DEFC[MD] I,P VICAR>DEFCMD COMMAND=name + VICAR>+ STRING=replaced_string Defines a VICAR command or an equivalent command. DEFG[BL] I,P VICAR>DEFGBL + VICAR>+ NAME=variable_name_list + VICAR>+ [TYPE=type] + VICAR>+ [COUNT=min:max] + VICAR>+ [INITIAL=initial_value] + VICAR>+ [VALID=valid_values] + VICAR>+ [ACCESS=file_access_mode] Defines the following variable globally throughout all procedures. REFGBL is required before usage of the variable. DEFL[OG]-A[DD] I,P VICAR>DEFLOG-ADD log_name_value Creates logical name. Only available in VMS VICAR. DEFL[OG]-D[ELETE] I,P VICAR>DEFLOG-DELETE log_name_value Deletes a logical name. Only available in VMS VICAR. DEFS[YM]-A[DD] I,P VICAR>DEFSYM-ADD symbol_value Creates symbol. Only available in VMS VICAR. DEFS[YM]-D[ELETE] I,P VICAR>DEFSYM-DELETE symbol_value Deletes a symbol. Only available in VMS VICAR. DELC[MD] I,P VICAR>DELCMD COMMAND=name Deletes a defined command; same as DELETE-COMMAND. DELE[TE] I,P VICAR>DELETE NAME=variable_name Deletes a single Global or Local variable. DELE[TE]-C[OMMAND] I,P VICAR>DELETE-COMMAND + VICAR>+ COMMAND=name Deletes any command defined by using DEFCMD; same as DELCMD. DELE[TE]-G[LOBALS] I,P VICAR>DELETE-GLOBALS + VICAR>+ PROC=proc_name Deletes all the Globals defined in a GLOBAL Proc Definition File. DELE[TE]-L[OCALS] I,P VICAR>DELETE-LOCALS Deletes all the currently defined Local variables. DELE[TE]-V[ARIABLE] I,P VICAR>DELETE-VARIABLE + VICAR>+ NAME=variable_name Same as DELETE. DISABLE Disable a TAE Function. DISA[BLE]-FO[RCE_LOWER] I,P VICAR>DISABLE-FORCE_LOWER Disables case conversion of all file references from TM. This is the default. (Only available on UNIX systems.) DISA[BLE]-H[OST] I,P VICAR>DISABLE-HOST Disables entry into Host Command Language. DISA[BLE]-I[NTERRUPT] I,P VICAR>DISABLE-INTERRUPT Disables TAE/VICAR interrupt mode. DISA[BLE]-L[OG] I,P VICAR>DISABLE-LOG Disables TAE/VICAR session logging. Closes SESSION.TSL for TAE and SESSION.LOG for VICAR. DISA[BLE]-R[ECVAR] I,P VICAR>DISABLE-RECVAR Disables the use of the RECVAR command by deleting the input queue created by ENABLE-RECVAR. DISA[BLE]-T[OL] I VICAR>DISABLE-TOL Disables terminal output logging, initiated by ENABLE-TOL. DISM[OUNT] I,P VICAR>DISMOUNT + VICAR>+ [DEVICE=device_name] + VICAR>+ NAME=symbolic_name + VICAR>+ [OPTION=option] Causes the specified tape to be dismounted. DISP[LAY] I,P VICAR>DISPLAY + VICAR>+ [VARIABLE=variable_nam_lst] Displays the value of a variable. DISP[LAY]-A[LL] I,P VICAR>DISPLAY-ALL Displays all of the variables in current proc. DISP[LAY]-G[LOBALS] I,P VICAR>DISPLAY-GLOBALS Displays all of the Global symbols and their values. DISP[LAY]-L[OCALS] I,P VICAR>DISPLAY-LOCALS Displays all of the local symbols and their values. DISP[LAY]-PARF[ILE] I,P VICAR>DISPLAY-PARFILE + VICAR>+ FILE=file_name + VICAR>+ [VARIABLE=variable_list] Displays all or selected variables in a parameter file. DISP[LAY]-PARM[S] I,P VICAR>DISPLAY-PARMS Displays all of the parameters and their values. DISP[LAY]-V[ARIABLE] I VICAR>DISPLAY-VARIABLE + VICAR>+ [VARIABLE=variable_nam_lst] Displays the value of a variable. Same as DISPLAY. ELSE P Executes the following commands if previous logical expression is not true in a procedure. See IF for an example. ELSE-IF P Executes the following commands if previous logical expression is not true and the following expression is true in a procedure. See IF for and example. EMACS I VICAR>EMACS Invokes Emacs editor. Only available in VMS VICAR. EMIT I,P VICAR>EMIT [$SFI=integer] + VICAR>+ [$SKEY=string] Sends values for $SFI and $SKEY from an asynchronous job to the VICAR Supervisor. Allows monitoring of an asynchronous job using SHOW-ASYNC. Available only from an asynchronous job. ENABLE Enable a TAE function. There is no default subcommand. ENA[BLE]-FO[RCE_LOWER] I,P VICAR>ENABLE-FORCE_LOWER Enables the conversion to lower case of all file references from TM (Only available on UNIX systems.) ENA[BLE]-I[NTERRUPT] I,P VICAR>ENABLE-INTERRUPT Enables TAE/VICAR interrrupt mode. ENA[BLE]-L[OG] I,P VICAR>ENABLE-LOG Enables TAE/VICAR session logging. Outputs SESSION.TSL for TAE and SESSION.LOG for VICAR. ENA[BLE]-R[ECVAR] I,P VICAR>ENABLE-RECVAR + VICAR>+ SIZE=queue_size Creates an input queue for use by RECVAR. ENA[BLE-S[CRIPT] I VICAR>ENABLE-SCRIPT + VICAR>+ FILE=script_file + VICAR>+[COUNT=integer] Redirects input to the specified script file. ENA[BLE-T[OL] I VICAR>ENABLE-TOL FILE=file_name Enables logging of all terminal output to the specified file. END-F[OR] P Ends a loop with a variable assignment in a procedure. See FOR for an example. END-G[LOBALS] P May be used to terminate a Global PDF. (END-PROC may also be used.) END-I[F] P Terminates an IF expression. See IF for an example. END-L[OOP] P Terminates an infinite loop. See LOOP for an example. END-P[ROC] P Last statement of a proc. See PROCEDURE for an example. END-S[UBCMD] P SUBCMD NAME=subcmd_name declarations END-SUBCMD Terminates a subcommand declaration. EX[IT I VICAR>EXIT Exits VICAR and return to the operating system. FLAG I,P Symbolically sets the value of the $SWITCH TAE global variable. Default subcommand is FLAG-SET. FLAG-A[DD] I,P VICAR>FLAG-ADD FLAGS=flag_list Adds the named options to the list already set for the $SWITCH Global. FLAG-D[ELETE] I,P VICAR>FLAG-DELETE FLAGS=flag_list Clears a list of options in the $SWITCH Global. FLAG-SE[T] I,P VICAR>FLAG-SET FLAGS=flag_list Sets the value of $SWITCH symbolically. Default subcommand for FLAG. FLAG-SH[OW] I,P VICAR>FLAG-SHOW FLAGS=flag_list Shows the value of $SWITCH. FOR P FOR variable_name=for-list loop body END-FOR Introduces a loop with a variable assignment. FREEDISP I VICAR>FREEDISP [device] Deallocates image display device allocated with USEDISP. Only available in VMS VICAR. GETPAR P GETPAR + PARMS=(parm1, parm2, ...) + [PREFACE=("string1", "string2", ...)] Within a procedure, initiates a user dialog and obtains parameters dynamically. GLOBAL[S] I,P GLOBALS [HELP=help_location] Global definitions Local definitions Global references END-PROC Declares global variables in a PDF. GOTO P GOTO LABEL=label Searchs forward in the PDF for the label and then continues execution of the PDF from that location. H[ELP] I VICAR>HELP [command/proc_name] Lists Help capabilities of VICAR/TAE or Help on the specified name. H[ELP]-C[OMMAND] I VICAR>HELP-COMMAND + VICAR>+ [COMMAND=name] Displays the help information on a command. H[ELP]-GL[OBAL] I VICAR>HELP-GLOBAL + VICAR>+ VARIABLE=global_name Displays the help information on a global variable. H[ELP]-H[ARDCOPY] I VICAR>HELP-HARDCOPY PROC=proc + VICAR>+ [OUTPUT=output_file_name] Writes out a file containing information on the specified proc or command. The output file contains the help available both from HELP-PROC and from TUTOR. H[ELP]-M[ESSAGE] I VICAR>HELP-MESSAGE + VICAR>+ [KEY=message_key] Displays the help information on an error message. H[ELP]-PA[RM] I VICAR>HELP-PARM + VICAR>+ PARM=parameter_name + VICAR>+ PROC=proc or proc-subcommand Displays the help information on a parameter from the specified procedure. H[ELP]-PR[OC] I VICAR>HELP-PROC + VICAR>+ PROC=proc or proc-subcommand Displays the help information on the specified proc or proc-subcommand. IF P IF (logical-expression) if-part ELSE else-part END-IF Begins an IF-ELSE loop of a procedure. Provides conditional execution based upon evaluation of logical expression. LET I,P VICAR>LET variable_name=expression Assigns an expression value to a variable. LISTP[ROC] I VICAR>LISTPROC proc_name Lists the specified proc to the standard output. LOCAL I,P LOCAL + NAME=variable_name_list + [TYPE=type] + [COUNT=min:max] + [INITIAL=initial_value] + [VALID=valid_values] + [ACCESS=file_access_mode] Defines the following variable within this procedure only. LO[GOFF] I VICAR>LOGOFF Terminates the interactive session, logging the user off VICAR and the host system. LOOP P LOOP I = I + 1 IF (I = 10) BREAK END-IF GETIMAGE NEW = NEWIMAGE IF ($KEY = "IMG-BADIMAGE") NEXT END-IF DSPIMAGE IMG = NEWIMAGE END-LOOP Designates the beginning of an infinite loop step within a procedure. MAL I,P VICAR>MAL FILE=symbolic_name + VICAR>+ NL=number_lines + VICAR>+ NS=number_samples + VICAR>+ FORMAT=data_format Allocates a memory file, a file that resides entirely in memory. Only available in VMS VICAR. M[ENU] I VICAR>MENU [NAME=menu_name] Puts VICAR in MENU mode. M[ENU]-C[LOSED] I VICAR>MENU-CLOSED + VICAR>+ [NAME=menu_name] Puts VICAR in MENU mode. Disallows reentry into Command mode. MENU-O[PEN] Same as MENU. MOUNT I,P VICAR>MOUNT DEVICE=dev_name + VICAR>+ [LABEL=volume_label] + VICAR>+ [NAME=symbolic_name] + VICAR>+ [DENSITY=bpi] + VICAR>+ [BLOCKING=(blksiz,recsiz)] + VICAR>+ [COMMENT=operator_msg] + VICAR>+ [PROTECT=protection] + VICAR>+ [INIT=initialization] Causes the specified tape to be mounted. NEXT P Forces a loop to the next iteration within a procedure. See LOOP for an example. NOP P Accepts any parameters (including parameters with invalid syntax) and does nothing. NOP[ASSTHRU] PARM P PARM NAME=param_name_list + [TYPE=type] + [COUNT=min:max] + [DEFAULT=default_value] + [VALID=valid_values] + [QUALS=proc_name] Defines a parameter in a procedure. PARMSET P PARMSET [HELP=help_location] parameter declarations END-PROC With END-PROC, brackets a parameter set PDF. PAS[STHRU] Used to turnpassthrumode on and off.Passthrumode is the ability to execute or pass-through a vicar command from within an interactive prompt-style program. PROCEDURE P PROCEDURE [HELP=help_location] declarations BODY procedure body END-PROC "The procedure follows:" PROCESS P PROCESS [EXECUTE=file_spec] + [HELP=help_location] + [OPTIONS=interrupt_option] + [NAME=proc_name] declarations END-PROC Names the executable image file for the process to execute. PUTMSG P PUTMSG MESSAGE=string + [KEY=string] Writes a TCL message to the standard output device. PUTMSG-TRACE P PUTMSG-TRACE MESSAGE=string + [KEY=string] Same as PUTMSG, but includes line number and proc_name with message. RECVAR P RECVAR variable=(v1, v2,...) + JOB=job_name Receives a collection of variables (a VBLOCK) from another job. RECVAR-D[ISABLE] RECVAR-E[NABLE] RECVAR-R[ECEIVE] REFGBL I,P REFGBL NAME=(name-1, name-2,...) Informs procedure that the variable references a VICAR Global symbol. REMO[VE] I VICAR>REMOVE JOB=job_name_list Deletes completed, asynchronous job(s) from the VICAR asynchronous job list. REPL[Y] I VICAR>REPLY [JOB=job_name] Allows the user to supply values to an asynchronous job that is waiting for Dynamic parameters. REST[ORE] I,P VICAR>RESTORE FILE=save_file_name + VICAR>+ [TARGET=variable_list] + VICAR>+ [VARIABLE=variable_list] Restores the parameters from a file issued in an earlier SAVE command. Same as RESTORE-VARIABLE. REST[ORE]-A[LL] I,P VICAR>RESTORE-ALL + VICAR>+ FILE=save_file_name Restores all variables from a parameter file. REST[ORE]-G[LOBALS] I,P VICAR>RESTORE-GLOBAL + VICAR>+ FILE=save_file_name Restores only the Global variables from the save file. REST[ORE]-L[OCALS] I,P VICAR>RESTORE-LOCAL + VICAR>+ FILE=save_file_name Restores only the Local variables from the save file. REST[ORE]-P[ARMS] I,P VICAR>RESTORE-PARM + VICAR>+ FILE=save_file_name Restores only parameters from the save file. REST[ORE]-V[ARIABLE] I,P VICAR>RESTORE-VARIABLE + VICAR>+ FILE=save_file_name + VICAR>+ [TARGET=trgt_var_list] + VICAR>+ [VARIABLE=rest_var_list] Restores the parameters from a file issued in an earlier SAVE command. Same as RESTORE. RETURN P RETURN [$SFI=integer] + [$SKEY=string] Terminates procedure execution. REW[IND] I,P VICAR>REWIND DEVICE=symbolic_name Causes the specified tape to rewind. Only available in VMS VICAR. RUN SAVE I,P VICAR>SAVE FILE=save_file_name Saves all the parameters of a command in a file. SAVE-A[LL] I,P VICAR>SAVE-ALL + VICAR>+ FILE=save_file_namesave_file_name Save all variables in a specified save file. SAVE-G[LOBALS] I,P VICAR>SAVE-GLOBAL FILE=file_name Save all Global variables in a specified save file. SAVE-L[OCALS] I,P VICAR>SAVE-LOCAL FILE=file_name Save all Local variables in a specified save file. SAVE-P[ARMS] I,P VICAR>SAVE-PARM FILE=file_name Saves current parameters in a specified save file. SAVE-V[ARIABLE] I,P VICAR>SAVE-VARIABLE + VICAR>+ FILE=save_file_name + VICAR>+ [VARIABLE=variable_list] Saves all the parameters of a command in a file. Same as SAVE. SENDVAR P SENDVAR VARIABLE=(v1, v2,...) + JOB=job_name Packages a collection of TCL variables into a message (a TAE VBLOCK) and sends the message to another job. SETL[IB] I,P VICAR>SETLIB + VICAR>+ LIBRARY=library_name_list Defines a set of libraries to be used in the search for a proc or a menu. SETL[IB]-A[DD] I,P VICAR>SETLIB-ADD + VICAR>+ LIBRARY=library_name_list Adds another library to the previous libraries to search through. SETL[IB]-D[ELETE] I,P VICAR>SETLIB-DELETE + VICAR>+ LIBRARY=library_name_list Deletes the specified library from the list to search through. SETL[IB]-S[ET] SH[OW] I,P VICAR>SHOW Shows status of VICAR environment or display application library names. SH[OW]-A[SYNC] I,P VICAR>SHOW-ASYNC + VICAR>+ JOB=job_name/list] + VICAR>+ [FORM=list_format] Displays asynchronous job status. SH[OW]-B[ATCH] I,P VICAR>SHOW-BATCH QUEUE=name Displays batch queue status. Only available in VMS VICAR. SH[OW]-L[IBRARY] I,P VICAR>SHOW-LIBRARY Same as SHOW. SH[OW]-W[AITING] I,P VICAR>SHOW-WAITING Displays asynchronous jobs waiting for dynamic parameters. STOP P STOP Terminates all procedure levels. SUBCMD P SUBCMD NAME=subcmd_name declarations END-SUBCMD With END-SUBCMD, declares a set of variables (usually parameters) to be associated with the named subcommand. SUBCMD-DEFAULT makes the named subcommand the default. SWI[TCH] I,P SWITCH VALUE=hexadecimal_value Sets the value of the bits in $SWITCH numerically. Use with caution. T[UTOR] I VICAR>TUTOR proc_name + VICAR>+ [proc_parameters] Enters TUTOR in display mode indicated by the Global $TUTOR. T[UTOR]-S[CREEN] I VICAR>TUTOR-SCREEN proc_name + VICAR>+ [proc_parameters] Enters TUTOR in formatted screen mode. T[UTOR]-N[OSCREEN] I VICAR>TUTOR-NOSCREEN proc_name + VICAR>+ [proc_parameters] Enters TUTOR in no screen mode. USA[GE] I,P VICAR>USAGE Causes VICAR to display statistics of resource usage. Same as USAGE-SHOW. Currently only available in VMS VICAR. USA[GE]-S[HOW] I,P VICAR>USAGE-SHOW Causes VICAR to display statistics of resource usage. Same as USAGE. Currently only available in VMS VICAR. USE[DISP] I VICAR>USEDISP [device] Allocates image display device. Only available in VMS VICAR. USH I,P USH any-UNIX/shell-command Executes the UNIX/shell as an application process under TAE. Only available in UNIX VICAR. WAIT-A[SYNC] I VICAR>WAIT-ASYNC JOB=job_name_list Causes VICAR to wait for completion of the specified asynchronous job(s). WPT P Window Programming Tools. WPT-B[EGINWAIT] P WPT-BEGINWAIT PANEL=parameter-name Sets the "wait indictator", indicating to the user that the specified panel is temporarily in a wait state and is not available for interaction. WPT-EN[DWAIT] P WPT-ENDWAIT PANEL=parameter-name Removes the "wait indicator." WPT-ER[ASE] P WPT-ERASE PANEL=panel-name Erases a panel from the screen. WPT-EV[ENT] P WPT-EVENT PARM=parm-name + [PANEL=panel-name] + [TIMEOUT=seconds] Waits for the next WPT event and delivers event information. When an event is received from a panel, the target variable identified by WPT-PANEL is updated to reflect the current values on the screen. WPT-I[NIT] P WPT-INIT [HOST=host] + [DISPLAY=display] + [PROTOCOL=protocol] Initializes the WPT package. Should be executed before any other WPT TCL command. WPT-M[ESSAGE] P WPT-MESSAGE PANEL=panel-name + MESSAGE=message Creates a dialog box for communicating information to the user. WPT-PAN[EL] P WPT-PANEL VIEW=view + [TARGET=target] + [PANEL=panel-name] + [STATE=state] Creates a WPT panel and enables the receipt of events from the panel. The panel may be creates in one of several states. WPT-PAR[MUPDATE] P WPT-PARMUPDATE PANEL=panel-name + PARM=parameter name Updates a parameter display. The parameter display may be given a new value, a new selection or a new valid list. WPT-REJ[ECT] P WPT-REJECT PANEL=panel-name + PARM=parm-name + MESSAGE=message Generates a rejection message for a user-supplied parameter value. WPT-REH[EARSE] P WPT-REHEARSE INTERVAL=interval + ORDER=order + CYCLES=cycles Turns on or off the simulated update of all Data Driven Objects (DDOs) on all visible application panels. The update interval and style of updating may be specified. WPT-S[ETPANELSTATE] P WPT-SETPANELSTATE PANEL=panel-name + STATE=state-name Changes the current display state of a panel. WPT-V[IEWUPDATE] P WPT-VIEWUPDATE PANEL=panel-name + PARM=parm-name + VIEW=view WRITE P WRITE STRING=string Writes an ASCII string to the standard output device. ? I VICAR>? Displays the help information on the most recent error message. Same as HELP- MESSAGE without specified KEY.
ASYNCEND=value
ALLOWED VALUES: NOTIFY SILENT DEFAULT: SILENTThe
ASYNCEND qualifier is only valid if the
RUNTYPE qualifier is set to ASYNC. It
specifies whether notification of job completion is desired. JOB=job-name
ALLOWED VALUES: ASYNC job_name DEFAULT: derived from proc nameThe
JOB qualifier is an alternate way of specifying the
name of an asynchronous job. RESTORE=file-specification
ALLOWED VALUES: a file spec DEFAULT: noneThe
RESTORE qualifier specifies a file (created with
SAVE) that contains parameter values. Values provided
explicitly on the command line override values provided from the
restored file. RUNTYPE=(mode,queue_name)
ALLOWED VALUES: (BATCH, queue_name) (ASYNC, job_name) INTERACTIVE NORUN DEFAULT: INTERACTIVEThe
RUNTYPE qualifier specifies whether the proc is to be run
interactively or submitted for batch or async execution.
RUNTYPE=(BATCH, queue_name)This qualifier specifies that the proc is to be submitted to the queue queue_name and executed in batch.
RUNTYPE=ASYNC or RUNTYPE=(ASYNC, job_name)This qualifier specifies that the proc is to be executed asynchronously. If job_name is present, then the specified name is assigned to the job. If job_name is omitted, TAE constructs one.
SAVE=file-specification
ALLOWED VALUES: a file spec DEFAULT: noneThe
SAVE qualifier specifies a file for saving the values
of the parameters to be accessed later with RESTORE. STDOUT=file-name
ALLOWED VALUES: a file spec DEFAULT: user terminalThe
STDOUT qualifier specifies the file or device to be
used to receive data sent to the "standard output" file or device.
10.6 VICAR Intrinsic Global Variables
Defined in $taepdf/taegbl.pdf and $TAEPDF:TAEGBL.PDF
All global variables are implicitly referenced (no REFGBL command is
required before use) on the interactive level. All variables used in
procedures must be declared using the REFGBL command except for those
which are implicitly defined by VICAR and are marked by "+".
Global variables defined by TCL which may be modified by the user are
flagged with a "*". To change the value of a Global variable, use
HELP-GLOBAL
$global_name or TUTOR TAEGBL.
GLOBAL MOD
VARIABLE FLAG DEFINITION
$AECHO * Determines which lines, if any, in a PDF are
to be echoed as they are executed in an
asynchronous job. The ith element of $AECHO
applies to the ith level, starting with level
1. The last element entered will apply to all
subsequent levels. Level 0 will always be
echoed. (Procedure invocation and resulting
levels are described at the end of this
Appendix.) Possible values:
"NO" - No echo
"FULL" - Declarations plus body are echoed.
"BODY" - Body only is echoed.
"YES" - Equivalent to "BRIEF"
"TRACE" - List filespec of proc.
Default: ("YES", "NO"); level 1 echoed,
levels 2 thru n not echoed.
$APLIB * Contains the names of the currently active
applications libraries. $APLIB may be
conveniently set with the tae setlib
command.
Default: disk locations of V2$SYSLIB, R1LIB,
R2LIB and R3LIB.
$BECHO * Determines which lines, if any, in a PDF are
to be echoed as they are executed in a batch
job. The ith element of $BECHO applies to the
ith level, starting with level 1. The last
element entered will apply to all subsequent
levels. Level 0 will always be echoed.
(Procedure invocation and resulting levels are
described at the end of this Appendix.)
Possible values:
"NO" - No echo
"FULL" - Declarations plus body are echoed.
"BODY" - Body only is echoed.
"YES" - Equivalent to "BRIEF"
"TRACE" - List filespec of proc.
Default: ( "YES", "NO"); level 1 echoed,
levels 2 thru n not echoed.
$DEFCMD0 * Contains a list of defined commands. $defcmd0
is set by the tae defcmd command. Type
"help defcmd" for assistance in executing
the defcmd command. Each element of $defcmd0
represents one defined command. The '='
character separates the command name from the
replacement string. If more than 50 commands
are defined, TAE creates additional global
variables (named $defcmd1, $defcmd2, ...)
as needed.
$DYNTUT * Selects the form of the Dynamic TUTOR session
on the user's terminal. This may be set with
the "let" command. Possible values:
"NOSCREEN"
"SCREEN"
Default: "SCREEN"
$ECHO * Controls which lines, if any, in a PDF are to
be echoed onto the terminal as they are
executed in interactive mode. The ith element
of $ECHO applies to the ith level, starting
with level 1. The last element entered will
apply to all subsequent levels. Level 0 will
always be echoed. (Procedure invocation and
resulting levels are described at the end of
this Appendix.) Possible values:
"NO" - No echo
"FULL" - Declarations plus body are echoed.
"BODY" - Body only is echoed.
"YES" - Equivalent to "BRIEF"
"TRACE" -List filespec of proc.
Default: "NO"; only level 0 will be echoed.
$FILEVER * Determines whether file verification is
enabled. If the value of $FILEVER is "YES"
then proc parameters of type FILE are
verified according to the ACCESS specifi-
cation. If $filever is "NO", then no file
verification is performed and the ACCESS
specification for FILE parameters is
ignored. Possible values:
"YES"
"NO"
$LASTCMD * This is an archive of the twenty most recent
interactive commands. You may turn off
archiving by setting $LASTCMD to the null
value: let $LASTCMD = --
$LOG * Contains the name of the session log file
for the current TAE session.
Default: "session.tsl"
$MENUS * This is the current menu stack. It is used
by the TAE menu processor to find the next
menu to display, and to know the menu
history for the menu "back" command. Procs
that reference $menus can reset the "next"
menu for the menu user.
$MENUOPT * Sets the menu display options. It is a
vector of up to four strings and is
validated for the following values:
"NO_NAME" - suppress the "menu:" portion
of the display.
"NO_TAG" - suppress the menu name on the
display
"NO_LIBRARY" - suppress the library name
on the display.
"NO_PRESS_FOR_MENU" - suppress the
"Press return for menu"
prompt and charge right into
the menu screen.
$MESSAGE * Controls the terminal action when an error or
informational message must be displayed.
Possible values:
"SILENT" - no special action taken.
"BELL" - sounds the terminal "beep"
"PAUSE" - user must hit "return" key before
proceeding.
"ATTN" - combination of "BELL" and
"PAUSE"
Default: "BELL"
$PROMPT * Contains the ASCII string for user's prompt.
Default: "VICAR".
$RUNTYPE * Indicates the current job environment. The
values are:
"INTERACTIVE" - interactive job
"BATCH" - batch job
"ASYNC" - asynchronous job
$SESSION * A string that uniquely identifies the
current job among all other active jobs.
In VAX/VMS and UNIX systems, $SESSION
contains the process identification of
TAE's terminal monitor.
$SFI * Proc termination "success/fail" indicator.
When a proc terminates normally, $SFI is
set to a positive number by TAE. When
a proc terminates abnormally, $SFI is set
to a negative value by TAE. Following
completion of a proc, you may display
$SFI with the following command:
DISPLAY $SFI
$SKEY * Proc termination status key. This string
is set to return status information to
the invoking proc.
$SWITCH * $SWITCH is an integer of bit flags for use
by application programmers. TAE reserves
the right-hand eight bits for its own use.
Currently, the right-hand bit means "run
all application programs using the VMS
/DEBUG qualifier". Thus, a programmer
may always LINK with the debugger and
enable the debugger only when needed. The
second rightmost bit signals that for batch
or async job, sys$output is to be assigned
to a file of type SPL. The debug output is
to be placed in a file of type TML.
The third rightmost bit tells TM to initiate
the async TM through the file []ASYNC.COM
and place the output in []TM.DAT. This flag
is used for async debugging. The fourth
rightmost bit is no longer used. The fifth
rightmost bit is used to request for
display of library in dynamic tutor.
$SYSCHAR * Strings of system characteristics referenced
by help files to generate "conditional" help
text on various systems.
$SYSLIB * Contains the name of the system library.
Default: $TAELIB.
$TUTOPT * This global sets tutor display options. It
is a vector of up to three strings and is
validated for the following values:
"NO_TAG" - suppress the "TUTOR:"
portion of the display.
"NO_NAME" - suppress the PDF name on the
display.
"NO_LIBRARY" - suppress the library name
on the display.
"NO_SELFTUTOR" - do not honor SELFTUTOR
requests in PDFs.
"COMPRESS" - use the "compressed" form
of tutor.
$TUTOR * Selects the form of the TUTOR session.
Possible values:
"SCREEN"
"NOSCREEN"
$TUTSELE * This global is only meaningful in TAE
Facelift tutor mode. It determines
whether valids for a parm should be
displayed in a separate valid panel.
$TUTSELE may be set with the LET command.
Possible values:
"YES"
"NO"
$USERLIB * Contains the name of the user library.
Procedure invocation and resulting levels: Procedures may contain invocations of other procedures. Commands received from the asynchronous/batch/interactive user are said to be executing on the "primary level" (level 0). A procedure invoked from level 0 executes at level 1. A procedure executing on level 1 may invoke another procedure, which executes at level 2, and so on.
10.7 MENU Mode User Operations
If you wish to return to the Contents page, click here.