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 用於呈現包幫助頁麵。