About This Guide > Documentation Conventions

Documentation Conventions

Table 1 defines notice icons used in this guide. Table 2 defines text conventions used throughout the documentation.

 Table 1:  Notice Icons 

 Icon
 Meaning
 Description

 



 Informational note

 Indicates important features or instructions.


 



 Caution

 Indicates that you may risk losing data or damaging your hardware.


 



 Warning

 Alerts you to the risk of personal injury.



 

 Table 2:  Text Conventions

 Convention
 Description
 Examples

 Bold typeface

 Represents commands, keywords, scripts, options, and tools in text.


  
 Use the pkgadd tool.
  
 Specify the keyword exp-msg.
  
 Run the install.sh script with the -unconfig option.



 Bold sans serif typeface

 Represents text that the user must type.

user input



Fixed-width font

 Represents information as displayed on your terminal's screen.

Usage: allpvs {[start 
[console]]|stop|restart 
[console]|status|help}


 Angle brackets

 Indicate variables.

 All script names are located in the <NMC-RX home>/utils directory.


 Key name 

 Indicates the name of a key on the keyboard.

 Press Enter.


 Key names linked with a plus sign (+).

 Indicates that you must press two or more keys simultaneously.

 Press Ctrl+b.


 Italics


  
 Emphasize words. 
  
 Identify chapter, appendix, and book names. 
  
 Identify files, directories, and paths in text.



  
 There are two levels of access: user and privileged.
  
 Chapter 2, Services.
  
 The /etc/default.properties file.