1% File src/library/utils/man/unix/make.packages.html.Rd
2% Part of the R package, https://www.R-project.org
3% Copyright 1995-2011 R Core Team
4% Distributed under GPL 2 or later
5
6\name{make.packages.html}
7\alias{make.packages.html}
8\title{Update HTML Package List}
9\usage{
10make.packages.html(lib.loc = .libPaths(), temp = FALSE,
11                   verbose = TRUE, docdir = R.home("doc"))
12}
13\description{
14  Re-create the HTML list of packages.
15}
16\arguments{
17  \item{lib.loc}{character vector.  List of libraries to be included.}
18  \item{temp}{logical: should the package indices be created in a
19    temporary location for use by the HTTP server?}
20  \item{verbose}{logical.  If true, print out a message.
21#ifdef windows
22    On Windows, show a progress bar.
23#endif
24  }
25  \item{docdir}{If \code{temp} is false, directory in whose \file{html}
26    directory the \file{packages.html} file is to be created/updated.}
27}
28\details{
29  This creates the \file{packages.html} file, either a temporary copy
30  for use by \code{\link{help.start}}, or the copy in
31#ifdef unix
32  \file{R.home("doc")/html}
33#endif
34#ifdef windows
35  \file{\var{\link{R_HOME}}\\doc\\html}
36#endif
37  (for which you will need write permission).
38
39  It can be very slow, as all the package \file{DESCRIPTION} files in
40  all the library trees are read.
41
42  For \code{temp = TRUE} there is some caching of information, so the
43  file will only be re-created if \code{lib.loc} or any of the
44  directories it lists have been changed.
45}
46
47\value{
48  Invisible logical, with \code{FALSE} indicating a failure to create
49  the file, probably due to lack of suitable permissions.
50}
51\seealso{
52  \code{\link{help.start}}
53}
54\examples{\dontrun{
55make.packages.html()
56# this can be slow for large numbers of installed packages.
57}}
58
59\keyword{utilities}
60