| blob | a54c9288ed67be52dfeffb744412fa8b9f193129 |
1 #!/usr/bin/env perl
2 #
3 # This file, ack, is generated code.
4 # Please DO NOT EDIT or send patches for it.
5 #
6 # Please take a look at the source from
7 # https://github.com/beyondgrep/ack3
8 # and submit patches against the individual files
9 # that build ack.
10 #
26 # Global command-line options
53 # Flag if we need any context tracking.
56 # The regex that we search for in each file.
59 # Special /m version of our $search_re.
66 # Internal stats for debugging.
69 MAIN: {
74 App::Ack::die( "Program/library version mismatch\n\t$0 is $main::VERSION\n\t$INC{'App/Ack.pm'} is $App::Ack::VERSION" );
75 }
77 # Do preliminary arg checking;
82 # Get the --thpppt, --bar, --cathy and --man checking out of the way.
87 # See if we want to ignore the environment. (Don't tell Al Gore.)
90 }
94 App::Ack::warn( 'WARNING: ack no longer uses the ACK_OPTIONS environment variable. Use an ackrc file instead.' );
95 }
96 }
100 }
102 # Load colors
106 }
112 }
119 );
124 }
159 }
162 }
172 }
174 }
177 }
181 }
184 # Expand out \t, \n and \r.
192 # If the $opt_output contains $&, $` or $', those vars won't be
193 # captured until they're used at least once in the program.
194 # Do the eval to make this happen.
199 }
200 }
201 }
203 # Set up file filters.
211 }
214 # No need to check for regex, since mutex options are handled elsewhere.
215 }
221 }
222 # XXX What is this checking for?
225 }
229 }
233 }
234 }
239 }
245 }
246 }
252 }
253 }
259 }
262 }
265 }
268 }
277 }
278 }
283 }
285 # End of MAIN
294 }
297 }
300 }
303 }
306 }
319 }
324 }
327 }
328 }
329 }
333 }
336 }
352 }
353 }
356 }
368 }
371 }
372 }
374 # If we have one or more --noignore-dir directives, we can't ignore
375 # entire subdirectory hierarchies, so we return an "accept all"
376 # filter and scrutinize the files more in _compile_file_filter.
385 };
386 }
399 # We want to check if files match the uninverted filters
401 }
404 }
405 }
411 # This depends on InverseFilter->invert returning the original filter (for optimization).
421 }
424 }
425 }
426 # ack always selects files that are specified on the command
427 # line, regardless of filetype. If you want to ack a JPEG,
428 # and say "ack foo whatever.jpg" it will do it for you.
435 }
436 }
449 }
451 }
452 }
459 }
460 }
461 }
463 # Ignore named pipes found in directory searching. Named
464 # pipes created by subprocesses get specified on the command
465 # line, so the rule of "always select whatever is on the
466 # command line" wins.
469 # We can't handle unreadable filenames; report them.
476 }
478 }
479 }
485 }
489 # Don't bother invoking inverse filters unless we consider the current file a match.
492 }
494 };
495 }
498 # Returns a (fairly) unique identifier for a file.
499 # Use this function to compare two files to see if they're
500 # equal (ie. the same file, but with a different path/links/etc).
506 }
508 # XXX Is this the best method? It always hits the FS.
511 }
513 # XXX This could be better.
515 }
516 }
517 }
519 # Returns a regex object based on a string and command-line options.
520 # Dies when the regex $str is undefined (i.e. not given on command line).
528 # Check for lowercaseness before we do any modifications.
535 # Whole words only.
540 # Explicit \w is good.
541 }
543 # Can start with \w, (, [ or dot.
546 }
547 }
549 # Can end with \w, }, ), ], +, *, or dot.
552 }
553 # ... unless it's escaped.
556 }
559 App::Ack::die( '-w will not do the right thing if your regex does not begin and end with a word character.' );
560 }
563 # No need for fancy regex if it's a simple word.
565 }
568 }
569 }
573 }
579 # No line_scan is possible if there's a $ in the regex.
581 }
582 }
587 }
590 }
594 {
596 # Number of context lines
600 # Array to keep track of lines that might be required for a "before" context
602 # Position to insert next line in @before_context_buf
605 # Number of "after" context lines still pending
608 # Number of latest line that got printed
635 }
636 }
642 }
645 }
646 }
650 }
652 }
655 }
671 }
673 }
678 }
680 # Check for context before the main loop, so we don't pay for it if we don't need it.
698 }
701 # @- = @LAST_MATCH_START
702 # @+ = @LAST_MATCH_END
704 }
705 }
706 }
713 }
716 }
717 }
723 }
726 # Disable $opt_column since there are no matches in the context lines.
730 }
732 # Save line for "before" context.
735 }
736 }
741 }
742 }
757 }
761 }
764 }
765 }
770 }
774 }
777 }
782 }
783 }
800 }
803 }
804 }
809 }
810 }
815 }
816 }
836 }
839 }
840 }
845 }
846 }
849 }
850 }
858 }
859 }
864 }
865 }
868 }
886 }
889 }
892 }
894 }
902 # Stash copies of the special variables because we can't rely
903 # on them not changing in the process of doing the s///.
910 }
912 }
913 }
917 # We have to do underlining before any highlighting because highlighting modifies string length.
929 }
930 }
943 # Fourth argument replaces the string specified by the first three.
946 # Move the offset of where /g left off forward the number of spaces of highlighting.
949 }
950 # Reset formatting and delete everything to the end of the line.
952 }
957 # Print the underline, if appropriate.
959 # Figure out how many spaces are used per line for the ANSI coloring.
968 }
969 }
977 }
979 }
980 }
983 }
990 # Check if we need to print context lines first.
995 }
997 # We want at most $n_before_ctx_lines of context.
1000 }
1003 my $line = $before_context_buf[($before_context_pos - $before_unprinted + $n_before_ctx_lines) % $n_before_ctx_lines];
1007 # Disable $opt->{column} since there are no matches in the context lines.
1012 }
1013 }
1017 # We want to get the next $n_after_ctx_lines printed.
1023 }
1025 }
1029 }
1042 }
1043 }
1048 }
1049 }
1050 }
1066 }
1067 }
1069 }
1070 }
1077 }
1078 }
1079 }
1080 }
1084 }
1089 }
1092 =pod
1094 =encoding UTF-8
1096 =head1 NAME
1098 ack - grep-like text finder
1100 =head1 SYNOPSIS
1102 ack [options] PATTERN [FILE...]
1103 ack -f [options] [DIRECTORY...]
1105 =head1 DESCRIPTION
1107 ack is designed as an alternative to F<grep> for programmers.
1109 ack searches the named input FILEs or DIRECTORYs for lines containing a
1110 match to the given PATTERN. By default, ack prints the matching lines.
1111 If no FILE or DIRECTORY is given, the current directory will be searched.
1113 PATTERN is a Perl regular expression. Perl regular expressions
1114 are commonly found in other programming languages, but for the particulars
1115 of their behavior, please consult
1116 L<perlreref|https://perldoc.perl.org/perlreref.html>. If you don't know
1117 how to use regular expression but are interested in learning, you may
1118 consult L<perlretut|https://perldoc.perl.org/perlretut.html>. If you do not
1119 need or want ack to use regular expressions, please see the
1120 C<-Q>/C<--literal> option.
1122 Ack can also list files that would be searched, without actually
1123 searching them, to let you take advantage of ack's file-type filtering
1124 capabilities.
1126 =head1 FILE SELECTION
1128 If files are not specified for searching, either on the command
1129 line or piped in with the C<-x> option, I<ack> delves into
1130 subdirectories selecting files for searching.
1132 I<ack> is intelligent about the files it searches. It knows about
1133 certain file types, based on both the extension on the file and,
1134 in some cases, the contents of the file. These selections can be
1135 made with the B<--type> option.
1137 With no file selection, I<ack> searches through regular files that
1138 are not explicitly excluded by B<--ignore-dir> and B<--ignore-file>
1139 options, either present in F<ackrc> files or on the command line.
1141 The default options for I<ack> ignore certain files and directories. These
1142 include:
1144 =over 4
1146 =item * Backup files: Files matching F<#*#> or ending with F<~>.
1148 =item * Coredumps: Files matching F<core.\d+>
1150 =item * Version control directories like F<.svn> and F<.git>.
1152 =back
1154 Run I<ack> with the C<--dump> option to see what settings are set.
1156 However, I<ack> always searches the files given on the command line,
1157 no matter what type. If you tell I<ack> to search in a coredump,
1158 it will search in a coredump.
1160 =head1 DIRECTORY SELECTION
1162 I<ack> descends through the directory tree of the starting directories
1163 specified. If no directories are specified, the current working directory is
1164 used. However, it will ignore the shadow directories used by
1165 many version control systems, and the build directories used by the
1166 Perl MakeMaker system. You may add or remove a directory from this
1167 list with the B<--[no]ignore-dir> option. The option may be repeated
1168 to add/remove multiple directories from the ignore list.
1170 For a complete list of directories that do not get searched, run
1171 C<ack --dump>.
1173 =head1 MATCHING IN A RANGE OF LINES
1175 The C<--range-start> and C<--range-end> options let you specify ranges of
1176 lines to search within each file.
1178 Say you had the following file, called F<testfile>:
1180 # This function calls print on "foo".
1181 sub foo {
1182 print 'foo';
1183 }
1184 my $print = 1;
1185 sub bar {
1186 print 'bar';
1187 }
1188 my $task = 'print';
1190 Calling C<ack print> will give us five matches:
1192 $ ack print testfile
1193 # This function calls print on "foo".
1194 print 'foo';
1195 my $print = 1;
1196 print 'bar';
1197 my $task = 'print';
1199 What if we only want to search for C<print> within the subroutines? We can
1200 specify ranges of lines that we want ack to search. The range starts with
1201 any line that matches the pattern C<^sub \w+>, and stops with any line that
1202 matches C<^}>.
1204 $ ack --range-start='^sub \w+' --range-end='^}' print testfile
1205 print 'foo';
1206 print 'bar';
1208 Note that ack searched two ranges of lines. The listing below shows which
1209 lines were in a range and which were out of the range.
1211 Out # This function calls print on "foo".
1212 In sub foo {
1213 In print 'foo';
1214 In }
1215 Out my $print = 1;
1216 In sub bar {
1217 In print 'bar';
1218 In }
1219 Out my $task = 'print';
1221 You don't have to specify both C<--range-start> and C<--range-end>. IF
1222 C<--range-start> is omitted, then the range runs from the first line in the
1223 file unitl the first line that matches C<--range-end>. Similarly, if
1224 C<--range-end> is omitted, the range runs from the first line matching
1225 C<--range-start> to the end of the file.
1227 For example, if you wanted to search all HTML files up until the first
1228 instance of the C<< <body> >>, you could do
1230 ack foo --range-end='<body>'
1232 Or to search after Perl's `__DATA__` or `__END__` markers, you would do
1234 ack pattern --range-end='^__(END|DATA)__'
1236 It's possible for a range to start and stop on the same line. For example
1238 --range-start='<title>' --range-end='</title>'
1240 would match this line as both the start and end of the range, making a
1241 one-line range.
1243 <title>Page title</title>
1245 Note that the patterns in C<--range-start> and C<--range-end> are not
1246 affected by options like C<-i>, C<-w> and C<-Q> that modify the behavior of
1247 the main pattern being matched.
1249 Again, ranges only affect where matches are looked for. Everything else in
1250 ack works the same way. Using C<-c> option with a range will give a count
1251 of all the matches that appear within those ranges. The C<-l> shows those
1252 files that have a match within a range, and the C<-L> option shows files
1253 that do not have a match within a range.
1255 The C<-v> option for negating a match works inside the range, too.
1256 To see lines that don't match "google" within the "<head>" section of
1257 your HTML files, you could do:
1259 ack google -v --html --range-start='<head' --range-end='</head>'
1261 Specifying a range to search does not affect how matches are displayed.
1262 The context for a match will still be the same, and
1264 Using the context options work the same way, and will show context
1265 lines for matches even if the context lines fall outside the range.
1266 Similarly, C<--passthru> will show all lines in the file, but only show
1267 matches for lines within the range.
1269 =head1 OPTIONS
1271 =over 4
1273 =item B<--ackrc>
1275 Specifies an ackrc file to load after all others; see L</"ACKRC LOCATION SEMANTICS">.
1277 =item B<-A I<NUM>>, B<--after-context=I<NUM>>
1279 Print I<NUM> lines of trailing context after matching lines.
1281 =item B<-B I<NUM>>, B<--before-context=I<NUM>>
1283 Print I<NUM> lines of leading context before matching lines.
1285 =item B<--[no]break>
1287 Print a break between results from different files. On by default
1288 when used interactively.
1290 =item B<-C [I<NUM>]>, B<--context[=I<NUM>]>
1292 Print I<NUM> lines (default 2) of context around matching lines.
1293 You can specify zero lines of context to override another context
1294 specified in an ackrc.
1296 =item B<-c>, B<--count>
1298 Suppress normal output; instead print a count of matching lines for
1299 each input file. If B<-l> is in effect, it will only show the
1300 number of lines for each file that has lines matching. Without
1301 B<-l>, some line counts may be zeroes.
1303 If combined with B<-h> (B<--no-filename>) ack outputs only one total
1304 count.
1306 =item B<--[no]color>, B<--[no]colour>
1308 B<--color> highlights the matching text. B<--nocolor> suppresses
1309 the color. This is on by default unless the output is redirected.
1311 On Windows, this option is off by default unless the
1312 L<Win32::Console::ANSI> module is installed or the C<ACK_PAGER_COLOR>
1313 environment variable is used.
1315 =item B<--color-filename=I<color>>
1317 Sets the color to be used for filenames.
1319 =item B<--color-match=I<color>>
1321 Sets the color to be used for matches.
1323 =item B<--color-colno=I<color>>
1325 Sets the color to be used for column numbers.
1327 =item B<--color-lineno=I<color>>
1329 Sets the color to be used for line numbers.
1331 =item B<--[no]column>
1333 Show the column number of the first match. This is helpful for
1334 editors that can place your cursor at a given position.
1336 =item B<--create-ackrc>
1338 Dumps the default ack options to standard output. This is useful for
1339 when you want to customize the defaults.
1341 =item B<--dump>
1343 Writes the list of options loaded and where they came from to standard
1344 output. Handy for debugging.
1346 =item B<--[no]env>
1348 B<--noenv> disables all environment processing. No F<.ackrc> is
1349 read and all environment variables are ignored. By default, F<ack>
1350 considers F<.ackrc> and settings in the environment.
1352 =item B<--flush>
1354 B<--flush> flushes output immediately. This is off by default
1355 unless ack is running interactively (when output goes to a pipe or
1356 file).
1358 =item B<-f>
1360 Only print the files that would be searched, without actually doing
1361 any searching. PATTERN must not be specified, or it will be taken
1362 as a path to search.
1364 =item B<--files-from=I<FILE>>
1366 The list of files to be searched is specified in I<FILE>. The list of
1367 files are separated by newlines. If I<FILE> is C<->, the list is loaded
1368 from standard input.
1370 Note that the list of files is B<not> filtered in any way. If you
1371 add C<--type=html> in addition to C<--files-from>, the C<--type> will
1372 be ignored.
1375 =item B<--[no]filter>
1377 Forces ack to act as if it were receiving input via a pipe.
1379 =item B<--[no]follow>
1381 Follow or don't follow symlinks, other than whatever starting files
1382 or directories were specified on the command line.
1384 This is off by default.
1386 =item B<-g I<PATTERN>>
1388 Print searchable files where the relative path + filename matches
1389 I<PATTERN>.
1391 Note that
1393 ack -g foo
1395 is exactly the same as
1397 ack -f | ack foo
1399 This means that just as ack will not search, for example, F<.jpg>
1400 files, C<-g> will not list F<.jpg> files either. ack is not intended
1401 to be a general-purpose file finder.
1403 Note also that if you have C<-i> in your .ackrc that the filenames
1404 to be matched will be case-insensitive as well.
1406 This option can be combined with B<--color> to make it easier to
1407 spot the match.
1409 =item B<--[no]group>
1411 B<--group> groups matches by file name. This is the default
1412 when used interactively.
1414 B<--nogroup> prints one result per line, like grep. This is the
1415 default when output is redirected.
1417 =item B<-H>, B<--with-filename>
1419 Print the filename for each match. This is the default unless searching
1420 a single explicitly specified file.
1422 =item B<-h>, B<--no-filename>
1424 Suppress the prefixing of filenames on output when multiple files are
1425 searched.
1427 =item B<--[no]heading>
1429 Print a filename heading above each file's results. This is the default
1430 when used interactively.
1432 =item B<--help>
1434 Print a short help statement.
1436 =item B<--help-types>
1438 Print all known types.
1440 =item B<--help-colors>
1442 Print a chart of various color combinations.
1444 =item B<--help-rgb-colors>
1446 Like B<--help-colors> but with more precise RGB colors.
1448 =item B<-i>, B<--ignore-case>
1450 Ignore case distinctions in PATTERN. Overrides B<--smart-case> and B<-I>.
1452 =item B<-I>, B<--no-ignore-case>
1454 Turns on case distinctions in PATTERN. Overrides B<--smart-case> and B<-i>.
1456 =item B<--ignore-ack-defaults>
1458 Tells ack to completely ignore the default definitions provided with ack.
1459 This is useful in combination with B<--create-ackrc> if you I<really> want
1460 to customize ack.
1462 =item B<--[no]ignore-dir=I<DIRNAME>>, B<--[no]ignore-directory=I<DIRNAME>>
1464 Ignore directory (as CVS, .svn, etc are ignored). May be used
1465 multiple times to ignore multiple directories. For example, mason
1466 users may wish to include B<--ignore-dir=data>. The B<--noignore-dir>
1467 option allows users to search directories which would normally be
1468 ignored (perhaps to research the contents of F<.svn/props> directories).
1470 The I<DIRNAME> must always be a simple directory name. Nested
1471 directories like F<foo/bar> are NOT supported. You would need to
1472 specify B<--ignore-dir=foo> and then no files from any foo directory
1473 are taken into account by ack unless given explicitly on the command
1474 line.
1476 =item B<--ignore-file=I<FILTER:ARGS>>
1478 Ignore files matching I<FILTER:ARGS>. The filters are specified
1479 identically to file type filters as seen in L</"Defining your own types">.
1481 =item B<-k>, B<--known-types>
1483 Limit selected files to those with types that ack knows about.
1485 =item B<-l>, B<--files-with-matches>
1487 Only print the filenames of matching files, instead of the matching text.
1489 =item B<-L>, B<--files-without-matches>
1491 Only print the filenames of files that do I<NOT> match.
1493 =item B<--match I<PATTERN>>
1495 Specify the I<PATTERN> explicitly. This is helpful if you don't want to put the
1496 regex as your first argument, e.g. when executing multiple searches over the
1497 same set of files.
1499 # search for foo and bar in given files
1500 ack file1 t/file* --match foo
1501 ack file1 t/file* --match bar
1503 =item B<-m=I<NUM>>, B<--max-count=I<NUM>>
1505 Print only I<NUM> matches out of each file. If you want to stop ack
1506 after printing the first match of any kind, use the B<-1> options.
1508 =item B<--man>
1510 Print this manual page.
1512 =item B<-n>, B<--no-recurse>
1514 No descending into subdirectories.
1516 =item B<-o>
1518 Show only the part of each line matching PATTERN (turns off text
1519 highlighting). This is exactly the same as C<--output=$&>.
1521 =item B<--output=I<expr>>
1523 Output the evaluation of I<expr> for each line (turns off text
1524 highlighting). If PATTERN matches more than once then a line is
1525 output for each non-overlapping match.
1527 I<expr> may contain the strings "\n", "\r" and "\t", which will be
1528 expanded to their corresponding characters line feed, carriage return
1529 and tab, respectively.
1531 I<expr> may also contain the following Perl special variables:
1533 =over 4
1535 =item C<$1> through C<$9>
1537 The subpattern from the corresponding set of capturing parentheses.
1538 If your pattern is C<(.+) and (.+)>, and the string is "this and
1539 that', then C<$1> is "this" and C<$2> is "that".
1541 =item C<$_>
1543 The contents of the line in the file.
1545 =item C<$.>
1547 The number of the line in the file.
1549 =item C<$&>, C<$`> and C<$'>
1551 C<$&> is the the string matched by the pattern, C<$`> is what
1552 precedes the match, and C<$'> is what follows it. If the pattern
1553 is C<gra(ph|nd)> and the string is "lexicographic", then C<$&> is
1554 "graph", C<$`> is "lexico" and C<$'> is "ic".
1556 Use of these variables in your output will slow down the pattern
1557 matching.
1559 =item C<$+>
1561 The match made by the last parentheses that matched in the pattern.
1562 For example, if your pattern is C<Version: (.+)|Revision: (.+)>,
1563 then C<$+> will contain whichever set of parentheses matched.
1565 =item C<$f>
1567 C<$f> is available, in C<--output> only, to insert the filename.
1568 This is a stand-in for the discovered C<$filename> usage in old C<< ack2 --output >>,
1569 which is disallowed with C<ack3> improved security.
1571 The intended usage is to provide the grep or compile-error syntax needed for editor/IDE go-to-line integration,
1572 e.g. C<--output=$f:$.:$_> or C<--output=$f\t$.\t$&>
1574 =back
1576 =item B<--pager=I<program>>, B<--nopager>
1578 B<--pager> directs ack's output through I<program>. This can also be specified
1579 via the C<ACK_PAGER> and C<ACK_PAGER_COLOR> environment variables.
1581 Using --pager does not suppress grouping and coloring like piping
1582 output on the command-line does.
1584 B<--nopager> cancels any setting in F<~/.ackrc>, C<ACK_PAGER> or C<ACK_PAGER_COLOR>.
1585 No output will be sent through a pager.
1587 =item B<--passthru>
1589 Prints all lines, whether or not they match the expression. Highlighting
1590 will still work, though, so it can be used to highlight matches while
1591 still seeing the entire file, as in:
1593 # Watch a log file, and highlight a certain IP address.
1594 $ tail -f ~/access.log | ack --passthru 123.45.67.89
1596 =item B<--print0>
1598 Only works in conjunction with B<-f>, B<-g>, B<-l> or B<-c>, options
1599 that only list filenames. The filenames are output separated with a
1600 null byte instead of the usual newline. This is helpful when dealing
1601 with filenames that contain whitespace, e.g.
1603 # Remove all files of type HTML.
1604 ack -f --html --print0 | xargs -0 rm -f
1606 =item B<-p[N]>, B<--proximate[=N]>
1608 Groups together match lines that are within N lines of each other.
1609 This is useful for visually picking out matches that appear close
1610 to other matches.
1612 For example, if you got these results without the C<--proximate> option,
1614 15: First match
1615 18: Second match
1616 19: Third match
1617 37: Fourth match
1619 they would look like this with C<--proximate=1>
1621 15: First match
1623 18: Second match
1624 19: Third match
1626 37: Fourth match
1628 and this with C<--proximate=3>.
1630 15: First match
1631 18: Second match
1632 19: Third match
1634 37: Fourth match
1636 If N is omitted, N is set to 1.
1638 =item B<-P>
1640 Negates the effect of the B<--proximate> option. Shortcut for B<--proximate=0>.
1642 =item B<-Q>, B<--literal>
1644 Quote all metacharacters in PATTERN, it is treated as a literal.
1646 =item B<-r>, B<-R>, B<--recurse>
1648 Recurse into sub-directories. This is the default and just here for
1649 compatibility with grep. You can also use it for turning B<--no-recurse> off.
1651 =item B<--range-start=PATTERN>, B<--range-end=PATTERN>
1653 Specifies patterns that mark the start and end of a range. See
1654 L<MATCHING IN A RANGE OF LINES> for details.
1656 =item B<-s>
1658 Suppress error messages about nonexistent or unreadable files. This is taken
1659 from fgrep.
1661 =item B<-S>, B<--[no]smart-case>, B<--no-smart-case>
1663 Ignore case in the search strings if PATTERN contains no uppercase
1664 characters. This is similar to C<smartcase> in the vim text editor.
1665 The options overrides B<-i> and B<-I>.
1667 B<-S> is a synonym for B<--smart-case>.
1669 B<-i> always overrides this option.
1671 =item B<--sort-files>
1673 Sorts the found files lexicographically. Use this if you want your file
1674 listings to be deterministic between runs of I<ack>.
1676 =item B<--show-types>
1678 Outputs the filetypes that ack associates with each file.
1680 Works with B<-f> and B<-g> options.
1682 =item B<-t TYPE>, B<--type=TYPE>, B<--TYPE>
1684 Specify the types of files to include in the search.
1685 TYPE is a filetype, like I<perl> or I<xml>. B<--type=perl> can
1686 also be specified as B<--perl>, although this is deprecated.
1688 Type inclusions can be repeated and are ORed together.
1690 See I<ack --help=types> for a list of valid types.
1692 =item B<-T TYPE>, B<--type=noTYPE>, B<--noTYPE>
1694 Specifies the type of files to exclude from the search. B<--type=noperl>
1695 can be done as B<--noperl>, although this is deprecated.
1697 If a file is of both type "foo" and "bar", specifying both B<--type=foo>
1698 and B<--type=nobar> will exclude the file, because an exclusion takes
1699 precedence over an inclusion.
1701 =item B<--type-add I<TYPE>:I<FILTER>:I<ARGS>>
1703 Files with the given ARGS applied to the given FILTER
1704 are recognized as being of (the existing) type TYPE.
1705 See also L</"Defining your own types">.
1707 =item B<--type-set I<TYPE>:I<FILTER>:I<ARGS>>
1709 Files with the given ARGS applied to the given FILTER are recognized as
1710 being of type TYPE. This replaces an existing definition for type TYPE. See
1711 also L</"Defining your own types">.
1713 =item B<--type-del I<TYPE>>
1715 The filters associated with TYPE are removed from Ack, and are no longer considered
1716 for searches.
1718 =item B<--[no]underline>
1720 Turns on underlining of matches, where "underlining" is printing a line of
1721 carets under the match.
1723 $ ack -u foo
1724 peanuts.txt
1725 17: Come kick the football you fool
1726 ^^^ ^^^
1727 623: Price per square foot
1728 ^^^
1730 This is useful if you're dumping the results of an ack run into a text
1731 file or printer that doesn't support ANSI color codes.
1733 The setting of underline does not affect highlighting of matches.
1735 =item B<-v>, B<--invert-match>
1737 Invert match: select non-matching lines.
1739 =item B<--version>
1741 Display version and copyright information.
1743 =item B<-w>, B<--word-regexp>
1745 Force PATTERN to match only whole words.
1747 =item B<-x>
1749 An abbreviation for B<--files-from=->. The list of files to search are read
1750 from standard input, with one line per file.
1752 Note that the list of files is B<not> filtered in any way. If you add
1753 C<--type=html> in addition to C<-x>, the C<--type> will be ignored.
1755 =item B<-1>
1757 Stops after reporting first match of any kind. This is different
1758 from B<--max-count=1> or B<-m1>, where only one match per file is
1759 shown. Also, B<-1> works with B<-f> and B<-g>, where B<-m> does
1760 not.
1762 =item B<--thpppt>
1764 Display the all-important Bill The Cat logo. Note that the exact
1765 spelling of B<--thpppppt> is not important. It's checked against
1766 a regular expression.
1768 =item B<--bar>
1770 Check with the admiral for traps.
1772 =item B<--cathy>
1774 Chocolate, Chocolate, Chocolate!
1776 =back
1778 =head1 THE .ackrc FILE
1780 The F<.ackrc> file contains command-line options that are prepended
1781 to the command line before processing. Multiple options may live
1782 on multiple lines. Lines beginning with a # are ignored. A F<.ackrc>
1783 might look like this:
1785 # Always sort the files
1786 --sort-files
1788 # Always color, even if piping to another program
1789 --color
1791 # Use "less -r" as my pager
1792 --pager=less -r
1794 Note that arguments with spaces in them do not need to be quoted,
1795 as they are not interpreted by the shell. Basically, each I<line>
1796 in the F<.ackrc> file is interpreted as one element of C<@ARGV>.
1798 F<ack> looks in several locations for F<.ackrc> files; the searching
1799 process is detailed in L</"ACKRC LOCATION SEMANTICS">. These
1800 files are not considered if B<--noenv> is specified on the command line.
1802 =head1 Defining your own types
1804 ack allows you to define your own types in addition to the predefined
1805 types. This is done with command line options that are best put into
1806 an F<.ackrc> file - then you do not have to define your types over and
1807 over again. In the following examples the options will always be shown
1808 on one command line so that they can be easily copy & pasted.
1810 File types can be specified both with the the I<--type=xxx> option,
1811 or the file type as an option itself. For example, if you create
1812 a filetype of "cobol", you can specify I<--type=cobol> or simply
1813 I<--cobol>. File types must be at least two characters long. This
1814 is why the C language is I<--cc> and the R language is I<--rr>.
1816 I<ack --perl foo> searches for foo in all perl files. I<ack --help=types>
1817 tells you, that perl files are files ending
1818 in .pl, .pm, .pod or .t. So what if you would like to include .xs
1819 files as well when searching for --perl files? I<ack --type-add perl:ext:xs --perl foo>
1820 does this for you. B<--type-add> appends
1821 additional extensions to an existing type.
1823 If you want to define a new type, or completely redefine an existing
1824 type, then use B<--type-set>. I<ack --type-set eiffel:ext:e,eiffel> defines
1825 the type I<eiffel> to include files with
1826 the extensions .e or .eiffel. So to search for all eiffel files
1827 containing the word Bertrand use I<ack --type-set eiffel:ext:e,eiffel --eiffel Bertrand>.
1828 As usual, you can also write B<--type=eiffel>
1829 instead of B<--eiffel>. Negation also works, so B<--noeiffel> excludes
1830 all eiffel files from a search. Redefining also works: I<ack --type-set cc:ext:c,h>
1831 and I<.xs> files no longer belong to the type I<cc>.
1833 When defining your own types in the F<.ackrc> file you have to use
1834 the following:
1836 --type-set=eiffel:ext:e,eiffel
1838 or writing on separate lines
1840 --type-set
1841 eiffel:ext:e,eiffel
1843 The following does B<NOT> work in the F<.ackrc> file:
1845 --type-set eiffel:ext:e,eiffel
1847 In order to see all currently defined types, use I<--help-types>, e.g.
1848 I<ack --type-set backup:ext:bak --type-add perl:ext:perl --help-types>
1850 In addition to filtering based on extension, ack offers additional
1851 filter types. The generic syntax is
1852 I<--type-set TYPE:FILTER:ARGS>; I<ARGS> depends on the value
1853 of I<FILTER>.
1855 =over 4
1857 =item is:I<FILENAME>
1859 I<is> filters match the target filename exactly. It takes exactly one
1860 argument, which is the name of the file to match.
1862 Example:
1864 --type-set make:is:Makefile
1866 =item ext:I<EXTENSION>[,I<EXTENSION2>[,...]]
1868 I<ext> filters match the extension of the target file against a list
1869 of extensions. No leading dot is needed for the extensions.
1871 Example:
1873 --type-set perl:ext:pl,pm,t
1875 =item match:I<PATTERN>
1877 I<match> filters match the target filename against a regular expression.
1878 The regular expression is made case-insensitive for the search.
1880 Example:
1882 --type-set make:match:/(gnu)?makefile/
1884 =item firstlinematch:I<PATTERN>
1886 I<firstlinematch> matches the first line of the target file against a
1887 regular expression. Like I<match>, the regular expression is made
1888 case insensitive.
1890 Example:
1892 --type-add perl:firstlinematch:/perl/
1894 =back
1896 =head1 ACK COLORS
1898 ack allows customization of the colors it uses when presenting matches
1899 onscreen. It uses the colors available in Perl's L<Term::ANSIColor>
1900 module, which provides the following listed values. Note that case does not
1901 matter when using these values.
1903 There are four different colors ack uses:
1905 Aspect Option Env. variable Default
1906 -------- ----------------- ------------------ ---------------
1907 filename --color-filename ACK_COLOR_FILENAME black on_yellow
1908 match --color-match ACK_COLOR_MATCH bold green
1909 line no. --color-lineno ACK COLOR_LINENO bold yellow
1910 column no. --color-colno ACK COLOR_COLNO bold yellow
1912 The column number column is only used if the column number is shown because
1913 of the --column option.
1915 Colors may be specified by command-line option, such as
1916 C<ack --color-filename='red on_white'>, or by setting an environment
1917 variable, such as C<ACK_COLOR_FILENAME='red on_white'>. Options for colors
1918 can be set in your ACKRC file (See "THE .ackrc FILE").
1920 ack can understand the following colors for the foreground:
1922 black red green yellow blue magenta cyan white
1924 The optional background color is specified by prepending "on_" to one of
1925 the foreground colors:
1927 on_black on_red on_green on_yellow on_blue on_magenta on_cyan on_white
1929 Each of the foreground colors can be modified with the following
1930 attributes, which may or may not be supported by your terminal:
1932 bold faint italic underline blink reverse concealed
1934 Any combinations of modifiers can be added to the foreground color. If your
1935 terminal supports it, and you enjoy visual punishment, you can specify:
1937 ack --color-filename="blink italic underline bold red on_yellow"
1939 For charts of the colors and what they look like, run C<ack --help-colors>
1940 and C<ack --help-rgb-colors>.
1942 If the eight standard colors, in their bold, faint and unmodified states,
1943 aren't enough for you to choose from, you can also specify colors by their
1944 RGB values. They are specified as "rgbXYZ" where X, Y, and Z are values
1945 between 0 and 5 giving the intensity of red, green and blue, respectively.
1946 Therefore, "rgb500" is pure red, "rgb505" is purple, and so on.
1948 Background colors can be specified with the "on_" prefix prepended on an
1949 RGB color, so that "on_rgb505" would be a purple background.
1951 The modifier attributes of blink, italic, underscore and so on may or may
1952 not work on the RGB colors.
1954 For a chart of the 216 possible RGB colors, run C<ack --help-rgb-colors>.
1956 =head1 ENVIRONMENT VARIABLES
1958 For commonly-used ack options, environment variables can make life
1959 much easier. These variables are ignored if B<--noenv> is specified
1960 on the command line.
1962 =over 4
1964 =item ACKRC
1966 Specifies the location of the user's F<.ackrc> file. If this file doesn't
1967 exist, F<ack> looks in the default location.
1969 =item ACK_COLOR_COLNO
1971 Color specification for the column number in ack's output. By default, the
1972 column number is not shown. You have to enable it with the B<--column>
1973 option. See the section "ack Colors" above.
1975 =item ACK_COLOR_FILENAME
1977 Color specification for the filename in ack's output. See the section "ack
1978 Colors" above.
1980 =item ACK_COLOR_LINENO
1982 Color specification for the line number in ack's output. See the section
1983 "ack Colors" above.
1985 =item ACK_COLOR_MATCH
1987 Color specification for the matched text in ack's output. See the section
1988 "ack Colors" above.
1990 =item ACK_PAGER
1992 Specifies a pager program, such as C<more>, C<less> or C<most>, to which
1993 ack will send its output.
1995 Using C<ACK_PAGER> does not suppress grouping and coloring like
1996 piping output on the command-line does, except that on Windows
1997 ack will assume that C<ACK_PAGER> does not support color.
1999 C<ACK_PAGER_COLOR> overrides C<ACK_PAGER> if both are specified.
2001 =item ACK_PAGER_COLOR
2003 Specifies a pager program that understands ANSI color sequences.
2004 Using C<ACK_PAGER_COLOR> does not suppress grouping and coloring
2005 like piping output on the command-line does.
2007 If you are not on Windows, you never need to use C<ACK_PAGER_COLOR>.
2009 =back
2011 =head1 ACK & OTHER TOOLS
2013 =head2 Simple vim integration
2015 F<ack> integrates easily with the Vim text editor. Set this in your
2016 F<.vimrc> to use F<ack> instead of F<grep>:
2018 set grepprg=ack\ -k
2020 That example uses C<-k> to search through only files of the types ack
2021 knows about, but you may use other default flags. Now you can search
2022 with F<ack> and easily step through the results in Vim:
2024 :grep Dumper perllib
2026 =head2 Editor integration
2028 Many users have integrated ack into their preferred text editors.
2029 For details and links, see L<https://beyondgrep.com/more-tools/>.
2031 =head2 Shell and Return Code
2033 For greater compatibility with I<grep>, I<ack> in normal use returns
2034 shell return or exit code of 0 only if something is found and 1 if
2035 no match is found.
2037 (Shell exit code 1 is C<$?=256> in perl with C<system> or backticks.)
2039 The I<grep> code 2 for errors is not used.
2041 If C<-f> or C<-g> are specified, then 0 is returned if at least one
2042 file is found. If no files are found, then 1 is returned.
2044 =cut
2046 =head1 DEBUGGING ACK PROBLEMS
2048 If ack gives you output you're not expecting, start with a few simple steps.
2050 =head2 Try it with B<--noenv>
2052 Your environment variables and F<.ackrc> may be doing things you're
2053 not expecting, or forgotten you specified. Use B<--noenv> to ignore
2054 your environment and F<.ackrc>.
2056 =head2 Use B<-f> to see what files have been selected for searching
2058 Ack's B<-f> was originally added as a debugging tool. If ack is
2059 not finding matches you think it should find, run F<ack -f> to see
2060 what files have been selected. You can also add the C<--show-types>
2061 options to show the type of each file selected.
2063 =head2 Use B<--dump>
2065 This lists the ackrc files that are loaded and the options loaded
2066 from them. You may be loading an F<.ackrc> file that you didn't know
2067 you were loading.
2069 =head1 ACKRC LOCATION SEMANTICS
2071 Ack can load its configuration from many sources. The following list
2072 specifies the sources Ack looks for configuration files; each one
2073 that is found is loaded in the order specified here, and
2074 each one overrides options set in any of the sources preceding
2075 it. (For example, if I set --sort-files in my user ackrc, and
2076 --nosort-files on the command line, the command line takes
2077 precedence)
2079 =over 4
2081 =item *
2083 Defaults are loaded from App::Ack::ConfigDefaults. This can be omitted
2084 using C<--ignore-ack-defaults>.
2086 =item * Global ackrc
2088 Options are then loaded from the global ackrc. This is located at
2089 C</etc/ackrc> on Unix-like systems.
2091 Under Windows XP and earlier, the global ackrc is at
2092 C<C:\Documents and Settings\All Users\Application Data\ackrc>
2094 Under Windows Vista/7, the global ackrc is at
2095 C<C:\ProgramData\ackrc>
2097 The C<--noenv> option prevents all ackrc files from being loaded.
2099 =item * User ackrc
2101 Options are then loaded from the user's ackrc. This is located at
2102 C<$HOME/.ackrc> on Unix-like systems.
2104 Under Windows XP and earlier, the user's ackrc is at
2105 C<C:\Documents and Settings\$USER\Application Data\ackrc>.
2107 Under Windows Vista/7, the user's ackrc is at
2108 C<C:\Users\$USER\AppData\Roaming\ackrc>.
2110 If you want to load a different user-level ackrc, it may be specified
2111 with the C<$ACKRC> environment variable.
2113 The C<--noenv> option prevents all ackrc files from being loaded.
2115 =item * Project ackrc
2117 Options are then loaded from the project ackrc. The project ackrc is
2118 the first ackrc file with the name C<.ackrc> or C<_ackrc>, first searching
2119 in the current directory, then the parent directory, then the grandparent
2120 directory, etc. This can be omitted using C<--noenv>.
2122 =item * --ackrc
2124 The C<--ackrc> option may be included on the command line to specify an
2125 ackrc file that can override all others. It is consulted even if C<--noenv>
2126 is present.
2128 =item * Command line
2130 Options are then loaded from the command line.
2132 =back
2134 =head1 BUGS & ENHANCEMENTS
2136 ack is based at GitHub at L<https://github.com/beyondgrep/ack3>
2138 Please report any bugs or feature requests to the issues list at
2139 Github: L<https://github.com/beyondgrep/ack3/issues>.
2141 Please include the operating system that you're using; the output of
2142 the command C<ack --version>; and any customizations in your F<.ackrc>
2143 you may have.
2145 To suggest enhancements, please submit an issue at
2146 L<https://github.com/beyondgrep/ack3/issues>. Also read the
2147 F<DEVELOPERS.md> file in the ack code repository.
2149 Also, feel free to discuss your issues on the ack mailing
2150 list at L<https://groups.google.com/group/ack-users>.
2152 =head1 SUPPORT
2154 Support for and information about F<ack> can be found at:
2156 =over 4
2158 =item * The ack homepage
2160 L<https://beyondgrep.com/>
2162 =item * Source repository
2164 L<https://github.com/beyondgrep/ack3>
2166 =item * The ack issues list at Github
2168 L<https://github.com/beyondgrep/ack3/issues>
2170 =item * The ack announcements mailing list
2172 L<https://groups.google.com/group/ack-announcement>
2174 =item * The ack users' mailing list
2176 L<https://groups.google.com/group/ack-users>
2178 =item * The ack development mailing list
2180 L<https://groups.google.com/group/ack-users>
2182 =back
2184 =head1 COMMUNITY
2186 There are ack mailing lists and a Slack channel for ack. See
2187 L<https://beyondgrep.com/community/> for details.
2189 =head1 FAQ
2191 This is the Frequently Asked Questions list for ack.
2193 =head2 Can I stop using grep now?
2195 Many people find I<ack> to be better than I<grep> as an everyday tool
2196 99% of the time, but don't throw I<grep> away, because there are times
2197 you'll still need it. For example, you might be looking through huge
2198 log files and not using regular expressions. In that case, I<grep>
2199 will probably perform better.
2201 =head2 Why isn't ack finding a match in (some file)?
2203 First, take a look and see if ack is even looking at the file. ack is
2204 intelligent in what files it will search and which ones it won't, but
2205 sometimes that can be surprising.
2207 Use the C<-f> switch, with no regex, to see a list of files that ack
2208 will search for you. If your file doesn't show up in the list of files
2209 that C<ack -f> shows, then ack never looks in it.
2211 =head2 Wouldn't it be great if F<ack> did search & replace?
2213 No, ack will always be read-only. Perl has a perfectly good way
2214 to do search & replace in files, using the C<-i>, C<-p> and C<-n>
2215 switches.
2217 You can certainly use ack to select your files to update. For
2218 example, to change all "foo" to "bar" in all PHP files, you can do
2219 this from the Unix shell:
2221 $ perl -i -p -e's/foo/bar/g' $(ack -f --php)
2223 =head2 Can I make ack recognize F<.xyz> files?
2225 Yes! Please see L</"Defining your own types"> in the ack manual.
2227 =head2 Will you make ack recognize F<.xyz> files by default?
2229 We might, depending on how widely-used the file format is.
2231 Submit an issue at in the GitHub issue queue at
2232 L<https://github.com/beyondgrep/ack3/issues>. Explain what the file format
2233 is, where we can find out more about it, and what you have been using
2234 in your F<.ackrc> to support it.
2236 Please do not bother creating a pull request. The code for filetypes
2237 is trivial compared to the rest of the process we go through.
2239 =head2 Why is it called ack if it's called ack-grep?
2241 The name of the program is "ack". Some packagers have called it
2242 "ack-grep" when creating packages because there's already a package
2243 out there called "ack" that has nothing to do with this ack.
2245 I suggest you make a symlink named F<ack> that points to F<ack-grep>
2246 because one of the crucial benefits of ack is having a name that's
2247 so short and simple to type.
2249 To do that, run this with F<sudo> or as root:
2251 ln -s /usr/bin/ack-grep /usr/bin/ack
2253 Alternatively, you could use a shell alias:
2255 # bash/zsh
2256 alias ack=ack-grep
2258 # csh
2259 alias ack ack-grep
2261 =head2 What does F<ack> mean?
2263 Nothing. I wanted a name that was easy to type and that you could
2264 pronounce as a single syllable.
2266 =head2 Can I do multi-line regexes?
2268 No, ack does not support regexes that match multiple lines. Doing
2269 so would require reading in the entire file at a time.
2271 If you want to see lines near your match, use the C<--A>, C<--B>
2272 and C<--C> switches for displaying context.
2274 =head2 Why is ack telling me I have an invalid option when searching for C<+foo>?
2276 ack treats command line options beginning with C<+> or C<-> as options; if you
2277 would like to search for these, you may prefix your search term with C<--> or
2278 use the C<--match> option. (However, don't forget that C<+> is a regular
2279 expression metacharacter!)
2281 =head2 Why does C<"ack '.{40000,}'"> fail? Isn't that a valid regex?
2283 The Perl language limits the repetition quantifier to 32K. You
2284 can search for C<.{32767}> but not C<.{32768}>.
2286 =head2 Ack does "X" and shouldn't, should it?
2288 We try to remain as close to grep's behavior as possible, so when in
2289 doubt, see what grep does! If there's a mismatch in functionality there,
2290 please submit an issue to GitHub, and/or bring it up on the ack-users
2291 mailing list.
2293 =cut
2295 =head1 ACKNOWLEDGEMENTS
2297 How appropriate to have I<ack>nowledgements!
2299 Thanks to everyone who has contributed to ack in any way, including
2300 Dan Book,
2301 Tomasz Konojacki,
2302 Salomon Smeke,
2303 M. Scott Ford,
2304 Anders Eriksson,
2305 H.Merijn Brand,
2306 Duke Leto,
2307 Gerhard Poul,
2308 Ethan Mallove,
2309 Marek Kubica,
2310 Ray Donnelly,
2311 Nikolaj Schumacher,
2312 Ed Avis,
2313 Nick Morrott,
2314 Austin Chamberlin,
2315 Varadinsky,
2316 SE<eacute>bastien FeugE<egrave>re,
2317 Jakub Wilk,
2318 Pete Houston,
2319 Stephen Thirlwall,
2320 Jonah Bishop,
2321 Chris Rebert,
2322 Denis Howe,
2323 RaE<uacute>l GundE<iacute>n,
2324 James McCoy,
2325 Daniel Perrett,
2326 Steven Lee,
2327 Jonathan Perret,
2328 Fraser Tweedale,
2329 RaE<aacute>l GundE<aacute>n,
2330 Steffen Jaeckel,
2331 Stephan Hohe,
2332 Michael Beijen,
2333 Alexandr Ciornii,
2334 Christian Walde,
2335 Charles Lee,
2336 Joe McMahon,
2337 John Warwick,
2338 David Steinbrunner,
2339 Kara Martens,
2340 Volodymyr Medvid,
2341 Ron Savage,
2342 Konrad Borowski,
2343 Dale Sedivic,
2344 Michael McClimon,
2345 Andrew Black,
2346 Ralph Bodenner,
2347 Shaun Patterson,
2348 Ryan Olson,
2349 Shlomi Fish,
2350 Karen Etheridge,
2351 Olivier Mengue,
2352 Matthew Wild,
2353 Scott Kyle,
2354 Nick Hooey,
2355 Bo Borgerson,
2356 Mark Szymanski,
2357 Marq Schneider,
2358 Packy Anderson,
2359 JR Boyens,
2360 Dan Sully,
2361 Ryan Niebur,
2362 Kent Fredric,
2363 Mike Morearty,
2364 Ingmar Vanhassel,
2365 Eric Van Dewoestine,
2366 Sitaram Chamarty,
2367 Adam James,
2368 Richard Carlsson,
2369 Pedro Melo,
2370 AJ Schuster,
2371 Phil Jackson,
2372 Michael Schwern,
2373 Jan Dubois,
2374 Christopher J. Madsen,
2375 Matthew Wickline,
2376 David Dyck,
2377 Jason Porritt,
2378 Jjgod Jiang,
2379 Thomas Klausner,
2380 Uri Guttman,
2381 Peter Lewis,
2382 Kevin Riggle,
2383 Ori Avtalion,
2384 Torsten Blix,
2385 Nigel Metheringham,
2386 GE<aacute>bor SzabE<oacute>,
2387 Tod Hagan,
2388 Michael Hendricks,
2389 E<AElig>var ArnfjE<ouml>rE<eth> Bjarmason,
2390 Piers Cawley,
2391 Stephen Steneker,
2392 Elias Lutfallah,
2393 Mark Leighton Fisher,
2394 Matt Diephouse,
2395 Christian Jaeger,
2396 Bill Sully,
2397 Bill Ricker,
2398 David Golden,
2399 Nilson Santos F. Jr,
2400 Elliot Shank,
2401 Merijn Broeren,
2402 Uwe Voelker,
2403 Rick Scott,
2404 Ask BjE<oslash>rn Hansen,
2405 Jerry Gay,
2406 Will Coleda,
2407 Mike O'Regan,
2408 Slaven ReziE<0x107>,
2409 Mark Stosberg,
2410 David Alan Pisoni,
2411 Adriano Ferreira,
2412 James Keenan,
2413 Leland Johnson,
2414 Ricardo Signes,
2415 Pete Krawczyk and
2416 Rob Hoelz.
2418 =head1 AUTHOR
2420 Andy Lester, C<< <andy at petdance.com> >>
2422 =head1 COPYRIGHT & LICENSE
2424 Copyright 2005-2019 Andy Lester.
2426 This program is free software; you can redistribute it and/or modify
2427 it under the terms of the Artistic License v2.0.
2429 See https://www.perlfoundation.org/artistic-license-20.html or the LICENSE.md
2430 file that comes with the ack distribution.
2432 =cut
2446 }
2454 }
2469 # Line ending, changes to "\0" if --print0.
2473 # These have to be checked before any filehandle diddling.
2478 }
2483 }
2488 }
2493 }
2501 exit 0;
2502 }
2504 sub ackbar {
2507 6?!I'7!I"?%+!
2508 3~!I#7#I"7#I!?!+!="+"="+!:!
2509 2?#I!7!I!?#I!7!I"+"=%+"=#
2510 1?"+!?*+!=#~"=!+#?"="+!
2511 0?"+!?"I"?&+!="~!=!~"=!+%="+"
2512 /I!+!?)+!?!+!=$~!=!~!="+!="+"?!="?!
2515 ,I!?!I!?"I"?!+#?"+!?!+#="~$:!~!:!~!:!,!:!,":#~!
2516 +I!?&+!="+!?#+$=!~":!~!:!~!:!,!:#,!:!,%:"
2517 *+!I!?!+$=!+!=!+!?$+#=!~":!~":#,$:",#:!,!:!
2518 *I!?"+!?!+!=$+!?#+#=#~":$,!:",!:!,&:"
2519 )I!?$=!~!=#+"?!+!=!+!=!~!="~!:!~":!,'.!,%:!~!
2520 (=!?"+!?!=!~$?"+!?!+!=#~"=",!="~$,$.",#.!:!=!
2521 (I"+"="~"=!+&=!~"=!~!,!~!+!=!?!+!?!=!I!?!+"=!.",!.!,":!
2524 $?!+!I!?"+"=!+"~!,!:"+#~#:#,"=!~"=!,!~!,!.",!:".!:! */! !I!t!'!s! !a! !g!r!e!p!!! !/!
2525 $+"=!+!?!+"~!=!:!~!:"I!+!,!~!=!:!~!,!:!,$:!~".&:"~!,# (-/
2526 %~!=!~!=!:!.!+"~!:!,!.!,!~!=!:$.!,":!,!.!:!~!,!:!=!.#="~!,!:" ./!
2527 %=!~!?!+"?"+!=!~",!.!:!?!~!.!:!,!:!,#.!,!:","~!:!=!~!=!:",!~! ./!
2528 %+"~":!~!=#~!:!~!,!.!~!:",!~!=!~!.!:!,!.",!:!,":!=":!.!,!:!7! -/!
2529 %~",!:".#:!=!:!,!:"+!:!~!:!.!,!~!,!.#,!.!,$:"~!,":"~!=! */!
2530 &=!~!=#+!=!~",!.!:",#:#,!.",+:!,!.",!=!+!?!
2531 &~!=!~!=!~!:"~#:",!.!,#~!:!.!+!,!.",$.",$.#,!+!I!?!
2532 &~!="~!:!~":!~",!~!=!~":!,!:!~!,!:!,&.$,#."+!?!I!?!I!
2534 &~!=!~!="~!=!:!~":!,!~%:#,!:",!.!,#.",#I!7"I!?!+!?"I"
2535 &+!I!7!:#~"=!~!:!,!:"~$.!=!.!,!~!,$.#,!~!7!I#?!+!?"I"7!
2543 7+:!,!~#,"=!7'I!?#I"7/+!7+
2544 77I!+!7!?!7!I"71+!7,
2545 _BAR
2548 }
2550 sub cathy {
2552 0+!--+!
2553 0|! "C!H!O!C!O!L!A!T!E!!! !|!
2554 0|! "C!H!O!C!O!L!A!T!E!!! !|!
2555 0|! "C!H!O!C!O!L!A!T!E!!! !|!
2557 0+!--+!
2558 6\! 1:!,!.! !
2559 7\! /.!M!~!Z!M!~!
2560 8\! /~!D! "M! !
2561 4.! $\! /M!~!.!8! +.!M# 4
2562 0,!.! (\! .~!M!N! ,+!I!.!M!.! 3
2563 /?!O!.!M!:! '\! .O!.! +~!Z!=!N!.! 4
2564 ..! !D!Z!.!Z!.! '\! 9=!M".! 6
2565 /.! !.!~!M".! '\! 8~! 9
2566 4M!.! /.!7!N!M!.! F
2567 4.! &:!M! !N"M# !M"N!M! #D!M&=! =
2568 :M!7!M#:! !~!M!7!,!$!M!:! #.! !O!N!.!M!:!M# ;
2569 8Z!M"~!N!$!D!.!N!?! !I!N!.! (?!M! !M!,!D!M".! 9
2570 (?!Z!M!N!:! )=!M!O!8!.!M!+!M! !M!,! !O!M! +,!M!.!M!~!Z!N!M!:! &:!~! 0
2571 &8!7!.!~!M"D!M!,! &M!?!=!8! !M!,!O! !M!+! !+!O!.!M! $M#~! !.!8!M!Z!.!M! !O!M"Z! %:!~!M!Z!M!Z!.! +
2572 &:!M!7!,! *M!.!Z!M! !8"M!.!M!~! !.!M!.!=! #~!8!.!M! !7!M! "N!Z#I! !D!M!,!M!.! $."M!,! !M!.! *
2573 2$!O! "N! !.!M!I! !7" "M! "+!O! !~!M! !d!O!.!7!I!M!.! !.!O!=!M!.! !M",!M!.! %.!$!O!D! +
2575 07!~! ".!8! !.!M! "I!+! !.!M! &Z!D!.!7!=!M! !:!.!M! #:!8"+! !.!+!8! !8! 3
2578 $,!M!:!O!?! ".! !?!=! $=!:!O! !M! "M! !M! !+!$! (.! +.!M! !M!.! !8! !+"Z!~! $:!M!$! !.! '
2581 *$!O! &M!,! "O! !.!M!.! #M! (~!M( &O!.! !7! "M! !.!M!.!M!,! #.!M! !M! &
2583 )D! &8!N!:! ".!O! !M!="M! "M! (7!M) %." !M!D!."M!.! !$!=! !M!,! +
2584 (M! &+!.!M! #Z!7!O!M!.!~!8! +,!M#D!?!M#D! #.!Z!M#,!Z!?! !~!N! "N!.! !M! +
2585 'D!:! %$!D! !?! #M!Z! !8!.! !M"?!7!?!7! '+!I!D! !?!O!:!M!:! ":!M!:! !M!7".!M! "8!+! !:!D! !.!M! *
2586 %.!O!:! $.!O!+! !D!.! #M! "M!.!+!N!I!Z! "7!M!N!M!N!?!I!7!Z!=!M'D"~! #M!.!8!$! !:! !.!M! "N!?! !,!O! )
2587 !.!?!M!:!M!I! %8!,! "M!.! #M! "N! !M!.! !M!.! !+!~! !.!M!.! ':!M! $M! $M!Z!$! !M!.! "D! "M! "?!M! (
2588 !7!8! !+!I! ".! "$!=! ":!$! "+! !M!.! !O! !M!I!M".! !=!~! ",!O! '=!M! $$!,! #N!:! ":!8!.! !D!~! !,!M!.! !:!M!.! &
2589 !:!,!.! &Z" #D! !.!8!."M!.! !8!?!Z!M!.!M! #Z!~! !?!M!Z!.! %~!O!.!8!$!N!8!O!I!:!~! !+! #M!.! !.!M!.! !+!M! ".!~!M!+! $
2590 !.! 'D!I! #?!M!.!M!,! !.!Z! !.!8! #M&O!I!?! (~!I!M"." !M!Z!.! !M!N!.! "+!$!.! "M!.! !M!?!.! "8!M! $
2595 +8!O! &.!8! "I!,! !~!M! &N!M! !M!D! '?!N!O!." $?!7! "?!~! #M!.! #I!D!.! (
2597 3I! #M! "M!,! !:! &.!M" ".!,! !.!$!M!I! #.! !:! !.!M!?! "N!+! ".! /
2598 1M!,! #.!M!8!M!=!.! +~!N"O!Z"~! *+!M!.! "M! 2
2599 0.!M! &M!.! 8:! %.!M!Z! "M!=! *O!,! %
2600 0?!$! &N! )." .,! %."M! ":!M!.! 0
2601 0N!:! %?!O! #.! ..! &,! &.!D!,! "N!I! 0
2602 CATHY
2604 }
2611 }
2616 Usage: ack [OPTION]... PATTERN [FILES OR DIRECTORIES]
2618 Search for PATTERN in each source file in the tree from the current
2619 directory on down. If any files or directories are specified, then
2620 only those files and directories are checked. ack may also search
2621 STDIN, but only if no file or directory arguments are specified,
2622 or if one of them is "-".
2624 Default switches may be specified in an .ackrc file. If you want no dependency
2625 on the environment, turn it off with --noenv.
2627 Example: ack -i select
2629 Searching:
2630 -i, --ignore-case Ignore case distinctions in PATTERN
2631 -S, --[no]smart-case Ignore case distinctions in PATTERN,
2632 only if PATTERN contains no upper case.
2633 Ignored if -i or -I are specified.
2634 -I, --no-ignore-case Turns on case-sensitivity in PATTERN.
2635 Negates -i and --smart-case.
2636 -v, --invert-match Invert match: select non-matching lines
2637 -w, --word-regexp Force PATTERN to match only whole words
2638 -Q, --literal Quote all metacharacters; PATTERN is literal
2639 --range-start PATTERN Specify PATTERN as the start of a match range.
2640 --range-end PATTERN Specify PATTERN as the end of a match range.
2641 --match PATTERN Specify PATTERN explicitly. Typically omitted.
2643 Search output:
2644 -l, --files-with-matches Only print filenames containing matches
2645 -L, --files-without-matches Only print filenames with no matches
2646 --output=expr Output the evaluation of expr for each line
2647 (turns off text highlighting)
2648 -o Show only the part of a line matching PATTERN
2649 Same as --output='\$&'
2650 --passthru Print all lines, whether matching or not
2651 -m, --max-count=NUM Stop searching in each file after NUM matches
2652 -1 Stop searching after one match of any kind
2653 -H, --with-filename Print the filename for each match (default:
2654 on unless explicitly searching a single file)
2655 -h, --no-filename Suppress the prefixing filename on output
2656 -c, --count Show number of lines matching per file
2657 --[no]column Show the column number of the first match
2659 -A NUM, --after-context=NUM Print NUM lines of trailing context after
2660 matching lines.
2661 -B NUM, --before-context=NUM Print NUM lines of leading context before
2662 matching lines.
2663 -C [NUM], --context[=NUM] Print NUM lines (default 2) of output context.
2665 --print0 Print null byte as separator between filenames,
2666 only works with -f, -g, -l, -L or -c.
2668 -s Suppress error messages about nonexistent or
2669 unreadable files.
2672 File presentation:
2673 --pager=COMMAND Pipes all ack output through COMMAND. For
2674 example, --pager="less -R". Ignored if output
2675 is redirected.
2676 --nopager Do not send output through a pager. Cancels
2677 any setting in ~/.ackrc, ACK_PAGER or
2678 ACK_PAGER_COLOR.
2679 --[no]heading Print a filename heading above each file's
2680 results. (default: on when used interactively)
2681 --[no]break Print a break between results from different
2682 files. (default: on when used interactively)
2683 --group Same as --heading --break
2684 --nogroup Same as --noheading --nobreak
2685 -p, --proximate=LINES Separate match output with blank lines unless
2686 they are within LINES lines from each other.
2687 -P, --proximate=0 Negates --proximate.
2688 --[no]underline Print a line of carets under the matched text.
2689 --[no]color, --[no]colour Highlight the matching text (default: on unless
2690 output is redirected, or on Windows)
2691 --color-filename=COLOR
2692 --color-match=COLOR
2693 --color-colno=COLOR
2694 --color-lineno=COLOR Set the color for filenames, matches, line and
2695 column numbers.
2696 --help-colors Show a list of possible color combinations.
2697 --help-rgb-colors Show a list of advanced RGB colors.
2698 --flush Flush output immediately, even when ack is used
2699 non-interactively (when output goes to a pipe or
2700 file).
2703 File finding:
2704 -f Only print the files selected, without
2705 searching. The PATTERN must not be specified.
2706 -g Same as -f, but only select files matching
2707 PATTERN.
2708 --sort-files Sort the found files lexically.
2709 --show-types Show which types each file has.
2710 --files-from=FILE Read the list of files to search from FILE.
2711 -x Read the list of files to search from STDIN.
2713 File inclusion/exclusion:
2714 --[no]ignore-dir=name Add/remove directory from list of ignored dirs
2715 --[no]ignore-directory=name Synonym for ignore-dir
2716 --ignore-file=FILTER:ARGS Add filter for ignoring files.
2717 -r, -R, --recurse Recurse into subdirectories (default: on)
2718 -n, --no-recurse No descending into subdirectories
2719 --[no]follow Follow symlinks. Default is off.
2721 File type inclusion/exclusion:
2722 -t X, --type=X Include only X files, where X is a filetype,
2723 e.g. python, html, markdown, etc
2724 -T X, --type=noX Exclude X files, where X is a filetype.
2725 -k, --known-types Include only files of types that ack recognizes.
2726 --help-types Display all known types, and how they're defined.
2728 File type specification:
2729 --type-set=TYPE:FILTER:ARGS Files with the given ARGS applied to the given
2730 FILTER are recognized as being of type TYPE.
2731 This replaces an existing definition for TYPE.
2732 --type-add=TYPE:FILTER:ARGS Files with the given ARGS applied to the given
2733 FILTER are recognized as being type TYPE.
2734 --type-del=TYPE Removes all filters associated with TYPE.
2736 Miscellaneous:
2737 --version Display version & copyright
2738 --[no]env Ignore environment variables and global ackrc
2739 files. --env is legal but redundant.
2740 --ackrc=filename Specify an ackrc file to use
2741 --ignore-ack-defaults Ignore default definitions included with ack.
2742 --create-ackrc Outputs a default ackrc for your customization
2743 to standard output.
2744 --dump Dump information on which options are loaded
2745 and where they're defined.
2746 --[no]filter Force ack to treat standard input as a pipe
2747 (--filter) or tty (--nofilter)
2748 --help This help
2749 --man Print the manual.
2750 --help-types Display all known types, and how they're defined.
2751 --help-colors Show a list of possible color combinations.
2752 --help-rgb-colors Show a list of advanced RGB colors.
2753 --thpppt Bill the Cat
2754 --bar The warning admiral
2755 --cathy Chocolate! Chocolate! Chocolate!
2757 Filter specifications:
2758 If FILTER is "ext", ARGS is a list of extensions checked against the
2759 file's extension.
2760 If FILTER is "is", ARGS must match the file's name exactly.
2761 If FILTER is "match", ARGS is matched as a case-insensitive regex
2762 against the filename.
2763 If FILTER is "firstlinematch", ARGS is matched as a regex the first
2764 line of the file's contents.
2766 Exit status is 0 if match, 1 if no match.
2768 ack's home page is at https://beyondgrep.com/
2770 The full ack manual is available by running "ack --man".
2773 END_OF_HELP
2775 return;
2776 }
2780 sub show_help_types {
2781 App::Ack::print( <<'END_OF_HELP' );
2782 Usage: ack [OPTION]... PATTERN [FILES OR DIRECTORIES]
2784 The following is the list of filetypes supported by ack. You can specify a
2785 filetype to include with -t TYPE or --type=TYPE. You can exclude a
2786 filetype with -T TYPE or --type=noTYPE.
2788 Note that some files may appear in multiple types. For example, a file
2789 called Rakefile is both Ruby (--type=ruby) and Rakefile (--type=rakefile).
2791 END_OF_HELP
2797 }
2804 }
2806 }
2808 return;
2809 }
2813 sub show_help_colors {
2814 App::Ack::print( <<'END_OF_HELP' );
2815 ack allows customization of the colors it uses when presenting matches
2816 onscreen. See the "ACK COLORS" section of the ack manual (ack --man).
2818 Here is a chart of how various color combinations appear: Each of the eight
2819 foreground colors, on each of the eight background colors or no background
2820 color, with and without the bold modifier.
2822 Run ack --help-rgb-colors for a chart of the RGB colors.
2824 END_OF_HELP
2826 _show_color_grid();
2828 return;
2829 }
2833 sub show_help_rgb {
2834 App::Ack::print( <<'END_OF_HELP' );
2835 ack allows customization of the colors it uses when presenting matches
2836 onscreen. See the "ACK COLORS" section of the ack manual (ack --man).
2838 Colors may be specified as "rggNNN" where "NNN" is a triplet of digits
2839 from 0 to 5 specifying the intensity of red, green and blue, respectively.
2841 Here is a grid of the 216 possible values for NNN.
2843 END_OF_HELP
2845 _show_rgb_grid();
2847 App::Ack::say( 'Here are the 216 possible colors with the "reverse" modifier applied.', "\n" );
2849 _show_rgb_grid( 'reverse' );
2851 return;
2852 }
2855 sub _show_color_grid {
2864 );
2869 );
2875 $bg
2876 );
2881 $bg
2882 );
2884 }
2887 }
2898 }
2905 544 544 544 544 544 554 554 554 554 554 454 454 454 454 454 455 455 455 455 455 445 445 445 445 445 545 545 545 545 545
2906 533 533 533 543 543 553 553 553 453 453 353 353 353 354 354 355 355 355 345 345 335 335 335 435 435 535 535 535 534 534
2907 511 521 531 531 541 551 451 451 351 251 151 152 152 153 154 155 145 145 135 125 115 215 215 315 415 515 514 514 513 512
2908 500 510 520 530 540 550 450 350 250 150 050 051 052 053 054 055 045 035 025 015 005 105 205 305 405 505 504 503 502 501
2909 400 410 410 420 430 440 340 340 240 140 040 041 041 042 043 044 034 034 024 014 004 104 104 204 304 404 403 403 402 401
2910 300 300 310 320 320 330 330 230 130 130 030 030 031 032 032 033 033 023 013 013 003 003 103 203 203 303 303 302 301 301
2911 200 200 200 210 210 220 220 220 120 120 020 020 020 021 021 022 022 022 012 012 002 002 002 102 102 202 202 202 201 201
2912 100 100 100 100 100 110 110 110 110 110 010 010 010 010 010 011 011 011 011 011 001 001 001 001 001 101 101 101 101 101
2914 522 522 532 542 542 552 552 452 352 352 252 252 253 254 254 255 255 245 235 235 225 225 325 425 425 525 525 524 523 523
2916 411 411 421 431 431 441 441 341 241 241 141 141 142 143 143 144 144 134 124 124 114 114 214 314 314 414 414 413 412 412
2918 422 422 432 432 432 442 442 442 342 342 242 242 242 243 243 244 244 244 234 234 224 224 224 324 324 424 424 424 423 423
2920 311 311 311 321 321 331 331 331 231 231 131 131 131 132 132 133 133 133 123 123 113 113 113 213 213 313 313 313 312 312
2922 433 433 433 433 433 443 443 443 443 443 343 343 343 343 343 344 344 344 344 344 334 334 334 334 334 434 434 434 434 434
2923 211 211 211 211 211 221 221 221 221 221 121 121 121 121 121 122 122 122 122 122 112 112 112 112 112 212 212 212 212 212
2925 322 322 322 322 322 332 332 332 332 332 232 232 232 232 232 233 233 233 233 233 223 223 223 223 223 323 323 323 323 323
2927 555 555 555 555 555 555 555 555 555 555 555 555 555 555 555 555 555 555 555 555 555 555 555 555 555 555 555 555 555 555
2928 444 444 444 444 444 444 444 444 444 444 444 444 444 444 444 444 444 444 444 444 444 444 444 444 444 444 444 444 444 444
2929 333 333 333 333 333 333 333 333 333 333 333 333 333 333 333 333 333 333 333 333 333 333 333 333 333 333 333 333 333 333
2930 222 222 222 222 222 222 222 222 222 222 222 222 222 222 222 222 222 222 222 222 222 222 222 222 222 222 222 222 222 222
2931 111 111 111 111 111 111 111 111 111 111 111 111 111 111 111 111 111 111 111 111 111 111 111 111 111 111 111 111 111 111
2932 000 000 000 000 000 000 000 000 000 000 000 000 000 000 000 000 000 000 000 000 000 000 000 000 000 000 000 000 000 000
2933 HERE
2940 }
2949 });
2952 }
2964 }
2973 $copyright
2975 This program is free software. You may modify or distribute it
2976 under the terms of the Artistic License v2.0.
2977 END_OF_VERSION
2978 }
2985 sub set_up_pager {
2988 return if App::Ack::output_to_pipe();
2993 }
2996 return;
2997 }
3000 sub output_to_pipe {
3002 }
3005 sub exit_from_ack {
3010 }
3013 sub show_types {
3020 return;
3021 }
3024 sub filetypes {
3033 # Clone the file.
3037 last;
3038 }
3039 }
3040 }
3042 # https://metacpan.org/pod/distribution/Perl-Critic/lib/Perl/Critic/Policy/Subroutines/ProhibitReturnSort.pm
3045 }
3048 sub is_lowercase {
3051 # The simplest case.
3054 # If we have capitals, then go clean up any metacharacters that might have capitals.
3056 # Get rid of any literal backslashes first to avoid confusion.
3077 /x;
3081 # Eliminate named captures.
3085 # Eliminate named backreferences.
3090 # Now with those metacharacters and named things removed, now see if it's lowercase.
3093 return 0;
3094 }
3097 1; # End of App::Ack
3098 package App::Ack::ConfigDefault;
3100 use warnings;
3101 use strict;
3106 sub options {
3108 }
3111 sub options_clean {
3112 return grep { /./ && !/^#/ } options();
3113 }
3116 sub _options_block {
3118 # This is the default ackrc for ack version ==VERSION==.
3120 # There are four different ways to match
3121 #
3122 # is: Match the filename exactly
3123 #
3124 # ext: Match the extension of the filename exactly
3125 #
3126 # match: Match the filename against a Perl regular expression
3127 #
3128 # firstlinematch: Match the first 250 characters of the first line
3129 # of text against a Perl regular expression. This is only for
3130 # the --type-add option.
3133 ### Directories to ignore
3135 # Bazaar
3136 # https://bazaar.canonical.com/
3137 --ignore-directory=is:.bzr
3139 # Codeville
3140 # http://freshmeat.sourceforge.net/projects/codeville
3141 --ignore-directory=is:.cdv
3143 # Interface Builder (Xcode)
3144 # https://en.wikipedia.org/wiki/Interface_Builder
3145 --ignore-directory=is:~.dep
3146 --ignore-directory=is:~.dot
3147 --ignore-directory=is:~.nib
3148 --ignore-directory=is:~.plst
3150 # Git
3151 # https://git-scm.com/
3152 --ignore-directory=is:.git
3153 # When submodules are used, .git is a file.
3154 --ignore-file=is:.git
3156 # Mercurial
3157 # https://www.mercurial-scm.org/
3158 --ignore-directory=is:.hg
3160 # Quilt
3161 # https://directory.fsf.org/wiki/Quilt
3162 --ignore-directory=is:.pc
3164 # Subversion
3165 # https://subversion.apache.org/
3166 --ignore-directory=is:.svn
3168 # Monotone
3169 # https://www.monotone.ca/
3170 --ignore-directory=is:_MTN
3172 # CVS
3173 # https://savannah.nongnu.org/projects/cvs
3174 --ignore-directory=is:CVS
3176 # RCS
3177 # https://www.gnu.org/software/rcs/
3178 --ignore-directory=is:RCS
3180 # SCCS
3181 # https://en.wikipedia.org/wiki/Source_Code_Control_System
3182 --ignore-directory=is:SCCS
3184 # darcs
3185 # http://darcs.net/
3186 --ignore-directory=is:_darcs
3188 # Vault/Fortress
3189 --ignore-directory=is:_sgbak
3191 # autoconf
3192 # https://www.gnu.org/software/autoconf/
3193 --ignore-directory=is:autom4te.cache
3195 # Perl module building
3196 --ignore-directory=is:blib
3197 --ignore-directory=is:_build
3199 # Perl Devel::Cover module's output directory
3200 # https://metacpan.org/release/Devel-Cover
3201 --ignore-directory=is:cover_db
3203 # Node modules created by npm
3204 --ignore-directory=is:node_modules
3206 # CMake cache
3207 # https://www.cmake.org/
3208 --ignore-directory=is:CMakeFiles
3210 # Eclipse workspace folder
3211 # https://eclipse.org/
3212 --ignore-directory=is:.metadata
3214 # Cabal (Haskell) sandboxes
3215 # https://www.haskell.org/cabal/users-guide/installing-packages.html
3216 --ignore-directory=is:.cabal-sandbox
3218 ### Files to ignore
3220 # Backup files
3221 --ignore-file=ext:bak
3222 --ignore-file=match:/~$/
3224 # Emacs swap files
3225 --ignore-file=match:/^#.+#$/
3227 # vi/vim swap files http://vim.org/
3228 --ignore-file=match:/[._].*\.swp$/
3230 # core dumps
3231 --ignore-file=match:/core\.\d+$/
3233 # minified Javascript
3234 --ignore-file=match:/[.-]min[.]js$/
3235 --ignore-file=match:/[.]js[.]min$/
3237 # minified CSS
3238 --ignore-file=match:/[.]min[.]css$/
3239 --ignore-file=match:/[.]css[.]min$/
3241 # JS and CSS source maps
3242 --ignore-file=match:/[.]js[.]map$/
3243 --ignore-file=match:/[.]css[.]map$/
3245 # PDFs, because they pass Perl's -T detection
3246 --ignore-file=ext:pdf
3248 # Common graphics, just as an optimization
3249 --ignore-file=ext:gif,jpg,jpeg,png
3251 # Common archives, as an optimization
3252 --ignore-file=ext:gz,tar,tgz,zip
3255 ### Filetypes defined
3257 # Makefiles
3258 # https://www.gnu.org/s/make/
3259 --type-add=make:ext:mk
3260 --type-add=make:ext:mak
3261 --type-add=make:is:makefile
3262 --type-add=make:is:Makefile
3263 --type-add=make:is:Makefile.Debug
3264 --type-add=make:is:Makefile.Release
3265 --type-add=make:is:GNUmakefile
3267 # Rakefiles
3268 # https://rake.rubyforge.org/
3269 --type-add=rake:is:Rakefile
3271 # CMake
3272 # https://cmake.org/
3273 --type-add=cmake:is:CMakeLists.txt
3274 --type-add=cmake:ext:cmake
3276 # Actionscript
3277 --type-add=actionscript:ext:as,mxml
3279 # Ada
3280 # https://www.adaic.org/
3281 --type-add=ada:ext:ada,adb,ads
3283 # ASP
3284 # https://docs.microsoft.com/en-us/previous-versions/office/developer/server-technologies/aa286483(v=msdn.10)
3285 --type-add=asp:ext:asp
3287 # ASP.Net
3288 # https://dotnet.microsoft.com/apps/aspnet
3289 --type-add=aspx:ext:master,ascx,asmx,aspx,svc
3291 # Assembly
3292 --type-add=asm:ext:asm,s
3294 # DOS/Windows batch
3295 --type-add=batch:ext:bat,cmd
3297 # ColdFusion
3298 # https://en.wikipedia.org/wiki/ColdFusion
3299 --type-add=cfmx:ext:cfc,cfm,cfml
3301 # Clojure
3302 # https://clojure.org/
3303 --type-add=clojure:ext:clj,cljs,edn,cljc
3305 # C
3306 # .xs are Perl C files
3307 --type-add=cc:ext:c,h,xs
3309 # C header files
3310 --type-add=hh:ext:h
3312 # CoffeeScript
3313 # https://coffeescript.org/
3314 --type-add=coffeescript:ext:coffee
3316 # C++
3317 --type-add=cpp:ext:cpp,cc,cxx,m,hpp,hh,h,hxx
3319 # C++ header files
3320 --type-add=hpp:ext:hpp,hh,h,hxx
3322 # C#
3323 --type-add=csharp:ext:cs
3325 # CSS
3326 # https://www.w3.org/Style/CSS/
3327 --type-add=css:ext:css
3329 # Dart
3330 # https://dart.dev/
3331 --type-add=dart:ext:dart
3333 # Delphi
3334 # https://en.wikipedia.org/wiki/Embarcadero_Delphi
3335 --type-add=delphi:ext:pas,int,dfm,nfm,dof,dpk,dproj,groupproj,bdsgroup,bdsproj
3337 # Elixir
3338 # https://elixir-lang.org/
3339 --type-add=elixir:ext:ex,exs
3341 # Emacs Lisp
3342 # https://www.gnu.org/software/emacs
3343 --type-add=elisp:ext:el
3345 # Erlang
3346 # https://www.erlang.org/
3347 --type-add=erlang:ext:erl,hrl
3349 # Fortran
3350 # https://en.wikipedia.org/wiki/Fortran
3351 --type-add=fortran:ext:f,f77,f90,f95,f03,for,ftn,fpp
3353 # Go
3354 # https://golang.org/
3355 --type-add=go:ext:go
3357 # Groovy
3358 # https://www.groovy-lang.org/
3359 --type-add=groovy:ext:groovy,gtmpl,gpp,grunit,gradle
3361 # GSP
3362 # https://gsp.grails.org/
3363 --type-add=gsp:ext:gsp
3365 # Haskell
3366 # http://www.haskell.org/
3367 --type-add=haskell:ext:hs,lhs
3369 # HTML
3370 --type-add=html:ext:htm,html,xhtml
3372 # Jade
3373 # http://jade-lang.com/
3374 --type-add=jade:ext:jade
3376 # Java
3377 # https://www.oracle.com/technetwork/java/index.html
3378 --type-add=java:ext:java,properties
3380 # JavaScript
3381 --type-add=js:ext:js
3383 # JSP
3384 # https://www.oracle.com/technetwork/java/javaee/jsp/index.html
3385 --type-add=jsp:ext:jsp,jspx,jspf,jhtm,jhtml
3387 # JSON
3388 # https://json.org/
3389 --type-add=json:ext:json
3391 # Kotlin
3392 # https://kotlinlang.org/
3393 --type-add=kotlin:ext:kt,kts
3395 # Less
3396 # http://www.lesscss.org/
3397 --type-add=less:ext:less
3399 # Common Lisp
3400 # https://common-lisp.net/
3401 --type-add=lisp:ext:lisp,lsp
3403 # Lua
3404 # https://www.lua.org/
3405 --type-add=lua:ext:lua
3408 # Markdown
3409 # https://en.wikipedia.org/wiki/Markdown
3410 --type-add=markdown:ext:md,markdown
3411 # We understand that there are many ad hoc extensions for markdown
3412 # that people use. .md and .markdown are the two that ack recognizes.
3413 # You are free to add your own in your ackrc file.
3415 # Matlab
3416 # https://en.wikipedia.org/wiki/MATLAB
3417 --type-add=matlab:ext:m
3419 # Objective-C
3420 --type-add=objc:ext:m,h
3422 # Objective-C++
3423 --type-add=objcpp:ext:mm,h
3425 # OCaml
3426 # https://ocaml.org/
3427 --type-add=ocaml:ext:ml,mli,mll,mly
3429 # Perl
3430 # http://perl.org/
3431 --type-add=perl:ext:pl,pm,pod,t,psgi
3434 # Perl tests
3435 --type-add=perltest:ext:t
3437 # Perl's Plain Old Documentation format, POD
3438 --type-add=pod:ext:pod
3440 # PHP
3441 # https://www.php.net/
3442 --type-add=php:ext:php,phpt,php3,php4,php5,phtml
3445 # Plone
3446 # https://plone.org/
3447 --type-add=plone:ext:pt,cpt,metadata,cpy,py
3449 # Python
3450 # https://www.python.org/
3451 --type-add=python:ext:py
3454 # R
3455 # https://www.r-project.org/
3456 --type-add=rr:ext:R
3458 # reStructured Text
3459 # http://docutils.sourceforge.net/rst.html
3460 --type-add=rst:ext:rst
3462 # Ruby
3463 # https://www.ruby-lang.org/
3464 --type-add=ruby:ext:rb,rhtml,rjs,rxml,erb,rake,spec
3465 --type-add=ruby:is:Rakefile
3468 # Rust
3469 # https://www.rust-lang.org/
3470 --type-add=rust:ext:rs
3472 # Sass
3473 # https://sass-lang.com
3474 --type-add=sass:ext:sass,scss
3476 # Scala
3477 # https://www.scala-lang.org/
3478 --type-add=scala:ext:scala
3480 # Scheme
3481 # https://groups.csail.mit.edu/mac/projects/scheme/
3482 --type-add=scheme:ext:scm,ss
3484 # Shell
3485 --type-add=shell:ext:sh,bash,csh,tcsh,ksh,zsh,fish
3488 # Smalltalk
3489 # http://www.smalltalk.org/
3490 --type-add=smalltalk:ext:st
3492 # Smarty
3493 # https://www.smarty.net/
3494 --type-add=smarty:ext:tpl
3496 # SQL
3497 # https://www.iso.org/standard/45498.html
3498 --type-add=sql:ext:sql,ctl
3500 # Stylus
3501 # http://stylus-lang.com/
3502 --type-add=stylus:ext:styl
3504 # SVG
3505 # https://en.wikipedia.org/wiki/Scalable_Vector_Graphics
3506 --type-add=svg:ext:svg
3508 # Swift
3509 # https://developer.apple.com/swift/
3510 --type-add=swift:ext:swift
3513 # Tcl
3514 # https://www.tcl.tk/
3515 --type-add=tcl:ext:tcl,itcl,itk
3517 # TeX & LaTeX
3518 # https://www.latex-project.org/
3519 --type-add=tex:ext:tex,cls,sty
3521 # Template Toolkit (Perl)
3522 # http//template-toolkit.org/
3523 --type-add=ttml:ext:tt,tt2,ttml
3525 # Typescript
3526 # https://www.typescriptlang.org/
3527 --type-add=ts:ext:ts,tsx
3529 # Visual Basic
3530 --type-add=vb:ext:bas,cls,frm,ctl,vb,resx
3532 # Verilog
3533 --type-add=verilog:ext:v,vh,sv
3535 # VHDL
3536 # http://www.eda.org/twiki/bin/view.cgi/P1076/WebHome
3537 --type-add=vhdl:ext:vhd,vhdl
3539 # Vim
3540 # https://www.vim.org/
3541 --type-add=vim:ext:vim
3543 # XML
3544 # https://www.w3.org/TR/REC-xml/
3545 --type-add=xml:ext:xml,dtd,xsd,xsl,xslt,ent,wsdl
3546 --type-add=xml:firstlinematch:/<[?]xml/
3548 # YAML
3549 # https://yaml.org/
3550 --type-add=yaml:ext:yaml,yml
3551 HERE
3555 }
3574 }
3586 # On Unix, uniquify on inode.
3589 }
3591 }
3593 }
3603 App::Ack::die( File::Spec->catdir(@_) . ' contains both .ackrc and _ackrc. Please remove one of those files.' )
3618 );
3619 }
3622 }
3627 }
3630 }
3635 # XXX This should go through some untainted cwd-fetching function, and not get untainted brute-force like this.
3644 }
3646 }
3648 # We only test for existence here, so if the file is deleted out from under us, this will fail later.
3650 }
3667 default
3668 bundling
3669 no_auto_help
3670 no_auto_version
3671 no_ignore_case
3674 }
3687 }
3693 }
3698 my $previous_inversion_matches = $opt->{idirs} && !($is_inverted xor $opt->{idirs}[-1]->is_inverted());
3704 # This relies on invert of an inverted filter to return the original.
3706 }
3707 }
3711 }
3717 }
3718 };
3719 }
3725 state $dir_sep_chars = $App::Ack::is_windows ? quotemeta( '\\/' ) : quotemeta( File::Spec->catfile( '', '' ) );
3730 }
3741 }
3742 elsif ( $spec =~ /^(\w+)=(.*)/ ) { # Check to see if we have ack1-style argument specification.
3748 }
3751 }
3754 }
3755 }
3763 # Loop through all the registered filters. If we hit one that
3764 # matches this extension and it's inverted, we need to delete it from
3765 # the options.
3769 # XXX Do a real list comparison? This just checks string equivalence.
3773 }
3774 }
3777 }
3798 }
3801 }
3804 };
3805 };
3820 }
3823 };
3824 };
3831 };
3837 );
3844 # $args are modified in place, so no need to munge $arg_sources
3846 }
3850 }
3851 }
3857 };
3860 }
3873 }
3876 {
3879 }
3883 }
3886 }
3889 };
3904 'create-ackrc' => sub { say for ( '--ignore-ack-defaults', App::Ack::ConfigDefault::options() ); exit; },
3911 }
3912 },
3935 }
3937 },
3938 'l|files-with-matches'
3940 'L|files-without-matches'
3951 },
3965 'S|smart-case!' => sub { my (undef,$value) = @_; $opt->{S} = $value; $opt->{i} = 0 if $value; },
3980 }
3986 # Contexts default to 2.
3988 }
4001 }
4002 }
4008 );
4009 }
4023 };
4029 };
4030 }
4035 };
4040 };
4041 }
4046 }
4050 }
4055 }
4056 }
4059 }
4060 }
4062 # XXX We need to check on a -- in the middle of a non-ARGV source
4065 }
4082 }
4086 }
4087 };
4093 };
4101 }
4115 );
4120 };
4121 }
4122 }
4125 }
4138 }
4154 }
4156 }
4164 }
4167 }
4179 }
4180 }
4194 );
4195 }
4199 );
4200 }
4201 }
4208 }
4216 );
4220 # Check for --dump early.
4227 );
4231 }
4232 }
4233 }
4244 # All of our sources should be transformed into an array ref
4249 }
4252 }
4253 }
4256 }
4257 }
4260 # Throw the default filter in if no others are selected.
4263 }
4265 }
4278 );
4285 }
4287 # We explicitly use open so we get a nice error message.
4288 # XXX This is a potential race condition!.
4291 }
4294 }
4296 }
4301 };
4311 };
4312 }
4313 }
4318 };
4321 }
4341 }
4345 }
4348 # Verifies no mutually-exclusive options were passed. Dies if they were.
4365 }
4366 }
4367 }
4370 }
4373 # Processes the command line option and returns a hash of the options that were
4374 # used on the command line, using their full name. "--prox" shows up in the hash as "--proximate".
4381 # The real argument parsing doesn't check for --type-add, --type-del or --type-set because
4382 # they get removed by the argument processing. We have to account for them here.
4390 };
4398 # Capture the %parsed hash.
4399 CAPTURE_PARSED: {
4405 };
4409 );
4410 }
4412 # Capture the @raw array.
4413 CAPTURE_RAW: {
4417 );
4425 };
4436 }
4439 }
4448 }
4449 }
4450 }
4452 # Parse @ARGV twice, once with each capture spec.
4458 }
4462 # This list is machine-generated by crank-mutex. Do not modify it by hand.
4468 },
4469 A => {
4479 },
4480 B => {
4490 },
4491 C => {
4501 },
4502 H => {
4507 },
4508 L => {
4531 },
4538 },
4539 c => {
4555 },
4556 column => {
4566 },
4567 f => {
4591 },
4592 g => {
4615 },
4616 group => {
4622 },
4623 h => {
4628 },
4629 heading => {
4635 },
4636 l => {
4657 },
4658 m => {
4664 },
4665 match => {
4668 },
4672 },
4673 o => {
4688 },
4689 output => {
4705 },
4706 p => {
4719 },
4720 passthru => {
4735 },
4741 },
4742 u => {
4746 },
4747 v => {
4751 },
4755 },
4756 x => {
4759 },
4760 };
4784 }
4787 }
4793 }
4801 }
4810 # Do nothing.
4811 }
4814 }
4815 }
4818 }
4825 # Tells if the file needs a line-by-line scan. This is a big
4826 # optimization because if you can tell from the outset that the pattern
4827 # is not found in the file at all, then there's no need to do the
4828 # line-by-line iteration.
4830 # Slurp up an entire file up to 10M, see if there are any matches
4831 # in it, and if so, let us know so we can iterate over it directly.
4833 # The $regex may be undef if it had a "$" in it, and is therefore unsuitable for this heuristic.
4843 }
4845 }
4847 # If we read all 10M, then we need to scan the rest.
4848 # If there are any carriage returns, our results are flaky, so scan the rest.
4851 }
4855 }
4856 }
4857 }
4858 }
4861 }
4873 }
4874 }
4877 }
4887 }
4889 }
4892 }
4900 }
4912 }
4914 }
4920 }
4924 }
4926 }
4929 }
4930 }
4933 }
4957 };
4958 }
4971 }
4990 }
5006 }
5008 };
5011 }
5022 }
5030 };
5031 }
5034 }
5035 }
5052 }
5055 }
5064 }
5071 }
5076 }
5081 }
5088 }
5098 }
5104 groups => {},
5105 ungrouped => [],
5107 }
5114 }
5118 }
5121 }
5129 }
5132 }
5135 }
5141 }
5147 }
5157 }
5163 }
5169 }
5179 }
5193 }
5197 }
5203 }
5209 }
5215 }
5219 }
5229 }
5235 data => {},
5237 }
5244 }
5247 }
5254 }
5257 }
5263 }
5269 }
5280 }
5291 }
5293 # This test reads the first 250 characters of a file, then just uses the
5294 # first line found in that. This prevents reading something like an entire
5295 # .min.js file (which might be only one "line" long) into memory.
5301 }
5308 }
5316 }
5320 }
5331 }
5339 }
5345 }
5351 }
5355 }
5363 }
5373 }
5384 }
5388 }
5394 }
5400 }
5406 }
5410 }
5420 }
5426 data => {},
5428 }
5436 }
5442 }
5448 }
5454 }
5464 }
5474 }
5478 }
5484 }
5490 }
5496 }
5506 }
5512 data => {},
5514 }
5522 }
5528 }
5534 }
5540 }
5549 }
5563 }
5567 }
5573 }
5579 }
5585 }
5589 }
5599 }
5605 matches => [],
5608 }
5619 }
5625 }
5627 # This class has no inspect() or to_string() method.
5628 # It will just use the default one unless someone writes something useful.
5658 );
5660 }
5678 }
5680 }
5683 }
5688 }
5708 }
5713 }
5718 }
5719 }
5730 }
5738 }
5745 }
5752 }
5765 }
5781 }
5783 # Any leftover keys are bogus
5787 }
5789 # If it's not a code ref, assume standard sort
5792 }
5801 $is_dir
5804 }
5807 }
5818 }
5828 }
5831 }
5836 # Only do directory checking if we have a descend_filter
5842 }
5843 }
5845 }
5851 }
5854 }