Rogue Wave banner
Previous fileTop of DocumentContentsNext file

1.5 Conventions

This manual uses special conventions for type and path name variables.

Table 2 -- Typographic conventions

ConventionPurposeExample 
Courier
Directory names, file names, examples, operating system commands, function names, and code.
the c:\rwav directory
<x>
A variable in a file name or directory path. Table 3 lists possible variables.
<ver> = the version number of your product
italic
Emphasis.
New terms.
operating system family
the opaque mechanism
bold
Emphasis.
Commands from an interface.
Rogue Wave product names.
do this before that
the OK button
a Tools.h++ file
bold italic
Class names.
RWCollectable

In addition to the typographic conventions, this manual uses path name variables to indicate information in a file name or path name that varies depending on your product, compiler, platform, and other issues. Table 3 lists these path name variables.

The following example shows how these variables can be used.

Using Tools.h++ 7.1.0 as an example, the variable-filled path above could become the specific path below.

This specific path indicates a c:\rwav root directory, the Tools.h++ 7.1.0 library, Windows NT, the Microsoft Visual C++ compiler, and the 7s library build type.

Table 3 -- Path name variables

ConventionPurposeExample 
<rw_root>
The name you gave your Rogue Wave root directory.
c:\rwav
<ver>
The version number of your product, operating system, or compiler.
tls0710
WINNT4
MSVC60

<osfam>
A mnemonic representing your operating system family: w for Windows, u for Unix, including Linux.
tls0710w
<OS>
A mnemonic representing your operating system. Appendix B lists all operating system mnemonics.
WIN95
SOLARIS

<COMPILER>
A mnemonic representing your compiler. Appendix B lists all compiler mnemonics.
MSVC
<buildtype>
A build type, consisting of a build number, binding type, and optional user-defined library suffix. Section 2.5 provides more information.
7s
7d_test
<ext>
An extension. Section 2.4 provides more information.
.lib

\
A delimiter in a path name. Unix users, replace "\" with "/".
parts\htmldocs


Previous fileTop of DocumentContentsNext file

©Copyright 1999, Rogue Wave Software, Inc.
Contact Rogue Wave about documentation or support issues.