| Line 1... |
Line 1... |
| 1 |
% File src/library/utils/man/help.Rd
|
1 |
% File src/library/utils/man/help.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-2014 R Core Team
|
3 |
% Copyright 1995-2018 R Core Team
|
| 4 |
% Distributed under GPL 2 or later
|
4 |
% Distributed under GPL 2 or later
|
| 5 |
|
5 |
|
| 6 |
\name{help}
|
6 |
\name{help}
|
| 7 |
\alias{help}
|
7 |
\alias{help}
|
| 8 |
\title{Documentation}
|
8 |
\title{Documentation}
|
| Line 26... |
Line 26... |
| 26 |
word (if syntactically valid) or character string.
|
26 |
word (if syntactically valid) or character string.
|
| 27 |
|
27 |
|
| 28 |
See \sQuote{Details} for what happens if this is omitted.
|
28 |
See \sQuote{Details} for what happens if this is omitted.
|
| 29 |
}
|
29 |
}
|
| 30 |
\item{package}{a name or character vector giving the packages to look
|
30 |
\item{package}{a name or character vector giving the packages to look
|
| 31 |
into for documentation, or \code{NULL}. By default, all packages
|
31 |
into for documentation, or \code{NULL}. By default, all packages
|
| 32 |
whose namespaces are loaded are used. To avoid a name being deparsed use e.g.
|
32 |
whose namespaces are loaded are used. To avoid a name being deparsed use e.g.
|
| 33 |
\code{(pkg_ref)} (see the examples).}
|
33 |
\code{(pkg_ref)} (see the examples).}
|
| 34 |
\item{lib.loc}{a character vector of directory names of \R libraries,
|
34 |
\item{lib.loc}{a character vector of directory names of \R libraries,
|
| 35 |
or \code{NULL}. The default value of \code{NULL} corresponds to all
|
35 |
or \code{NULL}. The default value of \code{NULL} corresponds to all
|
| 36 |
libraries currently known. If the default is used, the loaded
|
36 |
libraries currently known. If the default is used, the loaded
|
| Line 46... |
Line 46... |
| 46 |
The following types of help are available:
|
46 |
The following types of help are available:
|
| 47 |
\itemize{
|
47 |
\itemize{
|
| 48 |
\item Plain text help
|
48 |
\item Plain text help
|
| 49 |
\item HTML help pages with hyperlinks to other topics, shown in a
|
49 |
\item HTML help pages with hyperlinks to other topics, shown in a
|
| 50 |
browser by \code{\link{browseURL}}.
|
50 |
browser by \code{\link{browseURL}}.
|
| 51 |
#ifdef unix
|
51 |
\cr
|
| - |
|
52 |
(On Unix-alikes,
|
| 52 |
(Where possible an existing browser window is re-used: the macOS
|
53 |
where possible an existing browser window is re-used: the macOS
|
| 53 |
GUI uses its own browser window.)
|
54 |
GUI uses its own browser window.)
|
| 54 |
#endif
|
55 |
|
| 55 |
If for some reason HTML help is unavailable (see
|
56 |
If for some reason HTML help is unavailable (see
|
| 56 |
\code{\link{startDynamicHelp}}), plain text help will be used
|
57 |
\code{\link{startDynamicHelp}}), plain text help will be used
|
| 57 |
instead.
|
58 |
instead.
|
| 58 |
\item For \code{help} only, typeset as PDF --
|
59 |
\item For \code{help} only, typeset as PDF --
|
| 59 |
see the section on \sQuote{Offline help}.
|
60 |
see the section on \sQuote{Offline help}.
|
| 60 |
}
|
61 |
}
|
| 61 |
#ifdef unix
|
62 |
\describe{
|
| - |
|
63 |
\item{On Unix-alikes:}{
|
| 62 |
The \sQuote{factory-fresh} default is text help except from the macOS
|
64 |
The \sQuote{factory-fresh} default is text help except from the macOS
|
| 63 |
GUI, which uses HTML help displayed in its own browser window.
|
65 |
GUI, which uses HTML help displayed in its own browser window.
|
| 64 |
#endif
|
66 |
}
|
| 65 |
#ifdef windows
|
67 |
\item{On Windows:}{
|
| 66 |
The default for the type of help is selected when \R is installed --
|
68 |
The default for the type of help is selected when \R is installed --
|
| 67 |
the \sQuote{factory-fresh} default is HTML help.
|
69 |
the \sQuote{factory-fresh} default is HTML help.
|
| 68 |
#endif
|
70 |
}
|
| 69 |
|
71 |
}
|
| 70 |
The rendering of text help will use directional quotes in suitable
|
72 |
The rendering of text help will use directional quotes in suitable
|
| 71 |
locales (UTF-8 and single-byte Windows locales): sometimes the fonts
|
73 |
locales (UTF-8 and single-byte Windows locales): sometimes the fonts
|
| 72 |
used do not support these quotes so this can be turned off by setting
|
74 |
used do not support these quotes so this can be turned off by setting
|
| 73 |
\code{\link{options}(useFancyQuotes = FALSE)}.
|
75 |
\code{\link{options}(useFancyQuotes = FALSE)}.
|
| 74 |
|
76 |
|
The R Project SVN
R