perldoc - Pod 形式の Perl 文書の検索
perldoc [-h] [-v] [-t] [-u] [-m] [-l] [-F] [-i] [-V] [-T] [-r] [-d出力先ファイル] [-oフォーマット名] [-Mフォーマッタクラス名] [-wフォーマッタオプション:値] [-nnroff の代替] [-X] [-L 言語コード] ページ名|モジュール名|プログラム名
perldoc -f 組み込み関数
perldoc -L it -f 組み込み関数
perldoc -q FAQ キーワード
perldoc -L fr -q FAQ キーワード
スイッチの詳細については後述します。
perldoc は perl インストールツリーや perl スクリプトに埋め込まれている
pod 形式の文書の断片を検索します。
文書は pod2man | nroff -man | $PAGER を通して表示されます。
(HP-UX においては これに加えて col -x も使われます。)
これは perl ライブラリモジュールの文書で一番使われています。
多くのシステムではこれらのモジュールの man ページも持っていると 思われるので、man(1) コマンドを使うこともできるでしょう。
Perl ライブラリモジュールのコンテンツ一覧を見たいのなら、perltoc を 参照してください。
簡単なヘルプメッセージを出力します(help)。
項目検索の詳細を出力します(verbosely)。
nroff の代わりにプレーンテキストへのコンバータを使って表示します(text)。 高速にはなりますが、見栄えは落ちるでしょう。
Pod の整形を省略して Pod ソースそのものを表示します(Unformatted)。
モジュールの中身全てを表示します。 コード及び整形前の pod 文書を意味します。 これは必要とした情報の詳細が文書では説明されていなくてコードを直接 見たいときに役に立つでしょう; perldoc はファイルを見つけたらその中身を単純に 出力します。
モジュールのファイル名のみ(only)を表示します。
引数をファイル名として処理します。 ディレクトリの探索は行われません。
-f オプションは perl 組み込み関数の名前を受け取り、perlfunc から必要な 部分のみを表示します。
例:
perldoc -f sprintf
-q オプションは引数に正規表現を受け取ります。
それを使って perlfaq[1-9] にある質問(question>)見出しを検索し、
マッチングした項目を表示します。
例: perldoc -q shuffle
出力をページャに送らずに単に STDOUT に送るようにします。
出力をページャや STDOUT ではなく指定したファイルに保存するようにします。
例: perldoc -oLaTeX -dtextwrapdocs.tex Text::Wrap
Perldoc の出力に指定した pod 形式クラスを使います。
例: -oman。
これは実際はちょうど -M スイッチのラッパーです;
-oフォーマット名 はフォーマット名(大文字小文字を変えたものも)を
いくつかのクラス名接頭辞の終わりに加えた名前のクラスを探します。
例えば、-oLaTeX は次のクラスを全て試みます:
Pod::Perldoc::ToLaTeX Pod::Perldoc::Tolatex Pod::Perldoc::ToLatex
Pod::Perldoc::ToLATEX Pod::Simple::LaTeX Pod::Simple::latex
Pod::Simple::Latex Pod::Simple::LATEX Pod::LaTeX Pod::latex Pod::Latex
Pod::LATEX。
pod の整形に使うモジュールを指定します。
このクラスは少なくとも parser_from_file メソッドを持っている必要が
あります。
例: perldoc -MPod::Perldoc::ToChecker。
コンマやセミコロンで区切って複数のクラスを指定することもできます。
例: -MTk::SuperPod;Tk::Pod
フォーマッタの呼び出し時に一緒に(with)設定するオプションを指定します。
例えば -w textsize:15 はフォーマッタオブジェクトをフォーマットに
使う前に $formatter->textsize(15) を設定することになります。
これが有効であるためにはフォーマッタはその様なメソッドを
提供していなければなりません。
さらに、指定した値も有効なものでなければなりません。
(つまり textsize が整数を予期しているのなら -w textsize:big と
指定してしまってはトラブルの元になるでしょう。)
-w optionname:TRUE の代わりに (値を伴わない) -w optionname を
使うこともできます。
これはおそらく -w page_numbering の様に on/off で設定する機能に
便利でしょう。
-w textsize=15 の様に ":" の代わりに "=" を使うこともできます。
使っているシェルによっては楽になるかもしれません。
インデックスがあればそれを使います -- -X オプションはベース名が
ファイル $Config{archlib}/pod.idx の中でコマンド上に与えられている
名前にマッチするエントリを探します。
pod.idx ファイルは各行に完全なファイル名を含んでいるべきです。
これは言語翻訳のための 言語コード を指定できるようにします。
POD2::<言語コード> パッケージが存在しない (あるいはシステムに
インストールされていない)なら、スイッチは無視されます。
全ての利用可能な翻訳パッケージは POD2:: 名前空間に見付かるはずです。
新しく地域化された POD2::* pod 文書を作成して Pod::Perldoc に
統合する方法については POD2::IT (または POD2::FR) を参照してください。
検索するものを指定します。
(File::Basename のような) ネストしたモジュールは File::Basename または
FIle/Basename のように指定します。
perlfunc のようにページ名を与えることもできます。
nroff の代わりに使うプログラムを指定します。
再帰探索を行います。
大文字小文字を無視します。
実行している perldoc のバージョンを表示します。
perldoc は汚染(tainted)で実行されないため、そしてセキュリティ上の議論が あるためにスーパーユーザとして実行されたときには実効及び実 ID を nobody もしくは nouser アカウント、それらが有効でなければ -2 に設定することで 権限を解除しようとします。 権限を解除できなかったときには実行されません。
PERLDOC 環境変数に設定されているスイッチはコマンドライン引数より
先に評価されます。
PERLDOC に適した値にはどんなモジュールを持っているかによって -oman,
-otext, -otk, -ortf, -oxml の類が、また好みの
フォーマッタクラスの指定 -MPod::Perldoc::ToMan 等に便利でしょう。
perldoc は PERL5LIB (もしくは PERL5LIB が定義されていなければ
PERLLIB ) 及び PATH 環境変数を検索します。
(後者は perldoc 自身のように実行形式に埋め込まれている pod に有効です。)
perldoc は持っているページャを探す前に好みに応じて PERLDOC_PAGER,
MANPAGER, PAGER に定義されているページャを使います。
(perldoc にプレインテキストや未整形 pod の表示を指定されているときには
MANPAGER は使われません。)
PERLDOC_PAGER に便利な値には less -+C -E があるでしょう。
PERLDOCDEBUG に正の整数を与えることで perldoc に -v スイッチよりさらに
詳細な出力を行わせることができます。
perlpod, Pod::Perldoc
現在のメンテナ: Sean M. Burke, <sburke@cpan.org>
これまでの貢献者: Kenneth Albanowski <kjahds@kjahds.com>, Andy Dougherty <doughera@lafcol.lafayette.edu>, そして多くの方々。