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>.
35 Restrict clones of L<public-inbox-v2-format(5)> inboxes to the
36 given range of epochs. The range may be a single non-negative
37 integer or a (possibly open-ended) C<LOW..HIGH> range of
38 non-negative integers. C<~> may be prefixed to either (or both)
39 integer values to represent the offset from the maximum possible
42 For example, C<--epoch=~0> alone clones only the latest epoch,
43 C<--epoch=~2..> clones the three latest epochs.
45 Default: C<0..~0> or C<0..> or C<..~0>
46 (all epochs, all three examples are equivalent)
52 Provide more feedback on stderr.
58 Suppress feedback messages.
66 =item --torsocks=auto|no|yes
70 Whether to wrap L<git(1)> and L<curl(1)> commands with torsocks.
74 =item --inbox-version=NUM
76 Force a public-inbox version (must be C<1> or C<2>).
80 The following options are passed to L<public-inbox-init(1)>:
84 =item -j JOBS, --jobs=JOBS
86 =item -L LEVEL, --indexlevel=LEVEL
90 The following options are passed to L<public-inbox-index(1)>:
94 =item --batch-size=SIZE
98 =item -j JOBS, --jobs=JOBS
100 =item --max-size=SIZE
102 =item --sequential-shard
110 The configuration for lei resides at C<$XDG_CONFIG_HOME/lei/config>.
114 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
116 The mail archives are hosted at L<https://public-inbox.org/meta/> and
117 L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
121 Copyright 2021 all contributors L<mailto:meta@public-inbox.org>
123 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
127 L<lei-forget-external(1)>, L<lei-ls-external(1)>, L<lei-import(1)>,
128 L<public-inbox-index(1)>, L<public-inbox-extindex(1)>,
129 L<public-inbox-extindex-format(5)>