Chapter 3: HSI Commands 3.1 Request Format 3.2 Request Format Rules 3.3 Commands 3.4 Parameters 3.5 Keywords 3.5.1 Keyword Format 3.6 Keysets 3.6.1 Active Keysets 3.6.2 Saved Keysets

COMMAND option(s) parameter ... KEYWORD=value ... <comment>

• COMMAND is a word defining a specific HSI operation or action. It must be the first word of each HSI request.
  Note: The exclamation mark ("!") character is a "shell escape". If COMMAND starts with this character, the remainder of the physical command line (including all continuation lines) is executed as a local command, outside HSI ( i.e. you can execute a local command as if you were in a local shell ).
• The COMMAND is a literal name that must be entered exactly as shown
  Note: some commands have abbreviated or shortened forms that are synonyms for the full command names.
• Literal names, such as "COMMAND" or "KEYWORD", are shown in this document in uppercase characters.
  Note: These literal names are merely placeholders for actual commands and keywords, which must be entered in lower case.
• Option(s) are used to qualify the command or specify particular processing, and begin with a minus sign prefix (-). Options are described in the sections discussing the specific commands to which they apply.
• Parameter is the object of the command. Parameters are symbolic values that you assign; they are not predefined by HSI. Examples include file names and paths.
• Multiple parameters can be specified for most commands.
• KEYWORD=value is a literal name and associated value that is used to specify a qualifier of the command. The keyword format is described under the topic Keywords later in this chapter.
  Note: Case is significant in actual values given to keywords, just as it is in most places in computer usage. For example, the path "./foodir/foofile" specifies a different directory and file from the path "./FooDir/FooFile".
• The values associated with keywords are literal or symbolic depending on the keyword.
• Each command has certain keywords that are associated with it.
• Unless otherwise noted, use of a keyword is optional.
• If an associated keyword is not specified in a request, the value of the keyword in the active keyset is used. (Active keysets are explained later in this chapter.)
• The <comment> field can contain any text information you use to document a command line and is most useful with command or script files containing HSI requests. Comments begin with the less than (<) symbol and end with the greater than (>) symbol or with the end of the line. HSI does not process comments or echo them back to you. Only one comment can be entered in a request, and it cannot be embedded in a parameter, keyword, or keyword value.

Detailed descriptions of all commands, parameters, and keywords are presented alphabetically in Chapter 8: HSI Commands, Keywords, and Parameters

[ PAGE TOP ]

• Parameters, options, keywords, and a comment can be in any order following a command.
• At least one space must separate the command word, parameters, keywords, and comment.
• If a keyword or option is repeated within a request, only the final value provided will be used.
• A request can contain only one command word, but most can contain multiple parameters. One request and response will be generated per parameter.
• If a request has multiple parameters (for example, get A B C) and there is an error when executing the request for one of the parameters, HSI will attempt to execute the request for the remaining parameters.
• A request will not be executed if there is a syntax error in a parameter or keyword.
• Multiple requests can be entered on the same line if they are separated by semicolons. Spaces can be placed on either side of the semicolon(s).
• If there is an error in one request of a multiple-request line, any requests following it will not be executed.
• Input to HSI should be in lowercase, except for pathnames, which may be mixed case.
• The basic set of characters for request parameters (node names, roots, and keysets) is the alphanumerics (all letters and the digits 0 through 9), plus the following 7 characters:
$ % + - . _ #

The exclamation (!) character has special meaning when it is the first non-whitespace character of the command, as described in Request Format above. It causes the remainder of the command line to be issued as a local command.

Some of these characters have special meanings in HSI commands or on worker operating systems and care should be taken in their use. See the table in Commands in this section for the meanings of special characters in HSI requests.

• Normally a <RETURN> signals the end of a request to HPSS. However, your input can exceed the line length of the terminal. You can continue a request on more than one line by using a backslash ("\") at the end of the current line before a <RETURN>. The "\" is not replaced by a space in the request.

Example: continuing a request line

save myfilea myfileb myfilec \<RETURN>
myfiled myfileg <RETURN> (end of request input)

Note that HSI will issue a continue prompt ("[CONTINUE]:" by default) at the beginning of the continued input line. You can then continue your request. If you are not using a system which has type-ahead buffers, you must wait for the prompt before entering any input on a line, even if the line is a continuation. When you have completed the continued line, HSI will execute the entire input and then respond. The following table lists special characters along with a description of their meanings in HSI requests.

Character	Description
;	The semicolon separates HSI requests on the same line.
( )	Parentheses enclose multiple values that are assigned to a single keyword.
-	When used as the value of a keyword (e.g. DIR= -), a minus sign indicates the system default is to be used rather than any user-defined value.
-	When used as a path parameter, a minus sign specifies that the path stored in DIR0 is to be used.
-	When used in commands which support options (e.g., ls), a minus sign is used as a prefix for option strings.
-	Used to designate the beginning and end range of wild card characters when the range is enclosed in square brackets.
<-	When used as a keyset parameter, a minus sign specifies that the default value is to be used as the keyset name.
<   >	Less-than and greater-than symbols delimit a comment contained in a request line.
:	A colon associates a localfile with a HPSS path. For example, save a : b specifies that the localfile "a" is to be saved on HPSS using the name "b." get a : b copies the HPSS file "b" to the local file "a." Note: The path on the left side of the " : " separator is always local to the client, and the path on the right side of that separator is within HPSS. Note: As of HSI version 2.4, the colon character must be surrounded by whitespace; if not, then the colon will be considered to be part of the HPSS pathname. Earlier versions of HSI did not require whitespace, but this led to ambiguities in the way that pathnames containing colon characters were parsed.
'	The prime notation (n') specifies the DIRn working directory to be used where n is a number from 0 to 9.
/	A slash is the first character of a complete path and precedes each node that is part of a path.
?	A question mark is used as a wild card character in paths to replace any single character.
*	An asterisk is used as a wild card character in paths to replace any string of zero or more characters.
^	A caret is used as a wild card character to provide a "not" operation on a wild path.
[ ]	Square brackets are used to select one wildcard character in paths. A list of characters in brackets, [2468], or a range of characters in brackets, [a-f], represents one character in a wild card path.
{ }	Curly braces are used to specify a comma-separated set of wildcard patterns in paths.