view release on metacpan or  search on metacpan

script/git-find  view on Meta::CPAN

=over

=item B<( )>, B<[ ]>

Grouping.  Parentheses and brackets are interchangeable.

=item B<-not>, B<--not>, B<!>, B<^>

Logical negation.

=item B<-a>, B<--a>, B<-and>, B<--and>, B<&&>

Logical and.  This is the default operator between terms if no operator
is given.

=item B<-o>, B<--o>, B<-or>, B<--or>, B<||>

Logical or

=item B<,> (a single comma)

Sequence: separates items to be evaluated separately.  The return value
is that of the last item in the sequence.

=back

=head2 Revs

By default, git-find searches the current index (cache).  This is the same
as the default for git-ls-files(1).
You can specify one or more revs to search using any of the forms described
in L<gitrevisions(7)|https://git-scm.com/docs/gitrevisions>.

You can specify the special value C<]]> (a double right bracket) to search
the working tree that is currently checked out.
(Mnemonic: search I<right> here.)  If you have an actual rev called "]]",
git-find won't be able to help you.  Sorry!

    TODO? You can specify multiple ranges of revs separated by C<-o> (or its
    equivalent forms given in L</Operators>) or C<,>.  Comma is treated as
    equivalent to C<-o> when separating revs.

=head2 Expression

The expression includes one or more elements separated by L</Operators>.
Elements can be options, tests, or operators.

Elements of expressions can be specified in a form similar to find(1).
Long elements (e.g., C<-name>) can start with a single or a double dash.

Tests are of two types:

=over

=item Index tests

These are tests that only require information from the git index, such
as the name of the file and whether it is executable.  They are (at least on
Unix-like systems):

C<-cmin>, C<-cnewer>, C<-ctime>, C<-empty>, C<-executable>, C<-false>, C<-gid>,
C<-group>, C<-ilname>, C<-iname>, C<-inum>, C<-ipath>, C<-iregex>,
C<-iwholename>, C<-level>, C<-mmin>, C<-mtime>, C<-name>, C<-nogroup>,
C<-nouser>, C<-path>, C<-readable>, C<-regex>, C<-size>, C<-true>, C<-type>,
C<-uid>, C<-user>, C<-wholename>, C<-writeable>

    TODO also -links, -lname, -perm, -samefile, -xtype?

=item Detailed tests

All tests other than index tests may require
checking out a worktree with one or more of the given revs.
Therefore, they may be much slower than name-only tests.  However, if the only
rev given is C<]]> (working directory), detailed tests can be executed without
checking out a worktree, so the slowdown is not as bad.

=back

=head1 DIFFERENCES FROM FIND(1)

In git-find but not in find(1): -ref, -rev

In find(1) but not in git-find: find switches; TODO -xtype, -context?

=head1 WARNINGS

If the C<-W> option is given, warnings are enabled.  Possible warnings are:

=over

=item B<-Wdetailed>

Warn if a detailed test is used on a search scope other than C<]]> (the
current working tree).

=back

=head1 AUTHOR

Christopher White, C<< <cxw at cpan.org> >>

=head1 BUGS

Please report any bugs or feature requests through the GitHub interface at
L<https://github.com/cxw42/git-find/issues>.  I will be notified, and then
you'll automatically be notified of progress on your bug as I make changes.

=head1 SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc App::GitFind

You can also look for information at:

=over 4

=item * GitHub (report bugs here)

L<https://github.com/cxw42/git-find>