RdUtils {base} | R Documentation |
Utilities for converting files in R documentation (Rd) format to other formats or create indices from them, and for converting documentation in other formats to Rd format.
R CMD Rdconv [options] file R CMD Rd2dvi [options] files R CMD Rd2pdf [options] files R CMD Sd2Rd [options] file
file |
the path to a file to be processed. |
files |
a list of file names specifying the R documentation sources to use, by either giving the paths to the files, or the path to a directory with the sources of a package. |
options |
further options to control the processing, or for obtaining information about usage and version of the utility. |
R CMD Rdconv
converts Rd format to plain text, HTML or LaTeX
formats: it can also extract the examples.
R CMD Rd2dvi
is the user-level program for producing DVI/PDF output
from Rd sources. It will make use of the environment variables
R_PAPERSIZE (set by R CMD
, with a default set when R
was installed) and xdvi (the DVI previewer, default
xdvi
),
and R_PDFVIEWER (the PDF previewer). (Valid values for
R_PAPERSIZE are a4
, letter
, legal
and
executive
.) Rd2pdf
is shorthand for Rd2dvi
--pdf
.
R CMD Sd2Rd
converts S (version 3 or 4) documentation formats to Rd
format: it is no longer much used and the results may need
hand-tuning. (It requires Perl.)
Use R CMD foo --help
to obtain usage information on utility
foo
.
The chapter “Processing Rd format” in the “Writing R Extensions” manual.