help.start
Hypertext Documentation
Description
Start the hypertext system for help.
Use this system to browse the contents of available packages, and to find
and display help files by topic.
Usage
help.start(update = FALSE, gui = "irrelevant", browser = getOption("browser"),
remote = NULL)
Arguments
| update |
a logical value. If TRUE, the file packages.html under
"<home>/doc/html/" is updated before the local hypertext help system
starts. The default is FALSE.
|
| gui |
not used currently. Present for compatibility with S+.
|
| browser |
Defines the browser to start the URL. Passed to browseURL().
|
| remote |
a character string specifying the remote HTTP server and port number.
If NULL (the default), the local HTTP server is used to launch
the hypertext help system.
|
Details
This function starts a hypertext help system on a local or a remote HTTP server.
If remote is NULL, startDynamicHelp() is called to start
a local HTTP server. The local server is fixed as
http://127.0.0.1:<port>.
The URL to start for the hypertext help system is set as
<HTTP_server:port>/doc/html/index.html.
The function browseURL() is called to start this URL.
Value
returns nothing invisibly.
Side Effects
A web browser window appears and displays the landing page for the TIBCO Enterprise Runtime
for R. From this page, you can browse the libraries, search the language reference by topic alias,
and discover other pertinent information about TIBCO Enterprise Runtime for R.
Differences between TIBCO Enterprise Runtime for R and Open-source R
The update argument is not used by TIBCO Enterprise Runtime for R.
In open-source R, this argument is used to update the file
R_HOME/doc/html/packages.html. In TIBCO Enterprise Runtime for R, this information is maintained
internally to Rdhttpd and is generated dynamically on request.
See Also
Examples
## Not run:
# Starting the help system
help.start()
help.start(remote = "www.tibco.terr.com:23456") # Remote server.
## End(Not run)