Documentation Conventions
Table 1.1. Documentation Conventions
| Convention | Usage | Example |
|---|---|---|
| Bold | Menus, commands, GUI elements, strong emphasis | Click Apply or OK. |
| → | Series of menu selections | Select File → Save |
Monospace | Filenames, directories, URLs etc. | Refer to readme.txt |
| Italics | Placeholder values in examples, reference to other documents or products, emphasis | See the Tectia SSH Client User Manual |
# | In front of a command, # indicates that the command is run as a privileged user (root). | # rpm --install package.rpm |
$ | In front of a command, $ indicates that the command is run as a non-privileged user. | $ sshg3 user@host |
OS#, OS$ | In front of a command, OS# or OS$ indicates that the command is specific for certain operating systems. Multiple operating systems are separated with a /. | SUSE# mkdir dirname RedHat/CentOS$ rm file1 |
\ | At the end of a line in a command, \ indicates that the command continues on the next line, but there was not space enough to show it on one line. | $ ssh-keygen-g3 -t rsa \ -F -c mykey |
A Note indicates neutral or positive information that emphasizes or supplements important points of the main text. A Note supplies information that may apply only in special cases (for example, memory limitations, equipment configurations, or specific versions of a program).
A Caution advises users that failure to take or to avoid a specified action could result in loss of data.
Operating System Names
When the information applies to several operating systems versions, the following naming systems are used:
- Unix refers to the following operating systems:
- HP-UX
- IBM AIX
- Red Hat Linux, CentOS, SUSE Linux
- Linux on IBM System z
- Sun Solaris
- IBM z/OS UNIX (Unix System Services); Tectia Server for IBM z/OS is running on z/OS UNIX.
- z/OS is used for IBM z/OS, when the information is directly related to IBM z/OS versions.
- Windows refers to all supported Windows versions.
Directory Paths
The following conventions are used in this document to refer to directory paths:
$HOME
A Unix environment variable, that indicates the path to the user's home directory.
%APPDATA%
A Windows environment variable, that indicates the path to the user-specific Application Data folder. By default expands to:
C:\Documents and Settings\<username>\Application Data on pre-Vista Windows versions
C:\Users\<username>\AppData\Roaming on Windows Vista and later.
%PROGRAMFILES%
A Windows environment variable that indicates the path to the Program Files directory. By default,
this expands to C:\Program Files
%PROGRAMFILES(x86)%
A Windows environment variable that indicates the path to the Program Files directory for 32-bit
applications. By default, this expands to C:\Program Files (x86). This directory only exists on
64-bit versions of Windows.
%SYSTEMROOT%
A Windows environment variable that indicates the path to the system directory.
On Windows XP and later Windows versions, this is usually C:\Windows. On older versions of
Windows, this is usually C:\WINNT
%USERPROFILE%
A Windows environment variable that indicates the path to the user-specific profile directory. By default, this expands to:
C:\Documents and Settings\<username> on pre-Vista Windows versions
C:\Users\<username> on Windows Vista and later.
%u
A variable for matching user names. This variable is used during key relocation to substitute for the user name of each user.
%h
A variable for matching home directories. This variable is used during key relocation to substitute for the home-directory path of each user.