名前¶

perldoc - Pod 形式の Perl 文書の検索

概要¶

perldoc [-h] [-D] [-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 -v Perl 変数

スイッチの詳細については後述します。

説明¶

perldoc は perl インストールツリーや perl スクリプトに埋め込まれている pod 形式の文書の断片を検索します。 文書は pod2man | nroff -man | $PAGER を通して表示されます。 (HP-UX においては これに加えて col -x も使われます。) これは perl ライブラリモジュールの文書で一番使われています。

多くのシステムではこれらのモジュールの man ページも持っていると 思われるので、man(1) コマンドを使うこともできるでしょう。

Perl ライブラリモジュールのコンテンツ一覧を見たいのなら、perltoc を 参照してください。

オプション¶

-h

Prints out a brief help message.

簡単なヘルプメッセージを出力します(help)。

-D

Describes search for the item in detail.

項目の詳細 (detail) を記述 (Describe) します。

-t

Display docs using plain text converter, instead of nroff. This may be faster, but it probably won't look as nice.

nroff の代わりにプレーンテキストへのコンバータを使って表示します(text)。 高速にはなりますが、見栄えは落ちるでしょう。

-u

Skip the real Pod formatting, and just show the raw Pod source (Unformatted)

Pod の整形を省略して Pod ソースそのものを表示します(Unformatted)。

-m module

(-m モジュール)

Display the entire module: both code and unformatted pod documentation. This may be useful if the docs don't explain a function in the detail you need, and you'd like to inspect the code directly; perldoc will find the file for you and simply hand it off for display.

モジュールの中身全てを表示します。 コード及び整形前の pod 文書を意味します。 これは必要とした情報の詳細が文書では説明されていなくてコードを直接 見たいときに役に立つでしょう; perldoc はファイルを見つけたらその中身を単純に 出力します。

-l

Display only the file name of the module found.

モジュールのファイル名のみ(only)を表示します。

-F

Consider arguments as file names; no search in directories will be performed.

引数をファイル名として処理します。 ディレクトリの探索は行われません。

-f perlfunc

(-f perl 関数)

The -f option followed by the name of a perl built in function will extract the documentation of this function from perlfunc.

-f オプションは perl 組み込み関数の名前を受け取り、perlfunc から必要な 部分のみを表示します。

Example:

例:

      perldoc -f sprintf

-q perlfaq-search-regexp

(-q perlfaq-検索正規表現)

The -q option takes a regular expression as an argument. It will search the question headings in perlfaq[1-9] and print the entries matching the regular expression.

-q オプションは引数に正規表現を受け取ります。 それを使って perlfaq[1-9] にある質問(question>)見出しを検索し、 マッチングした項目を表示します。

Example:

例:

     perldoc -q shuffle

-v perlvar

(-v perl 変数)

The -v option followed by the name of a Perl predefined variable will extract the documentation of this variable from perlvar.

-v オプションに引き続いて Perl の定義済み変数名を指定すると perlvar からこの変数の文書を抽出します。

Examples:

例:

     perldoc -v '$"'
     perldoc -v @+
     perldoc -v DATA

-T

This specifies that the output is not to be sent to a pager, but is to be sent right to STDOUT.

出力をページャに送らずに単に STDOUT に送るようにします。

-d destination-filename

(-d 出力先ファイル名)

This specifies that the output is to be sent neither to a pager nor to STDOUT, but is to be saved to the specified filename. Example: perldoc -oLaTeX -dtextwrapdocs.tex Text::Wrap

出力をページャや STDOUT ではなく指定したファイルに保存するようにします。 例: perldoc -oLaTeX -dtextwrapdocs.tex Text::Wrap

-o output-formatname

(-o 出力フォーマット名)

This specifies that you want Perldoc to try using a Pod-formatting class for the output format that you specify. For example: -oman. This is actually just a wrapper around the -M switch; using -oformatname just looks for a loadable class by adding that format name (with different capitalizations) to the end of different classname prefixes.

Perldoc の出力に指定した pod 形式クラスを使います。 例: -oman。 これは実際はちょうど -M スイッチのラッパーです; -oフォーマット名 はフォーマット名(大文字小文字を変えたものも)を いくつかのクラス名接頭辞の終わりに加えた名前のクラスを探します。

For example, -oLaTeX currently tries all of the following classes: 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.

例えば、-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。

-M module-name

(-M モジュール名)

This specifies the module that you want to try using for formatting the pod. The class must at least provide a parse_from_file method. For example: perldoc -MPod::Perldoc::ToChecker.

pod の整形に使うモジュールを指定します。 このクラスは少なくとも parser_from_file メソッドを持っている必要が あります。 例: perldoc -MPod::Perldoc::ToChecker。

You can specify several classes to try by joining them with commas or semicolons, as in -MTk::SuperPod;Tk::Pod.

コンマやセミコロンで区切って複数のクラスを指定することもできます。 例: -MTk::SuperPod;Tk::Pod

-w option:value or -w option

(-w オプション:値 または -w オプション)

This specifies an option to call the formatter with. For example, -w textsize:15 will call $formatter->textsize(15) on the formatter object before it is used to format the object. For this to be valid, the formatter class must provide such a method, and the value you pass should be valid. (So if textsize expects an integer, and you do -w textsize:big, expect trouble.)

フォーマッタの呼び出し時に一緒に(with)設定するオプションを指定します。 例えば -w textsize:15 はフォーマッタオブジェクトをフォーマットに 使う前に $formatter->textsize(15) を設定することになります。 これが有効であるためにはフォーマッタはその様なメソッドを 提供していなければなりません。 さらに、指定した値も有効なものでなければなりません。 (つまり textsize が整数を予期しているのなら -w textsize:big と 指定してしまってはトラブルの元になるでしょう。)

You can use -w optionname (without a value) as shorthand for -w optionname:TRUE. This is presumably useful in cases of on/off features like: -w page_numbering.

-w optionname:TRUE の代わりに (値を伴わない) -w optionname を 使うこともできます。 これはおそらく -w page_numbering の様に on/off で設定する機能に 便利でしょう。

You can use a "=" instead of the ":", as in: -w textsize=15. This might be more (or less) convenient, depending on what shell you use.

-w textsize=15 の様に ":" の代わりに "=" を使うこともできます。 使っているシェルによっては楽になるかもしれません。

-X

Use an index if it is present. The -X option looks for an entry whose basename matches the name given on the command line in the file $Config{archlib}/pod.idx. The pod.idx file should contain fully qualified filenames, one per line.

インデックスがあればそれを使います。 -X オプションはベース名がファイル $Config{archlib}/pod.idx の中で コマンド上に与えられている名前にマッチするエントリを探します。 pod.idx ファイルは各行に完全なファイル名を含んでいるべきです。

-L language_code

(-L 言語コード)

This allows to specify the language code for desired language translation. If POD2::<language_code> package doesn't exist (or isn't installed in your system), the switch will be ignored. All available translation packages should be found under the POD2:: namespace. See POD2::IT (or POD2::FR) in order to see how to create and integrate new localized POD2::* pod documentation packages in Pod::Perldoc.

これは言語翻訳のための 言語コード を指定できるようにします。 POD2::<言語コード> パッケージが存在しない (あるいはシステムに インストールされていない)なら、スイッチは無視されます。 全ての利用可能な翻訳パッケージは POD2:: 名前空間に見付かるはずです。 新しく地域化された POD2::* pod 文書を作成して Pod::Perldoc に 統合する方法については POD2::IT (または POD2::FR) を参照してください。

PageName|ModuleName|ProgramName

(ページ名|モジュール名|プログラム名)

The item you want to look up. Nested modules (such as File::Basename) are specified either as File::Basename or File/Basename. You may also give a descriptive name of a page, such as perlfunc.

検索するものを指定します。 (File::Basename のような) ネストしたモジュールは File::Basename または FIle/Basename のように指定します。 perlfunc のようにページ名を与えることもできます。

For simple names like 'foo', when the normal search fails to find a matching page, a search with the "perl" prefix is tried as well. So "perldoc intro" is enough to find/render "perlintro.pod".

'foo' の単純な名前について、通常の検索がページにマッチングするのに 失敗したとき、"perl" 接頭辞付きでも検索します。 従って "perldoc intro" とすれば "perlintro.pod" を検索/表示するのに 十分です。

-n some-formatter

(-n nroffの代替)

Specify replacement for nroff

nroff の代わりに使うプログラムを指定します。

-r

Recursive search.

再帰探索を行います。

-i

Ignore case.

大文字小文字を無視します。

-V

Displays the version of perldoc you're running.

実行している perldoc のバージョンを表示します。

セキュリティ¶

perldoc は汚染(tainted)で実行されないため、そしてセキュリティ上の議論が あるためにスーパーユーザとして実行されたときには実効及び実 ID を nobody もしくは nouser アカウント、それらが有効でなければ -2 に設定することで 権限を解除しようとします。 権限を解除できなかったときには実行されません。

ENVIRONMENT¶

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 に -D スイッチよりさらに 詳細な出力を行わせることができます; 数値が大きくなるほど、より多くを 出力します。

変更点¶

3.14_05 まで、-v オプションは perldoc 操作の詳しい表示を生成するために 使われていましたが、今では -D で有効になります。

SEE ALSO¶

perlpod, Pod::Perldoc

作者¶

現在のメンテナ: Adriano R. Ferreira <[email protected]>

これまでの貢献者: Sean M. Burke <[email protected]>, Kenneth Albanowski <[email protected]>, Andy Dougherty <[email protected]>, そして多くの方々。