Notation

Qedit 5.7 for HP-UX

Home Previous Next


Notation

This manual uses a standard notation to describe commands. Here is a sample definition:

VERIFY[ @ | ALL ]

[ keyword ...]

  1. UPPERCASE - If the commands and keywords are shown in uppercase characters in a syntax statement, they must be entered in the order shown (example: ALL). However, you can enter the characters in either uppercase or lowercase.
  2. Lowercase, highlighted - These are "variables" to be filled in by the user (example: keyword). The variables may be highlighted by underlining or italics. Each such "variable" is defined elsewhere (see the Introduction when you have trouble). In the Help command, highlighting is not available, so these variables appear simply in lowercase.
  3. Brackets - enclose optional fields (example: [ALL]).
  4. Braces - enclose comments which are not part of the command. However, braces and comments are accepted in actual Qedit commands.
    /listq filename {Q means without line numbers}
  5. Up lines - separate alternatives from which you select (example: SET CHECK [ON|OFF]). The choices are sometimes listed on several lines without "up lines".
  6. Dot-dot-dot (...) - indicates that the variable may be repeated many times in the command.
  7. Other special characters - literal symbols that must appear in the command as they appear in the manual (for example, "=" in Add linenum = rangelist).

In examples, there is an implied Return key at the end of each line.

In examples in our documentation, we generally show Qedit commands preceded by the Qedit "/" prompt. However, in Qedit/UX the default prompt is actually "qux/". Note that you can change the prompt string with Set Prompt.

Control characters, generated by holding down Control while striking another key, are either spelled out (e.g., Control-H) or abbreviated with a circumflex prefix (e.g., ^H).

When Qedit asks you a question, the default answer is shown in [brackets]. The default is the answer that Qedit will assume if you press only the Return key.


Home Previous Next