common user interface - cui user guide - emperex · common user interface (cui) user’s guide...

Common User Interface

(CUI)

User’s Guide

Abstract This publication is designed to help guide first-time users of Emperex Corporation’sproducts through the set of common environment-related commands. Thesecommands are available through all Emperex Corporation’s products which haveline-oriented command interfaces.

Part Number 080000 D20

Product Version CUI D20.13

OperatingSystem

GUARDIAN C30-D4x, Gxx

Printing Date September 2007

Emperex Cor po ra tion5955 Air port Road, Suite 200,Mis sis sauga, On tario, Can ada,L4V 1R9

Phone: (905) 677- 6666Fax: (905) 677-6671

www.emperex.com

Document History

Edition Part Number Operating System Date

First Edition 080000 C20 Guardian C10-C30 January 1991Second Edition 080000 C30 Guardian C10-C30 July 1991Third Edition 080000 C30 Guardian C10-C30 February 1993Fourth Edition 080000 C40 Guardian C30-D30 November 1995Fifth Edition 080000 C40 Guardian C30-D30 January 1997D00 Release Edition 1 080000 D00.01 Guardian C30-D30 May 1997D20 Release Edition 1 080000 D20.08 Guardian C30-D30 October 2003

Copyright Notice

Copyright © 1991-2003 by Emperex Corporation. Printed in Canada.

All rights reserved. No part of this document may be reproduced in any form, includingphotocopying, optical character scanning recognition, facsimile (FAX) transmission, ortranslation to another language without the prior written consent of Emperex Corporation.

The information contained in this document is furnished under a license agreement andnon-disclosure agreement. The software and associated documentation may be used only inaccordance with the terms of the agreement.

Trademarks or Service Marks

The following are trademarks or service marks of Emperex Corporation.

DBOL, DDSDIFF, DDSMAKE, GMAIL, InterAccess, RMS, TBOL

The following are trademarks or service marks of HP Computers Incorporated:

DDL, Enscribe, Expand, Guardian, NonStop, PATHMAKER, TACL, TAL, Tandem, Transfer.

Table of Contents

Preface

Pur pose and Scope ...................................................................................v

Or gani za tion ............................................................................................v

Who Should Read What ..........................................................................v

Re lated Manu als and Prod ucts ................................................................vi

Common User Interface (CUI) Facilities 1

Ca pa bili ties ..............................................................................................1-1

Environment Commands 2

His tory Buffer ..........................................................................................2-2

! Com mand ..............................................................................................2-3

? Com mand ..............................................................................................2-4

ALIAS Com mand.....................................................................................2-5

AL LOW Com mand .................................................................................2-8

COM MENT Com mand ...........................................................................2-9

DE LAY Com mand....................................................................................2-10

ECHO Com mand......................................................................................2-11

ENV Com mand .......................................................................................2-12

ENV CON TINUE Com mand ...................................................................2-14

ENV HEADER Com mand .......................................................................2-15

ENV HELP Com mand..............................................................................2-16

ENV PAGE Com mand .............................................................................2-17

ENV PMSG Com mand.............................................................................2-18

ENV STATS Com mand ...........................................................................2-19

EXIT Com mand .......................................................................................2-20

FC Com mand ...........................................................................................2-21

FILEINFO Com mand ..............................................................................2-23

FILE NAMES Com mand ..........................................................................2-25

FILES Com mand .....................................................................................2-27

HELP Com mand ......................................................................................2-29

HIS TORY Com mand................................................................................2-31

IF Com mand .............................................................................................2-32

LOG Com mand .......................................................................................2-34

OBEY Com mand .....................................................................................2-35

OUT Com mand .......................................................................................2-36

RUN Com mand .......................................................................................2-37

SET PROMPT Com mand .........................................................................2-39

SYS TEM Com mand ................................................................................2-42

TIME Com mand ......................................................................................2-43

VOL UME Com mand ..............................................................................2-44

080000 Emperex Corporation iii

Table of Contents

Interacting with the CUI 3

En ter ing Com mands ................................................................................3-1

Us ing In put Files .....................................................................................3-3

iv 080000 Emperex Corporation

Table of Contents

0 Preface

Welcome to the Common User Interface to all Emperex Corporation’s products. Our goal indesigning the CUI is to make a basic set of commands available to all of our utilities whichare already familiar to Tandem users.

We at Emperex are proud of our products. We take pride in the level of support that weprovide. If you have any questions regarding this, or any other Emperex product, software, orsupport materials, please contact your Emperex representative.

Purpose and Scope

This publication is intended to assist new users of Emperex products in becoming familiarwith the common user interface (CUI). This manual will also provide introductoryinformation for users who have only a general knowledge of Tandem computer systems.

This publication applies to all current Tandem computer systems which run Release D00 orlater of the Guardian 90 operating system.

Organization

The organization of this publication is intended to help you understand the commands whichmake up the common user interface (CUI).

q Section 1 provides a brief overview of the CUI facilities.

q Section 2 provides detailed information about each command in the CUI.

q Section 3 describes the various ways in which users communicate with the CUI. Thetechniques available to users are also described.

Who Should Read What

This publication is written for all users new to Emperex products.

080000 Emperex Corporation v

Preface

Purpose and Scope

Related Manuals and Products

Here is a list of RMS manuals:

q The Introduction to RMS (Part No. 80201) provides introductory information on thecapabilities of the RMS product. You should read this manual first!

q The RMS User’s Guide (Part No. 80207).

q The RMSCOM and RMSMON Reference Manual (Part No. 80203) contains detailedreference information for using RMS.

q The RMS Tutorial Guide (Part No. 80208) gives step-by-step instructions on how to useRMS.

q The RMS Utilities Reference Manual (Part No. 80206) describes the utility programsassociated with RMS.

q The RMS Installation Guide (Part No. 80202).

q The RMS Programming Manual, Volumes 1 and 2 (Part Nos. 80204 and 80205).

q The Data Compression Facilities (PRESS) User’s Guide (Part No. 80501).

q General Transfer/Mail™ Gateway Reference and Customization Guide (Part No. 84021B40).

The following are D30 versions of Tandem publications and are supplemental:

q GUARDIAN Operating System User’s Guide

q GUARDIAN Programmer’s Guide

q GUARDIAN System Operations Guide

q ENSCRIBE™ Programmer’s Guide

q TACL Programming Guide

q TACL Reference Manual

q Pathway PATHCOM Reference Manual

q Pathway System Management Guide

q NonStop™ SQL/MP Reference Manual

q NonStop™ SQL/MP Report Writer Guide

vi 080000 Emperex Corporation

Preface


q NonStop™ SQL Messages Manual

q NonStop™ SQL Installation and Management Guide

q NETBATCH Manual

q TAL Programmer’s Guide.

You might also find these manuals helpful:

q Programmatic Network Administrator (PNA) RDL Manual (Part No. 48818)

q Programmatic Network Administrator (PNA) System Management Manual (Part No.48815).

080000 Emperex Corporation vii

Preface


Notes:

viii 080000 Emperex Corporation

Preface


Notation Conventions

The following list summarizes the conventions for syntax notation in this manual:

Syntax Conventions

Notation Meaning

UPPERCASELETTERS

Upper-case letters represent keywords and reserved words; you must enterthese items exactly as shown.

lowercase letters Lower-case italic letters represent variable items that you must supply.

Brackets [ ] Brackets enclose optional syntax items. A vertically-aligned group of itemsenclosed in brackets represents a list of selections from which you maychoose one or none.

Braces { } Braces enclose required syntax items. A vertically-aligned group of itemsenclosed in braces represents a list of selections from which you mustchoose only one.

Vertical Line(|) A vertical line separating items in a list enclosed in either braces or brackets is an alternative to vertical alignment of the options (usually in short liststhat can be easily shown on one line).

Ellipsis ... An ellipsis immediately following a pair of brackets or braces indicates thatyou can repeat the enclosed syntax item any number of times.

Spaces If two items are separated by a space, that space is required between theitems. If one of the items is a punctuation symbol such as a parenthesis or acomma, spaces are optional.

Punctuation Parenthesis, commas, semicolons, and other symbols or punctuation notdescribed above must be entered precisely as shown. If any of thepunctuation above appears enclosed in quotation marks, that character is arequired character and you must enter it as shown.

& Continue to type the command as one line.

change-xxxx This is the change number, found in the left margin. It indicates that achange or addition has been made to both the software and the manual since the last edition.

This line indicates where the changed or new information ends.

All Returns are implicit.

080000 Emperex Corporation ix

Notes:

x 080000 Emperex Corporation

11 Common User Interface (CUI)

Facilities

The Common User Interface (CUI) provides a common set of commands to all EmperexCorporation’s products. After learning one product, you will already have the basics neededto learn another product.

The CUI presented in this manual is design to support line-oriented command interfaces onTandem computer systems running the GUARDIAN 90 operating system versions C10 orhigher.

Capabilities

The CUI supports the following facilities:

q Command History. The CUI maintains a history of commands that you enter during asession in any Emperex product. You can examine, edit, and re-executepreviously-entered commands.

q Program Execution. The CUI allows you to start up other programs from within the CUI.You can even turn on the display of process management messages.

q Command Logging. The CUI can provide a complete log of interactions between the user and the product supporting the CUI.

q Environment Control. The CUI can display and change common environment settings,such as default volume.

q Output Redirection. You can have the CUI redirect its output to another file, terminal, orspooler location.

q Input Redirection. The CUI can read commands from alternate input files. The facilityeven supports sections within input files.

q On-line Help. The CUI manages the on-line help portion of an application. Allapplications using the CUI present help in the same manner.

080000 Emperex Corporation 1-1

Common User Interface (CUI) Facilities

Capabilities

Notes:

1-2 080000 Emperex Corporation

Common User Interface (CUI) Facilities

Capabilities

22 Environment Commands

The commands implemented within the CUI allow the user to interact or query files andprocesses that are common to all applications. The commands allow a user to redirect theinput and output of application commands, execute programs, change the default volume,manipulate the command history buffer, display file names, and, in some applications get help on command syntax.

The following environment commands are supported by the CUI:

Table 2-1 Environment Command Summary

Command Description

! Re-executes a command.

? Displays a previous command.

ALIAS Controls command aliases.

ALLOW Controls the number of errors and warnings allowed percommand.

COMMENT Places a comment into a command file.

DELAY Pauses RMSCOM for a specific period.

ECHO Sends text to the output file(s).

ENV Displays and controls current environment settings.

ENV CONTINUE Causes the application program to continue processing inputafter the command line options and commands have beenprocessed.

ENV HEADER Turns the display of page header information on or off when apage break occurs.

ENV HELP Sets the default level of detail associated with help queries.

ENV PAGE Changes the default page size.

ENV PMSG Controls the display of process-control information.

ENV STATS Controls the display of statistics when the command-levelinterface is terminated.

EXIT Terminates RMSCOM processing.


Environment Commands

FC Fixes a previous command.

FILEINFO Displays detailed file information.

FILENAMES Displays names of specified files.

FILES Displays files in a subvolume.

HELP Obtains help.

HISTORY Displays previous commands.

IF Controls conditional command processing.

LOG Logs commands and responses to a file.

OBEY Executes commands from a disk file.

OUT Redirects output to a file.

RUN Runs a program from within RMSCOM.

SETPROMPT Changes the default prompt text.

SYSTEM Changes the default system.

TIME Displays current date and time.

VOLUME Changes the current default volume.

History Buffer

All programs supporting the CUI contain a buffer to hold commands. Commands are enteredinto the buffer when a command interpreter reads a line from the input file. The buffer is 2048 bytes long. A number of commands are provided to examine and manipulate commands in the buffer. These include: ? to display a command in the buffer; ! to repeat a command in thebuffer; and FC to correct or modify a command in the buffer and optionally repeat it.Commands may be referenced using absolute command numbers, relative command numbers, or by the text of the command itself. The HISTORY command provides a method ofdisplaying the contents of the history buffer.



History Buffer

! Command

The ! command displays and re-executes a command from the history buffer.

! { [ [-]number ] }{ [ string ] }

number

is an unsigned integer.

string

is any text that does not begin with a digit.

Considerations

q The ! command without any parameters re-executes the previous command.

q The ! command with a negative number re-executes the relative command number. Forexample, ! -1 re-executes the previous command and is equivalent to ! with noparameters.

q The ! command with a positive number re-executes the command-numbered number. The HISTORY and ? commands provide absolute command numbers which are appropriatefor this form of the ! command.

q The ! string form of the command searches the history buffer for the most recentcommand that begins with string and re-executes the command. Trailing blanks areignored for this form of the ! command.

q This command is only available if the CUI is interactive. This command is not allowed in OBEY files.



! Command

? Command

The ? command displays a command from the history buffer.

? { [ [-]number ] }{ [ string ] }

number


string

is any text that does not begin with a digit.

Considerations

q ? alone displays the preceding command.

q ? number displays the command-numbered number.

q ? -number displays the relative command number.

q ? string displays the most recent command that starts with string. Trailing blanks areignored for this form of the ? command.




? Command

ALIAS Command

The ALIAS command controls the processing of command expansion aliases.

ALIAS [ name [ “command-text” ] ]

name

is the command alias to be added, deleted, or modified.

command-text

is the command string to be substituted for name. This string can contain any text thatcorresponds to a valid command.

Considerations

q ALIAS on its own, displays all current aliases.

q ALIAS name will delete the alias corresponding to name.

q ALIAS name command-text will add a new alias if name is not currently defined, orchange the current definition of name if it is already defined.

q Aliases are restricted to 80 bytes. The total expansion of an alias cannot exceed 253bytes.

q The alias facility supports parameter substitution. If %n% appears in the command-text,the n-th token in the input text will be substituted. %0% corresponds to the alias name.

q To insert a double quote into a prompt string use \".

q To insert a percent into a prompt string without expansion use \%.

q To insert a backslash required as part of an application command, four backslashes arerequired. Use \\\\.

q Any command can be aliased except for the ALIAS command. The command

ALIAS FILES “FILEINFO *”

is a perfectly valid alias definition.

q The number of allowed aliases may vary between applications. The standard maximumnumber of aliases is 128.



ALIAS Command

Example

The following example illustrates parameter substitution within an alias:

CUI 1) ALIAS ci “info component %1%,detail”CUI 2) ci *yields: info component *,detail

Function Key Alias Definitions

Function keys can be assigned commands in a manner similar to the normal command aliases.

ALIAS SF16 “EXIT”

sets up an alias to shift-f16 to the EXIT command.

Function key aliases can accept parameters. Parameters must be entered on the command linebefore the function key.

CUI) ALIAS F1 “FILES ”CUI) $DATA.CATALOG<f1>

translates to a FILES command on the $DATA.CATALOG subvolume.

Note! Currently, function keys are only supported for Tandem 65xx terminals and terminal emulator products.

Note! ALIAS supports an additional parameter form. The %*% parameter will place the entire input string, except for the initialkeyword, into the resulting command. For example, using the ALIAS command:

ALIAS aa “INFO %*%”

When you enter the command:

aa comp \SYS\APPL\BCOMP

in effect, it becomes:

INFO COMP \SYS\APPL\BCOMP



ALIAS Command



ALIAS Command

ALLOW Command

The ALLOW command controls the maximum number of errors or warnings that can occurwithin a command before the command processing terminates. If the limit is exceeded, thecurrent command, OBEY or IN-file processing is terminated.

The ALLOW command is only relevant for OBEY files and IN-file processing.

ALLOW [ ALL ] [ ERRORS ][ NO ] [ WARNINGS ][ count ]

ALL

tells the CUI that it should continue processing regardless of the number of errors orwarnings.An OBEY file will continue to execute lines it can execute successfully and not stop if one line fails.

This command will not allow an RMS operation which requires several steps to besuccessfully completed in succession to continue when an error is encountered.

NO

tells the CUI that it should immediately stop when an error or warning occurs.

count

indicates the maximum number of errors or warnings that can occur before commandtermination. count must be greater than 0 and less than 32768.

Considerations

q Initially, no errors and all warnings are allowed.

q If none of ALL, NO, or count is specified, ALL is assumed.

q If none of ERRORS or WARNINGS is specified, ERRORS is assumed.

q ALLOW on its own causes the number of errors and warnings to be reset to their initialvalues.



ALLOW Command

COMMENT Command

The COMMENT command documents command or obey files.

COMMENT any text

or

== any text

Considerations

q The COMMENT command can appear anywhere in an obey file.

q The == is a valid alias for the COMMENT command and has the same semantics asCOMMENT.

q == will not be treated as a comment if it appears as part of the another command. Youwill have to terminate the other command first, as described below.

Examples

The following are valid comments:

CUI) COMMENT This is a comment lineCUI) == This is also a comment lineCUI) ENV; == This is how to place a comment on a command line



COMMENT Command

DELAY Command

The DELAY command pauses RMSCOM (or any other process using the CUI) for a specificperiod.

DELAY n { SECONDS | MINUTES | HOURS }

n

is a valid number from 0 to 32767.

Considerations

None.



DELAY Command

ECHO Command

The ECHO command sends text to the current output file(s).

ECHO “string” ...

string

is any quoted string of characters.

Considerations

ECHO is really only useful in OBEY files.

Examples

The following displays text:

CUI) == Dump a blank lineCUI) ECHO

CUI) == Dump stringsCUI) ECHO “Hello” “world”Hello world.



ECHO Command

ENV Command

The ENV command writes to the out file the SAVED VOLUME, the CURRENT VOLUMEand the current LOG file name (if one exists) as well as other environment parameters.

ENV

Considerations

None.

Examples

The ENV command produces the following report to the current OUT file:

CUI VERSION C30SAVED VOLUME startup-volumeCURRENT VOLUME current-volumeHELP LEVEL { SYNTAX | DETAIL }CURRENT SECURITY “GGGG”SAVED SECURITY “GGGG”DEFINE =_DEFAULTS, CLASS DEFAULTS,

VOLUME current-volume

HOME-TERM home-terminalUSER-ID guardian-user-idSTATS { ON | OFF }PMSG { ON | OFF }PAGE 60, 80HEADINGS { ON | OFF }ERRORS ALLOWED { NONE | ALL | count }WARNINGS ALLOWED { NONE | ALL | count }LOG logging-state

startup-volume

is the volume that the CUI received in its startup message from the process that started theCUI command interpreter.

current-volume

is the current volume that the CUI is using for file name expansion. It will be the same asthe startup volume unless a VOLUME or SYSTEM command has been issued to changethe current volume.

home-terminal

corresponds to the TERM parameter specified in the RUN command.



ENV Command

guardian-user-id

is the current process accessor id (PAID) of the CUI process.

60, 80

is the length (in lines) and the width (in characters) of the page.

logging-state

is either the name of the current log file, or the message “logging disabled” if no log file is currently being used.



ENV Command

ENV CONTINUE Command

The ENV CONTINUE command causes the application program to continue processing input after the command line options and commands have been processed. The default action formost applications is to terminate after processing the command line.

ENV CONTINUE { ON | OFF }

Considerations

None.



ENV CONTINUE Command

ENV HEADER Command

The ENV HEADER command turns the display of page header information on or off when apage break occurs.

ENV HEADER { ON | OFF }

Considerations

None.



ENV HEADER Command

ENV HELP Command

The ENV HELP command sets the default level of detail associated with help queries. Pleaserefer to the HELP HELP documentation for the levels of detail available.

ENV HELP { ON | OFF }

Considerations

None.



ENV HELP Command

ENV PAGE Command

The ENV PAGE command changes the default page size. Adjusting page sizes causes a pagebreak to occur on the next output. The new page size takes effect on the next page.

ENV PAGE { ON | OFF }

Considerations

None.



ENV PAGE Command

ENV PMSG Command

The ENV PMSG command controls the display of process-control information whenprocesses are started and stopped while using the RUN command.

ENV PMSG { ON | OFF }

Considerations

q By default, no process-control messages are displayed. ENV PMSG ON allows thedisplay of these messages.

q The following process messages are supported:

q Process Startup messages report the <CPU, PIN> or process name of the processstarted by a RUN command.

q Normal Process Termination messages report the <CPU, PIN> or process name ofthe process which stopped, followed by any additional details which the terminatedprocess specified when it shut down.

Abnormal Process Termination messages report the <CPU, PIN> or process name of theprocess which abended, followed by any additional details which the abnormally-terminatedprocess specified when it halted.



ENV PMSG Command

ENV STATS Command

The ENV STATS command controls the display of statistics when the command-levelinterface is terminated. This command has no other effect during program execution.

ENV STATS { ON | OFF }

Considerations

q By default, the number of errors and warnings are displayed when the programterminates. ENV STATS OFF inhibits the display of these statistics.

q Applications supporting the CUI have the choice of displaying these statistics or notwhen commands are specified either in an OBEY file or on the TACL RUN commandline.



ENV STATS Command

EXIT Command

The EXIT command stops the current command interpreter process.

EXIT

Considerations

Termination processing for each product can be different. Please consult the appropriatereference manual for the product that you are using for specific details on what thatapplication does when a command interpreter shuts down.



EXIT Command

FC Command

The FC command changes or corrects any command that is still in your command historybuffer.

FC { [ [-]number ] }{ [ string ] }

number


string

is any string not beginning with a digit.

Considerations

q FC alone allows you to correct the immediately-preceding command.

q FC number allows you to correct the specific command number.

q FC -number allows you to correct the command that preceded the current command bynumber commands; for example, FC -1 is the same as FC.

q FC string allows you to correct the most recent command that started with string. Trailing blanks are ignored for this form of the FC command.




FC Command

Editing Template

The following description summarizes the syntax of the editing template for the FCcommand.

subcommand [ // subcommand ] ...

subcommand is any of:

//

is a separator, allowing multiple subcommands on a given line. A subcommand canimmediately follow one or more uppercase or lowercase D’s without being preceded by //.

{ R | r } replacement-string

replaces characters in the previous command, starting with the character displayedimmediately above the R or r. A replacement-string preceded by R or r can be any stringof characters, including spaces, and can itself begin with R, I, or D (or r, i or d).Characters in replacement-string replace characters in the previous command on aone-for-one basis.

{ I | i } inserting-string

inserts characters into the previous command in front of the character displayed above theI or i.

{ D | d }

deletes characters in the previous command. Any original character displayed above a Dor d that begins a subcommand in the editing template is deleted.

replacement-string

is any text that does not begin with R, I, or D (or i, r, or d). Characters inreplacement-string replace characters immediately above them on a one-for-one basis. For example, a D in replacement-string replaces the character displayed above it instead ofdeleting it.

The editing template processor in CUI conforms to the Tandem editing template standarddescribed with the FC command in the TACL Reference Manual.



FC Command

FILEINFO Command

The FILEINFO command displays information about files in the specified subvolume.

FILEINFO [ /OUT list-file / ] [ filename-template ]

list-file

is the name of the file that receives the output from the FILEINFO command. If you omitthis parameter, output is sent to the current OUT file that is in effect for the current CUI.

filename-template

is file name specification template. A template must be formatted as follows:

[[[ \system. ] $volume. ] subvolume. ] filename

The following template characters can appear in any element of a filename-template,including the system and volume fields:

* Matches zero or more characters.

? Matches any single character.

Considerations

q If the system, volume, or subvolume parameters are not specified then the current volume is used to supply any missing parameters.

q There is no guaranteed presentation order of systems and volumes when templatecharacters are present in the respective parameters. Subvolumes and file names arealways presented in alphabetic sequence.

q If no files match the specified template, the CUI will report an error with the followingmessage:

No files matched template.



FILEINFO Command

$DATA.RMS

Code EOF Last Modification Owner RWEP PExt SExtFILE1 100 407106 20-Jun-90 10:44:31 15,253 “GGGG” 14 16FILE2 101 97366 20-Jun-90 10:02:50 15,253 “GGGG” 4 16FILE3 100 317708 22-Jun-90 19:05:30 15,253 “GGGG” 10 12FILE4 100 270908 22-Jun-90 16:55:02 15,253 “GGGG” 30 16FILE5 101 35954 22-Jun-90 08:44:10 15,253 “GGGG” 26 2FILE6 100 213062 19-Jun-90 16:45:26 15,253 “GGGG” 10 2

Examples

The following is an example of the output generated by the FILEINFO command:

where:

$DATA.RMS

is the subvolume name.

FILE1..FILE6

are the names of the files in $DATA.RMS.



FILEINFO Command

FILENAMES Command

The FILENAMES command displays the files in the specified subvolume.

FILENAMES [ /OUT list-file / ] [filename-template]

list-file

is the name of the file that receives the output from the FILENAMES command. If youomit this parameter, output is sent to the current OUT file that is in effect for the currentCUI.

filename-template

is a filename specification template. A template must be formatted as follows:

[[ \system. ] $volume. ] subvolume. ] filename

The following template characters can appear in any element of a filename-template,including the system and volume fields:



Considerations


q There is no guaranteed presentation order of systems and volumes when templatecharacters are present in the respective parameters. Subvolumes and file names arealways presented in alphabetical sequence.



FILENAMES Command

Examples

The following is an example of the output generated by the FILENAMES command:

CUI) FILENAMES $DATA.RMS.FILE*

$DATA.RMS

FILE1 FILE2 FILE3 FILE4 FILE5 FILE6

where

$DATA.RMS


FILE1 .. FILE6




FILENAMES Command

FILES Command

The FILES command displays the files in the specified subvolume.

FILES [ /OUT list-file / ] [ subvolume-template ]

list-file

is the name of the file that receives the output from the FILES command. If you omit thisparameter, output is sent to the current OUT file that is in effect for the current CUI.

subvolume-template

is subvolume specification template. A template must be formatted as follows:

[[ \system. ] $volume. ] subvolume

The following template characters can appear in any element of a subvolume-template,including the system and volume fields:



Considerations


q There is no guaranteed presentation order of systems and volumes when templatecharacters are present in the respective parameters. Subvolumes and file names arealways presented in alphabetic sequence.



FILES Command

Examples

The following is an example of the output generated by the FILES command:

$DATA.RMS

FILE1 FILE2 FILE3 FILE4 FILE5 FILE6

where:

$DATA.RMS


FILE1..FILE6




FILES Command

HELP Command

The HELP command displays the syntax of any command interpreter, CUI command orsyntactic entity, or obtains an explanation of command interpreter error numbers.

The HELP command is an optional part of the CUI and is implemented by the appropriatecommand interpreter. Not all applications provide the same level of on-line help.

HELP [ / OUT list-file / ] [help-topic][ , { CONSIDER } ][ , { DETAIL } ][ , { EXAMPLE } ][ , { PREAMBLE } ][ , { SECCOND } ][ , { SEE } ][ , { SYNTAX } ]

list-file

specifies the file to receive the HELP command listing. If you omit this option the outputfrom the HELP command is sent to the current OUT file in effect for the current CUI.

CONSIDER

gets the considerations section of the help topic for the specified command.

DETAIL

gets all sections of the help topic and expands any syntactic elements found for thespecified command.

EXAMPLE

gets any example sections in the help topic.

PREAMBLE

gets the description of the help for the specified command.

SECCOND

gets any security considerations for the help topic.

SEE

gets any SEE ALSO references in the help topic.



HELP Command

SYNTAX

gets the syntax section of the help topic.

Considerations

q If list-file is not provided then HELP runs interactively if there are subjects associatedwith help-topic.

q When HELP is entered with no following parameters, it displays a list of all applicationcommands and subjects for which help is available.



HELP Command

HISTORY Command

The HISTORY command displays previously-entered commands from the history buffer.

HISTORY [ / OUT file-name / ] [ number ]

file-name

is the name of the file that will receive the output generated by the HISTORY command.If / OUT file-name / is not provided then the output is sent to the current out file of theCUI.

number

is the number of commands to display from the history buffer. If number is not providedthen 10 commands are displayed.

Considerations

The history buffer can contain a maximum of 2048 bytes of command text.

History Command Report Format

CUI 10) HISTORY CUI command num)commandCUI command num)command. . .. . .. . .

command num

is the command number shown by the CUI when it prompts the user.

command

is the command text that was entered at the prompt.



HISTORY Command

IF Command

The IF command controls conditional execution of commands within an OBEY input file.

IF argument[ commands ]

[ ELSEcommands ]

ENDIF

argument

is one of the supported argument selections that evaluated to a TRUE expression:

T65xx

evaluates to TRUE if and only if the device on which the application is running is aTandem 6510, 6520 ... type of terminal.

T327x

evaluates to TRUE if and only if the device on which the application is running is anIBM 327x terminal.

TTY

evaluates to TRUE if and only if the device is neither a T65xx or T327x terminal.

commands

is any supported application or CUI command.

Considerations

It is possible to specify nested IF statements as long as there is a corresponding ENDIFstatement for the respective IF command.



IF Command

Example

IF T65xxECHO “This application is running on a Tandem terminal!”

ELSEIF T327x

ECHO “This application is running on an IBMterminal!”

ELSEECHO “This application is running on a conversational terminal!”

ENDIFENDIF



IF Command

LOG Command

The LOG command provides a mechanism to capture the commands and responses providedby the CUI command interpreter.

LOG [ file-name [ ! ] ]

file-name

is the name of the log file for commands and responses.

Considerations

q If no file name is provided and a log file is in use, the log file is closed and logging isdisabled.

q If a file name is provided then any current log file is closed and the new file name isopened. If an exclamation is also provided then the contents of the new log file arepurged when the file is opened, otherwise the new log output will be appended to anycurrent contents of the file.

q If the file name provided does not exist then an Edit file is created with extent size of 2pages.



LOG Command

OBEY Command

The OBEY command executes a series of commands from a disk file.

OBEY [ ! ] file-name [ ( section-name ) ]

file-name

is the name of a disk file containing application commands.

section-name

is the optional section within file-name which is to be used. If no section is specified, allsections of file-name are used.

Considerations

q OBEY commands may not be nested within an OBEY file.

q If the initial IN file or the initial OUT file is a terminal, then BREAK is monitored. IfBREAK is encountered, the processing of the OBEY file is terminated.

q If the ! is used, commands read from file-name are not echoed to the OUT file.



OBEY Command

OUT Command

The OUT command provides a mechanism to redirect the output generated by one or moreapplication commands.

OUT [ file-name [ ! ] ]

file-name

is the name of the file where the output of the CUI command interpreter is sent.

Considerations

q If the OUT command is entered with no parameters and an alternate OUT file is in usethen the alternate OUT file is closed and any further output is appended to the initialOUT file. If a file name is provided then a new alternate OUT file is opened. If anexclamation is also provided the current contents of the file are purged; otherwise thecurrent contents are left and any new output will be appended to the file.

q If the file name does not exist then an Edit-format file is created with extent size of 2pages.

Examples

OUT file-name produces the following message in file-name:

Out file file-name opened

OUT with no file name produces the following message in the initial OUT file, if an alternateOUT file was in use:

Out file file-name closed



OUT Command

RUN Command

The RUN command starts another program from within a CUI.

RUN program-file [ / run-option [ , run-option ] / ] [ startup ]

program-file

is the name of the disk file containing the object program to be run. Partial names areexpanded using the current volume of the CUI. If the name does not contain a period thenthe program file is expanded first using $SYSTEM.SYSTEM as the default volume, thenusing the current volume of the CUI.

run-option is any of the following:

CPU cpu-number

is the number of the processor where the new process is to execute. Specifycpu-number as in integer in the range from 0 - 15 inclusive. If you omit this option theprocess executes in the same CPU as the CUI.

IN file-name

is the new process’s input file. This file name is sent to the new process in its startupmessage. If you do not include this parameter then the home terminal of the CUI isused.

OUT file-name

is the new process’s output file. This file name is sent to the new process in its startupmessage. If you do not include this parameter then the home terminal of the CUI isused.

PRI priority

is the new process’s execution priority. Processes with higher numbers are executedfirst. Specify priority as an integer in the range 1 through 199, inclusive. If you omitthe PRI option then the new process runs at the same priority as the CUI.

NAME [ process-name ]

is the name of the process that the CUI will create. This process name is a standardTandem process name. If no name is provided, a name is assigned by the GUARDIAN 90 Operating System.



RUN Command

startup

is a program parameter or a string of parameters sent to the new process in the startupmessage. Leading blanks and trailing spaces are deleted.

Considerations

q A CUI may become hung if the process that is started does not process the startupsequence properly.

q The param-string can contain semi-colons (;). These are correctly passed to the programbeing executed. Be aware that the RUN command is considered to be the last commandin a line.

Examples

The command:

CUI 4) RUN FUP;ENV

will cause FUP to receive “;ENV” in its startup message. The CUI will not execute the ENVcommand following the termination of the FUP process.



RUN Command

SETPROMPT Command

The SETPROMPT command changes the prompt string shown by a command-level interface.

SETPROMPT “new-prompt-string”

new-prompt-string

is the actual text of the string to be used as a prompt. This string can containmeta-characters which expand to program-specific values. See the considerations sectionbelow for details.

Considerations

q The new prompt string should be short and concise. Excessive amounts of information inthe prompt string can be confusing. The initial application CUI prompt string is usuallyof the form “!) ”. This will result in the command number being printed at each prompt.

q The meta-characters described can appear in a prompt string. These characters areexpanded to the indicated values:

! Expands to the current command number.

$D Expands to the current date (DDMONYYYY).

$T Expands to the current time (HH:MM:SS).

$V Expands to the current disk volume. This string will be innetwork form if the current volume is not of the local node($VOLUME or \NODE.$VOLUME).

$S Expands to the current subvolume (SUBVOL).

$N Expands to the current node name.

$U Expands to the current user name (PROCESSACCESSID)

$1-$9 Expands to the application supplied parameters. Theseparameters will be documented in the relevant applicationreference manual.



SETPROMPT Command

The following special expansion characters can be placed in a setprompt string:

\\! Expands to an exclamation mark, “!”.

\\$ Expands to a dollar sign, “$”.

\\\\ Expands to a backslash, “\”.

\\e Expands to an escape character, % 033.

\\b Expands to a bell, % 007.

\\r Expands to a carriage return, % 015.

\" Expands to a double quote.

Note! Remember that if you wish a space to appear at the end of the prompt string, just before the user input, you must have a space asthe last character of the new prompt.

\\e will yield one character on output.

q If the $T parameter is used, the value of the time field in the prompt string displayed inthe HISTORY command has no meaning.

q Prompt strings are restricted to 77 bytes on output



SETPROMPT Command

Examples

The following is a sample session from Emperex’s RMS for managing application software:

RMS 1) setprompt “!>”2>group \APPL\PROJ\EDI3>setprompt “$2:$3 !) ”$RMP:\APPL\PROJ\EDI 4) group SERVER1$RMP:\APPL\PROJ..\SERVER1 5) group MODULE1$RMP:\APPL\PROJ..\MODULE1 6) setprompt “$4 !) ” \APPL\PROJ\EDI\SERVER1\MODULE1 7) setprompt “$D RMS !) ”21MAY1990 RMS 8) setprompt “$V.$S !) ”$SYSTEM.NOSUBVOL 9) setprompt “RMS !) ”RMS 10)

Note! It is possible on 65xx terminals to place the prompt on line 25. The following setprompt string illustrates this:

RMS 10) setprompt “!\\eo\\e6\\$$N.RMSCOM $2 ($u) \\e6 & $4\\r)”

The 25th line will contain some string that looks like:

\DDS.RMSCOM $RMP (SYS.MGR) \APPL\PROJ\SERVER1\MODULE



SETPROMPT Command

SYSTEM Command

The SYSTEM command temporarily changes your current system setting from the startupsystem of the command interpreter. The current system is used for file name expansion within the CUI.

SYSTEM [ system-name ]

system-name

is the name of the EXPAND node to use for file name expansion; the current volume andsubvolume names remain unchanged.

Considerations

If no parameter is provided, the local system is established as the current system. You canrestore the default system, volume, and subvolume using the VOLUME command.



SYSTEM Command

TIME Command

The TIME command displays the current date and time to the CUI OUT file.

TIME

Considerations

The date and time are displayed in Local Civil Time format based on the time-zone of thesystem where the CUI is running.



TIME Command

VOLUME Command

The VOLUME command temporarily changes your current volume setting from the startupvolume of the command interpreter. The current volume is used for file name expansionwithin the CUI.

VOLUME [ system-name ][ [ system-name . ] volume-name ][ [ system-name . ] subvol-name ][ [ system-name . ] volume-name.subvol-name ]

system-name

is the name of the EXPAND node to use for file name expansion; the current volume andsubvolume names remain unchanged.

volume-name

is the name of the disk volume to use for file name expansion; the current subvolumename remains unchanged.

subvol-name

is the name of the disk subvolume to use for file name expansion; the current volumename remains unchanged unless volume-name was also provided.

Considerations

If no parameter is provided, the startup volume is established as the current volume.



VOLUME Command

Notes:



VOLUME Command



VOLUME Command

33 Interacting with the CUI

This section describes the various general considerations for using the CUI. The followingtopics are covered in this section:

q Entering Commands

q Using Input Files

q Continuing Commands

q Issuing Multiple Commands on a Line

Entering Commands

Users interact with this CUI through a command-line-oriented interface. There are five basicmethods of specifying commands to the CUI.

Interactive Commands

The principal method of interacting with the CUI is through the interactive commandinterface. The CUI application will display a banner, its copyright notice, the banner of theapplications’ monitor process, and finally a user-prompt. The following is a sample of a CUIsession startup:

CUICOM Sample CUI Command Interpreter D6000C30 (01NOV95)COPYRIGHT EMPEREX CORPORATION INC. 1991 - 2003CUIMON - D6000C20 - (01NOV95)CUI 1)

The CUI 1) is the user prompt. Users can enter commands at this point. The number in theprompt generally refers to the command number as it appears in the command history bufferdescribed earlier.

When operating in this fashion, the CUI is considered interactive.

Input File Commands

The CUI is also capable of processing commands through an input file. This file is generallyspecified at the TACL or COMINT command line as follows:

TACL) RUN CUICOM/IN cmdfile/

There are restrictions placed on the commands available when the CUI is run in this fashion.History commands such as FC and ! are not allowed.


Interacting with the CUI

Entering Commands

Command Line Commands

An optional part of the CUI standard is the support for the placement of commands in TACLor COMINT command lines. For example:

TACL) RUN CUICOM ENV;SHOW

This command form allows you to specify CUI commands without using a command file andwithout invoking a user interface. The CUI standard implicitly issues the equivalent of anEXIT command after all specified commands.

TACL Variable Input

The CUI supports the input of commands from TACL variables. For example:

TACL) #PUSH CmdTACL) #APPEND Cmd ENVTACL) RUN CUICOM/INV Cmd/

The semantics of processing commands through TACL variables is the same as for normal,non-interactive input files.

TACL In-line Commands

The CUI also supports the TACL in-line command facility. For example:

TACL) #PUSH #INLINEPREFIXTACL) #SET #INLINEPREFIX @TACL) RUN CUICOM/INLINE/TACL) @ ENVTACL) INLEOF

The semantics of processing input through in-line commands is the same as for normal,non-interactive input files.



Entering Commands

Using Input Files

The CUI is capable of processing commands through a variety of different file types. Thefollowing input files are known to be supported:

q EDIT-format files (code 101)

q ENSCRIBE files (e.g., Relative, Entry-Sequenced)

q Terminals (e.g., Tandem 65xx, IBM 327x)

q Processes (including TACL requestors and variables)

If a terminal or process is used as an input file to the CUI and the same file is specified as theoutput file, the CUI is considered interactive, unless there are commands on thecommand-line.

Continuing Commands

The CUI supports command continuation. There are situations which invariably arise wherecommands will not fit within the record size of the input file or device. CUI provides thecapability of extending commands to a maximum of 1024 bytes.

To extend a command across multiple lines, place an ampersand (&) as the last character of aline. The CUI will automatically re-prompt its input file for additional command arguments.For example:

CUI 1) ENV &CUI 1)& PMSG ON

is equivalent to ENV PMSG ON. Note that the CUI appends an & to the user prompt whencommand continuation is used.

The CUI may not be able to process the FC command, however, if continued commands aretoo long. The supported length of the FC command varies between CUI versions.

Issuing Multiple Commands on a Line

The CUI supports the specification of multiple commands on a line. This support extends toall types of command specifications including input files. The semi-colon (;) is the separatorbetween commands on a single line. For example:

CUI) ENV; SHOW;HISTORY

You do not need spaces before or after the ;. These are optional.



Using Input Files

Notes:



Using Input Files

Index

C

CommandEXIT

2-1Command History Buffer 2-2

E

ECHO 2-32ENV 3-2 - 3-3Environment Commands

! 2-3?

2-4ALIAS

2-5ALLOW

2-7COMMENT

2-8DELAY

2-9ECHO

2-10ENV

2-11ENV PMSG

2-17ENV STATS

2-18EXIT

2-19FC

2-20FILEINFO

2-22FILENAMES

2-24FILES

2-26HELP

2-28HISTORY

2-30, 3-3IF

2-31LOG

2-33OBEY

2-34OUT

2-35RUN

2-36SETPROMPT

2-38SYSTEM

2-41TIME

2-42VOLUME

2-43EXIT 3-2

F

FC 2-2, 3-1, 3-3FC Editing Template 2-21FILEINFO 2-5

G

GUARDIAN vi

H

Help 1-1, 2-11HISTORY 2-3, 3-1

Report Format 2-30History Buffer 2-4

L

log 1-1, 2-11

O

OBEY 2-3 - 2-4, 2-20, 2-34OUT 2-11

R

Run 3-1 - 3-2

080000 Emperex Corporation I-1

Index

Notes:

080000 Emperex Corporation I-2

Index

common user interface - cui user guide - emperex · common user interface (cui) user’s guide...

Documents