*** empty log message ***

This commit is contained in:
dockes 2005-11-08 21:02:18 +00:00
parent aea91572c4
commit 7a190d6f88
8 changed files with 129 additions and 2 deletions

View File

@ -0,0 +1,20 @@
# New ports collection makefile for: recoll
# Date created: 5 November 2005
# Whom: J.F. Dockes
#
# $FreeBSD$
#
PORTNAME= recoll
PORTVERSION= 1.0.5
CATEGORIES= deskutils
MASTER_SITES= http://www.lesbonscomptes.com/recoll/
MAINTAINER= jean-francois.dockes@wanadoo.fr
COMMENT= A personal xapian-based text search utility, with a qt GUI
USE_GMAKE= yes
LIB_DEPENDS= xapian.8:${PORTSDIR}/databases/xapian-core \
qt-mt.3:${PORTSDIR}/x11-toolkits/qt33
.include <bsd.port.mk>

View File

@ -0,0 +1,2 @@
MD5 (recoll-1.0.5.tar.gz) = cded4e6a36cd9ef3a148cedb58f4af91
SIZE (recoll-1.0.5.tar.gz) = 259473

View File

@ -0,0 +1,26 @@
Recoll is a personal full text search tool for Linux, FreeBSD and other Unix
systems.
Recoll is based on a very strong backend (Xapian), for which it provides an
easy to use, feature-rich, zero-administration interface.
Recoll is free and copyrighted under the GPL license, see COPYING inside
the distribution. A lot of the code is imported from other packages, see
the Credits. Features:
* Document types: text, html, pdf (with pdftotext), postscript (with
ghostscript's pstotext), msword (with antiword), openoffice files,
maildir and mailbox mail folders (Mozilla and thunderbird mail
ok). Deals with compressed versions of same.
* Relatively powerful query facilities, with boolean searches, phrases,
filter on file types and directory tree.
* Support for multiple charsets. Internal processing and storage uses
Unicode UTF-8.
* Stemming performed at query time (can switch stemming language after
indexing)
* Easy installation. No database daemon, web server or exotic language
necessary. The idea is that everybody should index their files
because it makes life easier.
* GUI based on qt, written with qt Designer.
* An indexer which runs either as a thread inside the GUI or as an
external, cron'able program.

View File

@ -0,0 +1,12 @@
bin/recoll
bin/recollindex
bin/recollinstall
share/examples/recoll/rcldoc
share/examples/recoll/rclpdf
share/examples/recoll/rclps
share/examples/recoll/rclsoff
share/examples/recoll/rcluncomp
share/examples/recoll/recoll.conf
share/examples/recoll/mimeconf
share/examples/recoll/mimemap
@dirrm share/examples/recoll

View File

@ -712,7 +712,7 @@ TREEVIEW_WIDTH = 250
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
# generate Latex output.
GENERATE_LATEX = YES
GENERATE_LATEX = NO
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be

View File

@ -1,5 +1,5 @@
documentation:
doxygen Doxyfile
clean:
rm -f doc/*
rm -f html/*

47
src/doc/prog/filters.txt Normal file
View File

@ -0,0 +1,47 @@
/*!@filters
\page filters About filters
\section filtintro Overview
Before a document can be processed either for indexing or previewing, it
must be translated into an internal common format.
The MimeHandler class defines the virtual interface for filters. There are
derived classes for text, html (MimeHandlerHtml), and mail folders
(MimeHandlerMail)
There is also a derived class (MimeHandlerExec) that will execute an
external program to translate the document to simple html (to be further
processed by MimeHandlerHtml).
To extend Recoll for a new document type, you may either subclass the
MimeHandler class (look at one of the existing subclasses), or write an
external filter, which will probably be the simpler solution in most cases.
\section extfilts External filters
Filters are programs (usually shell scripts) that will turn a document of
foreign type into something that Recoll can understand. Html was chosen as
a pivot format for its ability to carry structured information.
The meta-information tags that Recoll will use at the moment are the
following:
- title
- charset
- keywords
- description
For an example, you can take a look, at rclsoff which translates openoffice
documents.
The filter is executed with the input file name as a parameter and should
output the result to stdout.
\section extassoc Associating a filter to a mime type
This is done in mimeconf. Take a look at the file, the format is
self-explanatory.
*/

20
src/doc/prog/top.txt Normal file
View File

@ -0,0 +1,20 @@
/*!@mainpage Recoll: A personal/desktop text-search program
\author email address: jean-francois.dockes@wanadoo.fr
\section intro Introduction
Home page: http://www.recoll.org
This is the documentation for Recoll, a personal text search tool. Recoll
is written in C++, has a QT-based gui and uses the <a
href="http://www.xapian.org">Xapian</a> full text search engine.
Recoll supports a number of document types, the decoding of which is either
performed with internal code or an externally executed, program.
It should be relatively easy to write a new filter for some yet unsupported
file type, and the documentation for this is found here: <a
href="filters.html">Writing input filters</a>
*/