'\" t
.\"     Title: \fBrkward\fR
.\"    Author: [see the "Authors" section]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: 2013-03-29
.\"    Manual: [FIXME: manual]
.\"    Source: [FIXME: source]
.\"  Language: English
.\"
.TH "\FBRKWARD\FR" "1" "2013\-03\-29" "[FIXME: source]" "[FIXME: manual]"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
rkward \- A KDE frontend to R
.SH "SYNOPSIS"
.HP \w'\fBrkward\fR\ 'u
\fBrkward\fR [\fIworkspace_file\fR] [\fB\-\-evaluate\fR\fI Rcode\fR] [\fB\-\-debug\-level\fR\fI level\fR] [\fB\-\-debug\-flags\fR\fI flags\fR] [\fB\-\-debugger\fR\fI debugger_command\fR] [\fB\-\-backend\-debugger\fR\fI debugger_command\fR] [\fB\-\-r\-executable\fR\fI path_to_executable\fR] [KDE\ Generic\ Options] [Qt\ Generic\ Options]
.SH "DESCRIPTION"
.PP
RKWard
is the a
KDE\-based GUI and IDE for the
R
scripting language for statistical computing\&.
.PP
For more information, please refer to
\m[blue]\fBthe RKWard website\fR\m[]\&\s-2\u[1]\d\s+2, and the documentation provided inside
RKWard\&.
.SH "OPTIONS"
.PP
\fB\-\-evaluate\fR \fIRcode\fR
.RS 4
The given
R
code is evaluated after
RKWard
has started, and after any specified workspace is loaded\&. Mostly useful for automated testing\&.
.RE
.PP
\fB\-\-debug\-level\fR \fIlevel\fR
.RS 4
Verbosity of debug output\&. 0\-5, where 0 is no output, 5 is all output including function trace information\&. Default it 2\&.
.RE
.PP
\fB\-\-debug\-flags\fR \fIflags\fR
.RS 4
Allows to configure, which sections of code to debug\&. Flags are given as a binary number\&. Refer to the source files for documentation, as this really is an internal option\&.
.RE
.PP
\fB\-\-debugger\fR \fIcommand\fR
.RS 4
Run
RKWard
through the specified debugger command\&. To add command line options to the debugger command, enclose them in single quotes (\*(Aq\*(Aq) together with the command\&.
\fINOTE:\fR
To use the \e\-\e\-debugger option, it must be specified as the first option on the command line\&. Only the frontend process will be debugged, using this option\&.
.sp
Note that there are a number of pitfalls that may complicate setting up the debugger session as desired\&. Consider starting
RKWard
with option \e\-\e\-debug\-lebel 3, which will print the effective command line used to start the frontend (but not set some environment variables)\&. Under Windows, the debugger command will
\fInot\fR
be connected to stdin\&. For interactive debugging, consider using a graphical debugger\&.
.RE
.PP
\fB\-\-backend\-debugger\fR \fIcommand\fR
.RS 4
Run the
RKWard
backend through the specified debugger command\&. To add command line options to the debugger command, enclose them in single quotes (\*(Aq\*(Aq) together with the command\&.
\fINOTE:\fR
Debugger arguments will be split by spaces\&. If this is not appropriate, you will have to write your own wrapper script for invoking the debugger\&. Also, make sure to redirect all debugger output and/or input as appropriate\&. See the examples\&.
.RE
.PP
\fB\-\-r\-executable\fR \fIcommand\fR
.RS 4
In the case of several R installations, specify the installation to use, e\&.g\&. /usr/bin/R\&. Note that the rkward R library must have been installed to this installation of R, or startup will fail\&.
.RE
.SH "SEE ALSO"
.PP
\fBR\fR(1)
.SH "EXAMPLES"
.PP
.if n \{\
.RS 4
.\}
.nf
# Run the rkward backend through valgrind
rkward \-\-backend\-debugger \*(Aqvalgrind \-\-log\-file=valgrind\&.log\*(Aq\&.
# Debug the frontend through gdb
rkward \-\-debugger \*(Aqgdb \-\-args\*(Aq
.fi
.if n \{\
.RE
.\}
.SH "AUTHORS"
.PP
RKWard
was written by Thomas Friedrichsmeier and the
RKWard
team\&. See
\m[blue]\fBthe RKWard website\fR\m[]\&\s-2\u[1]\d\s+2\&.
.SH "NOTES"
.IP " 1." 4
the RKWard website
.RS 4
\%http://rkward.sf.net/
.RE