-
Notifications
You must be signed in to change notification settings - Fork 138
/
ack
1483 lines (1031 loc) · 42.1 KB
/
ack
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/perl
use strict;
use warnings;
use 5.8.0;
use App::Ack ();
use App::Ack::ConfigLoader ();
use App::Ack::Resources;
use App::Ack::Resource::Basic ();
# XXX Don't make this so brute force
use App::Ack::Filter ();
use App::Ack::Filter::Default;
use App::Ack::Filter::Extension;
use App::Ack::Filter::FirstLineMatch;
use App::Ack::Filter::Inverse;
use App::Ack::Filter::Is;
use App::Ack::Filter::Match;
use Getopt::Long 2.36 ();
use Carp 1.22 ();
our $VERSION = '2.00b02';
# Check http://betterthangrep.com/ for updates
# These are all our globals.
MAIN: {
$App::Ack::orig_program_name = $0;
$0 = join(' ', 'ack', $0);
if ( $App::Ack::VERSION ne $main::VERSION ) {
App::Ack::die( "Program/library version mismatch\n\t$0 is $main::VERSION\n\t$INC{'App/Ack.pm'} is $App::Ack::VERSION" );
}
# Do preliminary arg checking;
my $env_is_usable = 1;
for ( @ARGV ) {
last if ( $_ eq '--' );
# Get the --thpppt and --bar checking out of the way.
/^--th[pt]+t+$/ && App::Ack::_thpppt($_);
/^--bar$/ && App::Ack::_bar();
# See if we want to ignore the environment. (Don't tell Al Gore.)
if ( /^--(no)?env$/ ) {
$env_is_usable = defined $1 ? 0 : 1;
}
}
if ( !$env_is_usable ) {
my @keys = ( 'ACKRC', grep { /^ACK_/ } keys %ENV );
delete @ENV{@keys};
}
App::Ack::load_colors();
Getopt::Long::Configure('default', 'no_auto_help', 'no_auto_version');
Getopt::Long::Configure('pass_through', 'no_auto_abbrev');
Getopt::Long::GetOptions(
'help' => sub { App::Ack::show_help(); exit; },
'version' => sub { App::Ack::print_version_statement(); exit; },
'man' => sub { App::Ack::show_man(); exit; },
);
Getopt::Long::Configure('default', 'no_auto_help', 'no_auto_version');
if ( !@ARGV ) {
App::Ack::show_help();
exit 1;
}
main();
}
sub _compile_descend_filter {
my ( $opt ) = @_;
my $idirs = $opt->{idirs};
return unless $idirs && @{$idirs};
my %ignore_dirs;
foreach my $idir (@{$idirs}) {
if ( $idir =~ /^(\w+):(.*)/ ) {
if ( $1 eq 'is') {
$ignore_dirs{$2} = 1;
}
else {
Carp::croak( 'Non-is filters are not yet supported for --ignore-dir' );
}
}
else {
Carp::croak( qq{Invalid filter specification "$_"} );
}
}
return sub {
return !exists $ignore_dirs{$_} && !exists $ignore_dirs{$File::Next::dir};
};
}
sub _compile_file_filter {
my ( $opt, $start ) = @_;
my $ifiles = $opt->{ifiles};
$ifiles ||= [];
my @ifiles_filters = map {
my $filter;
if ( /^(\w+):(.+)/ ) {
my ($how,$what) = ($1,$2);
$filter = App::Ack::Filter->create_filter($how, split(/,/, $what));
}
else {
Carp::croak( qq{Invalid filter specification "$_"} );
}
$filter
} @{$ifiles};
my $filters = $opt->{'filters'} || [];
my $inverse_filters = [ grep { $_->is_inverted() } @{$filters} ];
@{$filters} = grep { !$_->is_inverted() } @{$filters};
my %is_member_of_starting_set = map { (App::Ack::get_file_id($_) => 1) } @{$start};
return sub {
return 1 if $is_member_of_starting_set{ App::Ack::get_file_id($File::Next::name) };
foreach my $filter (@ifiles_filters) {
my $resource = App::Ack::Resource::Basic->new($File::Next::name);
return 0 if ! $resource || $filter->filter($resource);
}
my $match_found = 1;
if ( @{$filters} ) {
$match_found = 0;
foreach my $filter (@{$filters}) {
my $resource = App::Ack::Resource::Basic->new($File::Next::name);
return 0 if ! $resource;
if ($filter->filter($resource)) {
$match_found = 1;
last;
}
}
}
# Don't bother invoking inverse filters unless we consider the current resource a match
if ( $match_found && @{$inverse_filters} ) {
foreach my $filter ( @{$inverse_filters} ) {
my $resource = App::Ack::Resource::Basic->new($File::Next::name);
return 0 if ! $resource;
if ( not $filter->filter( $resource ) ) {
$match_found = 0;
last;
}
}
}
return $match_found;
};
}
sub show_types {
my $resource = shift;
my $ors = shift;
my @types = App::Ack::filetypes( $resource );
my $types = join( ',', @types );
my $arrow = @types ? ' => ' : ' =>';
App::Ack::print( $resource->name, $arrow, join( ',', @types ), $ors );
return;
}
sub main {
my @arg_sources = App::Ack::retrieve_arg_sources();
my $opt = App::Ack::ConfigLoader::process_args( @arg_sources );
$App::Ack::report_bad_filenames = !$opt->{dont_report_bad_filenames};
if ( $opt->{flush} ) {
$| = 1;
}
if ( not defined $opt->{color} ) {
$opt->{color} = !App::Ack::output_to_pipe() && !$App::Ack::is_windows;
}
if ( not defined $opt->{heading} and not defined $opt->{break} ) {
$opt->{heading} = $opt->{break} = !App::Ack::output_to_pipe();
}
if ( defined($opt->{H}) || defined($opt->{h}) ) {
$opt->{show_filename}= $opt->{H} && !$opt->{h};
}
my $resources;
if ( $App::Ack::is_filter_mode && !$opt->{files_from} ) { # probably -x
$resources = App::Ack::Resources->from_stdin( $opt );
my $regex = $opt->{regex};
$regex = shift @ARGV if not defined $regex;
$opt->{regex} = App::Ack::build_regex( $regex, $opt );
}
else {
if ( $opt->{f} || $opt->{lines} ) {
if ( $opt->{regex} ) {
App::Ack::warn( "regex ($opt->{regex}) specified with -f or --lines" );
App::Ack::exit_from_ack( 0 ); # XXX the 0 is misleading
}
}
else {
my $regex = $opt->{regex};
$regex = shift @ARGV if not defined $regex;
$opt->{regex} = App::Ack::build_regex( $regex, $opt );
}
my @start;
if ( not defined $opt->{files_from} ) {
@start = @ARGV;
}
if ( !exists($opt->{show_filename}) ) {
unless(@start == 1 && !(-d $start[0])) {
$opt->{show_filename} = 1;
}
}
if ( defined $opt->{files_from} ) {
$resources = App::Ack::Resources->from_file( $opt, $opt->{files_from} );
exit 1 unless $resources;
}
else {
@start = ('.') unless @start;
foreach my $target (@start) {
if ( !-e $target && $App::Ack::report_bad_filenames) {
App::Ack::warn( "$target: No such file or directory" );
}
}
$opt->{file_filter} = _compile_file_filter($opt, \@start);
$opt->{descend_filter} = _compile_descend_filter($opt);
$resources = App::Ack::Resources->from_argv( $opt, \@start );
}
}
App::Ack::set_up_pager( $opt->{pager} ) if defined $opt->{pager};
my $print_filenames = $opt->{show_filename};
my $max_count = $opt->{m};
my $ors = $opt->{print0} ? "\0" : "\n";
my $only_first = $opt->{1};
my $nmatches = 0;
my $total_count = 0;
RESOURCES:
while ( my $resource = $resources->next ) {
# XXX this variable name combined with what we're trying
# to do makes no sense.
# XXX Combine the -f and -g functions
if ( $opt->{f} ) {
# XXX printing should probably happen inside of App::Ack
if ( $opt->{show_types} ) {
show_types( $resource, $ors );
}
else {
App::Ack::print( $resource->name, $ors );
}
++$nmatches;
last RESOURCES if defined($max_count) && $nmatches >= $max_count;
}
elsif ( $opt->{g} ) {
my $is_match = ( $resource->name =~ /$opt->{regex}/o );
if ( $opt->{v} ? !$is_match : $is_match ) {
if ( $opt->{show_types} ) {
show_types( $resource, $ors );
}
else {
App::Ack::print( $resource->name, $ors );
}
++$nmatches;
last RESOURCES if defined($max_count) && $nmatches >= $max_count;
}
}
elsif ( $opt->{lines} ) {
my $print_filename = $opt->{show_filename};
my $passthru = $opt->{passthru};
my %line_numbers;
foreach my $line ( @{ $opt->{lines} } ) {
my @lines = split /,/, $line;
@lines = map {
/^(\d+)-(\d+)$/
? ( $1 .. $2 )
: $_
} @lines;
@line_numbers{@lines} = (1) x @lines;
}
my $filename = $resource->name;
local $opt->{color} = 0;
App::Ack::iterate($resource, $opt, sub {
chomp;
if ( $line_numbers{$.} ) {
App::Ack::print_line_with_context($opt, $filename, $_, $.);
}
elsif ( $passthru ) {
App::Ack::print_line_with_options($opt, $filename, $_, $., ':');
}
return 1;
});
}
elsif ( $opt->{count} ) {
my $matches_for_this_file = App::Ack::count_matches_in_resource( $resource, $opt );
unless ( $opt->{show_filename} ) {
$total_count += $matches_for_this_file;
next RESOURCES;
}
if ( !$opt->{l} || $matches_for_this_file > 0) {
if ( $print_filenames ) {
App::Ack::print( $resource->name, ':', $matches_for_this_file, $ors );
}
else {
App::Ack::print( $matches_for_this_file, $ors );
}
}
}
elsif ( $opt->{l} ) {
my $is_match = App::Ack::resource_has_match( $resource, $opt );
if ( $opt->{v} ? !$is_match : $is_match ) {
App::Ack::print( $resource->name, $ors );
++$nmatches;
last RESOURCES if $only_first;
last RESOURCES if defined($max_count) && $nmatches >= $max_count;
}
}
else {
$nmatches += App::Ack::print_matches_in_resource( $resource, $opt );
if ( $nmatches && $only_first ) {
last RESOURCES;
}
}
}
if ( $opt->{count} && !$opt->{show_filename} ) {
App::Ack::print( $total_count, "\n" );
}
close $App::Ack::fh;
App::Ack::exit_from_ack( $nmatches );
}
=head1 NAME
ack - grep-like text finder
=head1 SYNOPSIS
ack [options] PATTERN [FILE...]
ack -f [options] [DIRECTORY...]
=head1 DESCRIPTION
Ack is designed as a replacement for 99% of the uses of F<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.
PATTERN is a Perl regular expression. Perl regular expressions
are commonly found in other programming languages, but for the particulars
of their behavior, please consult
L<http://perldoc.perl.org/perlreref.html|perlreref>. If you don't know
how to use regular expression but are interested in learning, you may
consult L<http://perldoc.perl.org/perlretut.html|perlretut>. If you do not
need or want ack to use regular expressions, please see the
C<-Q>/C<--literal> option.
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.
=head1 FILE SELECTION
If files are not specified for searching, either on the command
line or piped in with the C<-x> option, I<ack> delves into
subdirectories selecting files for searching.
I<ack> is intelligent about the files it searches. It knows about
certain file types, based on both the extension on the file and,
in some cases, the contents of the file. These selections can be
made with the B<--type> option.
With no file selection, I<ack> searches through regular files that
are not explicitly excluded by B<--ignore-dir> and B<--ignore-file>
options, either present in F<ackrc> files or on the command line.
The default options for I<ack> ignore certain files and directories. These
include:
=over 4
=item * Backup files: Files matching F<#*#> or ending with F<~>.
=item * Coredumps: Files matching F<core.\d+>
=item * Version control directories like F<.svn> and F<.git>.
=back
Run I<ack> with the C<--dump> option to see what settings are set.
However, I<ack> always searches the files given on the command line,
no matter what type. If you tell I<ack> to search in a coredump,
it will search in a coredump.
=head1 DIRECTORY SELECTION
I<ack> descends through the directory tree of the starting directories
specified. If no directories are specified, the current working directory is
used. However, it will ignore the shadow directories used by
many version control systems, and the build directories used by the
Perl MakeMaker system. You may add or remove a directory from this
list with the B<--[no]ignore-dir> option. The option may be repeated
to add/remove multiple directories from the ignore list.
For a complete list of directories that do not get searched, run
C<ack --dump>.
=head1 WHEN TO USE GREP
I<ack> trumps I<grep> as an everyday tool 99% of the time, but don't
throw I<grep> away, because there are times you'll still need it.
E.g., searching through huge files looking for regexes that can be
expressed with I<grep> syntax should be quicker with I<grep>.
If your script or parent program uses I<grep> C<--quiet> or C<--silent>
or needs exit 2 on IO error, use I<grep>.
=head1 OPTIONS
=over 4
=item B<-A I<NUM>>, B<--after-context=I<NUM>>
Print I<NUM> lines of trailing context after matching lines.
=item B<-B I<NUM>>, B<--before-context=I<NUM>>
Print I<NUM> lines of leading context before matching lines.
=item B<--[no]break>
Print a break between results from different files. On by default
when used interactively.
=item B<-C [I<NUM>]>, B<--context[=I<NUM>]>
Print I<NUM> lines (default 2) of context around matching lines.
=item B<-c>, B<--count>
Suppress normal output; instead print a count of matching lines for
each input file. If B<-l> is in effect, it will only show the
number of lines for each file that has lines matching. Without
B<-l>, some line counts may be zeroes.
If combined with B<-h> (B<--no-filename>) ack outputs only one total
count.
=item B<--color>, B<--nocolor>
B<--color> highlights the matching text. B<--nocolor> supresses
the color. This is on by default unless the output is redirected.
On Windows, this option is off by default unless the
L<Win32::Console::ANSI> module is installed or the C<ACK_PAGER_COLOR>
environment variable is used.
=item B<--color-filename=I<color>>
Sets the color to be used for filenames.
=item B<--color-match=I<color>>
Sets the color to be used for matches.
=item B<--color-lineno=I<color>>
Sets the color to be used for line numbers.
=item B<--column>
Show the column number of the first match. This is helpful for
editors that can place your cursor at a given position.
=item B<--create-ackrc>
Dumps the default ack options to standard output. This is useful for
when you want to customize the defaults.
=item B<--env>, B<--noenv>
B<--noenv> disables all environment processing. No F<.ackrc> is
read and all environment variables are ignored. By default, F<ack>
considers F<.ackrc> and settings in the environment.
=item B<--flush>
B<--flush> flushes output immediately. This is off by default
unless ack is running interactively (when output goes to a pipe or
file).
=item B<-f>
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.
=item B<--follow>, B<--nofollow>
Follow or don't follow symlinks, other than whatever starting files
or directories were specified on the command line.
This is off by default.
=item B<-g I<REGEX>>
Print files where the relative path + filename matches I<REGEX>.
=item B<--group>, B<--nogroup>
B<--group> groups matches by file name. This is the default
when used interactively.
B<--nogroup> prints one result per line, like grep. This is the
default when output is redirected.
=item B<-H>, B<--with-filename>
Print the filename for each match.
=item B<-h>, B<--no-filename>
Suppress the prefixing of filenames on output when multiple files are
searched.
=item B<--[no]heading>
Print a filename heading above each file's results. This is the default
when used interactively.
=item B<--help>
Print a short help statement.
=item B<--help-types>, B<--help=types>
Print all known types.
=item B<-i>, B<--ignore-case>
Ignore case in the search strings.
=item B<--[no]ignore-dir=I<DIRNAME>>
Ignore directory (as CVS, .svn, etc are ignored). May be used
multiple times to ignore multiple directories. For example, mason
users may wish to include B<--ignore-dir=data>. The B<--noignore-dir>
option allows users to search directories which would normally be
ignored (perhaps to research the contents of F<.svn/props> directories).
The I<DIRNAME> must always be a simple directory name. Nested
directories like F<foo/bar> are NOT supported. You would need to
specify B<--ignore-dir=foo> and then no files from any foo directory
are taken into account by ack unless given explicitly on the command
line.
=item B<-k>, B<--known-types>
Limit selected files to those with types that ack knows about. This is
equivalent to the default behavior found in ack 1.
=item B<--line=I<NUM>>
Only print line I<NUM> of each file. Multiple lines can be given with multiple
B<--line> options or as a comma separated list (B<--line=3,5,7>). B<--line=4-7>
also works. The lines are always output in ascending order, no matter the
order given on the command line.
=item B<-l>, B<--files-with-matches>
Only print the filenames of matching files, instead of the matching text.
=item B<-L>, B<--files-without-matches>
Only print the filenames of files that do I<NOT> match. This is equivalent
to specifying B<-l> and B<-v>.
=item B<--match I<REGEX>>
Specify the I<REGEX> explicitly. This is helpful if you don't want to put the
regex as your first argument, e.g. when executing multiple searches over the
same set of files.
# search for foo and bar in given files
ack file1 t/file* --match foo
ack file1 t/file* --match bar
=item B<-m=I<NUM>>, B<--max-count=I<NUM>>
Stop reading a file after I<NUM> matches.
=item B<--man>
Print this manual page.
=item B<-n>, B<--no-recurse>
No descending into subdirectories.
=item B<-o>
Show only the part of each line matching PATTERN (turns off text
highlighting)
=item B<--output=I<expr>>
Output the evaluation of I<expr> for each line (turns off text
highlighting)
=item B<--pager=I<program>>, B<--nopager>
B<--pager> directs ack's output through I<program>. This can also be specified
via the C<ACK_PAGER> and C<ACK_PAGER_COLOR> environment variables.
Using --pager does not suppress grouping and coloring like piping
output on the command-line does.
B<--nopager> cancels any setting in ~/.ackrc, C<ACK_PAGER> or C<ACK_PAGER_COLOR>.
No output will be sent through a pager.
=item B<--passthru>
Prints all lines, whether or not they match the expression. Highlighting
will still work, though, so it can be used to highlight matches while
still seeing the entire file, as in:
# Watch a log file, and highlight a certain IP address
$ tail -f ~/access.log | ack --passthru 123.45.67.89
=item B<--print0>
Only works in conjunction with -f, -g, -l or -c (filename output). The filenames
are output separated with a null byte instead of the usual newline. This is
helpful when dealing with filenames that contain whitespace, e.g.
# remove all files of type html
ack -f --html --print0 | xargs -0 rm -f
=item B<-Q>, B<--literal>
Quote all metacharacters in PATTERN, it is treated as a literal.
=item B<-r>, B<-R>, B<--recurse>
Recurse into sub-directories. This is the default and just here for
compatibility with grep. You can also use it for turning B<--no-recurse> off.
=item B<-s>
Suppress error messages about nonexistent or unreadable files. This is taken
from fgrep.
=item B<--smart-case>, B<--no-smart-case>
Ignore case in the search strings if PATTERN contains no uppercase
characters. This is similar to C<smartcase> in vim. This option is
off by default.
B<-i> always overrides this option.
=item B<--sort-files>
Sorts the found files lexicographically. Use this if you want your file
listings to be deterministic between runs of I<ack>.
=item B<--show-types>
Outputs the filetypes that ack associates with each file.
Works with B<-f> and B<-g> options.
=item B<--type=TYPE>, B<--type=noTYPE>
Specify the types of files to include or exclude from a search.
TYPE is a filetype, like I<perl> or I<xml>. B<--type=perl> can
also be specified as B<--perl>, and B<--type=noperl> can be done
as B<--noperl>.
If a file is of both type "foo" and "bar", specifying --foo and
--nobar will exclude the file, because an exclusion takes precedence
over an inclusion.
Type specifications can be repeated and are ORed together.
See I<ack --help=types> for a list of valid types.
=item B<--type-add I<TYPE>:I<FILTER>:I<FILTERARGS>>
Files with the given FILTERARGS applied to the given FILTER
are recognized as being of (the existing) type TYPE.
See also L</"Defining your own types">.
=item B<--type-set I<TYPE>:I<FILTER>:I<FILTERARGS>>
Files with the given FILTERARGS applied to the given FILTER are recognized as
being of type TYPE. This replaces an existing definition for type TYPE. See
also L</"Defining your own types">.
=item B<--type-del I<TYPE>>
The filters associated with TYPE are removed from Ack, and are no longer considered
for searches.
=item B<-v>, B<--invert-match>
Invert match: select non-matching lines
=item B<--version>
Display version and copyright information.
=item B<-w>, B<--word-regexp>
Force PATTERN to match only whole words. The PATTERN is wrapped with
C<\b> metacharacters.
=item B<-1>
Stops after reporting first match of any kind. This is different
from B<--max-count=1> or B<-m1>, where only one match per file is
shown. Also, B<-1> works with B<-f> and B<-g>, where B<-m> does
not.
=item B<--thpppt>
Display the all-important Bill The Cat logo. Note that the exact
spelling of B<--thpppppt> is not important. It's checked against
a regular expression.
=item B<--bar>
Check with the admiral for traps.
=back
=head1 THE .ackrc FILE
The F<.ackrc> file contains command-line options that are prepended
to the command line before processing. Multiple options may live
on multiple lines. Lines beginning with a # are ignored. A F<.ackrc>
might look like this:
# Always sort the files
--sort-files
# Always color, even if piping to a another program
--color
# Use "less -r" as my pager
--pager=less -r
Note that arguments with spaces in them do not need to be quoted,
as they are not interpreted by the shell. Basically, each I<line>
in the F<.ackrc> file is interpreted as one element of C<@ARGV>.
F<ack> looks in several locations for F<.ackrc> files; the searching
process is detailed in L</"ACKRC LOCATION SEMANTICS">. These
files are not considered if B<--noenv> is specified on the command line.
=head1 Defining your own types
ack allows you to define your own types in addition to the predefined
types. This is done with command line options that are best put into
an F<.ackrc> file - then you do not have to define your types over and
over again. In the following examples the options will always be shown
on one command line so that they can be easily copy & pasted.
I<ack --perl foo> searches for foo in all perl files. I<ack --help=types>
tells you, that perl files are files ending
in .pl, .pm, .pod or .t. So what if you would like to include .xs
files as well when searching for --perl files? I<ack --type-add perl:ext:xs --perl foo>
does this for you. B<--type-add> appends
additional extensions to an existing type.
If you want to define a new type, or completely redefine an existing
type, then use B<--type-set>. I<ack --type-set eiffel:ext:e,eiffel> defines
the type I<eiffel> to include files with
the extensions .e or .eiffel. So to search for all eiffel files
containing the word Bertrand use I<ack --type-set eiffel:ext:e,eiffel --eiffel Bertrand>.
As usual, you can also write B<--type=eiffel>
instead of B<--eiffel>. Negation also works, so B<--noeiffel> excludes
all eiffel files from a search. Redefining also works: I<ack --type-set cc:ext:c,h>
and I<.xs> files no longer belong to the type I<cc>.
When defining your own types in the F<.ackrc> file you have to use
the following:
--type-set=eiffel:ext:e,eiffel
or writing on separate lines
--type-set
eiffel:ext:e,eiffel
The following does B<NOT> work in the F<.ackrc> file:
--type-set eiffel:ext:e,eiffel
In order to see all currently defined types, use I<--help-types>, e.g.
I<ack --type-set backup:ext:bak --type-add perl:ext:perl --help-types>
In addition to filtering based on extension (like ack 1.x allowed), ack 2
offers additional filter types. The generic syntax is
I<--type-set TYPE:FILTER:FILTERARGS>; I<FILTERARGS> depends on the value
of I<FILTER>.
=over 4
=item is:I<FILENAME>
I<is> filters match the target filename exactly. It takes exactly one
argument, which is the name of the file to match.
Example:
--type-set make:is:Makefile
=item ext:I<EXTENSION>[,I<EXTENSION2>[,...]]
I<ext> filters match the extension of the target file against a list
of extensions. No leading dot is needed for the extensions.
Example:
--type-set perl:ext:pl,pm,t
=item match:I<REGEX>
I<match> filters match the target filename against a regular expression.
The regular expression is made case insensitive for the search.
Example:
--type-set make:match:/(gnu)?makefile/
=item firstlinematch:I<REGEX>
I<firstlinematch> matches the first line of the target file against a
regular expression. Like I<match>, the regular expression is made
case insensitive.
Example:
--type-add perl:firstlinematch:/perl/
=back
More filter types may be made available in the future.
=head1 ENVIRONMENT VARIABLES
For commonly-used ack options, environment variables can make life
much easier. These variables are ignored if B<--noenv> is specified
on the command line.
=over 4
=item ACKRC
Specifies the location of the F<.ackrc> file. If this file doesn't
exist, F<ack> looks in the default location.
=item ACK_OPTIONS
This variable specifies default options to be placed in front of
any explicit options on the command line.
=item ACK_COLOR_FILENAME
Specifies the color of the filename when it's printed in B<--group>
mode. By default, it's "bold green".
The recognized attributes are clear, reset, dark, bold, underline,
underscore, blink, reverse, concealed black, red, green, yellow,
blue, magenta, on_black, on_red, on_green, on_yellow, on_blue,
on_magenta, on_cyan, and on_white. Case is not significant.
Underline and underscore are equivalent, as are clear and reset.
The color alone sets the foreground color, and on_color sets the
background color.
This option can also be set with B<--color-filename>.
=item ACK_COLOR_MATCH
Specifies the color of the matching text when printed in B<--color>
mode. By default, it's "black on_yellow".
This option can also be set with B<--color-match>.
See B<ACK_COLOR_FILENAME> for the color specifications.
=item ACK_COLOR_LINENO
Specifies the color of the line number when printed in B<--color>
mode. By default, it's "bold yellow".
This option can also be set with B<--color-lineno>.
See B<ACK_COLOR_FILENAME> for the color specifications.
=item ACK_PAGER
Specifies a pager program, such as C<more>, C<less> or C<most>, to which
ack will send its output.
Using C<ACK_PAGER> does not suppress grouping and coloring like
piping output on the command-line does, except that on Windows
ack will assume that C<ACK_PAGER> does not support color.
C<ACK_PAGER_COLOR> overrides C<ACK_PAGER> if both are specified.
=item ACK_PAGER_COLOR
Specifies a pager program that understands ANSI color sequences.
Using C<ACK_PAGER_COLOR> does not suppress grouping and coloring
like piping output on the command-line does.
If you are not on Windows, you never need to use C<ACK_PAGER_COLOR>.
=back
=head1 ACK & OTHER TOOLS
=head2 Vim integration
F<ack> integrates easily with the Vim text editor. Set this in your
F<.vimrc> to use F<ack> instead of F<grep>:
set grepprg=ack\ -k
That example uses C<-k> to search through only files of the types ack
knows about, but you may use other default flags. Now you can search
with F<ack> and easily step through the results in Vim:
:grep Dumper perllib
=head2 Emacs integration
Phil Jackson put together an F<ack.el> extension that "provides a
simple compilation mode ... has the ability to guess what files you
want to search for based on the major-mode."
L<http://www.shellarchive.co.uk/content/emacs.html>
=head2 TextMate integration
Pedro Melo is a TextMate user who writes "I spend my day mostly
inside TextMate, and the built-in find-in-project sucks with large
projects. So I hacked a TextMate command that was using find +
grep to use ack. The result is the Search in Project with ack, and
you can find it here:
L<http://www.simplicidade.org/notes/archives/2008/03/search_in_proje.html>"
=head2 Shell and Return Code
For greater compatibility with I<grep>, I<ack> in normal use returns
shell return or exit code of 0 only if something is found and 1 if
no match is found.
(Shell exit code 1 is C<$?=256> in perl with C<system> or backticks.)
The I<grep> code 2 for errors is not used.
If C<-f> or C<-g> are specified, then 0 is returned if at least one
file is found. If no files are found, then 1 is returned.
=cut
=head1 DEBUGGING ACK PROBLEMS