The R Project SVN R

Rev

Rev 6994 | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed

\name{make.function.html}
\alias{link.html.help}
\alias{make.function.html}
\alias{make.packages.html}
\alias{make.search.html}
\title{Update HTML documentation files}
\usage{
link.html.help(verbose=FALSE)
make.function.html()
make.packages.html()
make.search.html()
}
\description{
  Functions to re-create the HTML documentation files to reflect all
  installed packages. \code{make.function.html} creates the
  alphabetical list of functions, \code{make.packages.html} creates
  the list of packages, and \code{make.search.html} creates the
  database used by the Java search engine. \code{link.html.help} runs
  all three.
}
\arguments{
  \item{verbose}{logical. If true, print out a message. For use to
    explain a delay when called from other functions.}
}
\value{
  No value is returned. The file \code{R\_HOME\\doc\\html\\function.html},
  \code{R\_HOME\\doc\\html\\packages.html} or
  \code{R\_HOME\\doc\\html\\search\\index.txt} is (re-)created.
}
\author{Guido Masarotto and Brian Ripley}
\note{You will need write permission in the \code{R\_HOME\\doc\\html}
  directory.}
\keyword{utilities}