1.5 Conventions

This manual uses special conventions for type and path name variables, as shown in Table 2.

Table 2 -- Typographic conventions

Convention	Purpose	Example
`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 handle-body idiom
bold	Emphasis. Commands from an interface. Rogue Wave product names.	do this before that the OK button a Threads.h++file
bold italic	Class names.	*RWRunnable*

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.

rw_root\workspaces\OS+ver\COMPILER+ver\buildtype\buildloc\thrver+osfam

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

c:\rwav\workspaces\WINNT4\MSVC60\7s\buildloc\thr0200w

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

This table also uses Threads.h++ 2.0 as an example.

Table 3 -- Path name variables

Convention	Purpose	Example
`rw_root`	The name you gave your Rogue Wave root directory.	`c:\rwav`
`ver`	The version number of your product, operating system, or compiler.	thr`0200` `WINNT4` `MSVC60`
`osfam`	A mnemonic representing your operating system family: `w` for Windows, `u` for Unix, and `o` for OS/2.	thr`0200w`
`OS`	A mnemonic representing your operating system. Appendix A lists all operating system mnemonics.	`WIN95` `SOLARIS`
`COMPILER`	A mnemonic representing your compiler. Appendix A lists all compiler mnemonics.	`MSVC` `SGICC64`
`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.5 provides more information.	`.lib`
`\`	A delimiter in a path name. Unix users, replace "\" with "/".	`parts\htmldocs`