user/dev discussion of public-inbox itself
 help / color / mirror / code / Atom feed
From: Eric Wong <>
Subject: [PATCH 3/3] doc: start working on public-inbox-extindex(1) manpage
Date: Sun, 24 Jan 2021 19:53:46 -0900	[thread overview]
Message-ID: <> (raw)
In-Reply-To: <>

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
+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
+=item --jobs=JOBS, -j
+... TODO, see L<public-inbox-index(5)>
+=head1 FILES
+... TODO, see L<public-inbox-index(5)>
+=over 8
+=item PI_CONFIG
+Used to override the default "~/.public-inbox/config" value.
+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.
+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>
+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<>
+The mail archives are hosted at L<>
+and L<http://hjrcffqmbrq6wope.onion/meta/>
+Copyright 2021 all contributors L<>
+License: AGPL-3.0+ L<>
+=head1 SEE ALSO
+L<Search::Xapian>, L<DBD::SQLite>
diff --git a/MANIFEST b/MANIFEST
index ddee1539..127b7caf 100644
@@ -28,6 +28,7 @@ Documentation/public-inbox-convert.pod

      parent reply	other threads:[~2021-01-25  4:53 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-01-25  4:53 [PATCH 0/3] doc: some extindex updates Eric Wong
2021-01-25  4:53 ` [PATCH 1/3] doc: extindex-format: make lexgrog happy Eric Wong
2021-01-25  4:53 ` [PATCH 2/3] build: check with lexgrog(1) if available Eric Wong
2021-01-25  4:53 ` Eric Wong [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:

  List information:

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \ \ \ \

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

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).