argra****@users*****
argra****@users*****
2012年 12月 22日 (土) 19:58:57 JST
Index: docs/perl/5.10.1/perldoc.pod
diff -u /dev/null docs/perl/5.10.1/perldoc.pod:1.1
--- /dev/null Sat Dec 22 19:58:57 2012
+++ docs/perl/5.10.1/perldoc.pod Sat Dec 22 19:58:56 2012
@@ -0,0 +1,612 @@
+
+=encoding euc-jp
+
+=head1 NAME
+
+=begin original
+
+perldoc - Look up Perl documentation in Pod format.
+
+=end original
+
+perldoc - Pod 形式の Perl 文書の検索
+
+=head1 SYNOPSIS
+
+=begin original
+
+B<perldoc> [B<-h>] [B<-v>] [B<-t>] [B<-u>] [B<-m>] [B<-l>] [B<-F>]
+[B<-i>] [B<-V>] [B<-T>] [B<-r>]
+[B<-dI<destination_file>>]
+[B<-oI<formatname>>]
+[B<-MI<FormatterClassName>>]
+[B<-wI<formatteroption:value>>]
+[B<-n>I<nroff-replacement>]
+[B<-X>]
+[B<-L> I<language_code>]
+PageName|ModuleName|ProgramName
+
+=end original
+
+B<perldoc> [B<-h>] [B<-v>] [B<-t>] [B<-u>] [B<-m>] [B<-l>] [B<-F>]
+[B<-i>] [B<-V>] [B<-T>] [B<-r>]
+[B<-dI<出力先ファイル]
+[B<-oI<フォーマット名>>]
+[B<-MI<フォーマッタクラス名>>]
+[B<-wI<フォーマッタオプション:値>>]
+[B<-n>I<nroff の代替>]
+[B<-X>]
+[B<-L> I<言語コード>]
+ページ名|モジュール名|プログラム名
+
+=begin original
+
+B<perldoc> B<-f> BuiltinFunction
+
+=end original
+
+B<perldoc> B<-f> 組み込み関数
+
+=begin original
+
+B<perldoc> B<-L> it B<-f> BuiltinFunction
+
+=end original
+
+B<perldoc> B<-L> it B<-f> 組み込み関数
+
+=begin original
+
+B<perldoc> B<-q> FAQ Keyword
+
+=end original
+
+B<perldoc> B<-q> FAQ キーワード
+
+=begin original
+
+B<perldoc> B<-L> fr B<-q> FAQ Keyword
+
+=end original
+
+B<perldoc> B<-L> fr B<-q> FAQ キーワード
+
+=begin original
+
+See below for more description of the switches.
+
+=end original
+
+スイッチの詳細については後述します。
+
+=head1 DESCRIPTION
+
+=begin original
+
+I<perldoc> looks up a piece of documentation in .pod format that is embedded
+in the perl installation tree or in a perl script, and displays it via
+C<pod2man | nroff -man | $PAGER>. (In addition, if running under HP-UX,
+C<col -x> will be used.) This is primarily used for the documentation for
+the perl library modules.
+
+=end original
+
+I<perldoc> は perl インストールツリーや perl スクリプトに埋め込まれている
+pod 形式の文書の断片を検索します。
+文書は C<pod2man | nroff -man | $PAGER> を通して表示されます。
+(HP-UX においては これに加えて C<col -x> も使われます。)
+これは perl ライブラリモジュールの文書で一番使われています。
+
+=begin original
+
+Your system may also have man pages installed for those modules, in
+which case you can probably just use the man(1) command.
+
+=end original
+
+多くのシステムではこれらのモジュールの man ページも持っていると
+思われるので、man(1) コマンドを使うこともできるでしょう。
+
+=begin original
+
+If you are looking for a table of contents to the Perl library modules
+documentation, see the L<perltoc> page.
+
+=end original
+
+Perl ライブラリモジュールのコンテンツ一覧を見たいのなら、L<perltoc> を
+参照してください。
+
+=head1 OPTIONS
+
+=over 5
+
+=item B<-h>
+
+=begin original
+
+Prints out a brief B<h>elp message.
+
+=end original
+
+簡単なヘルプメッセージを出力します(B<h>elp)。
+
+=item B<-v>
+
+=begin original
+
+Describes search for the item in detail (B<v>erbosely).
+
+=end original
+
+項目検索の詳細を出力します(B<v>erbosely)。
+
+=item B<-t>
+
+=begin original
+
+Display docs using plain B<t>ext converter, instead of nroff. This may be faster,
+but it probably won't look as nice.
+
+=end original
+
+nroff の代わりにプレーンテキストへのコンバータを使って表示します(B<t>ext)。
+高速にはなりますが、見栄えは落ちるでしょう。
+
+=item B<-u>
+
+=begin original
+
+Skip the real Pod formatting, and just show the raw Pod source (B<U>nformatted)
+
+=end original
+
+Pod の整形を省略して Pod ソースそのものを表示します(B<U>nformatted)。
+
+=item B<-m> I<module>
+
+(B<-m> I<モジュール>)
+
+=begin original
+
+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.
+
+=end original
+
+モジュールの中身全てを表示します。
+コード及び整形前の pod 文書を意味します。
+これは必要とした情報の詳細が文書では説明されていなくてコードを直接
+見たいときに役に立つでしょう; perldoc はファイルを見つけたらその中身を単純に
+出力します。
+
+=item B<-l>
+
+=begin original
+
+Display onB<l>y the file name of the module found.
+
+=end original
+
+モジュールのファイル名のみ(onB<l>y)を表示します。
+
+=item B<-F>
+
+=begin original
+
+Consider arguments as file names; no search in directories will be performed.
+
+=end original
+
+引数をファイル名として処理します。
+ディレクトリの探索は行われません。
+
+=item B<-f> I<perlfunc>
+
+(B<-f> I<perl 関数>)
+
+=begin original
+
+The B<-f> option followed by the name of a perl built in function will
+extract the documentation of this function from L<perlfunc>.
+
+=end original
+
+B<-f> オプションは perl 組み込み関数の名前を受け取り、L<perlfunc> から必要な
+部分のみを表示します。
+
+=begin original
+
+Example:
+
+=end original
+
+例:
+
+ perldoc -f sprintf
+
+=item B<-q> I<perlfaq-search-regexp>
+
+(B<-q> I<perlfaq-検索正規表現>)
+
+=begin original
+
+The B<-q> option takes a regular expression as an argument. It will search
+the B<q>uestion headings in perlfaq[1-9] and print the entries matching
+the regular expression. Example: C<perldoc -q shuffle>
+
+=end original
+
+B<-q> オプションは引数に正規表現を受け取ります。
+それを使って perlfaq[1-9] にある質問(B<q>uestion>)見出しを検索し、
+マッチングした項目を表示します。
+例: C<perldoc -q shuffle>
+
+=item B<-T>
+
+=begin original
+
+This specifies that the output is not to be sent to a pager, but is to
+be sent right to STDOUT.
+
+=end original
+
+出力をページャに送らずに単に STDOUT に送るようにします。
+
+=item B<-d> I<destination-filename>
+
+(B<-d> I<出力先ファイル名>)
+
+=begin original
+
+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:
+C<perldoc -oLaTeX -dtextwrapdocs.tex Text::Wrap>
+
+=end original
+
+出力をページャや STDOUT ではなく指定したファイルに保存するようにします。
+例: C<perldoc -oLaTeX -dtextwrapdocs.tex Text::Wrap>
+
+=item B<-o> I<output-formatname>
+
+(B<-o> I<出力フォーマット名>)
+
+=begin original
+
+This specifies that you want Perldoc to try using a Pod-formatting
+class for the output format that you specify. For example:
+C<-oman>. This is actually just a wrapper around the C<-M> switch;
+using C<-oI<formatname>> just looks for a loadable class by adding
+that format name (with different capitalizations) to the end of
+different classname prefixes.
+
+=end original
+
+Perldoc の出力に指定した pod 形式クラスを使います。
+例: C<-oman>。
+これは実際はちょうど C<-M> スイッチのラッパーです;
+C<-oI<フォーマット名>> はフォーマット名(大文字小文字を変えたものも)を
+いくつかのクラス名接頭辞の終わりに加えた名前のクラスを探します。
+
+=begin original
+
+For example, C<-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.
+
+=end original
+
+例えば、C<-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。
+
+=item B<-M> I<module-name>
+
+(B<-M> I<モジュール名>)
+
+=begin original
+
+This specifies the module that you want to try using for formatting the
+pod. The class must at least provide a C<parse_from_file> method.
+For example: C<perldoc -MPod::Perldoc::ToChecker>.
+
+=end original
+
+pod の整形に使うモジュールを指定します。
+このクラスは少なくとも C<parser_from_file> メソッドを持っている必要が
+あります。
+例: C<perldoc -MPod::Perldoc::ToChecker>。
+
+=begin original
+
+You can specify several classes to try by joining them with commas
+or semicolons, as in C<-MTk::SuperPod;Tk::Pod>.
+
+=end original
+
+コンマやセミコロンで区切って複数のクラスを指定することもできます。
+例: C<-MTk::SuperPod;Tk::Pod>
+
+=item B<-w> I<option:value> or B<-w> I<option>
+
+(B<-w> I<オプション:値> 若しくは B<-w> I<オプション>)
+
+=begin original
+
+This specifies an option to call the formatter B<w>ith. For example,
+C<-w textsize:15> will call
+C<< $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 C<textsize> expects an integer, and you do C<-w textsize:big>,
+expect trouble.)
+
+=end original
+
+フォーマッタの呼び出し時に一緒に(B<w>ith)設定するオプションを指定します。
+例えば C<-w textsize:15> はフォーマッタオブジェクトをフォーマットに
+使う前に C<< $formatter->textsize(15) >> を設定することになります。
+これが有効であるためにはフォーマッタはその様なメソッドを
+提供していなければなりません。
+さらに、指定した値も有効なものでなければなりません。
+(つまり C<textsize> が整数を予期しているのなら C<-w textsize:big> と
+指定してしまってはトラブルの元になるでしょう。)
+
+=begin original
+
+You can use C<-w optionname> (without a value) as shorthand for
+C<-w optionname:I<TRUE>>. This is presumably useful in cases of on/off
+features like: C<-w page_numbering>.
+
+=end original
+
+C<-w optionname:I<TRUE>> の代わりに (値を伴わない) C<-w optionname> を
+使うこともできます。
+これはおそらく C<-w page_numbering> の様に on/off で設定する機能に
+便利でしょう。
+
+=begin original
+
+You can use a "=" instead of the ":", as in: C<-w textsize=15>. This
+might be more (or less) convenient, depending on what shell you use.
+
+=end original
+
+C<-w textsize=15> の様に ":" の代わりに "=" を使うこともできます。
+使っているシェルによっては楽になるかもしれません。
+
+=item B<-X>
+
+=begin original
+
+Use an index if it is present -- the B<-X> option looks for an entry
+whose basename matches the name given on the command line in the file
+C<$Config{archlib}/pod.idx>. The F<pod.idx> file should contain fully
+qualified filenames, one per line.
+
+=end original
+
+インデックスがあればそれを使います -- B<-X> オプションはベース名が
+ファイル C<$Config{archlib}/pod.idx> の中でコマンド上に与えられている
+名前にマッチするエントリを探します。
+F<pod.idx> ファイルは各行に完全なファイル名を含んでいるべきです。
+
+=item B<-L> I<language_code>
+
+=begin original
+
+This allows to specify the I<language code> for desired language translation.
+If C<POD2::E<lt>language_codeE<gt>> 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 C<POD2::>
+namespace. See L<POD2::IT> (or L<POD2::FR>) in order to see how to create and
+integrate new localized C<POD2::*> pod documentation packages in
+L<Pod::Perldoc>.
+
+=end original
+
+これは言語翻訳のための I<言語コード> を指定できるようにします。
+C<POD2::E<lt>言語コードE<gt>> パッケージが存在しない (あるいはシステムに
+インストールされていない)なら、スイッチは無視されます。
+全ての利用可能な翻訳パッケージは C<POD2::> 名前空間に見付かるはずです。
+新しく地域化された C<POD2::*> pod 文書を作成して L<Pod::Perldoc> に
+統合する方法については L<POD2::IT> (または L<POD2::FR>) を参照してください。
+
+=item B<PageName|ModuleName|ProgramName>
+
+(B<ページ名|モジュール名|プログラム名>)
+
+=begin original
+
+The item you want to look up. Nested modules (such as C<File::Basename>)
+are specified either as C<File::Basename> or C<File/Basename>. You may also
+give a descriptive name of a page, such as C<perlfunc>.
+
+=end original
+
+検索するものを指定します。
+(C<File::Basename> のような) ネストしたモジュールは C<File::Basename> または
+C<FIle/Basename> のように指定します。
+C<perlfunc> のようにページ名を与えることもできます。
+
+=item B<-n> I<some-formatter>
+
+(B<-n> I<nroffの代替>)
+
+=begin original
+
+Specify replacement for nroff
+
+=end original
+
+nroff の代わりに使うプログラムを指定します。
+
+=item B<-r>
+
+=begin original
+
+Recursive search.
+
+=end original
+
+再帰探索を行います。
+
+=item B<-i>
+
+=begin original
+
+Ignore case.
+
+=end original
+
+大文字小文字を無視します。
+
+=item B<-V>
+
+=begin original
+
+Displays the version of perldoc you're running.
+
+=end original
+
+実行している perldoc のバージョンを表示します。
+
+=back
+
+=head1 SECURITY
+
+(セキュリティ)
+
+=begin original
+
+Because B<perldoc> does not run properly tainted, and is known to
+have security issues, when run as the superuser it will attempt to
+drop privileges by setting the effective and real IDs to nobody's
+or nouser's account, or -2 if unavailable. If it cannot relinquish
+its privileges, it will not run.
+
+=end original
+
+B<perldoc> は汚染(tainted)で実行されないため、そしてセキュリティ上の議論が
+あるためにスーパーユーザとして実行されたときには実効及び実 ID を nobody
+もしくは nouser アカウント、それらが有効でなければ -2 に設定することで
+権限を解除しようとします。
+権限を解除できなかったときには実行されません。
+
+=head1 ENVIRONMENT
+
+=begin original
+
+Any switches in the C<PERLDOC> environment variable will be used before the
+command line arguments.
+
+=end original
+
+C<PERLDOC> 環境変数に設定されているスイッチはコマンドライン引数より
+先に評価されます。
+
+=begin original
+
+Useful values for C<PERLDOC> include C<-oman>, C<-otext>, C<-otk>, C<-ortf>,
+C<-oxml>, and so on, depending on what modules you have on hand; or
+exactly specify the formatter class with C<-MPod::Perldoc::ToMan>
+or the like.
+
+=end original
+
+C<PERLDOC> に適した値にはどんなモジュールを持っているかによって C<-oman>,
+C<-otext>, C<-otk>, C<-ortf>, C<-oxml> の類が、また好みの
+フォーマッタクラスの指定 C<-MPod::Perldoc::ToMan> 等に便利でしょう。
+
+=begin original
+
+C<perldoc> also searches directories
+specified by the C<PERL5LIB> (or C<PERLLIB> if C<PERL5LIB> is not
+defined) and C<PATH> environment variables.
+(The latter is so that embedded pods for executables, such as
+C<perldoc> itself, are available.)
+
+=end original
+
+C<perldoc> は C<PERL5LIB> (もしくは C<PERL5LIB> が定義されていなければ
+C<PERLLIB> ) 及び C<PATH> 環境変数を検索します。
+(後者は C<perldoc> 自身のように実行形式に埋め込まれている pod に有効です。)
+
+=begin original
+
+C<perldoc> will use, in order of preference, the pager defined in
+C<PERLDOC_PAGER>, C<MANPAGER>, or C<PAGER> before trying to find a pager
+on its own. (C<MANPAGER> is not used if C<perldoc> was told to display
+plain text or unformatted pod.)
+
+=end original
+
+C<perldoc> は持っているページャを探す前に好みに応じて C<PERLDOC_PAGER>,
+C<MANPAGER>, C<PAGER> に定義されているページャを使います。
+(C<perldoc> にプレインテキストや未整形 pod の表示を指定されているときには
+C<MANPAGER> は使われません。)
+
+=begin original
+
+One useful value for C<PERLDOC_PAGER> is C<less -+C -E>.
+
+=end original
+
+C<PERLDOC_PAGER> に便利な値には C<less -+C -E> があるでしょう。
+
+=begin original
+
+Having PERLDOCDEBUG set to a positive integer will make perldoc emit
+even more descriptive output than the C<-v> switch does -- the higher the
+number, the more it emits.
+
+=end original
+
+PERLDOCDEBUG に正の整数を与えることで perldoc に C<-v> スイッチよりさらに
+詳細な出力を行わせることができます。
+
+=head1 SEE ALSO
+
+L<perlpod>, L<Pod::Perldoc>
+
+=head1 AUTHOR
+
+=begin original
+
+Current maintainer: Sean M. Burke, <sburk****@cpan*****>
+
+=end original
+
+現在のメンテナ: Sean M. Burke, <sburk****@cpan*****>
+
+=begin original
+
+Past contributors are:
+Kenneth Albanowski <kjahd****@kjahd*****>,
+Andy Dougherty <dough****@lafco*****>,
+and many others.
+
+=end original
+
+これまでの貢献者:
+Kenneth Albanowski <kjahd****@kjahd*****>,
+Andy Dougherty <dough****@lafco*****>,
+そして多くの方々。
+
+=begin meta
+
+Translate: 山科 氷魚 (YAMASHINA Hio) <hio****@hio*****> (5.8.1)
+Update: SHIRAKATA Kentaro <argra****@ub32*****> (5.10.1)
+Status: completed
+
+=end meta
+
+=cut
+