|
|
|
This section describes the format and conventions used to document commands, utilities, and user exits in this guide. Each convention provides examples, describing how to use commands, how to use options, or how the system responds to user entries.
Note: The examples and instructions throughout this document use VMANAGER as the user ID for system administrator and maintenance functions, and VMSECURE as the service virtual machine user ID. If you use CA VM:Director, use VMDIRECT as the service virtual machine user ID. If you use a different user ID for the system administrator or the service virtual machine, replace those names in any instructions in which the default ones appear throughout this guide.
When a command contains uppercase and lowercase letters, then the uppercase letters denote the shortest acceptable abbreviation that you can use to type the command. However, when a code item appears entirely in uppercase letters, you cannot abbreviate the item.
You can type the code item in uppercase letters, lowercase letters, or any combination.
Example:
CMDNAme
In this example, you can enter CMDNA, CMDNAM, or CMDNAME in any combination of uppercase and lowercase letters.
The code syntax or code fragment definitions can continue from one line to the next line. The following examples describe code continuation:
Example:1
A | B C | D
This code is equivalent to the following code:
A | B C | D
Example:2
{choice1 | choice2 | choice99}
This code is equivalent to the following code:
{ choice1
| choice2
| choice99 }
An underlined code item denotes the default value. The system uses the default value unless you override it. You can override the default value by coding an option from the available list.
Example:
[parm1 | parm2 | parm3]
In this example, the code item parm1 is the default value, and this is used by the system when you do not specify any of the options. However, you can code parm1, parm2, or parm3.
A keyword name or constant always appears in uppercase letters. It must be coded exactly as shown in the code.
Example:
STOP {tracenumber | * | [USER] userid}
This example displays a keyword USER.
Defines optional code items—denoted by square brackets around a code item.
Example:
CMDName [parm1]
In this example, you can choose parm1 or no parameter at all. However, when two or more items are enclosed in square brackets and separated by vertical bar characters, all of them are optional.
Example:
In this example, you can choose parm1, parm2, parm3, or nothing at all.
[parm1 | parm2 | parm3]
Commands with positional parameters are identified by nested square brackets. Each positional parameter requires the specification of all previous positional parameters. The following example describes the positional parameter:
Example:
CMDName [posparm1 [posparm2 [posparm3]]]
In this example, posparm3 can be specified only when posparm1 and posparm2 are also specified.
A list of code items enclosed in square brackets and followed by an ellipsis means that you can select more than one item or, in some cases, repeat a single item.
Example:
[value1 | value2 | value3] ...
In this example, you can choose a single value, more than one value, or none of the values.
An ellipsis following a code item means that the code item can be repeated.
Example:
Repeat…
You must select one item from a list of items when they are enclosed in curly braces. The items are separated by a vertical bar character.
Example:
CMDNAme {A | B | C}
In this example, your choice results in CMDNAME A, CMDNAME B, or CMDNAME C.
The following list describes the meaning of the special symbols used in codes:
The following list displays symbols. These symbols must be coded exactly as they appear in the code syntax.
Some codes use fragments, when the code syntax is too lengthy. The fragment name appears between double quotes in the code syntax.
The expanded fragment appears in the syntax after all other parameters or at the bottom of the code syntax. A heading with the fragment name identifies the expanded fragment.
Example:
CMDName "Parms"
Parms:
[A | B | C]
In this example, the fragment is named "Parms", and the expanded fragment appears at the bottom of the code syntax.
Uppercase characters represent system responses or prompts.
Example:
ENTER YOUR LOGON PASSWORD:
This example displays a system response.
User‑entered commands are shown in lowercase letters even though you can enter commands in either upper or lower case.
Example:
vmsecure addentry writers tcom (noformat nowait
This example shows what a user‑entered command looks like.
In this example "writers tcom" is the file name and file type of the directory entry you are adding.
However, if the entry is a record, it appears in uppercase letters.
Example:
ACCESS DRCT 1B0 U
This example shows a configuration record that is entered by a user.
Lowercase items in italics denote variables.
Example:
CMDNAme varname
In this example, varname represents a variable that you must specify when you code the command CMDNAME.
| Copyright © 2011 CA. All rights reserved. | Tell Technical Publications how we can improve this information |