perldoc-クラウドでのオンライン

プログラム：

NAME

perldoc-ポッド形式でPerlドキュメントを検索します。

SYNOPSIS

perldoc [-h] [-D] [-t] [-u] [-m] [-l] [-F]
[-i] [-V] [-T] [-r]
[-d 宛先ファイル]
[-o フォーマット名]
[-M フォーマッタクラス名]
[-w formatteroption：value]
[-nnroff-置換]
[-NS]
[-L 言語コード]
PageName | ModuleName | ProgramName | URL

例：

perldoc -f 組み込み関数

perldoc -L it -f BuiltinFunction

perldoc-qFAQキーワード

perldoc -L fr-qFAQキーワード

perldoc -v Perl変数

perldoc -PerlAPI

スイッチの詳細については、以下を参照してください。

DESCRIPTION

perldoc Perlに埋め込まれている.pod形式のドキュメントを検索します
インストールツリーまたはperlスクリプトで、「groff -man |$PAGER」を介して表示します。 （の
さらに、HP-UXで実行している場合は、「col -x」が使用されます。）これは、主に
Perlライブラリモジュールのドキュメント。

システムにこれらのモジュールのマニュアルページがインストールされている場合もあります。その場合は、次のことができます。
おそらくただ使用する man（1）コマンド。

Perlライブラリモジュールのドキュメントの目次を探している場合は、を参照してください。
perltocページ。

OPTIONS

-h 簡単な説明を印刷します helpメッセージ。

-D Dでアイテムの検索を記述します detail。

-t プレーンを使用してドキュメントを表示する tnroffの代わりにextコンバーター。 これは速いかもしれませんが、
おそらく見栄えが良くないでしょう。

-u 実際のポッドフォーマットをスキップして、生のポッドソースを表示するだけです（Unformatted）

-m モジュール
モジュール全体を表示します：コードとフォーマットされていないポッドドキュメントの両方。 これは
ドキュメントで必要な詳細な機能が説明されておらず、次のようにしたい場合に便利です。
コードを直接検査します。 perldocがファイルを見つけて、それを渡すだけです
表示用。

-l に表示ly見つかったモジュールのファイル名。

-F 引数をファイル名と見なします。 ディレクトリの検索は実行されません。

-f ペルファンク
この -f オプションの後にperl組み込み関数の名前が続くと、
perlfuncからのこの関数のドキュメント。

例：

perldoc -f sprintf

-q perlfaq-検索-正規表現
この -q オプションは、引数として正規表現を取ります。 検索します q質問
perlfaq [1-9]の見出しを作成し、正規表現に一致するエントリを出力します。

例：

perldoc-qシャッフル

-a ペルラピファンク
この -a オプションの後にperlapi関数の名前が続くと、
perlapiからのこの関数のドキュメント。

例：

perldoc -a newHV

-v パールバー
この -v オプションの後にPerlの事前定義された変数の名前が続くと、
perlvarからのこの変数のドキュメント。

例：

perldoc -v'$ "'
perldoc -v @ +
perldoc-vデータ

-T これは、出力がポケットベルに送信されるのではなく、送信されることを指定します
STDOUTに直接。

-d 宛先ファイル名
これは、出力がポケットベルにもSTDOUTにも送信されないことを指定しますが、
指定したファイル名で保存します。 例： "perldoc -oLaTeX -dtextwrapdocs.tex
テキストの折り返し"

-o 出力フォーマット名
これは、Perldocがポッドフォーマットクラスを使用してみることを指定します。
指定した出力形式。 例：「-oman」。 これは実際にはただの
「-M」スイッチのラッパー。 「-oformatname " ロード可能なクラスを探すだけです
そのフォーマット名（大文字と小文字が異なる）を異なる末尾に追加する
クラス名プレフィックス。

たとえば、「-oLaTeX」は現在、次のすべてのクラスを試行します。
Pod :: Perldoc :: ToLaTeX Pod :: Perldoc :: Tolatex Pod :: Perldoc :: ToLatex
ポッド::Perldoc::ToLATEXポッド::シンプル::LaTeXポッド::シンプル::ラテックスポッド::シンプル::ラテックス
Pod :: Simple::LATEXポッド::LaTeXポッド::latexポッド::Latexポッド::LATEX。

-M モジュール名
これは、ポッドのフォーマットに使用するモジュールを指定します。 The
クラスは、少なくとも「parse_from_file」メソッドを提供する必要があります。 例： "perldoc
-MPod :: Perldoc::ToChecker"。

次のように、コンマまたはセミコロンで結合することにより、試行するいくつかのクラスを指定できます。
「-MTk::SuperPod; Tk::Pod」で。

-w option：value or -w オプション
これは、フォーマッタを呼び出すオプションを指定します wi番目。 たとえば、「-w textsize：15」
「$formatter->」を呼び出します文字サイズ（15）」を使用する前のフォーマッタオブジェクト
オブジェクトをフォーマットします。 これが有効であるためには、フォーマッタクラスはそのようなものを提供する必要があります
メソッド、および渡す値は有効である必要があります。 （したがって、「textsize」が
整数で、「-w textsize：big」を実行すると、問題が発生する可能性があります。）

「-woptionname」（値なし）を「-woptionname」の省略形として使用できます。真実".
これは、「-wpage_numbering」のようなオン/オフ機能の場合におそらく役立ちます。

「-wtextsize=15」のように、「：」の代わりに「=」を使用できます。 これはもっとかもしれません
使用するシェルによっては、（またはそれ以下）便利です。

-X インデックスが存在する場合はそれを使用します。 The -X オプションは、ベース名が
ファイル「$Config{archlib}/pod.idx」のコマンドラインで指定された名前と一致します。
この ポッド.idx ファイルには、完全修飾ファイル名がXNUMX行にXNUMXつずつ含まれている必要があります。

-L language_code
これにより、 言語 コード 希望する言語の翻訳のために。 もしも
「POD2:: 「パッケージがシステムにインストールされていません。スイッチはインストールされています
無視されます。 利用可能なすべての翻訳パッケージは、「POD2::」の下にあります。
名前空間。 新しいローカライズされた「POD2::*」を作成する方法については、POD2 :: IT（またはPOD2 :: FR）を参照してください。
ドキュメントパッケージを作成し、Pod::Perldocに統合します。

PageName | ModuleName | ProgramName | URL
調べたいアイテム。 ネストされたモジュール（「File :: Basename」など）は
「File::Basename」または「File/Basename」のいずれかとして指定されます。 あなたはまた与えるかもしれません
「perlfunc」などのページの説明的な名前。 URLの場合、HTTPとHTTPSは
現在サポートされているのは種類のみです。

'foo'のような単純な名前の場合、通常の検索で一致するページが見つからない場合、
「perl」プレフィックスを使用した検索も試行されます。 したがって、「perldocイントロ」で十分です。
「perlintro.pod」を検索/レンダリングします。

-n いくつかのフォーマッター
groffの代替を指定

-r 再帰検索。

-i 大文字と小文字を区別しない。

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

SECURITY

なぜなら perldoc 適切に汚染されて実行されず、セキュリティの問題があることがわかっている場合
スーパーユーザーとして実行すると、効果的で実際の設定によって特権を削除しようとします
誰のアカウントまたはユーザーのアカウントのID、または使用できない場合は-2。 それが放棄できない場合
特権、それは実行されません。

ENVIRONMENT

「PERLDOC」環境変数のスイッチは、コマンドラインの前に使用されます
引数

「PERLDOC」の有用な値には、「-oterm」、「-otext」、「-ortf」、「-oxml」などがあります。
手元にあるモジュールによって異なります。 または、フォーマッタクラスを指定できます
正確には「-MPod::Perldoc::ToTerm」などを使用します。

「perldoc」は、「PERL5LIB」（または「PERLLIB」の場合は「PERLLIB」）で指定されたディレクトリも検索します。
「PERL5LIB」は定義されていません）および「PATH」環境変数。 （後者はそうです
「perldoc」自体などの実行可能ファイル用の埋め込みポッドが利用可能です。）

「Makefile.PL」または「Build.PL」のいずれかが存在するディレクトリでは、「perldoc」は「。」を追加します。 と
最初に検索パスに「lib」を追加します。スーパーユーザーでない限り、「blib」を追加します。
それも。 これは、ビルドディレクトリ内で作業していて、
以前にインストールされたモジュールのバージョンがある場合でも、ドキュメントを読んでください。

「perldoc」は、「PERLDOC_PAGER」で定義されたページャーを優先順に使用します。
自分でポケットベルを見つけようとする前に、「MANPAGER」または「PAGER」。 （「MANPAGER」は使用されません
「perldoc」がプレーンテキストまたはフォーマットされていないポッドを表示するように指示された場合。）

perldocを「-m」モード（モジュールのソースコードを表示）で使用すると、「perldoc」は試行します
「PERLDOC_SRC_PAGER」で設定されたポケットベルを使用します。 このコマンドの便利な設定は
「/usr/ bin/nano」のようなお気に入りのエディター。 （勝手に決めつけないで。）

「PERLDOC_PAGER」の有用な値のXNUMXつは、「less-+C-E」です。

PERLDOCDEBUGを正の整数に設定すると、perldocはさらに説明的なものを出力します。
「-D」スイッチよりも出力。 数値が大きいほど、放出量が多くなります。

CHANGES

3.14_05まで、スイッチ -v の冗長なメッセージを生成するために使用されました perldoc 操作、
これは現在、 -D.

onworks.netサービスを使用してオンラインでperldocを使用する