Previous
Next


Document Conventions  Locate

This section describes the typographic conventions used in this document.

Command syntax. A summary of arguments for commands started from a text prompt.
command nameScript name or other executable command plus mandatory arguments, such as java -jar.
[--option]An option
either | orA choice of arguments
,...Indicates that the preceding argument is repeatable
REPLACE_VALUE, replace_valueAn argument that should be replaced with an actual value
{argument1 | argument2}A choice between two arguments where one or the other is mandatory
For example, the syntax for running 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. Items in italics should be replaced by actual values.

Commands may be contained within text, as in this example:

The command java -jar wso2-soa-enablement-server-java.jar.jar does not work on some encodings. If you have any problems starting the installer, try running java -classpath wso2-soa-enablement-server-java.jar.jar Install --installation_option instead.

The command line may be separated, in which case it has a screen background:

java -jar wso2-soa-enablement-server-java.jar.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 tagsXML 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);
}
ClassNameAn inline Java or C++ class name
methodNameAn inline Java method name
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 WSO2 SOA Enablement 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



Previous
Next