local-lib5/man/man3/File::ChangeNotify.3pm

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "File::ChangeNotify 3"
 132 .TH File::ChangeNotify 3 "2009-12-07" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 File::ChangeNotify \- Watch for changes to files, cross\-platform style
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 1
 138 \&    use File::ChangeNotify;
 139 .Ve
 140 .PP
 141 .Vb 5
 142 \&    my $watcher =
 143 \&        File::ChangeNotify\->instantiate_watcher
 144 \&            ( directories => [ '/my/path', '/my/other' ],
 145 \&              filter      => qr/\e.(?:pm|conf|yml)$/,
 146 \&            );
 147 .Ve
 148 .PP
 149 .Vb 1
 150 \&    if ( my @events = $watcher\->new_events() ) { ... }
 151 .Ve
 152 .PP
 153 .Vb 2
 154 \&    # blocking
 155 \&    while ( my @events = $watcher\->wait_for_events() ) { ... }
 156 .Ve
 157 .SH "DESCRIPTION"
 158 .IX Header "DESCRIPTION"
 159 This module provides an \s-1API\s0 for creating a
 160 File::ChangeNotify::Watcher subclass that will work on your
 161 platform.
 162 .PP
 163 Most of the documentation for this distro is in
 164 File::ChangeNotify::Watcher.
 165 .SH "METHODS"
 166 .IX Header "METHODS"
 167 This class provides the following methods:
 168 .Sh "File::ChangeNotify\->instantiate_watcher(...)"
 169 .IX Subsection "File::ChangeNotify->instantiate_watcher(...)"
 170 This method looks at each available subclass of
 171 File::ChangeNotify::Watcher and instantiates the first one it can
 172 load, using the arguments you provided.
 173 .PP
 174 It always tries to use the File::ChangeNotify::Watcher::Default
 175 class last, on the assumption that any other class that is available
 176 is a better option.
 177 .Sh "File::ChangeNotify\->\fIusable_classes()\fP"
 178 .IX Subsection "File::ChangeNotify->usable_classes()"
 179 Returns a list of all the loadable File::ChangeNotify::Watcher
 180 subclasses.
 181 .SH "DONATIONS"
 182 .IX Header "DONATIONS"
 183 If you'd like to thank me for the work I've done on this module,
 184 please consider making a \*(L"donation\*(R" to me via PayPal. I spend a lot of
 185 free time creating free software, and would appreciate any support
 186 you'd care to offer.
 187 .PP
 188 Please note that \fBI am not suggesting that you must do this\fR in order
 189 for me to continue working on this particular software. I will
 190 continue to do so, inasmuch as I have in the past, for as long as it
 191 interests me.
 192 .PP
 193 Similarly, a donation made in this way will probably not make me work
 194 on this software much more, unless I get so many donations that I can
 195 consider working on free software full time, which seems unlikely at
 196 best.
 197 .PP
 198 To donate, log into PayPal and send money to autarch@urth.org or use
 199 the button on this page:
 200 <http://www.urth.org/~autarch/fs\-donation.html>
 201 .SH "AUTHOR"
 202 .IX Header "AUTHOR"
 203 Dave Rolsky, <autarch@urth.org>
 204 .SH "BUGS"
 205 .IX Header "BUGS"
 206 Please report any bugs or feature requests to
 207 \&\f(CW\*(C`bug\-file\-changenotify@rt.cpan.org\*(C'\fR, or through the web interface at
 208 <http://rt.cpan.org>.  I will be notified, and then you'll
 209 automatically be notified of progress on your bug as I make changes.
 210 .SH "COPYRIGHT & LICENSE"
 211 .IX Header "COPYRIGHT & LICENSE"
 212 Copyright 2009 Dave Rolsky, All Rights Reserved.
 213 .PP
 214 This program is free software; you can redistribute it and/or modify
 215 it under the same terms as Perl itself.