This section describes conventions used in this document.
Command syntax | The syntax of operating system commands. We use square brackets ([ ]) to indicate optional parameters, a vertical bar (|) to indicate a choice of parameters, ... to indicate that the parameter is repeatable and {} to indicate that at least one repeatable parameter must be included. For example: Enter this command to start the UserStore tool: UserStoreTool {[-t target_server ] | [--file userstore_file ]...} [option...] |
Command instances | Operating system commands and other user input that you can type on the command line and press Enter to invoke. These may be contained within text, as in this example: The command java -jar systinet-server-java.jar does not work on some encodings. If you have any problems starting the installer, try running java -classpath systinet-server-java.jar Install --installation_option instead. The command line may be separated, in which case it has a screen background: java -jar systinet-server-java.jar --help |
Filename | Filenames, directory names, paths and package names. For example: Run the install.bat or install.sh script from the bin directory of the new distribution. |
XML tags | XML element and attribute names. For example: use ref="customSerialization" |
Code block | Program source code. For example: package examples.helloWorld; public interface HelloWorldProxy { String hello (String message); } |
Key-Key | A combination of keystrokes. Press the indicated keys simultaneously. For example: Press Ctrl-Alt-Del to reboot your computer. |
GUI elements | A label, word or phrase in a GUI window, often clickable. For example: To edit a server's attributes, click on the server's link in the Security Domain Tree or click on Detail in the server's row in the Managed Systinet Servers form. GUI buttons have a special icon, for example: Click on the Save Configs button to save your changes after editing any Domain or Server properties. |
A menu selection | For example: Select Property->Add property |
We use the following formatting elements to draw your attention to certain pieces of information:
![]() | Note |
---|---|
A Note indicates information that emphasizes or supplements points within the main text. Typically, a note provides information that may apply only in specific situations. |
![]() | Tip |
---|---|
A Tip provides a helpful hint concerning procedures described in the text. It may suggest alternative methods or provide useful information about the capabilities of the product. |
![]() | Important |
---|---|
An Important note provides critical information for the completion of a task. Do not disregard an Important note. |
![]() | Caution |
---|---|
A Caution describes a situation where failure to take or avoid a specified action could result in a loss of data. |