內容

#名稱

pod2usage - 列印檔案中嵌入 pod 文件的用法訊息

#pod2usage: [-help] [-man] [-exit exitval] [-output outfile] [-verbose level] [-pathlist dirlist] [-formatter module] [-utf8] file

#-help

列印簡短的說明訊息並結束。

#-man

列印此命令的手冊頁並結束。

#-exit exitval

要傳回的結束狀態值。

#-output outfile

要列印的輸出檔案。如果使用特殊名稱「-」或「>&1」或「>&STDOUT」，則會使用標準輸出。如果使用「>&2」或「>&STDERR」，則會使用標準錯誤。

#-verbose level

要使用的詳細程度

1 : print SYNOPSIS only
2 : print SYNOPSIS sections and any OPTIONS/ARGUMENTS sections
3 : print the entire manpage (similar to running pod2text)

#-pathlist dirlist

如果輸入檔案未提供絕對路徑，則指定一個或多個目錄來搜尋輸入檔案。給定清單中的每個目錄路徑應以 Unix 上的「:」(MSWin32 和 DOS 上的「;」) 分隔。

#-formatter module

要使用的文字格式化器。預設為 Pod::Text，或對於非常舊的 Perl 版本 Pod::PlainText。替代方案可能是 Pod::Text::Termcap。

#-utf8

此選項假設格式化器(見上文)了解「utf8」選項。它會開啟 utf8 輸出的產生。

#file

包含要以使用訊息格式輸出的 pod 文件的檔案路徑名稱。如果省略，則會讀取標準輸入 - 但輸出只會使用 Pod::Text 格式化 - 除非已使用 -formatter 指定特定格式化程式。

pod2usage 會讀取指定的輸入檔案，尋找 pod 文件，並列印對應的使用訊息。如果未指定輸入檔案，則會讀取標準輸入。

pod2usage 會呼叫 Pod::Usage 模組中的 pod2usage() 函數。請參閱 "Pod::Usage 中的 pod2usage()"。

請使用 http://rt.cpan.org 回報錯誤。

Brad Appleton <bradapp@enteract.com>

根據 Tom Christiansen <tchrist@mox.perl.com> 編寫的 pod2text(1) 程式碼。