PERLPOD(1)               USER COMMANDS                 PERLPOD(1)



NAME
     pod - プレイン旧ドキュメント

DESCRIPTION
     Pod からなにがしへのトランスレータは、pod ファイルを段落ごと
     に読み込み、適切な出力フォーマットに変換します。　段落には、
     3 つの種類があります:

     +   インデントが付けられている (つまりスペースやタブで始まる)
         ことで示される verbatim 段落。　タブは 8 カラムごととし
         て、そのまま出力されます。　フォーマットのための特別なエ
         スケープはなく、イタリックにしたりすることはできません。
         \ は \ であり、他の何物でもありません。

     +   コマンド。　すべてのコマンド段落は "=" で始まり、識別子
         が続き、コマンドが使用する任意のテキストが続きます。　現
         在、認識されるコマンドは

             =head1 heading
             =head2 heading
             =item text
             =over N
             =back

         です。


     +   通常のテキストブロック。　行組みがなされ、さらにどこかに
         揃えられるかもしれません。　ある内部シーケンスがこことコ
         マンドで認識されます:

             I<text>     text のイタリック化、強調と変数に用いる
             B<text>     text のボールド化、スイッチとプログラムに用いる
             S<text>     分割できないスペースを含む text
             C<code>     リテラルのコード
             L<name>     name へのリンク (クロスリファレンス)
                             L<name>             manpage
                             L<name/ident>       manpage の項目
                             L<name/"sec">       他の manpage の節
                             L<"sec">            現在の manpage の節
                                                 (引用符は付けなくてもよい)
             F<file>     ファイル名に用いる
             Z<>         幅なしの文字

         これだけです。　簡単なものを目指しているので、強力なもの
         ではありません。　段落は段落らしく (矩形に) 見えて欲しい
         ので、見た目に目立ち、fmt で簡単に再整形できるようになっ
         ています (私の vi では、F7 になっています)。　欲しかった
         のは、埋め込まれるテキストの中の " や ' が左のクォートか、
         右のクォートかを (私の代わりに) 気遣ってくれるトランスレ
         ータで、verbatim モードでは、クォートをそのままにしてお
         いて欲しかったのです。　そうすれば、作りかけのプログラム



Perl manpages Last change: Release 5.0 Patchlevel 00            1






PERLPOD(1)               USER COMMANDS                 PERLPOD(1)



         を放り込んで、4 カラムずらして、印刷すればいい、verbatim
         で。　たぶん、一定幅のフォントで。

         特に、以下のようなものは、テキスト中にそのままにしておく
         ことができます:

             Perl
             FILEHANDLE
             $variable
             function()
             manpage(3r)

         そのうちに、別のコマンドやシーケンスを、付け足さなければ
         ならなくなることは、疑いようのないことですが、これまでの
         ところ、私は意外にもこれだけでやってきたのです。

         これが、本を作るのに十分だ、などと言うつもりは、全くあり
         ません。　ただ、オンラインドキュメントに使う、nroff や
         Tex などのマークアップ言語のための、誰にでも使える共通の
         ソースを作ろうとしています。　pod2html と pod2man という
         トランスレータがあります。

AUTHOR
     Larry Wall































Perl manpages Last change: Release 5.0 Patchlevel 00            2