R startDynamicHelp 启动动态 HTML 帮助系统

说明

此函数启动内部帮助服务器，以便在请求时呈现 HTML 帮助页面。

用法

startDynamicHelp(start = TRUE)

参数

start

逻辑：是否启动或关闭动态帮助系统。如果是 NA ，则服务器将启动(如果尚未运行)。

细节

该函数启动内部 HTTP 服务器，该服务器在环回接口上运行(‘⁠127.0.0.1⁠’)。如果options("help.ports")设置为非零整数值的向量，startDynamicHelp将按顺序尝试这些端口；否则，它会尝试最多 10 个随机端口来查找未使用的端口。可以通过设置环境变量来禁用它R_DISABLE_HTTPD为非空值或options("help.ports")到0.

startDynamicHelp 由需要使用服务器的函数调用，因此很少由用户直接调用。

注意options(help_type = "html")必须设置为实际使用 HTML 帮助，尽管它可能是默认的R安装。

如果服务器无法启动或被禁用，help.start 将不可用，并且 HTML 帮助请求将提供文本帮助(带有警告)。

使用的浏览器确实需要能够连接到环回接口：有时它被设置为在所有接口上使用 HTTP 代理，这是行不通的 - 解决方案是添加一个异常：⁠127.0.0.1⁠’。

值

所选择的端口号以不可见的方式返回(如果服务器已停止，则为0)。

也可以看看

如果需要，help.start 和 help(help_type = "html") 将尝试启动 HTTP 服务器

Rd2HTML 用于呈现包帮助页面。