1.6   Documentation Conventions

Typographical Conventions

VxWorks documentation uses the conventions shown in Table 1-1 to differentiate various elements. Parentheses are always included to indicate a subroutine name, as in printf( ).

Table 1-1:  Font Usage for Special Terms  


Term
Example

files, pathnames 
/etc/hosts  
libraries, drivers  
memLib, nfsDrv  
host tools 
more, chkdsk 
subroutines 
semTake( )  
boot commands 
p 
code display 
main (); 
keyboard input 
make CPU=MC68040 ... 
display output 
value = 0 
user-supplied parameters 
name  
constants 
INCLUDE_NFS  
C keywords, cpp directives 
#define  
named key on keyboard 
RETURN  
control characters 
CTRL+C  
lower-case acronyms 
fd  

Cross-References

Cross-references in this guide to a reference entry for a tool or module refer to an entry in the VxWorks Reference Manual (for target libraries or subroutines) or to the reference appendix in the Tornado User's Guide (for host tools). These references are also provided in the Tornado Online Manuals. For more information about how to access online documentation, see the Tornado User's Guide: Documentation Guide.

Other references from one book to another are always at the chapter level, and take the form Book Title: Chapter Name.

Pathnames

The top-level Tornado directory structure includes three major directories (see the Tornado User's Guide: Directories and Files). Although all VxWorks files reside in the target directory, in order to maintain consistency with other Tornado manuals this manual uses pathnames of the following form: installDir/target. For example, if you install Tornado in /group/wind on a UNIX host or in C:\Tornado on a Windows host, the full pathname for the file shown as installDir/target/config/all/configAll.h is /group/wind/target/config/all/configAll.h (which is also $WIND_BASE/target/config/all/configAll.h) on UNIX or C:\Tornado\target\config\all\configAll.h on Windows.


*

NOTE: In this manual, forward slashes are used as pathname delimiters for both UNIX and Windows file names since this is the default for VxWorks.