<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
<section id="command_line">
	<title>Command Line Parameters</title>
	<para>General syntax </para>
	<programlisting>&gt;  rce --[RCE arguments] -[RCP arguments] -[VM arguments]</programlisting>
	<para>
		<table frame="all">
			<title>Command line arguments for RCE</title>
			<tgroup cols="3">
				<colspec colname="Argument" colnum="1" colwidth="2.98*"/>
				<colspec colname="Type" colnum="2" align="left" colwidth="0.8*"/>
				<colspec colname="Description" colnum="3" colwidth="4.88*" align="left"/>
				<thead>
					<row>
						<entry>Argument</entry>
						<entry>Type</entry>
						<entry>Description</entry>
					</row>
				</thead>
				<tbody>
					<row>
						<entry>profile "&lt;profile id or path>"</entry>
						<entry>RCE</entry>
						<entry>Sets a custom profile folder to use. If only an id (any valid
							directory name) is given, the profile directory "&lt;user
								home>/.rce/<replaceable>id</replaceable>" is used.
							Alternatively, a full filesystem path can be specified.</entry>
					</row>
					<row>
						<entry>profile</entry>
						<entry>RCE</entry>
						<entry>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 <xref linkend="profile_selection_ui"/>.</entry>
					</row>
					<row>
						<entry>batch "&lt;command string>"</entry>
						<entry>RCE</entry>
						<entry>Behaves like the "exec" command, but also implies the "--headless" option and always
							shuts down RCE after execution.</entry>
					</row>
					<row>
						<entry>headless</entry>
						<entry>RCE</entry>
						<entry>Starts RCE in a headless modus without GUI. It will remain in the
							OSGi console and waits for user input. </entry>
					</row>
					<row>
						<entry>exec "&lt;command string>"</entry>
						<entry>RCE</entry>
						<entry>
							<para>Executes one or more shell commands defined by &lt;command string>. For the list of
								available commands, refer to the command shell
								documentation<!--TODO add link-->. This argument is usually used
								together with --headless to run RCE in batch mode. Multiple
								commands can be chained within &lt;command string> by separating
								them with " ; " (note the spaces); each command is completed
								before the next is started.</para>
							<para>You can use the "<code>stop</code>" command at the end of the
								command sequence to shut down RCE after the other commands have
								been executed. However, any error during execution of these
								commands will cancel the sequence, and prevent the
									"<code>stop</code>" command from being executed. To ensure
								shut down at the end of the command sequence, use the
									<code>--batch</code> option instead of
								"<code>--exec</code>". </para>
							<para>As an example, <code>rce --headless --exec "wf run example.wf ; stop"</code> will
								execute the "example.wf" workflow in headless mode and then shut
								down RCE. However, if the workflow fails to start, RCE will keep
								running, as the "<code>stop</code>" command is never executed.
								To attempt execution of the workflow file, but then always shut
								down regardless of the outcome,  use <code>rce --batch "wf run
									example.wf"</code> instead.</para>
						</entry>
					</row>
					<row>
						<entry>configure</entry>
						<entry>RCE</entry>
						<entry>Starts the RCE Configuration UI (<xref linkend="configuration_ui"/>) which can be used
							to configure SSH accounts with passphrases or to configure e-mail
							support for the RCE instance.</entry>
					</row>
					<row>
						<entry>data @noDefault </entry>
						<entry>RCP</entry>
						<entry>Set the default workspace location to empty</entry>
					</row>
					<row>
						<entry>consoleLog </entry>
						<entry>RCP</entry>
						<entry>Logs everything for log files on the console as well.</entry>
					</row>
					<row>
						<entry>console</entry>
						<entry>RCP</entry>
						<entry>Runs RCE with an additional OSGi console window, which allows you
							to execute RCE shell commands. See the Command Shell
							documentation<!--TODO add link--> for more information.</entry>
					</row>
					<row>
						<entry><emphasis>Deprecated: </emphasis>console &lt;port></entry>
						<entry>RCP</entry>
						<entry>Specify the port that will be used to listen for telnet
							connections. (<emphasis>NOTE: </emphasis>this access is insecure;
							configure SSH access instead)</entry>
					</row>
					<row>
						<entry>clean </entry>
						<entry>RCP</entry>
						<entry>Cleans before startup</entry>
					</row>
					<row>
						<entry>vmargs</entry>
						<entry>VM</entry>
						<entry>Standard JVM arguments</entry>
					</row>
					<row>
						<entry>Dde.rcenvironment.rce.<?linebreak?>configuration.dir=<?linebreak?>&lt;insert-config-path></entry>
						<entry>VM</entry>
						<entry>Sets the configuration directory</entry>
					</row>
					<row>
						<entry>Drce.network.<?linebreak?>overrideNodeId =&lt;some-id></entry>
						<entry>VM</entry>
						<entry><para>Sets the local node id, overriding any stored value. This
								is mostly used for automated
							testing.</para>Example:<?linebreak?>
									"-Drce.network.overrideNodeId=<?linebreak?>a96db8fa762d59f2d2782f3e5e9662d4"</entry>
					</row>
					<row>
						<entry>Dcommunication.<?linebreak?>uploadBlockSize=<?linebreak?>&lt;block
							size in bytes></entry>
						<entry>VM</entry>
						<entry>
							<para>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).</para>
							<para>Example:<?linebreak?> "-Dcommunication.uploadBlockSize=131072"
								- sets the upload block size to 128kb (half the normal
								size)</para>
						</entry>
					</row>
				</tbody>
			</tgroup>
		</table>
	</para>
</section>
