The typographic conventions used in this documentation are
largely based on those used in the Python documentation.
They are summarized below.
- Filenames are presented in an italic font.
- -b, --option
- Program options are in a bold face. Variable parameters to
an option are presented in italics.
- The labels on buttons or other GUI controls (widgets) are
- Module and interface names are bold.
- Python class names are bold.
- Exception names are in bold type.
- function(arg1 [,
arg2 ] ) -> return type
- Function names are presented in bold and arguments are in
italics. Optional arguments are surrounded by brackets. If
the function returns a value other than None, it will
be specified following an arrow after the parameter list.
- ASYNCHRONOUS method()
- Method names, like function names, are presented in bold.
If a method may be invoked remotely in an asynchronous manner,
the word ASYNCHRONOUS will appear before the method
name in the description in italics.
- Expressions which need to be typed are placed in a