ConventionsAdded by IBM on December 16, 2010 | Version 1 (Original)
|Understand the conventions used in this information center to use the documentation more effectively.
Understand the conventions used in this information center to use the documentation more effectively.
The following section provides conventions that can help you interpret the information that is provided in this information center:
- File names, directories, and commands appear in Courier font. For example:
- File name: install.bat
- Directory: /opt/ibm/lotus/bin/server
- Command: load qptool -?
- Variables are either italicized, enclosed in brackets, or both. For example: http://hostname.example.com:10038/lotus/quickr, where hostname.example.com is the fully qualified host name of the machine where Lotus® Quickr™ is running and 10038 is the default transport port that is created by WebSphere® Application Server.
- Variables are used to indicate root installation directories. See Directory structure for more information.
- Directories are shown with forward slashes (/), unless operating-system specific information is provided. On Windows® systems, you should use backward slashes (\) when typing at a command line, unless otherwise noted.
- Operating-system specific information is provided. For example:
- Linux®: ./install -script /tmp/script.dat
- Windows: setup -s
- Tips on how to use specific topics are marked with a green check. For example:
How to use this planning section
- Links to reference information and external links are marked with one of these icons: or
- Most topics include a Related information section that links to other relevant topics. See the last section for an example.
- When the term Linux is used, this implies all Linux-based operating systems that are supported.
Parent topic: Reference