=pod =cut “=pod”ディレクティブは、次の“=cunt”までコードの解析を中断し、 なにもしないことをコンパイラーに指示します。これはコードとpodを 混ぜたい場合にドキュメントに別の段落を付加えるのに便利です。 =head1 =head2 head1とhead2はそれぞれ第一レベル、第二レベルのヘッダーを、 そのディレクティブと同じ段落にあるテキストを使って生成します。 =over =back =item Item, over, and back require a little more explanation: "=over" starts a section specifically for the generation of a list using "=item" commands. At the end of your list, use "=back" to end it. You will probably want to give "4" as the number to "=over", as some formatters will use this for indentation. The unit of indentation is optional. If the unit is not given the natural indentation of the formatting system applied will be used. Note also that there are some basic rules to using =item: don't use them outside of an =over/=back block, use at least one inside an =over/=back block, you don't _have_ to include the =back if the list just runs off the document, and perhaps most importantly, keep the items consistent: either use "=item *" for all of them, to produce bullets, or use "=item 1.", "=item 2.", etc., to produce numbered lists, or use "=item foo", "=item bar", etc., i.e., things that looks nothing like bullets or numbers. If you start with bullets or numbers, stick with them, as many formatters use the first "=item" type to decide how to format the list. item, over, backにはもうちょっと説明が必要です。“=over”は“=item” コマンドを使ってリストを生成するためのセクションを開始します。 リストの末尾では、セクションを終わらせるために“=back”コマンドを 使います。一部のフォーマッターがインデントに使用している“4”を “=over”に対する数として与えたくなるでしょう。 インデントの数はオプションです。 数が指定されなかった場合、 フォーマットシステムが適用する自然なインデントが用いられます。 =itemを使うに当たり幾つかの基本的なルールが あることに注意してください。=over/=backブロックの外側で使っては いけません。=over/=backブロックの中に最低一つ=itemがあること。 リストが単にドキュメントをrun offするだけなら=backを含める必要はありません。 そして、これが多分最も重要なことですが、アイテムに一貫性を持たせることです。 “=item *”をつかってbulletsを使うか、 “=item 1.”、“=item 2.”…として数字を使うか、 あるいは“=item foo”、“=item bar”のようにどちらでもないものを 使うにしろ、 すべてのアイテムに対して同種のものを使ってください。 bullet なり数字を最初に使ったら、多くのフォーマッターが最初の“=item” タイプをリスト全体に使うようにそれを使いつづけてください。 =for =begin =end for, begin, endはpodテキストとして解釈されることのないセクションを 取り込みます。しかし、これは特定のフォーマッターに直接渡されます。 フォーマッターはそのようなフォーマットのセクションを利用することができます。 あるいは完全に無視することもあるでしょう。“=for” ディレクティブは、それに続く段落全体を“=for”の直後にある 単語によって指定されるフォーマットであることを指定します。例を挙げましょう。 This is a raw HTML paragraph
]]>組となっているコマンド“=begin”と“=end”は“=for”と非常に良く 似ています。しかし、一つの段落に対してのみ適用されるのではなく、 “=begin”と“=end”の間にある段落を、特定のフォーマットで あるように取り扱います。 これを使った例を幾つか挙げましょう。 Figure 1. 
]]>現在使うことのできるフォーマッターの名前は"roff", "man", "latex", "tex", "text", "html"です(一部のフォーマッターは他のものの別名と して扱われます)。 そして忘れないで欲しいことは、これらのコマンドを使った場合、その コマンドが影響するのはコマンドが置かれた行ではなく、 コマンドがある段落の終端までだということです。ですから先の例には、 各コマンドの後ろに段落を終了させるために空行があるのです。 幾つか例を挙げましょう:
コードをタイプライタフォント、または
その他のプログラムテキストを表現する手法で描画します
L nameに対するリンク(クロスリファレンス)
L マニュアルページ
L マニュアルぺージ中のアイテム
L 他のマニュアルページにあるセクション
L<"sec"> 同じマニュアルページのセクション
(クォートは省略可能)
L 同上
上のものと同じだが 'text' だけが出力に使われる
(テキストには '/' も '>'も含めることはできません。同時に
'<'と'>'のバランスがとれていなければなりません)
L
L
L
L
L
]]> E sequence:
E シーケンスを使って
エスケープする方法です:
$a <=> $b"
$a <=> $b" となります。
Pod translators usually will require paragraphs to be separated by completely empty lines. If you have an apparently empty line with some spaces on it, this can cause odd formatting. podトランスレータは、通常は段落の分割に完全な空行を必要とします。 空白の入った見た目空行のようなものを入れると、 出力がおかしくなるかもしれません。 Translators will mostly add wording around a L<> link, so that L<foo(1)>becomes "thefoo (1) manpage", for example (see pod2man for details). Thus, you shouldn't write things likethe L<foo> manpage, if you want the translated document to read sensibly.トランスレータはほとんどの場合 L<> リンクに語の追加を行います。 このため、たとえば L<foo(1)>は“thefoo (1) manpage”と なります(詳しくはpod2manを参照)。 したがって、あなたは変換されたドキュメントを読みやすいものにするために、the L<foo> manpageという書き方はすべきではないのです。If you need total control of the text used for a link in the output use the form L<show this text|foo> instead. あなたがテキストの制御全てを必要としているなら、 出力リンクのためには L<show this text|foo>を使いましょう。 The podchecker command is provided to check pod syntax for errors and warnings. For example, it checks for completely blank lines in pod segments and for unknown escape sequences. It is still advised to pass it through one or more translators and proofread the result, or print out the result and proofread that. Some of the problems found may be bugs in the translators, which you may or may not wish to work around. podchecker コマンドは pod の文法に関するエラーと警告を チェックするために提供されています。 例えば、pod の分割に完全な空行が使われているかや、 不明なエスケープシーケンスなどをチェックします。 それでも一つまたは複数のトランスレータに通して結果をチェックするか、 結果を印刷してそれをチェックすることをお勧めします。 発見した問題の中には、回避しようと思ったり思わなかったりするような トランスレータのバグもあるでしょう。