Commit 71b0bbc4 authored by Thomas Friedrichsmeier's avatar Thomas Friedrichsmeier
Browse files

Update man page

parent 7dec2a62
......@@ -16,7 +16,7 @@
<address><email>rkward-devel@kde.org</email></address>
</affiliation>
</author>
<date>2014-11-16</date>
<date>2015-12-07</date>
<productname>K Desktop Environment</productname>
</refentryinfo>
......@@ -40,6 +40,7 @@
<group choice="opt"><option>--backend-debugger</option> <replaceable> debugger_command</replaceable></group>
<group choice="opt"><option>--r-executable</option> <replaceable> path_to_executable</replaceable></group>
<group choice="opt"><option>--reuse</option></group>
<group choice="opt"><option>--nowarn-external</option></group>
<arg choice="opt">KDE Generic Options</arg>
<arg choice="opt">Qt Generic Options</arg>
<arg choice="opt"><replaceable>files_to_open</replaceable></arg>
......@@ -87,8 +88,12 @@ Under Windows, the debugger command will <emphasis>not</emphasis> be connected t
<listitem><para>If an instance of RKWard is already running, bring that to the front, and open <replaceable>files_to_open</replaceable>. Note that all other command line options will be ignored in case an instance is reused.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--nowarn-external</option></term>
<listitem><para>Usually, when invoking RKWard plugins from the command line (i.e. when <replaceable>files_to_open</replaceable> contains urls of the form <replaceable>rkward://runplugin/...</replaceable>), RKWard will show a warning that such urls <emphasis>could</emphasis> be used to trigger malicious actions on your system. This warning applies specifically to links found on untrusted websites, or other untrusted external sources. If you want to script RKWard locally, you can avoid this warning by adding --nowarn-external to the command line.</para></listitem>
</varlistentry>
<varlistentry>
<term><replaceable>files_to_open</replaceable></term>
<listitem><para>You can specify any number of file names or urls for RKWard to open. Usually this will be either workspace files, workplace files, R script files, or rkward://-urls (e.g. for starting with a plugin dialog). Specifying more than one workspace file will lead to the workspaces being merge together, and is not recommended.</para></listitem>
<listitem><para>You can specify any number of file names or urls for RKWard to open. Usually this will be either workspace files, workplace files, R script files, or rkward://-urls (e.g. for starting with a plugin dialog). Specifying more than one workspace file will lead to the workspaces being merged together, and is not recommended.</para></listitem>
</varlistentry>
</variablelist>
......@@ -103,6 +108,11 @@ Under Windows, the debugger command will <emphasis>not</emphasis> be connected t
<refsect1>
<title>Examples</title>
<para><programlisting>
# Start with the t-test dialog
rkward --nowarn-external rkward://runplugin/rkward::t_test/
# Open two script files in a running instance of RKWard (or in a fresh instance, if RKWard is not running)
rkward --reuse file_a.R file_b.R
# Run the rkward backend through valgrind
rkward --backend-debugger 'valgrind --log-file=valgrind.log'.
# Debug the frontend through gdb
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment