Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
wrote docs
  • Loading branch information
tokuhirom committed Nov 20, 2010
1 parent 519fe32 commit 6694ba8
Show file tree
Hide file tree
Showing 2 changed files with 67 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.mkdn
Expand Up @@ -20,6 +20,36 @@ File::Stamped - time stamped log file

File::Stamped is utility for time stamped log file.

# METHODS

- my $fh = File::Stamped->new(%args);

This method creates new instance of File::Stamped. The arguments are followings.



- pattern : Str

This is file name pattern. It is the pattern for filename. The format is POSIX::strftime(), see also [POSIX](http://search.cpan.org/perldoc?POSIX).

- close_after_write : Bool

Default value is 1.

- iomode: Str

This is IO mode for opening file.

Default value is '>>:utf8'.

- autoflush: Bool

This attribute changes $|.

- $fh->print($str: Str)

This method prints the $str to the file.

# AUTHOR

Tokuhiro Matsuno <tokuhirom AAJKLFJEF GMAIL COM>
Expand Down
37 changes: 37 additions & 0 deletions lib/File/Stamped.pm
Expand Up @@ -98,6 +98,43 @@ File::Stamped - time stamped log file
File::Stamped is utility for time stamped log file.
=head1 METHODS
=over 4
=item my $fh = File::Stamped->new(%args);
This method creates new instance of File::Stamped. The arguments are followings.
=over 4
=item pattern : Str
This is file name pattern. It is the pattern for filename. The format is POSIX::strftime(), see also L<POSIX>.
=item close_after_write : Bool
Default value is 1.
=item iomode: Str
This is IO mode for opening file.
Default value is '>>:utf8'.
=item autoflush: Bool
This attribute changes $|.
=back
=item $fh->print($str: Str)
This method prints the $str to the file.
=back
=head1 AUTHOR
Tokuhiro Matsuno E<lt>tokuhirom AAJKLFJEF GMAIL COME<gt>
Expand Down

0 comments on commit 6694ba8

Please sign in to comment.