General syntax
> rce --[RCE arguments] -[RCP arguments] -[vmargs -[VM arguments]]
Table 3.1. Command line arguments for RCE
| Argument | Type | Description |
|---|---|---|
| profile "<profile id or path>" | RCE | Sets a custom profile folder to use. If only an id (any valid
directory name) is given, the profile directory "<user
home>/.rce/id" is used.
Alternatively, a full filesystem path can be specified. |
| profile | RCE | If the profile argument is specified without a profile id or path, RCE launches the Profile Selection UI, which allows to select a profile folder for the startup as described in ???. |
| batch "<command string>" | RCE | Behaves like the "exec" command, but also implies the "--headless" option and always shuts down RCE after execution. |
| headless | RCE | Starts RCE in a headless modus without GUI. It will remain in the OSGi console and waits for user input. |
| allow-privileged | RCE | Allows running RCE in a privileged process, i.e. as administrator (on Windows) or root (on Linux). Usually this is forbidden and the prohibition is enforced at application startup. However in certain circumstances it might be required to run RCE with such privileges and for these cases this flag can be used to disable the check at startup. However this is only to be used with absolute caution and in accordance with the system administrator! |
| exec "<command string>" | RCE |
Executes one or more shell commands defined by <command string>. For the list of available commands, refer to the command shell documentation. This argument is usually used together with --headless to run RCE in batch mode. Multiple commands can be chained within <command string> by separating them with " ; " (note the spaces); each command is completed before the next is started. You can use the " As an example, |
| configure | RCE | Starts the RCE Configuration UI (Section 2.2.4, “Configuration UI”) which can be used to configure SSH accounts with passphrases or to configure e-mail support for the RCE instance. |
| data @noDefault | RCP | Set the default workspace location to empty |
| consoleLog | RCP | Logs everything for log files on the console as well. |
| console | RCP | Runs RCE with an additional OSGi console window, which allows you to execute RCE shell commands. See the Command Shell documentation for more information. |
| Deprecated: console <port> | RCP | Specify the port that will be used to listen for telnet connections. (NOTE: this access is insecure; configure SSH access instead) |
| clean | RCP | Cleans before startup |
| vmargs | VM | Standard JVM arguments. This argument needs to be listed before any arguments intended to be passed to the JVM (i.e. arguments prefixed with -D), otherwise they will not be passed correctly. Also note that the JVM will receive these arguments appended to the ones specified in the rce.ini file (the file itself will not be modified). Example: "rce.exe -vmargs -D<some-arg>=<some-value>" |
| Dde.rcenvironment.rce.configuration.dir=<insert-config-path> | VM | Sets the configuration directory |
| Drce.network.overrideNodeId =<some-id> | VM | Sets the local node id, overriding any stored value. This is mostly used for automated testing. Example: "-Drce.network.overrideNodeId=a96db8fa762d59f2d2782f3e5e9662d4" |
| Dcommunication.uploadBlockSize=<block size in bytes> | VM |
Sets the block size to use when uploading data to a remote node. This is useful for very slow connections (less than about 10 kb/s) to avoid timeouts. The default value is 262144 (256 kb). Example: "-Dcommunication.uploadBlockSize=131072" - sets the upload block size to 128kb (half the normal size) |