Conventions

From HVR
Jump to: navigation, search

This section explains the document conventions used by HVR.

Computer Words and Examples

  • Words displayed in bold indicate computer 'words' that are fixed, or code examples in running paragraphs, such as 'grant execute permission'.
  • Words displayed in italics indicate computer words that are variable. For example, in a directory path such as $HVR_CONFIG/log/hubdb the word 'hubdb' is in italics indicating that it is variable and should be replaced by the word that is applicable to you.
  • Code examples are also displayed in a courier typeface. For example:
$ hvrsuspend u hubdb system

Menus

Menu selection sequences are displayed in bold and each selection is divided by the '' sign. For example, select Tools ▶ Data ▶ Entity ▶ Organization. This means select the menu option Tools in the menu bar, then select menu option Data in the Tools menu, followed by selecting menu option Entity in the Data submenu and finally click on menu option Organization in the Entity submenu.

Note

Note: Indicates this is a note.

Platform Specific Functionality

Oracle
Indicates functionality only supported on Oracle
Ingres
Indicates functionality only supported on Ingres or Vectorwise
SQL Server
Indicates functionality only supported on SQL Server
DB2
Indicates functionality only supported on DB2
Salesforce
Indicates functionality only supported on Salesforce.com
Unix & Linux
Indicates functionality only supported on Unix and Linux
Windows
Indicates functionality only supported on Microsoft Windows

Available Since

  Since    vX.X.X   Indicates the version of HVR that the item/feature was introduced.

File Pathnames

Many pathnames are shown using Unix conventions, e.g. using a forward slash '/' as file pathname delimiter. For the Microsoft Windows platform this can be understood as a backward slash '\'; generally HVR converts between forward and backward slashes as appropriate, so the two can be used interchangeably.