summaryrefslogtreecommitdiff
path: root/databases/p5-Search-Xapian/pkg-descr
diff options
context:
space:
mode:
authorSunpoet Po-Chuan Hsieh <sunpoet@FreeBSD.org>2019-01-05 22:45:20 +0000
committerSunpoet Po-Chuan Hsieh <sunpoet@FreeBSD.org>2019-01-05 22:45:20 +0000
commit47eafd67197995a71c6eb5f1e7bb572f3bd3e6f0 (patch)
treecb8e7b9e24aa406ca0b662dfcb652e5334b10edc /databases/p5-Search-Xapian/pkg-descr
parentmail/gnumail: Update to 1.3.0 (diff)
Add p5-Search-Xapian 1.2.25.2 (copied from p5-Search-Xapian12)
Notified by: mat
Notes
Notes: svn path=/head/; revision=489395
Diffstat (limited to 'databases/p5-Search-Xapian/pkg-descr')
-rw-r--r--databases/p5-Search-Xapian/pkg-descr19
1 files changed, 19 insertions, 0 deletions
diff --git a/databases/p5-Search-Xapian/pkg-descr b/databases/p5-Search-Xapian/pkg-descr
new file mode 100644
index 000000000000..a0b327ff2b5c
--- /dev/null
+++ b/databases/p5-Search-Xapian/pkg-descr
@@ -0,0 +1,19 @@
+This module wraps most methods of most Xapian classes. The missing classes and
+methods should be added in the future. It also provides a simplified, more
+'perlish' interface - as demonstrated above.
+
+The Xapian library is evolving very quickly at the time of writing, hence any
+documentation placed here would be likely to become out of date quite rapidly,
+and I do not have the patience to write some which could rapidly become
+redundant.
+
+Apologies to those of you considering using this module. For the time being, I
+would suggest garnering what you can from the tests and examples provided, or
+reading through the Xapian documentation on http://www.xapian.org/, notably the
+API documentation at http://www.xapian.org/docs/apidoc/html/annotated.html
+
+If you encounter problems, email either me or preferably the Xapian-discuss
+mailing list (which I am on - subscription details can be found on the Xapian
+web site).
+
+WWW: https://metacpan.org/release/Search-Xapian