3 lei-add-external - add inbox or external index
7 lei add-external [OPTIONS] LOCATION
11 Configure lei to search against an external (an inbox or external
12 index). When C<LOCATION> is an existing local path, it should point
13 to a directory that is a C<publicinbox.$NAME.inboxdir> or
14 C<extindex.$NAME.topdir> value in ~/.public-inbox/config.
19 TODO: mention curl options?
25 Set priority of a new or existing location.
31 Create C<LOCATION> by mirroring the public-inbox at C<URL>.
32 C<LOCATION> will have a Makefile with a C<make update>
33 target to update the external.
37 Restrict clones of L<public-inbox-v2-format(5)> inboxes to the
38 given range of epochs. The range may be a single non-negative
39 integer or a (possibly open-ended) C<LOW..HIGH> range of
40 non-negative integers. C<~> may be prefixed to either (or both)
41 integer values to represent the offset from the maximum possible
44 For example, C<--epoch=~0> alone clones only the latest epoch,
45 C<--epoch=~2..> clones the three latest epochs.
47 Default: C<0..~0> or C<0..> or C<..~0>
48 (all epochs, all three examples are equivalent)
54 Provide more feedback on stderr.
60 Suppress feedback messages.
68 =item --torsocks=auto|no|yes
72 Whether to wrap L<git(1)> and L<curl(1)> commands with L<torsocks(1)>.
76 =item --inbox-version=NUM
78 Force a remote public-inbox version (must be C<1> or C<2>).
79 This is auto-detected by default, and this option exists mainly
84 The following options are passed to L<public-inbox-init(1)>:
88 =item -j JOBS, --jobs=JOBS
90 =item -L LEVEL, --indexlevel=LEVEL
94 The following options are passed to L<public-inbox-index(1)>:
98 =item --batch-size=SIZE
102 =item -j JOBS, --jobs=JOBS
104 =item --max-size=SIZE
106 =item --sequential-shard
114 The configuration for lei resides at C<$XDG_CONFIG_HOME/lei/config>.
118 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
120 The mail archives are hosted at L<https://public-inbox.org/meta/> and
121 L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
125 Copyright 2021 all contributors L<mailto:meta@public-inbox.org>
127 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
131 L<lei-forget-external(1)>, L<lei-ls-external(1)>, L<lei-import(1)>,
132 L<public-inbox-index(1)>, L<public-inbox-extindex(1)>,
133 L<public-inbox-extindex-format(5)>