The R Project SVN R

Rev

Rev 84750 | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 84750 Rev 88636
Line 1... Line 1...
1 
% File src/library/tools/man/startDynamicHelp.Rd
 1 
% File src/library/tools/man/startDynamicHelp.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 2009-2015 R Core Team
 3 
% Copyright 2009-2025 R Core Team
4 
% Distributed under GPL 2 or later
 4 
% Distributed under GPL 2 or later
5 
 
 5 
 
6 
\name{startDynamicHelp}
 6 
\name{startDynamicHelp}
7 
\alias{startDynamicHelp}
 7 
\alias{startDynamicHelp}
8 
\alias{help.ports}
 8 
\alias{help.ports}
Line 25... Line 25...
25 
  loopback interface (\samp{127.0.0.1}).  If \code{options("help.ports")}
 25 
  loopback interface (\samp{127.0.0.1}).  If \code{options("help.ports")}
26 
  is set to a vector of non-zero integer values, \code{startDynamicHelp} will try
 26 
  is set to a vector of non-zero integer values, \code{startDynamicHelp} will try
27 
  those ports in order; otherwise, it tries up to 10 random ports to
 27 
  those ports in order; otherwise, it tries up to 10 random ports to
28 
  find one not in use.  It can be disabled by setting the environment
 28 
  find one not in use.  It can be disabled by setting the environment
29 
  variable \env{R_DISABLE_HTTPD} to a non-empty value or \code{options("help.ports")}
 29 
  variable \env{R_DISABLE_HTTPD} to a non-empty value or \code{options("help.ports")}
- 
 
 30 
  to \code{0}.  If the server could not be started (including when disabled by
- 
 
 31 
  the environment variable), it is permanently disabled for the rest of the
30 
  to \code{0}.
 32 
  R session.
31 
 
 33 
 
32 
  \code{startDynamicHelp} is called by functions that need to use the
 34 
  \code{startDynamicHelp} is called by functions that need to use the
33 
  server, so would rarely be called directly by a user.
 35 
  server, so would rarely be called directly by a user.
34 
 
 36 
 
35 
  Note that \code{options(help_type = "html")} must be set to actually
 37 
  Note that \code{options(help_type = "html")} must be set to actually