File: //usr/local/share/man/man3/File::Touch.3
.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. | will give a
.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.\"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Touch 3"
.TH Touch 3 "2009-07-25" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
File::Touch \- update access and modification timestamps, creating nonexistent files where necessary.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\& use File::Touch;
\& @file_list = ('one.txt','../two.doc');
\& $count = touch(@file_list);
.Ve
.PP
.Vb 8
\& use File::Touch;
\& $reference_file = '/etc/passwd';
\& $touch_obj = File::Touch->new(
\& reference => $reference_file,
\& no_create => 1
\& );
\& @file_list = ('one.txt','../two.doc');
\& $count = $touch_obj->touch(@file_list);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Here's a list of arguments that can be used with the object-oriented contruction:
.IP "atime_only => [0|1]" 4
.IX Item "atime_only => [0|1]"
If nonzero, change only the access time of files. Default is zero.
.IP "mtime_only => [0|1]" 4
.IX Item "mtime_only => [0|1]"
If nonzero, change only the modification time of files. Default is zero.
.IP "no_create => [0|1]" 4
.IX Item "no_create => [0|1]"
If nonzero, do not create new files. Default is zero.
.ie n .IP "reference => $reference_file" 4
.el .IP "reference => \f(CW$reference_file\fR" 4
.IX Item "reference => $reference_file"
If defined, use timestamps from this file instead of current time. Default is undefined.
.ie n .IP "atime => $time" 4
.el .IP "atime => \f(CW$time\fR" 4
.IX Item "atime => $time"
If defined, use this time (in epoch seconds) instead of current time for access time.
.ie n .IP "mtime => $time" 4
.el .IP "mtime => \f(CW$time\fR" 4
.IX Item "mtime => $time"
If defined, use this time (in epoch seconds) instead of current time for modification time.
.SH "Examples"
.IX Header "Examples"
.Sh "Update access and modification times, creating nonexistent files"
.IX Subsection "Update access and modification times, creating nonexistent files"
.Vb 4
\& use File::Touch;
\& my @files = ('one','two','three');
\& my $count = touch(@files);
\& print "$count files updated\en";
.Ve
.Sh "Set access time forward, leave modification time unchanged"
.IX Subsection "Set access time forward, leave modification time unchanged"
.Vb 7
\& use File::Touch;
\& my @files = ('one','two','three');
\& my $day = 24*60*60;
\& my $time = time() + 30 * $day;
\& my $ref = File::Touch->new( atime_only => 1, time => $time );
\& my $count = $ref->touch(@files);
\& print "$count files updated\en";
.Ve
.Sh "Set modification time back, update access time, do not create nonexistent files"
.IX Subsection "Set modification time back, update access time, do not create nonexistent files"
.Vb 7
\& use File::Touch;
\& my @files = ('one','two','three');
\& my $day = 24*60*60;
\& my $time = time() - 30 * $day;
\& my $ref = File::Touch->new( mtime => $time, no_create => 1 );
\& my $count = $ref->touch(@files);
\& print "$count files updated\en";
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Nigel Wetters Gourlay (nwetters@cpan.org)
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2001,2007,2009 Nigel Wetters Gourlay. All Rights Reserved.
This module is free software. It may be used, redistributed
and/or modified under the same terms as Perl itself.