ack - grep-like text finder
ack [options] PATTERN [FILE...] ack -f [options] [DIRECTORY...]
Ack is designed as a replacement for grep.
Ack searches the named input FILEs (or standard input if no files are named, or the file name - is given) for lines containing a match to the given PATTERN. By default, ack prints the matching lines.
Ack can also list files that would be searched, without actually searching them, to let you take advantage of ack's file-type filtering capabilities.
Operate on all files, regardless of type (but still skip directories like blib, CVS, etc.
Suppress normal output; instead print a count of matching lines for each input file.
--color highlights the matching text. --nocolor supresses the color. This is on by default unless the output is redirected, or running under Windows.
Only print the files that would be searched, without actually doing any searching. PATTERN must not be specified, or it will be taken as a path to search.
--group groups matches by file name with. This is the default when used interactively.
--nogroup prints one result per line, like grep. This is the default when output is redirected.
Print the filename for each match.
Suppress the prefixing of filenames on output when multiple files are searched.
Print a short help statement.
Ignore case in the search strings.
Only print the filenames of matching files, instead of the matching text.
Stop reading a file after NUM matches.
Print this manual page.
No descending into subdirectories.
Show only the part of each line matching PATTERN (turns off text highlighting)
Output the evaluation of expr for each line (turns off text highlighting)
Quote all metacharacters. PATTERN is treated as a literal.
Display the crucial Bill The Cat logo. Note that the exact spelling of --thpppppt is not important. It's checked against a regular expression.
Invert match: select non-matching lines
Display version and copyright information.
Force PATTERN to match only whole words. The PATTERN is wrapped with \b metacharacters.
\b
This variable specifies default options to be placed in front of any explicit options.
Note that FILES must still match valid selection rules. For example,
ack something --perl foo.rb
will search nothing, because foo.rb is a Ruby file.
File::Next - File-finding iterator
Version 0.32
File::Next is a lightweight, taint-safe file-finding module. It's lightweight and has no non-core prerequisites.
use File::Next; my $files = File::Next->files( '/tmp' ); while ( my $file = $files->() ) { # do something... }
Each of the public functions in File::Next returns an iterator that will walk through a directory tree. The simplest use case is:
use File::Next; my $iter = File::Next->files( '/tmp' ); while ( my $file = $iter->() ) { print $file, "\n"; } # Prints... /tmp/foo.txt /tmp/bar.pl /tmp/baz/1 /tmp/baz/2.txt /tmp/baz/wango/tango/purple.txt
Note that only files are returned by files()'s iterator.
files()
The first parameter to any of the iterator factory functions may be a hashref of parameters.
Note that the iterator will only return files, not directories.
The file_filter lets you check to see if it's really a file you want to get back. If the file_filter returns a true value, the file will be returned; if false, it will be skipped.
The file_filter function takes no arguments but rather does its work through a collection of variables.
$_ is the current filename within that directory
$_
$File::Next::dir is the current directory name
$File::Next::dir
$File::Next::name is the complete pathname to the file
$File::Next::name
These are analogous to the same variables in File::Find.
my $iter = File::Find::files( { file_filter => sub { /\.txt$/ } }, '/tmp' );
By default, the file_filter is sub {1}, or "all files".
sub {1}
The descend_filter lets you check to see if the iterator should descend into a given directory. Maybe you want to skip CVS and .svn directories.
my $descend_filter = sub { $_ ne "CVS" && $_ ne ".svn" }
The descend_filter function takes no arguments but rather does its work through a collection of variables.
$_ is the current filename of the directory
$File::Next::dir is the complete directory name
The descend filter is NOT applied to any directory names specified in the constructor. For example,
my $iter = File::Find::files( { descend_filter => sub{0} }, '/tmp' );
always descends into /tmp, as you would expect.
By default, the descend_filter is sub {1}, or "always descend".
If error_handler is set, then any errors will be sent through it. By default, this value is CORE::die.
CORE::die
If you want files sorted, pass in some true value, as in sort_files => 1.
sort_files => 1
If you want a special sort order, pass in a sort function like sort_files => sub { $a->[1] cmp $b->[1] }. Note that the parms passed in to the sub are arrayrefs, where $a->[0] is the directory name and $a->[1] is the file name. Typically you're going to be sorting on $a->[1].
sort_files => sub { $a->[1] cmp $b->[1] }
Returns an iterator that walks directories starting with the items in @starting_points.
All file-finding in this module is adapted from Mark Jason Dominus' marvelous Higher Order Perl, page 126.
A sort function for passing as a sort_files parameter:
sort_files
my $iter = File::Next::files( { sort_files => \&File::Next::sort_reverse }, 't/swamp' );
This function is the default, so the code above is identical to:
Same as sort_standard, but in reverse.
sort_standard
Pulls out the files/dirs that might be worth looking into in $dir. If $dir is the empty string, then search the current directory. This is different than explicitly passing in a ".", because that will get prepended to the path names.
$parms is the hashref of parms passed into File::Next constructor.
Andy Lester, <andy at petdance.com>
<andy at petdance.com>
Please report any bugs or feature requests to bug-file-next at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=File-Next. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
bug-file-next at rt.cpan.org
You can find documentation for this module with the perldoc command.
perldoc File::Next
You can also look for information at:
AnnoCPAN: Annotated CPAN documentation
http://annocpan.org/dist/File-Next
CPAN Ratings
http://cpanratings.perl.org/d/File-Next
RT: CPAN's request tracker
http://rt.cpan.org/NoAuth/Bugs.html?Dist=File-Next
Search CPAN
http://search.cpan.org/dist/File-Next
Subversion repository
https://file-next.googlecode.com/svn/trunk
Copyright 2006 Andy Lester, all rights reserved.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
App::Ack - A container for functions for the ack program
Version 1.38
If you want to know about the ack program
No user-serviceable parts inside. ack is all that should use this.
Asks whether $filename is of type $filetype.
Standard filter to pass as a File::Next descend_filter. It returns true if the directory is any of the ones we know we want to skip.
Returns a list of types that $filename could be. For example, a file foo.pod could be "perl" or "parrot".
The filetype will be undef if we can't determine it. This could be if the file doesn't exist, or it can't be read.
undef
It will be '-ignore' if it's something that ack should always ignore, even under -a.
Returns a list of all the types that we can detect.
Dumps the help page to the user.
Please report any bugs or feature requests to bug-ack at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=ack. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
bug-ack at rt.cpan.org
The App::Ack module isn't very interesting to users. However, you may find useful information about this distribution at:
http://annocpan.org/dist/ack
http://cpanratings.perl.org/d/ack
http://rt.cpan.org/NoAuth/Bugs.html?Dist=ack
http://search.cpan.org/dist/ack
http://ack.googlecode.com/svn/
Thanks to everyone who has contributed to ack in any way, including Rick Scott, Ask Bjørn Hanse, Jerry Gay, Will Coleda, Mike O'Regan, Slaven Rezic, Mark Stosberg, David Alan Pisoni, Adriano Ferreira, James Keenan, Leland Johnson, Ricardo Signes and Pete Krawczyk.
Copyright 2005-2006 Andy Lester, all rights reserved.
1 POD Error
The following errors were encountered while parsing the POD:
Non-ASCII character seen before =encoding in 'Bjørn'. Assuming UTF-8
To install App::Ack, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::Ack
CPAN shell
perl -MCPAN -e shell install App::Ack
For more information on module installation, please visit the detailed CPAN module installation guide.