The R Project SVN R

Rev

Rev 68948 | Go to most recent revision | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 68948 Rev 84750
Line 20... Line 20...
20 
  \item{start}{logical: whether to start or shut down the dynamic help
 20 
  \item{start}{logical: whether to start or shut down the dynamic help
21 
    system.  If \code{NA}, the server is started if not already running.}
 21 
    system.  If \code{NA}, the server is started if not already running.}
22 
}
 22 
}
23 
\details{
 23 
\details{
24 
  This function starts the internal HTTP server, which runs on the
 24 
  This function starts the internal HTTP server, which runs on the
25 
  loopback interface (\code{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}.
 30 
  to \code{0}.
Line 41... Line 41...
41 
  help will give text help (with a warning).
 41 
  help will give text help (with a warning).
42 
 
 42 
 
43 
  The browser in use does need to be able to connect to the loopback
 43 
  The browser in use does need to be able to connect to the loopback
44 
  interface: occasionally it is set to use a proxy for HTTP on all
 44 
  interface: occasionally it is set to use a proxy for HTTP on all
45 
  interfaces, which will not work -- the solution is to add an exception
 45 
  interfaces, which will not work -- the solution is to add an exception
46 
  for \code{127.0.0.1}.
 46 
  for \samp{127.0.0.1}.
47 
}
 47 
}
48 
\value{
 48 
\value{
49 
  The chosen port number is returned invisibly (which will be \code{0}
 49 
  The chosen port number is returned invisibly (which will be \code{0}
50 
  if the server has been stopped).
 50 
  if the server has been stopped).
51 
}
 51 
}