= Plugin for searching the source repository =

== Description ==

This plugin allows users to search the source repository.

== Installation ==

To use the repository search, users must have the `REPO_SEARCH` permission. Add this with `trac-admin` and off you go.

You can include and exclude parts of the repository by adding the following options to `trac.ini`:

{{{
[repo-search]
include = *.py:*.txt
exclude = *.pyc:*.png:*.jpg:*.gif:*/README
}}}

The globs are separated by your operating systems path seperator (`:` under UNIX) and each glob is matched against the ''full'' path. Hence `*/README` instead of just `README`.

If only `include` is specified the default is to exclude all other files.

To speed up searches, an indexer is included. A full index will occur the first time you search the repository, which can take quite some time. Subsequent changesets will be incrementally indexed and should be quite fast. To enable the indexer add the following entry to your `trac.ini`:

{{{
[repo-search]
index = /my/trac/env/idx
}}}

The `index` option is a a directory that must be writable by the web server user.

== Bugs/Feature Requests == 

Existing bugs and feature requests for RepoSearchPlugin are 
[report:9?COMPONENT=RepoSearchPlugin here].

If you have any issues, create a 
[http://trac-hacks.org/newticket?component=RepoSearchPlugin&owner=athomas new ticket].

== Download ==

Download the zipped source from [download:reposearchplugin here].

== Source ==

You can check out RepoSearchPlugin from [http://trac-hacks.org/svn/reposearchplugin here] using Subversion, or [source:reposearchplugin browse the source] with Trac.

== Recent Changes ==

[[ChangeLog(reposearchplugin, 3)]]

== Author/Contributors ==

'''Author:''' [wiki:athomas] [[BR]]
'''Contributors:'''

[[TagIt(plugin,athomas,0.9)]]