POD ファイル形式とは?
.pod ファイルは、Perl プログラミング言語用のドキュメントファイルです。POD ファイルは、可読性と機能性を高めるために特別なマークアップ構文を使用します。構文は非常に基本的で高度に標準化されており、フォントのサイズや色の変更、画像の追加、表の作成などのオプションはありません。これにより、.pod ファイルは HTML、TeX、Markdown、XML などの他の形式に簡単に変換できます。.pod ファイルは perldoc ツールを使用して対話的に読み取ることができます。
*Plain Old Documentation* は、明確で簡潔なソフトウェアドキュメントファイルを作成するのに適した、非常に便利なマークアップ言語です。CPAN で公開されている Perl モジュールやディストリビューションのドキュメントのほとんどは、この形式で記述されています。
独立した .pod ファイルとして存在するほかに、POD ドキュメントは =pod と =cut マーカー行の間に、.pl や .pm ソースファイル内に直接埋め込むことができます。Perl インタプリタはコンパイル時にこれらのセクションを単に無視します。POD は 3 つの段落タイプを定義しています。= で始まるコマンド段落(=head1、=over、=item、=back、=cut など)、等幅段落(空白でインデントされた行)、および B<>、I<>、C<>、L<> などのインラインフォーマットコードを含む通常のテキスト段落です。文字エンコーディングは =encoding utf-8 で宣言されます。
POD ドキュメントは、pod2man を使用してシステムヘルプマニュアル(man ページ)に、pod2html を使用して HTML に、または pod2text を使用してプレーンテキストに簡単に変換できます。
セキュリティと安全性
リスク: LOW本物の Perl POD ファイルは実行コードを含まないプレーンテキストであるため、どのエディタで開いても安全です。2つの注意点があります:(1) もし .pod が実際には Terminal Reality ゲームのアーカイブである場合、それはバイナリです。テキストとして «修正» しようとせず、ゲーム専用のエクストラクタで開いてください。(2) 埋め込まれた POD は .pl/.pm Perl ソース内に存在します。ドキュメント自体は不活性ですが、周囲の Perl コードはプログラムです。信頼できるスクリプトのみを実行してください。
形式の詳細
概要- Terminal Reality POD ゲームアーカイブ - Terminal Reality エンジンのタイトル(BloodRayne、FaceOff など)で使用されるパックされたゲームアセットアーカイブ (.pod)。ドキュメントではなくバイナリアーカイブです。
- ポッドキャストメディアファイル - 一部のアプリやフィードでは、ダウンロードしたオーディオエピソードに .pod というラベルを付けます。実際にはこれらは MP3/AAC オーディオであり、独自の形式ではありません。
- VMware / 仮想化およびその他のデータ - いくつかのツールが独自のデータ(ポータブル/パックされたデータファイルなど)に .pod を使用しますが、Perl ドキュメントとは無関係です。
POD ファイルを開くプログラム
技術的詳細
詳細仕様| フォーマットタイプ | プレーンテキスト軽量マークアップ言語 |
| 段落タイプ | コマンド (=head1, =over, =item, =cut)、等幅 (インデントされた行)、および通常のテキスト |
| コマンドマーカー | 1列目が «=» で始まる行 - =pod, =head1, =head2, =over, =item, =back, =cut, =begin, =end, =for, =encoding |
| インラインフォーマットコード | 太字、斜体、コード、リンク、エンティティ、改行なし、索引エントリ、ゼロ効果のための B<>, I<>, C<>, L<>, E<>, S<>, X<>, Z<> |
| エンコーディング宣言 | 最初のコマンド段落に配置される、=encoding とそれに続く IANA 文字セット名 (例: utf-8) |
| MIME タイプ | text/x-pod (主要); text/plain も許容 |
| ソースへの埋め込み | .pl / .pm ファイル内の =pod と =cut の間に配置可能。Perl コンパイラは実行時にこれらのブロックを無視する |
| 変換ツール | pod2man (man ページ), pod2html (HTML), pod2text (プレーンテキスト), pod2latex (LaTeX) - すべて Perl に付属、または CPAN で入手可能 |
| 対話型ビューア | perldoc は、インストールされた Perl モジュールまたはスタンドアロンの .pod ファイルから POD を読み取る |
| 一般的なファイルサイズ | 1 KB - 200 KB |
| プラットフォームのサポート | クロスプラットフォーム - Perl が動作するすべての環境 (Linux, macOS, Windows, *BSD) |
| ファイルの識別 | バイナリマジックバイトなし。1列目から始まる «=command» 段落 (=head1, =pod など) によって識別される |
| 関連するソース拡張子 | .pl (スクリプト), .pm (モジュール), .t (テストファイル) |
| 開発者 | Larry Wall および Perl コアチーム (Perl Foundation) |
| ドキュメントの範囲 | Perl エコシステム全体で、モジュールのドキュメント、スクリプトの説明、チュートリアル、FAQ に使用される |
| リリース日 | Perl 5 (1994); POD shipped as Perl's built-in documentation format |
| 最新バージョン | POD as specified by perlpod / perlpodspec, tracking current Perl (Perl 5.40, 2024) |
| オープンスタンダード | はい · ロイヤリティフリー |
| 仕様書 | perldoc.perl.org |
POD の変換
コミュニティ Q&A
ユーザーからの質問まだ質問はありません。POD ファイルについて最初の質問をしてみましょう。