pod2html

(原始碼, CPAN)

#名稱

pod2html - 將 .pod 檔案轉換為 .html 檔案

#語法

pod2html --help --htmldir=<name> --htmlroot=<URL>
         --infile=<name> --outfile=<name>
         --podpath=<name>:...:<name> --podroot=<name>
         --cachedir=<name> --flush --recurse --norecurse
         --quiet --noquiet --verbose --noverbose
         --index --noindex --backlink --nobacklink
         --header --noheader --poderrors --nopoderrors
         --css=<URL> --title=<name>

#說明

將 pod 格式的檔案（請參閱 perlpod）轉換為 HTML 格式。

#參數

pod2html 會使用下列參數

#backlink

--backlink
--nobacklink

將 =head1 指令轉換為指向 HTML 檔案頂端的連結。--nobacklink（這是預設行為）不會建立這些回溯連結。

#cachedir

--cachedir=name

指定用於儲存快取的目錄。預設目錄為目前的作業目錄。

#css

--css=URL

指定要從產生的 HTML 檔案連結的層疊樣式表的 URL。預設為沒有樣式表。

#flush

--flush

清除快取。

#header

--header
--noheader

建立包含「NAME」區段文字的標頭和頁尾區塊。--noheader（預設行為）不會建立標頭或頁尾區塊。

#help

--help

顯示使用訊息。

#htmldir

--htmldir=name

設定所有結果 HTML 檔案中交叉參照的相對目錄。不傳遞此參數會導致所有連結都是絕對連結，因為這是告訴 Pod::Html 文件樹根目錄的值。

不要在呼叫 pod2html 時同時使用此參數和 --htmlroot；它們互斥。

#htmlroot

--htmlroot=URL

設定 HTML 檔案的基礎 URL。建立交叉參照時，HTML 根目錄會加到 URL 前面。

如果需要相對連結，請不要使用此參數：請改用 --htmldir。

不要同時傳遞此參數和 --htmldir 給 pod2html；它們互斥。

#index

--index

在 HTML 檔案最上方產生索引（預設行為）。

#noindex

--noindex

不要在 HTML 檔案最上方產生索引。

#infile

--infile=name

指定要轉換的 pod 檔案。如果未指定 infile，會從 STDIN 讀取輸入。

#outfile

--outfile=name

指定要建立的 HTML 檔案。如果未指定 outfile，會輸出到 STDOUT。

#poderrors

--poderrors
--nopoderrors

如果 infile 中有任何 POD 錯誤，就在 outfile 中包含「POD ERRORS」區段（預設行為）。--nopoderrors 不會建立這個「POD ERRORS」區段。

#podpath

--podpath=name:...:name

指定 podroot 的哪些子目錄包含 pod 檔案，其 HTML 轉換形式可以在交叉參照中連結。

#podroot

--podroot=name

指定尋找函式庫 pod 的基礎目錄。

#quiet

--quiet
--noquiet

不要顯示大多數無害的警告訊息。--noquiet（預設行為）會顯示這些大多數無害的警告訊息（但這與「詳細」模式不同）。

#recurse

--recurse
--norecurse

遞迴進入 podpath 中指定的子目錄（預設行為）。--norecurse 不會遞迴進入這些子目錄。

#title

--title=title

指定結果 HTML 檔案的標題。

#verbose

--verbose
--noverbose

顯示進度訊息。--noverbose -- 這是預設行為 -- 沒有顯示這些進度訊息。

#AUTHOR

Tom Christiansen, <tchrist@perl.com>。

#BUGS

請參閱 Pod::Html 以取得翻譯器中已知錯誤的清單。

#SEE ALSO

perlpod, Pod::Html

#COPYRIGHT

此程式是根據 Artistic License 發布的。