| 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 Rd2txt [options] file 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. |
Rdconv converts Rd format to other formats. Currently,
plain text, HTML and LaTeX formats are supported. It can also extract
the examples for run-time testing.
Rd2dvi and Rd2txt are user-level programs
for producing DVI/PDF output or pretty text output from Rd sources.
Rd2dvi will make use of 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 previwer). (Valid values for
R_PAPERSIZE are a4, letter, legal and
executive.)
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.
Use R CMD foo --help to obtain usage information on utility foo.
The chapter “Processing Rd format” in the “Writing R Extensions” manual.