The R Project SVN R

Rev

Rev 56280 | Go to most recent revision | 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
2 
% Part of the R package, http://www.R-project.org
59039 ripley 3 
% Copyright 1995-2011 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{
56280 ripley 10 
make.packages.html(lib.loc = .libPaths(), temp = FALSE,
11 
                   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{
54071 ripley 17 
  \item{lib.loc}{character vector.  List of libraries to be included.}
49507 ripley 18 
  \item{temp}{logical: should the package indices be created in a
49558 ripley 19 
    temporary location for use by the HTTP server?}
54076 ripley 20 
  \item{verbose}{logical.  If true, print out a message.
21 
#ifdef windows
22 
    On Windows, show a progress bar.
23 
#endif
24 
  }
54078 ripley 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.}
27445 ripley 27 
}
28 
\details{
49510 ripley 29 
  This creates the \file{packages.html} file, either a temporary copy
49507 ripley 30 
  for use by \code{\link{help.start}}, or the copy in
54076 ripley 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).
27445 ripley 38 
 
49558 ripley 39 
  It can be very slow, as all the package \file{DESCRIPTION} files in
40 
  all the library trees are read.
49543 ripley 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.
27445 ripley 45 
}
54071 ripley 46 
 
27445 ripley 47 
\value{
49543 ripley 48 
  Invisible logical, with \code{FALSE} indicating a failure to create
49 
  the file, probably due to lack of suitable permissions.
27445 ripley 50 
}
51 
\seealso{
52 
  \code{\link{help.start}}
53 
}
43458 ripley 54 
\examples{\dontrun{
54071 ripley 55 
make.packages.html()
43458 ripley 56 
# this can be slow for large numbers of installed packages.
57 
}}
54071 ripley 58 
 
27445 ripley 59 
\keyword{utilities}