oota toshiya
ribbo****@users*****
2006年 4月 25日 (火) 13:26:36 JST
Index: docs/modules/File-Log-1.02/Log.pod
diff -u /dev/null docs/modules/File-Log-1.02/Log.pod:1.1
--- /dev/null Tue Apr 25 13:26:36 2006
+++ docs/modules/File-Log-1.02/Log.pod Tue Apr 25 13:26:36 2006
@@ -0,0 +1,279 @@
+## POD DOCUMENTATION ##
+
+
+=head1 名前
+
+Log - シンプルなオブジェクト指向のログ出力機能
+
+=head1 概要
+
+ use File::Log;
+
+ # 全てのパラメータを含む完全な形式
+ my $log = File::Log->new({
+ debug => 4, # デバッグレベルの設定
+ logFileName => 'myLogFile.log', # ログファイル名の指定
+ logFileMode => '>', # '>>' で追加、 '>' で上書き指定
+ dateTimeStamp => 1, # ログデータエントリに時刻を追加
+ stderrRedirect => 1, # ログファイルにSTDERRをリダイレクト
+ defaultFile => 1, # ログファイルを既定値のファイルハンドルにする
+ logFileDateTime => 1, # ログファイル名にタイムスタンプを付加
+ appName => 'myApplicationName', # アプリケーションの名前
+ PIDstamp => 1, # ログデータにプロセスIDを付加
+ storeExpText => 1, # 内部的な全ての例外テキストを格納
+ });
+
+ # 最小のインスタンス、ログファイル名はアプリケーションベース
+ my $log = File::Log->new();
+
+ # 標準的な使い方、デバッグレベルとログファイル名を指定(configファイルから指定)
+ my $log = Log->new(debug => $debugLevel, logFileName => $logFileName,);
+
+ # debug >= 2 の時にメッセージをログファイルに出力
+ $log->msg(2, "Add this to the log file if debug >= 2 \n");
+
+ # 例外(error)メッセージをログファイルに出力
+ $log->exp("Something went wrong\n");
+
+ # ログファイルをクローズ(終了時のオプション)
+ $log->close();
+
+ # デバッグレベルを変更し、古い値を取得
+ $oldDebugValue = $log->debugValue($newDebugValue);
+
+ $currentDebugValue = $log->debugValue();
+
+ # 全ての例外テキストを取得(そのため、全てのエラーで何か(たとえばメールの発信)ができる)
+ $allExceptions = $log->getExpText();
+
+ $numberErrors = $log->expCnt(); # $log->exp が何回呼ばれたか
+
+=head1 説明
+
+I<Log> は、ファイルにデータをロギングするためのメソッドを提供するクラスである。ログシステムの設定を変更するために、いくつかのパラメータを渡すことができる。
+
+=head1 必要なモジュール
+
+Carp (confess が必要), FindBin と Symbol;
+
+=head1 メソッド
+
+クラスメソッドはなく、以下のオブジェクトメソッドのみである。
+プライベートなクラスメソッドは下線 '_' で始まり、I<Private> として
+扱われる。
+
+=head2 new
+
+I<Log> オブジェクトを生成するために呼ばれる。以下の、オプションの名前が付いた
+パラメータは無名ハッシュ(anonymous hash)を経由してコンストラクタに渡すことが
+できる。
+
+=over 4
+
+=item debug
+
+デバッグレベルを設定するのに使われる。既定値は 9 である。デバッグレベルは
+データがログに書き込まれるか否かを決定する、他のメソッドで使われる。
+C<msg> と C<exp> メソッドを参照のこと。
+
+=item logFileName
+
+ログを書き込むファイルの名前とパス名を定義する。もしも定義されていなければ、
+appNameに'.log'を付加したものが使用される。もしもappNameがコンストラクタ中に
+定義されていなければ、BinFindがアプリケーションの名前を定義するのに使われる。
+
+=item logFileMode
+
+ログファイルを、追加モードか上書きモードかにするかを決めるのに使う。
+既定値は追加である。有効な値は、'>' が上書きモード、'>>'が追加モードである。
+
+=item dateTimeStamp
+
+もしも真ならば(既定値は偽)、C<msg> と C<exp> メソッドにおいて、日付と時刻が
+各々のエントリのデータの前に付加され、ログに書き込まれる。
+
+=item stderrRedirect
+
+もしも真ならば、(既定値は真)、STDERRがログファイルにリダイレクトされる。
+
+=item defaultFile
+
+もしも真ならば(既定値は偽)、選択されたログファイルは既定の出力ファイルになる。
+
+=item logFileDateTime
+
+もしも真ならば(既定値は偽)、ログファイルの、'.log' の前に、日付と時刻が付加
+されたファイル名になる。日付と時刻の形式は、 _YYYYMMDD-HHMMSS である。
+
+=item appName
+
+もしもlogFileNameが未定義ならば、appNameはログファイル名のベースとして使用
+される。もしもappNameが未定義ならば、FindBinモジュールが、アプリケーション
+の名前を決めるのに使われ、appNameハッシュ値に格納される。
+
+=item PIDstamp
+
+もしも真ならば(既定値は偽)、プロセスIDがC<msg> と C<exp> メソッドにおいて、
+ログに書かれるデータの前に付加される。これは、同じログファイルに複数のプロ
+セスが書き込む場合に便利である。
+
+=item storeExpText
+
+もしも真ならば(既定値は偽)、C<exp>メソッドで書かれるデータは、C<getExpText>
+メソッドであとで検索されるために内部に保存される。保存されたデータは、
+C<clearExpText>メソッドで初期化することもできる。これは、もしも、1つの
+テキスト行として(ログファイル中以外に)複数の例外を報告したいという場合に
+便利である。
+
+=back
+
+
+=head2 _init とプライベートメソッド
+
+構成の時にオブジェクトを初期化するI<Private> メソッドである。C<new()> によって
+呼ばれる。全ての I<Private> メソッドは、 B<_> で始まり、 PRIVATE として扱わ
+れる。その他の、プライベートメソッドは文書化されていない(それがプライベートで
+あったとしても)。
+
+=head2 msg
+
+C<msg> メソッドは、ログファイルにログメッセージを書き込むのに使用される。
+C<msg> の最初の B<POSITIONAL> 引数は、"デバッグレベル" で、"デバッグレベル"
+が、インスタンスの"debug level"より等しいか小さい場合、ログファイルにメッセージ
+が追加される。
+
+2番目とその後に続くオプショナルな引数は、ログファイルに出力されるテキストとして
+扱われる。
+
+例. $log->msg(2, "もしも 'debug' が2以上ならば、ログファイルに出力\n");
+
+改行文字は、メソッドによって自動的にB<付加されない>ことにB<注意>。
+
+=head2 exp
+
+C<exp> は例外を報告するのに使われる。これには"デバッグレベル"パラメータはなく、
+ログファイルに出力される、1つまたはそれ以上のテキスト文字列のみである。
+テキストは、各行の先頭に"**" が付加されるタイムスタンプまたはPID値の前に)。
+
+改行文字は、メソッドによって自動的にB<付加されない>ことにB<注意>。
+.
+
+=head2 close
+
+ログファイルのファイルハンドルをクローズする。
+
+=head2 DESTROY
+
+C<DESTROY> は、ログファイルのファイルハンドルをクローズして定義する。
+C<DESTROY> is defined and closes the file handle associated with the log file.
+
+
+=head2 PIDstamp
+
+C<PIDstamp> メソッドは、I<PIDstamp>インスタンス値を取得したり設定するのに
+使われる。もしも、パラメータ無しで呼ばれた場合には、現在のI<PIDstamp>インス
+タンス値が戻る。
+もしも、パラメータ付きで呼ばれた場合、パラメータが、I<PIDstamp>インスタンス値
+に設定され、古い値が戻る。
+
+更なる情報は、C<new>メソッドの情報を参照のこと。
+
+=head2 dateTimeStamp
+
+C<dateTimeStamp> メソッドは、I<dateTimeStamp>インスタンス値を取得したり設定
+するのに使われる。もしも、パラメータ無しで呼ばれた場合には、現在の
+I<dateTimeStamp>インスタンス値が戻る。
+もしも、パラメータ付きで呼ばれた場合、パラメータが、I<dateTimeStamp>インス
+タンス値に設定され、古い値が戻る。
+
+更なる情報は、C<new>メソッドの情報を参照のこと。
+
+
+=head2 debugValue
+
+C<debugValue> メソッドは、I<debugValue>インスタンス値を取得したり設定するのに
+使われる。もしも、パラメータ無しで呼ばれた場合には、現在のI<debugValue>
+インスタンス値が戻る。
+もしも、パラメータ付きで呼ばれた場合、パラメータが、I<debugValue>インスタンス
+値に設定され、古い値が戻る。
+
+更なる情報は、C<new>メソッドの情報を参照のこと。
+
+=head2 expText
+
+C<expText> メソッドは、I<expText>インスタンス値を取得したり設定するのに
+使われる。もしも、パラメータ無しで呼ばれた場合には、現在のI<expText>
+インスタンス値が戻る。
+もしも、パラメータ付きで呼ばれた場合、パラメータが、I<expText>インスタンス
+値に設定され、古い値が戻る。
+
+更なる情報は、C<new>メソッドの情報を参照のこと。
+
+=head2 getExpText
+
+C<expText> メソッドは、"Exception Text"インスタンスの値として格納された
+値を検索するのに使われる。
+
+=head2 clearExpText
+
+C<clearExpText> メソッドは、"Exception Text"インスタンスの値として格納さ
+れた、値を消去するのに使われる。
+
+=head2 expCnt
+
+C<expCnt> メソッドは、このオブジェクトのために呼ばれた exp メソッドの回数
+を検索するのに使われる。
+
+=head2 getFileName
+
+C<getFileName> は、このオブジェクトのために使われた真のログファイル名を
+検索するのに使われる。
+
+=head1 プロパティ
+
+C<new> メソッドを参照のこと。
+
+=head1 既知の問題
+
+特にない。しかし、もしも何か問題を発見したら、gng****@cpan***** に
+連絡を下さい。可能な限りすみやかに調べて対応します。
+
+もしも、何らかの拡張について助言があるのであれば、メールを下さい。
+助言を試してみます。
+
+=head1 作者
+
+ Greg George, IT Technology Solutions P/L, Australia
+ Mobile: +61-404-892-159, Email: gng****@cpan*****
+
+=head1 ライセンス
+
+Copyright (c) 1999- Greg George. All rights reserved.
+このプログラムは、フリーソフトウェアである。Perlそれ自身と同じように
+再配布、変更ができる。
+
+=head1 CVS ID
+
+$Id: Log.pod,v 1.1 2006/04/25 04:26:36 ribbon Exp $
+
+=head1 変更履歴
+
+ $Log: Log.pod,v $
+ Revision 1.1 2006/04/25 04:26:36 ribbon
+
+ add First version.
+
+ Revision 1.2 2004/10/08 23:10:14 Greg
+ - Changed new() to allow named argument as well as the anonymous hash reference.
+
+ Revision 1.1.1.1 2004/07/29 11:15:06 Greg
+ - Initial release to CPAN
+
+=head1 翻訳者
+
+ 太田俊哉 <ribbo****@users*****>
+
+=cut
+
+
+#---< End of File >---#