#名稱

podchecker - 檢查 POD 格式文件語法的文件

#語法

podchecker [-help] [-man] [-(no)warnings] [file ...]

#-help: 列印簡短的說明訊息並結束。
#-man: 列印手冊頁並結束。
#-warnings -nowarnings: 開啟/關閉列印警告。重複 -warnings 會增加警告層級，亦即列印更多警告。目前增加到層級 2 會標示未跳脫的「<,>」字元。
#file: 要語法檢查的 POD 檔案路徑名稱（預設為標準輸入）。

podchecker 會讀取指定的輸入檔案，尋找 POD 文件中的 POD 語法錯誤，並將找到的任何錯誤列印到 STDERR。最後，它會列印一個狀態訊息，指出找到的錯誤數目。

目錄會被忽略，並會列印適當的警告訊息。

podchecker 會呼叫 Pod::Checker 匯出的 podchecker() 函式。請參閱 Pod::Checker 中的「podchecker()」以取得更多詳細資料。

如果所有指定的 POD 檔案都沒有問題，podchecker 會傳回 0 (零) 的結束狀態。

如果至少一個指定的 POD 檔案有語法錯誤，podchecker 會傳回結束狀態 1。

狀態 2 表示至少一個指定的檔案不包含任何 POD 指令。

狀態 1 會覆寫狀態 2。如果您想要明確的結果，請只使用一個單一參數呼叫 podchecker。

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

Brad Appleton <bradapp@enteract.com>、Marek Rouchal <marekr@cpan.org>

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