NAME

Meta::Utils::File::Symlink - module to help you deal with symbolic links.

COPYRIGHT

Copyright (C) 2001, 2002 Mark Veltzer; All rights reserved.

LICENSE

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 2 of the License, 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., 59 Temple Place, Suite 330, Boston, MA 02111, USA.

DETAILS

        MANIFEST: Symlink.pm
        PROJECT: meta
        VERSION: 0.28

SYNOPSIS

        package foo;
        use Meta::Utils::File::Symlink qw();
        my($directory)="~/data";
        my($verbose)=1;
        Meta::Utils::File::Symlink::check($directory,$verbose);

DESCRIPTION

This library helps you with handling symbolic links. It has easy to use function to tell you if a file is a symbolic link, find out if a symbolic link is pointing at a valid file and the like.

There are two higher level services that this library provides: 1. scan directories in recursive fashion to check that all symlinks in those directories are valid. 2. scan directories in recursive fashion to replace all symlinks with the files they are pointing at. This module uses File::Find extensivly.

FUNCTIONS

        is_symlink($)
        check_symlink($)
        check_valid_symlink($)
        check_doit($)
        check($$)
        replace_doit()
        replace($$$)
        symlink($$)
        link($$)
        TEST($)

FUNCTION DOCUMENTATION

is_symlink($)

This function will return true iff the file given to it is a symlink.

check_symlink($)

This function will check that a file given to it is a symlink. If it is not it will throw an exception.

check_valid_symlink($)

This function will check that a file given to it is a symlink and also points to a valid file. If there is an error it will throw an exception.

check_doit($)

This function checks if the file she gets is a symlink and if so verifies the fact that is is ok.

check($$)

This function receives a directory and scans it using File::Find and fills up a hash with all the files found there. The routine also receives a verbose parameter. The routine returns nothing.

replace_doit()

This function checks if the file she gets is a symlink and if so removes it and replaces it with the content of the file it is pointing at.

replace($$$)

This function receives a directory and scans it using File::Find and fills up a hash with all the files found there. The routine also receives a demo parameter. The routine also receives a verbose parameter. The routine returns nothing.

symlink($$)

Create a symbolic link.

link($$)

Create a hard link.

TEST($)

Test suite for this module.

SUPER CLASSES

None.

BUGS

None.

AUTHOR

        Name: Mark Veltzer
        Email: mailto:veltzer@cpan.org
        WWW: http://www.veltzer.org
        CPAN id: VELTZER

HISTORY

        0.00 MV initial code brought in
        0.01 MV make quality checks on perl code
        0.02 MV more perl checks
        0.03 MV make Meta::Utils::Opts object oriented
        0.04 MV check that all uses have qw
        0.05 MV fix todo items look in pod documentation
        0.06 MV more on tests/more checks to perl
        0.07 MV spelling change
        0.08 MV correct die usage
        0.09 MV perl code quality
        0.10 MV more perl quality
        0.11 MV more perl quality
        0.12 MV perl documentation
        0.13 MV more perl quality
        0.14 MV perl qulity code
        0.15 MV more perl code quality
        0.16 MV revision change
        0.17 MV languages.pl test online
        0.18 MV perl packaging
        0.19 MV md5 project
        0.20 MV database
        0.21 MV perl module versions in files
        0.22 MV movies and small fixes
        0.23 MV thumbnail user interface
        0.24 MV more thumbnail issues
        0.25 MV website construction
        0.26 MV web site automation
        0.27 MV SEE ALSO section fix
        0.28 MV md5 issues

SEE ALSO

Error(3), File::Find(3), Meta::Utils::File::Copy(3), Meta::Utils::Output(3), strict(3)

TODO

-do we need to export the "_doit" routines ? No!!!

cpanm Meta::Init

perl -MCPAN -e shell
install Meta::Init