Skip to content

Latest commit

 

History

History
74 lines (52 loc) · 2.53 KB

README.pod

File metadata and controls

74 lines (52 loc) · 2.53 KB
Raw

pfind - A Perl based find replacement

DESCRIPTION

pfind is a replacement for the standard find command where the countless flags and options are mostly all replaced by a single option (--exec) that can execute arbitrary Perl code.

See examples of pfind in action in the documentation.

DOCUMENTATION

You can find the documentation for the program itself on meta::cpan. After the program is installed, you can also get its documentation by running any of the following commands: man pfind, pfind --help or perldoc pfind.

The built-in --help rendering will be better if the perldoc program is installed. It usually comes in a perl-doc package on most systems.

INSTALLATION

Requirements

Building and installing this program only requires Perl modules from the standard library. So as long as you have Perl installed (which should be the case by default on almost all system), you should be able to install pfind using one of the method below. This program requires Perl version 5.22 or above. You can check which Perl you have installed with the following command:

perl -v

Installing from the Git sources

To install the program manually from Git, you can run the following commands (you do need to have the make and git program installed):

git clone https://github.com/mkende/pfind.git
cd pfind
perl Makefile.PL
make
make test
sudo make install

Installing from CPAN

This module is available on CPAN (the Perl package manager). The CPAN command should be installed on any system that has Perl (which, again, should mostly be any system at all). So, to install pfind automatically using CPAN, you can just run the following command:

cpan App::Pfind

Note: if this is the first time that you run the cpan command, you will be asked to configure it. The default answer to most questions is usually fine.

DISTRIBUTION

The main development of this software is done on GitHub. However, it is also available on CPAN.

The following can be used only by the module maintainer on CPAN. To update the CPAN module, remember to increment the version number and then run the following commands:

perl Makefile.PL
make distcheck
# Optionally, to add files not in the manifest:
# make manifest
make dist

Finally, upload the App-Pfind-version.tar.gz file that has been created through PAUSE, ideally putting it under an App-Pfind directory.