X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=Documentation%2Flei-add-external.pod;h=ad0e1d072ec31c76684697d41f5b1a81cc273241;hb=0b15dfc58ceaecdcb1c9285c3ad55813006c8338;hp=ebefb4cfa919d36a79bc516ed946544754932b4e;hpb=7ede448ca426632fab03bf85b603848a68a3505f;p=public-inbox.git diff --git a/Documentation/lei-add-external.pod b/Documentation/lei-add-external.pod index ebefb4cf..ad0e1d07 100644 --- a/Documentation/lei-add-external.pod +++ b/Documentation/lei-add-external.pod @@ -9,12 +9,15 @@ lei add-external [OPTIONS] LOCATION =head1 DESCRIPTION Configure lei to search against an external (an inbox or external -index). When C is a local path, it should point to a -directory that is a C.inboxdir> or +index). When C is an existing local path, it should point +to a directory that is a C.inboxdir> or C.topdir> value in ~/.public-inbox/config. =head1 OPTIONS +=for comment +TODO: mention curl options? + =over =item --boost=NUMBER @@ -23,6 +26,62 @@ Set priority of a new or existing location. Default: 0 +=item --mirror=URL + +Create C by mirroring the public-inbox at C. + +=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 and L commands with torsocks. + +Default: C + +=item --inbox-version=NUM + +Force a public-inbox version (must be C<1> or C<2>). + +=back + +The following options are passed to L: + +=over + +=item -j JOBS, --jobs=JOBS + +=item -L LEVEL, --indexlevel=LEVEL + +=back + +The following options are passed to L: + +=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 @@ -33,8 +92,8 @@ The configuration for lei resides at C<$XDG_CONFIG_HOME/lei/config>. Feedback welcome via plain-text mail to L -The mail archives are hosted at L -and L +The mail archives are hosted at L and +L =head1 COPYRIGHT @@ -44,6 +103,6 @@ License: AGPL-3.0+ L =head1 SEE ALSO -L, L, +L, L, L, L, L, L