Unless stated otherwise, the following commandline options are accepted by all tools:
Print version information and exit.
Print this help and exit.
Print help for THING and exit. This option can be specified multiple times.
Note
This option is only available in the Common Lisp implementation.
Stream to which information messages should be sent. Allowed values for STREAM-NAME: stdout, standard-output, stderr, error-output, none. Default info stream is: error-output
Note
This option is only available in the Common Lisp implementation.
Controls the amount of generated log output. Allowed values for LEVEL: off, trace, info, warn and error. Default log level is warn.
Note
This option is only available in the Common Lisp implementation.
Trace specified things. This option can be supplied multiple times to trace multiple things. Each occurrence takes an individual SPEC which has to have one of the following forms:
"PACKAGE"
Trace all functions in the package named PACKAGE.
Note
The double quotes and uppercase.
FUNCTION-NAME
Trace the function named FUNCTION-NAME.
Note
No quotes, actual case of the function name.
Note
This option is only available in the Common Lisp implementation.
Enable debugging. This does the following things:
Note
This option is only available in the Common Lisp implementation.
Start a slime listener. Swank will print the port it listens on. In addition, a file named ./swank-port.txt containing the port number is written.
Note
This option is only available in the Common Lisp implementation.
Evaluate SEXP as Lisp code. This option can be supplied multiple times. Code fragments are evaluated in the order in which they appear on the commandline.
Note
This option is only available in the Common Lisp implementation.
Load FILE. This option can be supplied multiple times. Files are loaded in the order in which they appear on the commandline.
Note
This option is only available in the Common Lisp implementation.
DIRECTORIES is a list of paths from which data definitions should be loaded. This option can be supplied multiple times.
Note
This option is only available in the Common Lisp implementation.
Load data definition from FILE-OR-GLOB-EXPRESSION. If a glob expression is specified, in addition to the canonical globbing syntax, expressions of the form:
SOMESTUFF/**/MORESTUFF
can be used to search directories recursively. If the file designated by FILE-OR-GLOB-EXPRESSION depend on additional data definition files (i.e. contain import statements), the list of directories supplied via the --idl-path option is consulted to find these files. This option can be supplied multiple times.
Note
This option is only available in the Common Lisp implementation.
Plugins
- RSB_PLUGINS_CPP_PATH¶
A list of :-separated directory names which should be searched to locate RSB plugins.
Default value: INSTALL-PREFIX/lib/rsbVERSION/plugins.
- RSB_PLUGINS_CPP_LOAD¶
A list of :-separated plugin names which should be loaded during RSB initialization.
Example: RSB_PLUGINS_CPP_LOAD=rsbspread
TODO other languages
In-process Transport
See also
- Inprocess Transport
- Details about the inprocess transport
Spread Transport
See also
- Spread Transport
- Details about the Spread transport
- RSB_TRANSPORT_SPREAD_HOST¶
Name or IP-address of the machine running the Spread daemon.
Allowed values: a hostname or IP-address.
- RSB_TRANSPORT_SPREAD_PORT¶
Port on which the Spread daemon listens.
Allowed values: a port number, i.e. an integer in the range [1, 65535].
TCP-socket-based Transport
See also
- TCP-Socket Transport
- Details about the socket transport
- RSB_TRANSPORT_SOCKET_ENABLED¶
1: Enable TCP-socket-based transport in this process.
0: Disable TCP-socket-based transport in this process.
- RSB_TRANSPORT_SOCKET_HOST¶
Name or IP-address of the machine running the RSB TCP-socket-based server component.
Allowed values: a hostname or IP-address.
- RSB_TRANSPORT_SOCKET_PORT¶
Port on which the RSB TCP-socket-based server component listens.
Allowed values: a port number, i.e. an integer in the range [1, 65535].
- RSB_TRANSPORT_SOCKET_SERVER¶
1: This process should act as the RSB TCP-socket-based server component.
0: This process should connect to the TCP-socket-based server.
auto: This process should try to determine whether there already is a TCP-socket-based server for the configured host-port combination and act as a server or client accordingly.
Warning
Generally, the “auto” option only works and makes sense for setups confined to a single computer.
For details of the underlying mechanism, see Addresses and Ports.
- RSB_TRANSPORT_SOCKET_TCPNODELAY¶
1: The TCP_NODELAY flag should be used to trade reduced latency for (potentially) decreased throughput.
0: The TCP_NODELAY flag should not be used.
TCP YARP Transport
See also
- TCP+YARP Transport (without Nameservice operations)
- Details about the YARP transport without nameservice operations
Note
This transport is currently available in the C++ and Common Lisp implementations of RSB.
Note
The URL schema for this transport is tcp+yarp which is mapped to TCP_YARP (note the underscore) in environment variable names.
- RSB_TRANSPORT_TCP_YARP_ENABLED¶
1: enable low-level TCP YARP transport in this process.
0: disable the transport in this process.
YARP Transport with Nameservice Lookup
See also
- YARP Transport (with Nameservice operations)
- Details about the YARP transport with nameservice operations
Note
This transport is currently only available in the Common Lisp implementations of RSB.
- RSB_TRANSPORT_YARP_ENABLED¶
1: enable YARP transport with nameservice lookup in this process.
0: disable the transport in this process.
TCP ROS Transport
See also
- TCP+ROS Transport (without Master Lookup)
- Details about the ROS transport without nameservice (aka master) operations
Note
This transport is currently available in the Common Lisp implementation of RSB.
Note
The URL schema for this transport is tcp+ros which is mapped to TCP_ROS (note the underscore) in environment variable names.
- RSB_TRANSPORT_TCP_ROS_ENABLED¶
1: enable low-level TCP ROS transport in this process; 0: disable the transport in this process.
ROS Transport with Nameservice Lookup
See also
- ROS Transport (with Master Lookup)
- Details about the ROS transport with nameservice (aka master) operations
Note
This transport is currently only available in the Common Lisp implementations of RSB.
- RSB_TRANSPORT_ROS_ENABLED¶
1: enable ROS transport with nameservice lookup in this process; 0: disable the transport in this process.