The R Project SVN R

.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.020.
.TH R "1" "June 2004" "R 2.0.0" FSF
.SH NAME
R \- a language for data analysis and graphics
.SH SYNOPSIS
.B R
[\fIoptions\fR] [\fI< infile\fR] [\fI> outfile\fR]
.br
.B R
\fICMD command \fR[\fIarguments\fR]
.SH DESCRIPTION
Start R, a system for statistical computation and graphics, with the
specified options, or invoke an R tool via the 'R CMD' interface.
.PP
R is a language which bears a passing resemblance to the S language
developed at AT&T Bell Laboratories.  It provides support for a variety
of statistical and graphical analyses.  R is a true computer language
which contains a number of control-flow constructions for iteration and
alternation.  It allows users to add additional functionality by
defining new functions.
.LP
On platforms which support the \fBdlopen\fP(3) interface, Fortran and C
code can be linked and called at run time.
.LP
On systems which have the GNU \fBreadline\fP(3) library, R will maintain
a command history, so that commands can be recalled, edited and
re-executed.
.SH OPTIONS

Most options control what happens at the beginning and at the end of an
R session, in particular which files are being read and written, and how
much memory is reserved for the R process.
.TP
\fB\-h\fR, \fB\-\-help\fR
Print short help message and exit
.TP
\fB\-\-version\fR
Print version info and exit
.TP
RHOME
Print path to R home directory and exit
.TP
\fB\-\-save\fR
Do save workspace at the end of the session
.TP
\fB\-\-no\-save\fR
Don't save it
.TP
\fB\-\-no\-environ\fR
Don't read the site and user environment files
.TP
\fB\-\-no\-site\-file\fR
Don't read the site-wide Rprofile
.TP
\fB\-\-no\-init\-file\fR
Don't read the .Rprofile or ~/.Rprofile files
.TP
\fB\-\-restore\fR
Do restore previously saved objects at startup
.TP
\fB\-\-no\-restore\-data\fR
Don't restore previously saved objects
.TP
\fB\-\-no\-restore\-history\fR
Don't restore the R history file
.TP
\fB\-\-no\-restore\fR
Don't restore anything
.TP
\fB\-\-vanilla\fR
Combine \fB\-\-no\-save\fR, \fB\-\-no\-restore\fR, \fB\-\-no\-site\-file\fR,
\fB\-\-no\-init\-file\fR and \fB\-\-no\-environ\fR
.TP
\fB\-\-no\-readline\fR
Don't use readline for command-line editing
.TP
\fB\-\-min\-vsize\fR=\fIN\fR
Set vector heap min to N bytes; '4M' = 4 MegaB
.TP
\fB\-\-max\-vsize\fR=\fIN\fR
Set vector heap max to N bytes;
.TP
\fB\-\-min\-nsize\fR=\fIN\fR
Set min number of cons cells to N
.TP
\fB\-\-max\-nsize\fR=\fIN\fR
Set max number of cons cells to N
.TP
\fB\-\-max\-ppsize\fR=\fIN\fR
Set max size of protect stack to N
.TP
\fB\-q\fR, \fB\-\-quiet\fR
Don't print startup message
.TP
\fB\-\-silent\fR
Same as \fB\-\-quiet\fR
.TP
\fB\-\-slave\fR
Make R run as quietly as possible
.TP
\fB\-\-verbose\fR
Print more information about progress
.TP
\fB\-d\fR, \fB\-\-debugger\fR=\fINAME\fR
Run R through debugger NAME
.TP
\fB\-\-debugger\-args\fR=\fIARGS\fR
Pass ARGS as arguments to the debugger
.TP
\fB\-g\fR, \fB\-\-gui\fR=\fITYPE\fR
Use TYPE as GUI; possible values are 'X11'
(default), 'none' and 'gnome'
.TP
\fB\-\-args\fR
Skip the rest of the command line
.SS "Commands:"
.TP
BATCH
Run R in batch mode
.TP
COMPILE
Compile files for use with R
.TP
SHLIB
Build shared library for dynamic loading
.TP
INSTALL
Install add-on packages
.TP
REMOVE
Remove add-on packages
.TP
build
Build add-on packages
.TP
check
Check add-on packages
.TP
LINK
Front-end for creating executable programs
.TP
Rprof
Post-process R profiling files
.TP
Rdconv
Convert Rd format to various other formats
.TP
Rd2dvi
Convert Rd format to DVI/PDF
.TP
Rd2txt
Convert Rd format to pretty text
.TP
Sd2Rd
Convert S documentation to Rd format
.TP
config
Obtain configuration information about R
.PP
Please use 'R CMD command \fB\-\-help\fR' to obtain further information about
the usage of 'command'.
.SH "REPORTING BUGS"
Report bugs to <r-bugs@r-project.org>.
.SH COPYRIGHT
Copyright \(co 2004 R Development Core Team
.PP
R is free software and comes with ABSOLUTELY NO WARRANTY.
You are welcome to redistribute it under the terms of the GNU
General Public License.  For more information about these matters,
see http://www.gnu.org/copyleft/gpl.html.
.SH "SEE ALSO"

The full documentation for R is provided by a collection of Texinfo
manuals and individual help for R objects which is also available
on-line.
.LP
Start R and type \fB?\fP\fItopic\fP at the R prompt to obtain on-line
information for `\fItopic\fP'.
.LP
If the processed manuals have been installed they will be available as
DVI and/or PDF files in the directory `R RHOME`/doc/manual.
.LP
If the \fBinfo\fP program and the R manuals are installed on your
system, typing \fBinfo -f R-intro\fP, \fBinfo -f R-data\fP, 
\fBinfo -f R-exts\fP,\fBinfo
-f R-FAQ\fP and \fBinfo -f R-lang\fP should give you access to 
``An Introduction to R'' (the basic manual), the ``R Data Import/Export'' 
Guide, the ``R Extension Writer's Guide'', the ``R FAQ'' 
and the ``The R Language Definition''.