diff options
author | Eric Wong <e@80x24.org> | 2023-09-11 07:26:39 +0000 |
---|---|---|
committer | Eric Wong <e@80x24.org> | 2023-09-11 18:51:02 +0000 |
commit | 22c5b815cc4105228fd34cdaa2826dca70552a3e (patch) | |
tree | fb5fc859c7c18729d817a1664921db7b40917558 /Documentation | |
parent | bdf6cb8ca93a6aec7065b4ba8f3f4b1f58f427b4 (diff) | |
download | public-inbox-22c5b815cc4105228fd34cdaa2826dca70552a3e.tar.gz |
The Xapian SWIG bindings are favored by Xapian upstream for ease-of-maintenance compared to the XS version. While Debian lags on this front, the SWIG bindings are widely available on all *BSDs.
Diffstat (limited to 'Documentation')
-rw-r--r-- | Documentation/design_www.txt | 2 | ||||
-rw-r--r-- | Documentation/public-inbox-config.pod | 4 | ||||
-rw-r--r-- | Documentation/public-inbox-extindex.pod | 2 | ||||
-rw-r--r-- | Documentation/public-inbox-index.pod | 4 | ||||
-rw-r--r-- | Documentation/public-inbox-overview.pod | 2 | ||||
-rw-r--r-- | Documentation/technical/data_structures.txt | 2 |
6 files changed, 8 insertions, 8 deletions
diff --git a/Documentation/design_www.txt b/Documentation/design_www.txt index 68488b1f..a0003f99 100644 --- a/Documentation/design_www.txt +++ b/Documentation/design_www.txt @@ -7,7 +7,7 @@ URL and anchor naming /$INBOX/?r=$GIT_COMMIT -> HTML only /$INBOX/new.atom -> Atom feed -#### Optional, relies on Search::Xapian (or Xapian SWIG binding) +#### Optional, relies on Xapian /$INBOX/$MESSAGE_ID/t/ -> HTML content of thread (nested) /$INBOX/$MESSAGE_ID/T/ -> HTML content of thread (flat) anchors: diff --git a/Documentation/public-inbox-config.pod b/Documentation/public-inbox-config.pod index d2389abc..871ac6c5 100644 --- a/Documentation/public-inbox-config.pod +++ b/Documentation/public-inbox-config.pod @@ -125,8 +125,8 @@ C<basic> only requires L<DBD::SQLite(3pm)> and provides all NNTP functionality along with thread-awareness in the WWW interface. -C<medium> requires L<Search::Xapian(3pm)> to provide full-text -term search functionality in the WWW UI. +C<medium> requires L<Xapian(3pm)> or L<Search::Xapian(3pm)> to provide +full-text term search functionality in the WWW UI. C<full> also includes positional information used by Xapian to allow for searching for phrases using quoted text. diff --git a/Documentation/public-inbox-extindex.pod b/Documentation/public-inbox-extindex.pod index a5f699c5..fbb12fe9 100644 --- a/Documentation/public-inbox-extindex.pod +++ b/Documentation/public-inbox-extindex.pod @@ -13,7 +13,7 @@ public-inbox-extindex [OPTIONS] [EXTINDEX_DIR] --all public-inbox-extindex creates and updates an external search and overview database used by the read-only public-inbox PSGI (HTTP), NNTP, and IMAP interfaces. This requires either the -L<Search::Xapian> XS bindings OR the L<Xapian> SWIG bindings, +L<Xapian> SWIG bindings OR or L<Search::Xapian> XS bindings along with L<DBD::SQLite> and L<DBI> Perl modules. =head1 OPTIONS diff --git a/Documentation/public-inbox-index.pod b/Documentation/public-inbox-index.pod index 11108f78..14f157a5 100644 --- a/Documentation/public-inbox-index.pod +++ b/Documentation/public-inbox-index.pod @@ -13,8 +13,8 @@ public-inbox-index [OPTIONS] --all public-inbox-index creates and updates the search, overview and NNTP article number database used by the read-only public-inbox HTTP and NNTP interfaces. Currently, this requires -L<DBD::SQLite> and L<DBI> Perl modules. L<Search::Xapian> -is optional, only to support the PSGI search interface. +L<DBD::SQLite> and L<DBI> Perl modules. L<Xapian> (or L<Search::Xapian>) +are optional, only to support the PSGI search interface. Once the initial indices are created by public-inbox-index, L<public-inbox-mda(1)> and L<public-inbox-watch(1)> will diff --git a/Documentation/public-inbox-overview.pod b/Documentation/public-inbox-overview.pod index d4318576..35917ccc 100644 --- a/Documentation/public-inbox-overview.pod +++ b/Documentation/public-inbox-overview.pod @@ -48,7 +48,7 @@ that inbox. The instructions are roughly: # Optional but strongly recommended for hosting HTTP # (and required for NNTP) - # enable overview (requires DBD::SQLite) and, if Search::Xapian is + # enable overview (requires DBD::SQLite) and, if Xapian is # available, search: public-inbox-index INBOX_DIR diff --git a/Documentation/technical/data_structures.txt b/Documentation/technical/data_structures.txt index 5ed21882..11f78041 100644 --- a/Documentation/technical/data_structures.txt +++ b/Documentation/technical/data_structures.txt @@ -117,7 +117,7 @@ Per-inbox classes * PublicInbox::Search - Xapian read-only interface Common abbreviation: $srch, $ibx->search - Used everywhere if Search::Xapian (or Xapian.pm) is available. + Used everywhere if Xapian is available. Each indexed inbox has one of these, see public-inbox-v1-format(5) and public-inbox-v2-format(5) |