File-Flat-1.05

        - distribution tooling updates

5 files changed, 883 insertions, 1 deletions

diff --git a/CONTRIBUTING b/CONTRIBUTING
new file mode 100644
index 0000000..c6f0d1b
--- /dev/null
+++ b/CONTRIBUTING
@@ -0,0 +1,96 @@
+
+CONTRIBUTING
+
+Thank you for considering contributing to this distribution.  This file
+contains instructions that will help you work with the source code.
+
+PLEASE NOTE that if you have any questions or difficulties, you can reach the
+maintainer(s) through the bug queue described later in this document
+(preferred), or by emailing the releaser directly. You are not required to
+follow any of the steps in this document to submit a patch or bug report;
+these are just recommendations, intended to help you (and help us help you
+faster).
+
+The distribution is managed with Dist::Zilla (https://metacpan.org/release/Dist-Zilla).
+This means than many of the usual files you might expect are not in the
+repository, but are generated at release time (e.g. Makefile.PL).
+
+However, you can run tests directly using the 'prove' tool:
+
+  $ prove -l
+  $ prove -lv t/some_test_file.t
+  $ prove -lvr t/
+
+In most cases, 'prove' is entirely sufficient for you to test any patches you
+have.
+
+You may need to satisfy some dependencies.  The easiest way to satisfy
+dependencies is to install the last release -- this is available at
+https://metacpan.org/release/File-Flat
+
+If you use cpanminus, you can do it without downloading the tarball first:
+
+  $ cpanm --reinstall --installdeps --with-recommends File::Flat
+
+Dist::Zilla is a very powerful authoring tool, but requires a number of
+author-specific plugins.  If you would like to use it for contributing,
+install it from CPAN, then run one of the following commands, depending on
+your CPAN client:
+
+  $ cpan `dzil authordeps --missing`
+or
+  $ dzil authordeps --missing | cpanm
+
+You should then also install any additional requirements not needed by the
+dzil build but may be needed by tests or other development:
+
+  $ cpan `dzil listdeps --author --missing`
+or
+  $ dzil listdeps --author --missing | cpanm
+
+Or, you can use the 'dzil stale' command to install all requirements at once:
+
+  $ cpan Dist::Zilla::App::Command::stale
+  $ cpan `dzil stale --all`
+or
+  $ cpanm Dist::Zilla::App::Command::stale
+  $ dzil stale --all | cpanm
+
+You can also do this via cpanm directly:
+
+  $ cpanm --reinstall --installdeps --with-develop --with-recommends File::Flat
+
+Once installed, here are some dzil commands you might try:
+
+  $ dzil build
+  $ dzil test
+  $ dzil test --release
+  $ dzil xtest
+  $ dzil listdeps --json
+  $ dzil build --notgz
+
+You can learn more about Dist::Zilla at http://dzil.org/.
+
+The code for this distribution is hosted at GitHub. The repository is:
+https://github.com/karenetheridge/File-Flat
+You can submit code changes by forking the repository, pushing your code
+changes to your clone, and then submitting a pull request. Detailed
+instructions for doing that is available here:
+
+https://help.github.com/articles/creating-a-pull-request
+
+If you have found a bug, but do not have an accompanying patch to fix it, you
+can submit an issue report here:
+https://rt.cpan.org/Public/Dist/Display.html?Name=File-Flat
+or via email: bug-File-Flat@rt.cpan.org
+This is a good place to send your questions about the usage of this distribution.
+
+If you send me a patch or pull request, your name and email address will be
+included in the documentation as a contributor (using the attribution on the
+commit or patch), unless you specifically request for it not to be.  If you
+wish to be listed under a different name or address, you should submit a pull
+request to the .mailmap file to contain the correct mapping.
+
+
+This file was generated via Dist::Zilla::Plugin::GenerateFile::FromShareDir 0.014
+from a template file originating in Dist-Zilla-PluginBundle-Author-ETHER-0.145.
diff --git a/Changes b/Changes
index aa323d0..c90258f 100644
--- a/Changes
+++ b/Changes
@@ -1,6 +1,6 @@
 Revision history for Perl extension File::Flat.
 
-{{$NEXT}}
+1.05      2018-12-29 21:06:09Z
         - distribution tooling updates
 
 1.04      2008-03-24
diff --git a/INSTALL b/INSTALL
new file mode 100644
index 0000000..59a5755
--- /dev/null
+++ b/INSTALL
@@ -0,0 +1,72 @@
+This is the Perl distribution File-Flat.
+
+Installing File-Flat is straightforward.
+
+## Installation with cpanm
+
+If you have cpanm, you only need one line:
+
+    % cpanm File::Flat
+
+If it does not have permission to install modules to the current perl, cpanm
+will automatically set up and install to a local::lib in your home directory.
+See the local::lib documentation (https://metacpan.org/pod/local::lib) for
+details on enabling it in your environment.
+
+## Installing with the CPAN shell
+
+Alternatively, if your CPAN shell is set up, you should just be able to do:
+
+    % cpan File::Flat
+
+## Manual installation
+
+As a last resort, you can manually install it. Download the tarball, untar it,
+install configure prerequisites (see below), then build it:
+
+    % perl Makefile.PL
+    % make && make test
+
+Then install it:
+
+    % make install
+
+On Windows platforms, you should use `dmake` or `nmake`, instead of `make`.
+
+If your perl is system-managed, you can create a local::lib in your home
+directory to install modules to. For details, see the local::lib documentation:
+https://metacpan.org/pod/local::lib
+
+The prerequisites of this distribution will also have to be installed manually. The
+prerequisites are listed in one of the files: `MYMETA.yml` or `MYMETA.json` generated
+by running the manual build process described above.
+
+## Configure Prerequisites
+
+This distribution requires other modules to be installed before this
+distribution's installer can be run.  They can be found under the
+"configure_requires" key of META.yml or the
+"{prereqs}{configure}{requires}" key of META.json.
+
+## Other Prerequisites
+
+This distribution may require additional modules to be installed after running
+Makefile.PL.
+Look for prerequisites in the following phases:
+
+* to run make, PHASE = build
+* to use the module code itself, PHASE = runtime
+* to run tests, PHASE = test
+
+They can all be found in the "PHASE_requires" key of MYMETA.yml or the
+"{prereqs}{PHASE}{requires}" key of MYMETA.json.
+
+## Documentation
+
+File-Flat documentation is available as POD.
+You can run `perldoc` from a shell to read the documentation:
+
+    % perldoc File::Flat
+
+For more information on installing Perl modules via CPAN, please see:
+https://www.cpan.org/modules/INSTALL.html
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..ffbd238
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,379 @@
+This software is copyright (c) 2002 by Adam Kennedy.
+
+This is free software; you can redistribute it and/or modify it under
+the same terms as the Perl 5 programming language system itself.
+
+Terms of the Perl programming language system itself
+
+a) the GNU General Public License as published by the Free
+   Software Foundation; either version 1, or (at your option) any
+   later version, or
+b) the "Artistic License"
+
+--- The GNU General Public License, Version 1, February 1989 ---
+
+This software is Copyright (c) 2002 by Adam Kennedy.
+
+This is free software, licensed under:
+
+  The GNU General Public License, Version 1, February 1989
+
+                    GNU GENERAL PUBLIC LICENSE
+                     Version 1, February 1989
+
+ Copyright (C) 1989 Free Software Foundation, Inc.
+ 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The license agreements of most software companies try to keep users
+at the mercy of those companies.  By contrast, our General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  The
+General Public License applies to the Free Software Foundation's
+software and to any other program whose authors commit to using it.
+You can use it for your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Specifically, the General Public License is designed to make
+sure that you have the freedom to give away or sell copies of free
+software, that you receive source code or can get it if you want it,
+that you can change the software or use pieces of it in new free
+programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of a such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must tell them their rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License Agreement applies to any program or other work which
+contains a notice placed by the copyright holder saying it may be
+distributed under the terms of this General Public License.  The
+"Program", below, refers to any such program or work, and a "work based
+on the Program" means either the Program or any work containing the
+Program or a portion of it, either verbatim or with modifications.  Each
+licensee is addressed as "you".
+
+  1. You may copy and distribute verbatim copies of the Program's source
+code as you receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice and
+disclaimer of warranty; keep intact all the notices that refer to this
+General Public License and to the absence of any warranty; and give any
+other recipients of the Program a copy of this General Public License
+along with the Program.  You may charge a fee for the physical act of
+transferring a copy.
+
+  2. You may modify your copy or copies of the Program or any portion of
+it, and copy and distribute such modifications under the terms of Paragraph
+1 above, provided that you also do the following:
+
+    a) cause the modified files to carry prominent notices stating that
+    you changed the files and the date of any change; and
+
+    b) cause the whole of any work that you distribute or publish, that
+    in whole or in part contains the Program or any part thereof, either
+    with or without modifications, to be licensed at no charge to all
+    third parties under the terms of this General Public License (except
+    that you may choose to grant warranty protection to some or all
+    third parties, at your option).
+
+    c) If the modified program normally reads commands interactively when
+    run, you must cause it, when started running for such interactive use
+    in the simplest and most usual way, to print or display an
+    announcement including an appropriate copyright notice and a notice
+    that there is no warranty (or else, saying that you provide a
+    warranty) and that users may redistribute the program under these
+    conditions, and telling the user how to view a copy of this General
+    Public License.
+
+    d) You may charge a fee for the physical act of transferring a
+    copy, and you may at your option offer warranty protection in
+    exchange for a fee.
+
+Mere aggregation of another independent work with the Program (or its
+derivative) on a volume of a storage or distribution medium does not bring
+the other work under the scope of these terms.
+
+  3. You may copy and distribute the Program (or a portion or derivative of
+it, under Paragraph 2) in object code or executable form under the terms of
+Paragraphs 1 and 2 above provided that you also do one of the following:
+
+    a) accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of
+    Paragraphs 1 and 2 above; or,
+
+    b) accompany it with a written offer, valid for at least three
+    years, to give any third party free (except for a nominal charge
+    for the cost of distribution) a complete machine-readable copy of the
+    corresponding source code, to be distributed under the terms of
+    Paragraphs 1 and 2 above; or,
+
+    c) accompany it with the information you received as to where the
+    corresponding source code may be obtained.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form alone.)
+
+Source code for a work means the preferred form of the work for making
+modifications to it.  For an executable file, complete source code means
+all the source code for all modules it contains; but, as a special
+exception, it need not include source code for modules which are standard
+libraries that accompany the operating system on which the executable
+file runs, or for standard header files or definitions files that
+accompany that operating system.
+
+  4. You may not copy, modify, sublicense, distribute or transfer the
+Program except as expressly provided under this General Public License.
+Any attempt otherwise to copy, modify, sublicense, distribute or transfer
+the Program is void, and will automatically terminate your rights to use
+the Program under this License.  However, parties who have received
+copies, or rights to use copies, from you under this General Public
+License will not have their licenses terminated so long as such parties
+remain in full compliance.
+
+  5. By copying, distributing or modifying the Program (or any work based
+on the Program) you indicate your acceptance of this license to do so,
+and all its terms and conditions.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the original
+licensor to copy, distribute or modify the Program subject to these
+terms and conditions.  You may not impose any further restrictions on the
+recipients' exercise of the rights granted herein.
+
+  7. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of the license which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+the license, you may choose any version ever published by the Free Software
+Foundation.
+
+  8. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+                            NO WARRANTY
+
+  9. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  10. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+                     END OF TERMS AND CONDITIONS
+
+        Appendix: How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to humanity, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these
+terms.
+
+  To do so, attach the following notices to the program.  It is safest to
+attach them to the start of each source file to most effectively convey
+the exclusion of warranty; and each file should have at least the
+"copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) 19yy  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 1, or (at your option)
+    any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA  02110-1301 USA
+
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) 19xx name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the
+appropriate parts of the General Public License.  Of course, the
+commands you use may be called something other than `show w' and `show
+c'; they could even be mouse-clicks or menu items--whatever suits your
+program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the
+  program `Gnomovision' (a program to direct compilers to make passes
+  at assemblers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+That's all there is to it!
+
+
+--- The Artistic License 1.0 ---
+
+This software is Copyright (c) 2002 by Adam Kennedy.
+
+This is free software, licensed under:
+
+  The Artistic License 1.0
+
+The Artistic License
+
+Preamble
+
+The intent of this document is to state the conditions under which a Package
+may be copied, such that the Copyright Holder maintains some semblance of
+artistic control over the development of the package, while giving the users of
+the package the right to use and distribute the Package in a more-or-less
+customary fashion, plus the right to make reasonable modifications.
+
+Definitions:
+
+  - "Package" refers to the collection of files distributed by the Copyright
+    Holder, and derivatives of that collection of files created through
+    textual modification. 
+  - "Standard Version" refers to such a Package if it has not been modified,
+    or has been modified in accordance with the wishes of the Copyright
+    Holder. 
+  - "Copyright Holder" is whoever is named in the copyright or copyrights for
+    the package. 
+  - "You" is you, if you're thinking about copying or distributing this Package.
+  - "Reasonable copying fee" is whatever you can justify on the basis of media
+    cost, duplication charges, time of people involved, and so on. (You will
+    not be required to justify it to the Copyright Holder, but only to the
+    computing community at large as a market that must bear the fee.) 
+  - "Freely Available" means that no fee is charged for the item itself, though
+    there may be fees involved in handling the item. It also means that
+    recipients of the item may redistribute it under the same conditions they
+    received it. 
+
+1. You may make and give away verbatim copies of the source form of the
+Standard Version of this Package without restriction, provided that you
+duplicate all of the original copyright notices and associated disclaimers.
+
+2. You may apply bug fixes, portability fixes and other modifications derived
+from the Public Domain or from the Copyright Holder. A Package modified in such
+a way shall still be considered the Standard Version.
+
+3. You may otherwise modify your copy of this Package in any way, provided that
+you insert a prominent notice in each changed file stating how and when you
+changed that file, and provided that you do at least ONE of the following:
+
+  a) place your modifications in the Public Domain or otherwise make them
+     Freely Available, such as by posting said modifications to Usenet or an
+     equivalent medium, or placing the modifications on a major archive site
+     such as ftp.uu.net, or by allowing the Copyright Holder to include your
+     modifications in the Standard Version of the Package.
+
+  b) use the modified Package only within your corporation or organization.
+
+  c) rename any non-standard executables so the names do not conflict with
+     standard executables, which must also be provided, and provide a separate
+     manual page for each non-standard executable that clearly documents how it
+     differs from the Standard Version.
+
+  d) make other distribution arrangements with the Copyright Holder.
+
+4. You may distribute the programs of this Package in object code or executable
+form, provided that you do at least ONE of the following:
+
+  a) distribute a Standard Version of the executables and library files,
+     together with instructions (in the manual page or equivalent) on where to
+     get the Standard Version.
+
+  b) accompany the distribution with the machine-readable source of the Package
+     with your modifications.
+
+  c) accompany any non-standard executables with their corresponding Standard
+     Version executables, giving the non-standard executables non-standard
+     names, and clearly documenting the differences in manual pages (or
+     equivalent), together with instructions on where to get the Standard
+     Version.
+
+  d) make other distribution arrangements with the Copyright Holder.
+
+5. You may charge a reasonable copying fee for any distribution of this
+Package.  You may charge any fee you choose for support of this Package. You
+may not charge a fee for this Package itself. However, you may distribute this
+Package in aggregate with other (possibly commercial) programs as part of a
+larger (possibly commercial) software distribution provided that you do not
+advertise this Package as a product of your own.
+
+6. The scripts and library files supplied as input to or produced as output
+from the programs of this Package do not automatically fall under the copyright
+of this Package, but belong to whomever generated them, and may be sold
+commercially, and may be aggregated with this Package.
+
+7. C or perl subroutines supplied by you and linked into this Package shall not
+be considered part of this Package.
+
+8. The name of the Copyright Holder may not be used to endorse or promote
+products derived from this software without specific prior written permission.
+
+9. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
+WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
+MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+
+The End
+
diff --git a/README.pod b/README.pod
new file mode 100644
index 0000000..782f132
--- /dev/null
+++ b/README.pod
@@ -0,0 +1,335 @@
+=pod
+
+=encoding UTF-8
+
+=head1 NAME
+
+File::Flat - Implements a flat filesystem
+
+=head1 VERSION
+
+version 1.05
+
+=head1 DESCRIPTION
+
+=for stopwords FSI.pm VMS canExecute canOpen canRead canReadWrite canRemove canWrite cp getAppendHandle getReadHandle getReadWriteHandle getWriteHandle isaBinary isaDirectory isaFile isaText makeDirectory
+
+File::Flat implements a flat filesystem. A flat filesystem is a filesystem in
+which directories do not exist. It provides an abstraction over any normal
+filesystem which makes it appear as if directories do not exist. In effect,
+it will automatically create directories as needed. This is create for things
+like install scripts and such, as you never need to worry about the existence
+of directories, just write to a file, no matter where it is.
+
+=head2 Comprehensive Implementation
+
+The implementation of File::Flat is extremely comprehensive in scope. It has
+methods for all standard file interaction tasks, the -X series of tests, and
+some other things, such as slurp.
+
+All methods are statically called, for example, to write some stuff to a file.
+
+  use File::Flat;
+  File::Flat->write( 'filename', 'file contents' );
+
+=head2 Use of other modules
+
+File::Flat tries to use more task orientated modules wherever possible. This
+includes the use of L<File::Copy>, L<File::Copy::Recursive>, L<File::Remove>
+and others. These are mostly loaded on-demand.
+
+=head2 Pruning and $AUTO_PRUNE
+
+"Pruning" is a technique where empty directories are assumed to be useless,
+and thus empty removed whenever one is created. Thus, when some other task
+has the potential to leave an empty directory, it is checked and deleted if
+it is empty.
+
+By default File::Flat does not prune, and pruning must be done explicitly,
+via either the L<File::Flat/prune> method, or by setting the second
+argument to the L<File::Flat/remove> method to be true.
+
+However by setting the global C<$AUTO_PRUNE> variable to true, File::Flat
+will automatically prune directories at all times. You should generally use
+this locally, such as in the following example.
+
+  #!/usr/bin/perl
+  
+  use strict;
+  use File::Flat;
+  
+  delete_files(@ARGV);
+  exit();
+  
+  # Recursively delete and prune all files provided on the command line
+  sub delete_files {
+  	local $File::Flat::AUTO_PRUNE = 1;
+  	foreach my $file ( @_ ) {
+  		File::Flat->remove( $file ) or die "Failed to delete $file";
+  	}
+  }
+
+=head2 Non-Unix platforms
+
+As of version 0.97 File::Flat should work correctly on Win32. Other
+platforms (such as VMS) are believed to work, but require confirmation.
+
+=head1 METHODS
+
+=head2 exists $filename 
+
+Tests for the existence of the file.
+This is an exact duplicate of the -e function.
+
+=head2 isaFile $filename
+
+Tests whether C<filename> is a file.
+This is an exact duplicate of the -f function.
+
+=head2 isaDirectory $filename
+
+Test whether C<filename> is a directory.
+This is an exact duplicate of the -d function.
+
+=head2 canRead $filename
+
+Does the file or directory exist, and can we read from it.
+
+=head2 canWrite $filename
+
+Does the file or directory exist, and can we write to it 
+B<OR> can we create the file or directory.
+
+=head2 canReadWrite $filename
+
+Does a file or directory exist, and can we both read and write it.
+
+=head2 canExecute $filename
+
+Does a file or directory exist, and can we execute it.
+
+=head2 canOpen $filename
+
+Is this something we can open a filehandle to. Returns true if filename
+exists, is a file, and we can read from it.
+
+=head2 canRemove $filename
+
+Can we remove the file or directory.
+
+=head2 isaText $filename
+
+Does the file C<filename> exist, and is it a text file.
+
+=head2 isaBinary $filename
+
+Does the file C<filename> exist, and is it a binary file.
+
+=head2 fileSize $filename
+
+If the file exists, returns its size in bytes.
+Returns undef if the file does not exist.
+
+=head2 open [ $mode, ] $filename
+
+Rough analogue of the open function, but creates directories on demand
+as needed. Supports most of the normal options to the normal open function.
+
+In the single argument form, it takes modes in the form [mode]filename. For
+example, all the following are valid.
+
+  File::Flat->open( 'filename' );
+  File::Flat->open( '<filename' );
+  File::Flat->open( '>filename' );
+  File::Flat->open( '>>filename' );
+  File::Flat->open( '+<filename' );
+
+In the two argument form, it takes the following
+
+  File::Flat->open( '<', 'filename' );
+  File::Flat->open( '>', 'filename' );
+  File::Flat->open( '>>', 'filename' );
+  File::Flat->open( '+<', 'filename' );
+
+It does not support the more esoteric forms of open, such us opening to a pipe
+or other such things.
+
+On successfully opening the file, it returns it as an IO::File object.
+Returns undef on error.
+
+=head2 getReadHandle $filename
+
+The same as File::Flat->open( '<', 'filename' )
+
+=head2 getWriteHandle $filename
+
+The same as File::Flat->open( '>', 'filename' )
+
+=head2 getAppendHandle $filename
+
+The same as File::Flat->open( '>>', 'filename' )
+
+=head2 getReadWriteHandle $filename
+
+The same as File::Flat->open( '+<', 'filename' )
+
+=head2 read $filename
+
+Opens and reads in an entire file, chomping as needed.
+
+In array context, it returns an array containing each line of the file.
+In scalar context, it returns a reference to an array containing each line of
+the file. It returns undef on error.
+
+=head2 slurp $filename
+
+The C<slurp> method 'slurps' a file in. That is it attempts to read the entire
+file into a variable in as quick and memory efficient method as possible.
+
+On success, returns a reference to a scalar, containing the entire file.
+Returns undef on error.
+
+=head2 write $filename, ( $content | \$content | \@content )
+
+The C<write> method is the main method for writing content to a file.
+It takes two arguments, the location to write to, and the content to write, 
+in several forms.
+
+If the file already exists, it will be clobbered before writing starts.
+If the file doesn't exists, the file and any directories will be created as
+needed.
+
+Content can be provided in three forms. The contents of a scalar argument will
+be written directly to the file. You can optionally pass a reference to the 
+scalar. This is recommended when the file size is bigger than a few thousand
+characters, is it does not duplicate the file contents in memory.
+Alternatively, you can pass the content as a reference to an array containing
+the contents. To ensure uniformity, C<write> will add a newline to each line,
+replacing any existing newline as needed.
+
+Returns true on success, and undef on error.
+
+=head2 append $filename, ( $content | \$content | \@content )
+
+This method is the same as C<write>, except that it appends to the end of 
+an existing file ( or creates the file as needed ).
+
+This is the method you should be using to write to log files, etc.
+
+=head2 overwrite $filename, ( $content | \$content | \@content )
+
+Performs an atomic write over a file. It does this by writing to a temporary
+file, and moving the completed file over the top of the existing file ( or
+creating a new file as needed ). When writing to a file that is on the same
+partition as /tmp, this should always be atomic. 
+
+This method otherwise acts the same as C<write>.
+
+=head2 copy $source, $target
+
+The C<copy> method attempts to copy a file or directory from the source to
+the target. New directories to contain the target will be created as needed.
+
+For example C<<File::Flat->( './this', './a/b/c/d/that' );>> will create the
+directory structure required as needed. 
+
+In the file copy case, if the target already exists, and is a writable file,
+we replace the existing file, retaining file mode and owners. If the target
+is a directory, we do NOT copy into that directory, unlike with the 'cp'
+unix command. And error is instead returned.
+
+C<copy> will also do limited recursive copying or directories. If source
+is a directory, and target does not exists, a recursive copy of source will
+be made to target. If target already exists ( file or directory ), C<copy>
+will returns with an error.
+
+=head2 move $source, $target
+
+The C<move> method follows the conventions of the 'mv' command, with the 
+exception that the directories containing target will of course be created
+on demand.
+
+=head2 remove $filename [, $prune ]
+
+The C<remove> method will remove a file, or recursively remove a directory.
+
+If a second (true) argument is provided, then once the file or directory
+has been deleted, the method will the automatically work its way upwards
+pruning (deleting) empty and thus presumably useless directories.
+
+Returns true if the deletion (and pruning if requested) was a success, or
+C<undef> otherwise.
+
+=head2 prune $filename
+
+For a file that has already been delete, C<prune> will work upwards,
+removing any empty directories it finds.
+
+For anyone familiar with CVS, it is similar to the C<update -P> flag.
+
+Returns true, or C<undef> on error.
+
+=head2 truncate $filename [, $size ]
+
+The C<truncate> method will truncate an existing file to a particular size.
+A size of 0 ( zero ) is used if no size is provided. If the file does not
+exists, it will be created, and set to 0. Attempting to truncate a 
+directory will fail.
+
+Returns true on success, or undef on error.
+
+=head2 makeDirectory $directory [, mode ]
+
+In the case where you do actually have to create a directory only, the
+C<makeDirectory> method can be used to create a directory or any depth.
+
+An optional file mode ( default 0755 ) can be provided.
+
+Returns true on success, returns undef on error.
+
+=head1 TO DO
+
+Function interface to be written, like
+L<File::Spec::Functions>, to provide importable functions.
+
+There's something bigger here too, I'm not exactly sure what it is,
+but I think there might be the beginnings of a unified filesystem
+interface here... FSI.pm
+
+=head1 SEE ALSO
+
+L<File::Spec>, L<http://ali.as/>
+
+=head1 SUPPORT
+
+Bugs may be submitted through L<the RT bug tracker|https://rt.cpan.org/Public/Dist/Display.html?Name=File-Flat>
+(or L<bug-File-Flat@rt.cpan.org|mailto:bug-File-Flat@rt.cpan.org>).
+
+=head1 AUTHOR
+
+Adam Kennedy <adamk@cpan.org>
+
+=head1 CONTRIBUTORS
+
+=for stopwords Adam Kennedy Karen Etheridge
+
+=over 4
+
+=item *
+
+Adam Kennedy <adam@ali.as>
+
+=item *
+
+Karen Etheridge <ether@cpan.org>
+
+=back
+
+=head1 COPYRIGHT AND LICENSE
+
+This software is copyright (c) 2002 by Adam Kennedy.
+
+This is free software; you can redistribute it and/or modify it under
+the same terms as the Perl 5 programming language system itself.
+
+=cut