README.md
1# NAME
2
3File::ChangeNotify - Watch for changes to files, cross-platform style
4
5# VERSION
6
7version 0.31
8
9# SYNOPSIS
10
11 use File::ChangeNotify;
12
13 my $watcher =
14 File::ChangeNotify->instantiate_watcher
15 ( directories => [ '/my/path', '/my/other' ],
16 filter => qr/\.(?:pm|conf|yml)$/,
17 );
18
19 if ( my @events = $watcher->new_events ) { ... }
20
21 # blocking
22 while ( my @events = $watcher->wait_for_events ) { ... }
23
24# DESCRIPTION
25
26This module provides an API for creating a
27[File::ChangeNotify::Watcher](https://metacpan.org/pod/File::ChangeNotify::Watcher) subclass that will work on your
28platform.
29
30Most of the documentation for this distro is in
31[File::ChangeNotify::Watcher](https://metacpan.org/pod/File::ChangeNotify::Watcher).
32
33# METHODS
34
35This class provides the following methods:
36
37## File::ChangeNotify->instantiate\_watcher(...)
38
39This method looks at each available subclass of
40[File::ChangeNotify::Watcher](https://metacpan.org/pod/File::ChangeNotify::Watcher) and instantiates the first one it can
41load, using the arguments you provided.
42
43It always tries to use the [File::ChangeNotify::Watcher::Default](https://metacpan.org/pod/File::ChangeNotify::Watcher::Default)
44class last, on the assumption that any other class that is available
45is a better option.
46
47## File::ChangeNotify->usable\_classes
48
49Returns a list of all the loadable [File::ChangeNotify::Watcher](https://metacpan.org/pod/File::ChangeNotify::Watcher) subclasses
50except for [File::ChangeNotify::Watcher::Default](https://metacpan.org/pod/File::ChangeNotify::Watcher::Default), which is always usable.
51
52# SUPPORT
53
54Bugs may be submitted at [http://rt.cpan.org/Public/Dist/Display.html?Name=File-ChangeNotify](http://rt.cpan.org/Public/Dist/Display.html?Name=File-ChangeNotify) or via email to [bug-file-changenotify@rt.cpan.org](mailto:bug-file-changenotify@rt.cpan.org).
55
56I am also usually active on IRC as 'autarch' on `irc://irc.perl.org`.
57
58# SOURCE
59
60The source code repository for File-ChangeNotify can be found at [https://github.com/houseabsolute/File-ChangeNotify](https://github.com/houseabsolute/File-ChangeNotify).
61
62# DONATIONS
63
64If you'd like to thank me for the work I've done on this module, please
65consider making a "donation" to me via PayPal. I spend a lot of free time
66creating free software, and would appreciate any support you'd care to offer.
67
68Please note that **I am not suggesting that you must do this** in order for me
69to continue working on this particular software. I will continue to do so,
70inasmuch as I have in the past, for as long as it interests me.
71
72Similarly, a donation made in this way will probably not make me work on this
73software much more, unless I get so many donations that I can consider working
74on free software full time (let's all have a chuckle at that together).
75
76To donate, log into PayPal and send money to autarch@urth.org, or use the
77button at [http://www.urth.org/~autarch/fs-donation.html](http://www.urth.org/~autarch/fs-donation.html).
78
79# AUTHOR
80
81Dave Rolsky <autarch@urth.org>
82
83# CONTRIBUTORS
84
85- Aaron Crane <arc@cpan.org>
86- H. Merijn Branch <h.m.brand@xs4all.nl>
87- Karen Etheridge <ether@cpan.org>
88
89# COPYRIGHT AND LICENSE
90
91This software is Copyright (c) 2009 - 2019 by Dave Rolsky.
92
93This is free software, licensed under:
94
95 The Artistic License 2.0 (GPL Compatible)
96
97The full text of the license can be found in the
98`LICENSE` file included with this distribution.
99