Documentation Conventions

Documentation Conventions

Operating System Names
Directory Paths

The following typographical conventions are used in Tectia documentation:

Table 1.1. Documentation conventions

Convention	Usage	Example
Bold	Tools, menus, GUI elements and commands, command-line tools, strong emphasis	Click Apply or OK.
→	Series of menu selections	Select File → Save
`Monospace`	Command-line and configuration options, file names and directories, etc.	Refer to `readme.txt`
Italics	Reference to other documents or products, URLs, emphasis	See Tectia Client User Manual
`Monospace Italics`	Replaceable text or values	rename `oldfile newfile`
#	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
\	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

	Note
	A Note indicates neutral or positive information that emphasizes or supplements important points of the main text. Supplies information that may apply only in special cases (for example, memory limitations, equipment configurations, or specific versions of a program).

	Caution
	A Caution advises users that failure to take or to avoid a specified action could result in loss of data.