| Line 1... |
Line 1... |
| 1 |
% File src/library/utils/man/help.start.Rd
|
1 |
% File src/library/utils/man/help.start.Rd
|
| 2 |
% Part of the R package, https://www.R-project.org
|
2 |
% Part of the R package, https://www.R-project.org
|
| 3 |
% Copyright 1995-2024 R Core Team
|
3 |
% Copyright 1995-2025 R Core Team
|
| 4 |
% Distributed under GPL 2 or later
|
4 |
% Distributed under GPL 2 or later
|
| 5 |
|
5 |
|
| 6 |
\name{help.start}
|
6 |
\name{help.start}
|
| 7 |
\title{Hypertext Documentation}
|
7 |
\title{Hypertext Documentation}
|
| 8 |
\alias{help.start}
|
8 |
\alias{help.start}
|
| Line 10... |
Line 10... |
| 10 |
Start the hypertext (currently HTML) version of \R's online
|
10 |
Start the hypertext (currently HTML) version of \R's online
|
| 11 |
documentation.
|
11 |
documentation.
|
| 12 |
}
|
12 |
}
|
| 13 |
\usage{
|
13 |
\usage{
|
| 14 |
help.start(update = FALSE, gui = "irrelevant",
|
14 |
help.start(update = FALSE, gui = "irrelevant",
|
| - |
|
15 |
lib.loc = .libPaths(),
|
| 15 |
browser = getOption("browser"), remote = NULL)
|
16 |
browser = getOption("browser"), remote = NULL,
|
| - |
|
17 |
verbose = getOption("verbose"))
|
| 16 |
}
|
18 |
}
|
| 17 |
\arguments{
|
19 |
\arguments{
|
| 18 |
\item{update}{logical: should this attempt to update the package index to
|
20 |
\item{update}{logical: should this attempt to update the package index to
|
| 19 |
reflect the currently available packages. (Not attempted if
|
21 |
reflect the currently available packages. (Not attempted if
|
| 20 |
\code{remote} is non-\code{NULL}.)}
|
22 |
\code{remote} is non-\code{NULL}.)}
|
| 21 |
\item{gui}{just for compatibility with S-PLUS.}
|
23 |
\item{gui}{just for compatibility with S-PLUS.}
|
| - |
|
24 |
\item{lib.loc}{character vector, listing the package libraries to be included.}
|
| 22 |
\item{browser}{the name of the program to be used as hypertext
|
25 |
\item{browser}{the name of the program to be used as hypertext
|
| 23 |
browser. It should be in the \env{PATH}, or a full path specified.
|
26 |
browser. It should be in the \env{PATH}, or a full path specified.
|
| 24 |
Alternatively, it can be an \R function which will be called with a
|
27 |
Alternatively, it can be an \R function which will be called with a
|
| 25 |
URL as its only argument. This option is normally unset on Windows,
|
28 |
URL as its only argument. This option is normally unset on Windows,
|
| 26 |
when the file-association mechanism will be used.}
|
29 |
when the file-association mechanism will be used.}
|
| 27 |
\item{remote}{A character string giving a valid URL for the
|
30 |
\item{remote}{a character string giving a valid URL for the
|
| 28 |
\file{\var{\link{R_HOME}}} directory on a remote location.}
|
31 |
\file{\var{\link{R_HOME}}} directory on a \dQuote{remote} location;
|
| - |
|
32 |
may be \code{"file://<Rhome>"} pointing to a path on your local platform.}
|
| - |
|
33 |
\item{verbose}{logical indicating if information about the system
|
| - |
|
34 |
interface should be printed to the console.}
|
| 29 |
}
|
35 |
}
|
| 30 |
\details{
|
36 |
\details{
|
| 31 |
Unless \code{remote} is specified this requires the HTTP server to be
|
37 |
Unless \code{remote} is specified this requires the HTTP server to be
|
| 32 |
available (it will be started if possible: see
|
38 |
available (it will be started if possible: see
|
| 33 |
\code{\link{startDynamicHelp}}).
|
39 |
\code{\link{startDynamicHelp}}).
|
| Line 48... |
Line 54... |
| 48 |
}
|
54 |
}
|
| 49 |
|
55 |
|
| 50 |
\seealso{
|
56 |
\seealso{
|
| 51 |
\code{\link{help}()} for on- and off-line help in other formats.
|
57 |
\code{\link{help}()} for on- and off-line help in other formats.
|
| 52 |
|
58 |
|
| - |
|
59 |
\code{\link{make.packages.html}} for how the \file{*.html} pages are created.
|
| 53 |
\code{\link{browseURL}} for how the help file is displayed.
|
60 |
\code{\link{browseURL}} for how the help file is displayed.
|
| 54 |
|
61 |
|
| 55 |
\code{\link{RSiteSearch}} to access an on-line search of \R resources.
|
62 |
\code{\link{RSiteSearch}} to access an on-line search of \R resources.
|
| 56 |
}
|
63 |
}
|
| 57 |
\examples{\donttest{
|
64 |
\examples{\donttest{
|
The R Project SVN
R