diff options
author | Kyle Meyer <kyle@kyleam.com> | 2021-02-10 23:04:15 -0500 |
---|---|---|
committer | Eric Wong <e@80x24.org> | 2021-02-11 05:03:24 +0000 |
commit | f310a5054fb8e215885f0b48afac44ff32ca1d56 (patch) | |
tree | ade6428067caf145ef002cad6c4b0c8e3fed08c0 /Documentation/lei-add-external.pod | |
parent | 389767f3b7eccc58859d7eade9ee2ba26b28f20d (diff) | |
download | public-inbox-f310a5054fb8e215885f0b48afac44ff32ca1d56.tar.gz |
Catch up with recent developments.
Diffstat (limited to 'Documentation/lei-add-external.pod')
-rw-r--r-- | Documentation/lei-add-external.pod | 62 |
1 files changed, 60 insertions, 2 deletions
diff --git a/Documentation/lei-add-external.pod b/Documentation/lei-add-external.pod index 1be3f905..3bc0ba83 100644 --- a/Documentation/lei-add-external.pod +++ b/Documentation/lei-add-external.pod @@ -9,12 +9,14 @@ lei add-external [OPTIONS] LOCATION =head1 DESCRIPTION Configure lei to search against an external (an inbox or external -index). When C<LOCATION> is a local path, it should point to a -directory that is a C<public.<name>.inboxdir> or +index). When C<LOCATION> is an existing local path, it should point +to a directory that is a C<public.<name>.inboxdir> or C<extindex.<name>.topdir> value in ~/.public-inbox/config. =head1 OPTIONS +TODO: mention curl options? + =over =item --boost=NUMBER @@ -23,6 +25,62 @@ Set priority of a new or existing location. Default: 0 +=item --mirror=URL + +Create C<LOCATION> by mirroring the public-inbox at C<URL>. + +=item -v, --verbose + +Provide more feedback on stderr. + +=item -q, --quiet + +Suppress feedback messages. + +=back + +=head2 MIRRORING + +=over + +=item --torsocks=auto|no|yes, --no-torsocks + +Whether to wrap L<git(1)> and L<curl(1)> commands with torsocks. + +Default: C<auto> + +=item --inbox-version=NUM + +Force a public-inbox version (must be C<1> or C<2>). + +=back + +The following options are passed to L<public-inbox-init(1)>: + +=over + +=item -j JOBS, --jobs=JOBS + +=item -L LEVEL, --indexlevel=LEVEL + +=back + +The following options are passed to L<public-inbox-index(1)>: + +=over + +=item --batch-size=SIZE + +=item --compact + +=item -j JOBS, --jobs=JOBS + +=item --max-size=SIZE + +=item --sequential-shard + +=item --skip-docdata + =back =head1 FILES |