* [PATCH 3/3] doc: start working on public-inbox-extindex(1) manpage
2021-01-25 4:53 7% [PATCH 0/3] doc: some extindex updates Eric Wong
@ 2021-01-25 4:53 6% ` Eric Wong
0 siblings, 0 replies; 2+ results
From: Eric Wong @ 2021-01-25 4:53 UTC (permalink / raw)
To: meta
It's barely started, but I started writing this weeks ago, but
I'm still unsure about some behavioral/usability things and
hoping work on lei(1) can flush them out.
---
Documentation/public-inbox-extindex.pod | 84 +++++++++++++++++++++++++
MANIFEST | 1 +
2 files changed, 85 insertions(+)
create mode 100644 Documentation/public-inbox-extindex.pod
diff --git a/Documentation/public-inbox-extindex.pod b/Documentation/public-inbox-extindex.pod
new file mode 100644
index 00000000..a92181e4
--- /dev/null
+++ b/Documentation/public-inbox-extindex.pod
@@ -0,0 +1,84 @@
+=head1 NAME
+
+public-inbox-extindex - create and update external search indices
+
+=head1 SYNOPSIS
+
+public-inbox-extindex [OPTIONS] EXTINDEX_DIR INBOX_DIR...
+
+public-inbox-extindex [OPTIONS] [EXTINDEX_DIR] --all
+
+=head1 DESCRIPTION
+
+FIXME: behavior not finalized It should probably write to the
+config file the first time --all is used.
+
+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,
+along with L<DBD::SQLite> and L<DBI> Perl modules.
+
+=head1 OPTIONS
+
+=over
+
+=item --jobs=JOBS, -j
+
+... TODO, see L<public-inbox-index(5)>
+
+=back
+
+=head1 FILES
+
+L<public-inbox-extindex-format(5)>
+
+=head1 CONFIGURATION
+
+... TODO, see L<public-inbox-index(5)>
+
+=head1 ENVIRONMENT
+
+=over 8
+
+=item PI_CONFIG
+
+Used to override the default "~/.public-inbox/config" value.
+
+=item XAPIAN_FLUSH_THRESHOLD
+
+The number of documents to update before committing changes to
+disk. This environment is handled directly by Xapian, refer to
+Xapian API documentation for more details.
+
+Setting C<XAPIAN_FLUSH_THRESHOLD> or
+C<publicinbox.indexBatchSize> for a large C<--reindex> may cause
+L<public-inbox-mda(1)>, L<public-inbox-learn(1)> and
+L<public-inbox-watch(1)> tasks to wait long and unpredictable
+periods of time during C<--reindex>.
+
+Default: none, uses C<publicinbox.indexBatchSize>
+
+=back
+
+=head1 UPGRADING
+
+Occasionally, public-inbox will update it's schema version and
+require a full index by running this command.
+
+=head1 CONTACT
+
+Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
+
+The mail archives are hosted at L<https://public-inbox.org/meta/>
+and L<http://hjrcffqmbrq6wope.onion/meta/>
+
+=head1 COPYRIGHT
+
+Copyright 2021 all contributors L<mailto:meta@public-inbox.org>
+
+License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
+
+=head1 SEE ALSO
+
+L<Search::Xapian>, L<DBD::SQLite>
diff --git a/MANIFEST b/MANIFEST
index ddee1539..127b7caf 100644
--- a/MANIFEST
+++ b/MANIFEST
@@ -28,6 +28,7 @@ Documentation/public-inbox-convert.pod
Documentation/public-inbox-daemon.pod
Documentation/public-inbox-edit.pod
Documentation/public-inbox-extindex-format.pod
+Documentation/public-inbox-extindex.pod
Documentation/public-inbox-httpd.pod
Documentation/public-inbox-imapd.pod
Documentation/public-inbox-index.pod
^ permalink raw reply related [relevance 6%]
* [PATCH 0/3] doc: some extindex updates
@ 2021-01-25 4:53 7% Eric Wong
2021-01-25 4:53 6% ` [PATCH 3/3] doc: start working on public-inbox-extindex(1) manpage Eric Wong
0 siblings, 1 reply; 2+ results
From: Eric Wong @ 2021-01-25 4:53 UTC (permalink / raw)
To: meta
1-2/3 should make life easier for lintian users (Debian
developers).
3/3 - I'm still uncertain about some behavior of the command
w.r.t. config file updating and hoping they'll be fleshed out
as I start (ab)using it during lei(1) development
Eric Wong (3):
doc: extindex-format: make lexgrog happy
build: check with lexgrog(1) if available
doc: start working on public-inbox-extindex(1) manpage
.gitignore | 1 +
Documentation/include.mk | 3 +
.../public-inbox-extindex-format.pod | 2 +-
Documentation/public-inbox-extindex.pod | 84 +++++++++++++++++++
MANIFEST | 1 +
Makefile.PL | 8 +-
6 files changed, 97 insertions(+), 2 deletions(-)
create mode 100644 Documentation/public-inbox-extindex.pod
^ permalink raw reply [relevance 7%]
Results 1-2 of 2 | reverse | options above
-- pct% links below jump to the message on this page, permalinks otherwise --
2021-01-25 4:53 7% [PATCH 0/3] doc: some extindex updates Eric Wong
2021-01-25 4:53 6% ` [PATCH 3/3] doc: start working on public-inbox-extindex(1) manpage Eric Wong
Code repositories for project(s) associated with this public inbox
https://80x24.org/public-inbox.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).