SDX 6.4.x Integration Guide > About This Guide > Documentation Conventions

Documentation Conventions

The sample screens used throughout this guide are representations of the screens that you will see when you install and configure the SDX software. The actual screens may differ.

For convenience and clarity, the installation and configuration examples show default file paths. If you do not accept the installation defaults, your paths will vary from the examples.

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 a situation that might result in loss of data or hardware damage.


 



 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



Plain sans serif typeface

 Represents information as displayed on your terminal's screen.

struct DirectoryAccessInfo {
    sequence<string> ldapHost;
    string baseDN;
};


 Angle brackets

 Indicate variables.

 Another runtime variable is <gfwif>.


 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 distinguished names.
  
 Identify files, directories, and paths in text but not in command examples.



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



 Backslash

 At the end of a line, indicates that the text wraps to the next line.

 Plugin.radiusAcct-1.class=\ net.juniper.smgt.sae.plugin\
RadiusTrackingPluginEvent


 Words separated by the | symbol 

 Represent a choice to select one keyword or variable to the left or right of this symbol. (The keyword or variable may be either optional or required.)

 diagnostic | line