diff options
| author | fukachan <fukachan> | 2001-05-28 16:17:12 +0000 |
|---|---|---|
| committer | fukachan <fukachan> | 2001-05-28 16:17:12 +0000 |
| commit | 2b66d7580815f48c1bd7fb9ff50834a94e957dd9 (patch) | |
| tree | 226cd212fe15dccdccd3e552b8260e00bcd059dc /fml/lib/File/Rotate.pm | |
| parent | 44f5a673de6ec6dd6eef85ed9f523ca7b181146d (diff) | |
| download | fml8-2b66d7580815f48c1bd7fb9ff50834a94e957dd9.tar.gz fml8-2b66d7580815f48c1bd7fb9ff50834a94e957dd9.tar.bz2 fml8-2b66d7580815f48c1bd7fb9ff50834a94e957dd9.zip | |
clean up documents
Diffstat (limited to 'fml/lib/File/Rotate.pm')
| -rw-r--r-- | fml/lib/File/Rotate.pm | 18 |
1 files changed, 15 insertions, 3 deletions
diff --git a/fml/lib/File/Rotate.pm b/fml/lib/File/Rotate.pm index c7a243c9..d44b6646 100644 --- a/fml/lib/File/Rotate.pm +++ b/fml/lib/File/Rotate.pm @@ -4,8 +4,7 @@ # All rights reserved. This program is free software; you can # redistribute it and/or modify it under the same terms as Perl itself. # -# $Id$ -# $FML$ +# $FML: Rotate.pm,v 1.5 2001/04/03 09:31:27 fukachan Exp $ # package File::Rotate; @@ -18,7 +17,7 @@ END {} =head1 NAME -File::Rotate - file rotate operations +File::Rotate - file rotatation utilities =head1 SYNOPSIS @@ -31,6 +30,7 @@ File::Rotate - file rotate operations =head1 DESCRIPTION Utility functions for file rotate operations. +It turns over the given C<file>. C<rotation> renames and rearranges files like this: rm file.4 @@ -40,8 +40,20 @@ C<rotation> renames and rearranges files like this: mv file.0 file.1 mv file file.0 +=head1 METHODS + +=head2 C<new($args)> + +ordinary constructor. $args accpets the following parameters. + + parameter default value + ------------------------ + max_size 300*1024 + num_backlog 4 + =cut + # Descriptions: constructor # forward new() request to superclass (IO::File) # Arguments: $class_name $HASH_REFERENCE |