\Header{INSTALL}{Install Add-on Packages}
\keyword{utilities}{INSTALL}
\begin{Description}\relax
Utility for installing add-on packages.\end{Description}
\begin{Usage}
\begin{verbatim}R CMD INSTALL [options] [-l lib] pkgs\end{verbatim}
\end{Usage}
\begin{Arguments}
\begin{ldescription}
\item[\code{pkgs}] A list with the path names of the packages to be
installed.
\item[\code{lib}] the path name of the \R{} library tree to install to.
\item[\code{options}] a list of options through which in particular the
process for building the help files can be controlled.
\end{ldescription}
\end{Arguments}
\begin{Details}\relax
If used as \code{R CMD INSTALL pkgs} without explicitly specifying
\code{lib}, packages are installed into the library tree rooted at the
first directory given in the environment variable \code{R\_LIBS} if
this is set and non-null, and to the default library tree (which is
rooted at \file{\$R\_HOME/library}) otherwise.

To install into the library tree \code{lib}, use
\code{R CMD INSTALL -l lib pkgs}.

Both \code{lib} and the elements of \code{pkgs} may be absolute or
relative path names. \code{pkgs} can also contain name of package
archive files of the form \file{pkg\_version.tar.gz} as obtained from
CRAN, these are then extracted in a temporary directory.

Some package sources contain a \file{configure} script that can be
passed arguments or variables via the option \code{--configure-args}
and \code{--configure-vars}, respectively, if necessary.  The latter
is useful in particular if libraries or header files needed for the
package are in non-system directories.  In this case, one can use the
configure variables \code{LIBS} and \code{CPPFLAGS} to specify these
locations (and set these via \code{--configure-vars}), see section
`Configuration variables' in ``R Installation and Adminstration'' for
more information.  One can also bypass the configure mechanism using
the option \code{--no-configure}.

If \code{--no-docs} is given, no help files are built.  Options
\code{--no-text}, \code{--no-html}, and \code{--no-latex} suppress
creating the text, HTML, and LaTeX versions, respectively.  The
default is to build help files in all three versions.

If the option \code{--save} is used, the installation procedure
creates a binary image of the package code, which is then loaded when
the package is attached, rather than evaluating the package source at
that time.  Having a file \file{install.R} in the package directory
makes this the default behavior for the package (option
\code{--no-save} overrides).  You may need  \code{--save} if your
package requires other packages to evaluate its own source.  If the
file \file{install.R} is non-empty, it should contain R expressions to
be executed when the package is attached, after loading the saved
image.  Options to be passed to R when creating the save image can be
specified via \code{--save=ARGS}.

Use \code{R CMD INSTALL --help} for more usage information.\end{Details}
\begin{SeeAlso}\relax
\code{\Link{REMOVE}},
\code{\Link{update.packages}} for automatic update of packages using
the internet;
the chapter on ``Creating R packages'' in ``Writing \R{} Extensions''
(see the \file{doc/manual} subdirectory of the \R{} source tree).\end{SeeAlso}

