The R Project SVN R

Rev

Rev 68948 | Details | Compare with Previous | Last modification | View Log | RSS feed

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