1LEI-ADD-EXTERNAL(1)        public-inbox user manual        LEI-ADD-EXTERNAL(1)
2
3
4

NAME

6       lei-add-external - add inbox or external index
7

SYNOPSIS

9       lei add-external [OPTIONS] LOCATION
10

DESCRIPTION

12       Configure lei to search against an external (an inbox or external
13       index).  When "LOCATION" is an existing local path, it should point to
14       a directory that is a "publicinbox.$NAME.inboxdir" or
15       "extindex.$NAME.topdir" value in ~/.public-inbox/config.
16

OPTIONS

18       --boost=NUMBER
19           Set priority of a new or existing location.
20
21           Default: 0
22
23       --mirror=URL
24           Create "LOCATION" by mirroring the public-inbox at "URL".
25           "LOCATION" will have a Makefile with a "make update" target to
26           update the external.
27
28       --epoch=RANGE
29           Restrict clones of public-inbox-v2-format(5) inboxes to the given
30           range of epochs.  The range may be a single non-negative integer or
31           a (possibly open-ended) "LOW..HIGH" range of non-negative integers.
32           "~" may be prefixed to either (or both) integer values to represent
33           the offset from the maximum possible value.
34
35           For example, "--epoch=~0" alone clones only the latest epoch,
36           "--epoch=~2.." clones the three latest epochs.
37
38           Default: "0..~0" or 0.. or "..~0" (all epochs, all three examples
39           are equivalent)
40
41       -v
42       --verbose
43           Provide more feedback on stderr.
44
45       -q
46       --quiet
47           Suppress feedback messages.
48
49   MIRRORING
50       --torsocks=auto|no|yes
51       --no-torsocks
52           Whether to wrap git(1) and curl(1) commands with torsocks(1).
53
54           Default: "auto"
55
56       --inbox-version=NUM
57           Force a remote public-inbox version (must be 1 or 2).  This is
58           auto-detected by default, and this option exists mainly for
59           testing.
60
61       The following options are passed to public-inbox-init(1):
62
63       -j JOBS, --jobs=JOBS
64       -L LEVEL, --indexlevel=LEVEL
65
66       The following options are passed to public-inbox-index(1):
67
68       --batch-size=SIZE
69       --compact
70       -j JOBS, --jobs=JOBS
71       --max-size=SIZE
72       --sequential-shard
73       --skip-docdata
74

FILES

76       The configuration for lei resides at "$XDG_CONFIG_HOME/lei/config".
77

CONTACT

79       Feedback welcome via plain-text mail to <mailto:meta@public-inbox.org>
80
81       The mail archives are hosted at <https://public-inbox.org/meta/> and
82       <http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
83

85       Copyright 2021 all contributors <mailto:meta@public-inbox.org>
86
87       License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
88

SEE ALSO

90       lei-forget-external(1), lei-ls-external(1), lei-import(1),
91       public-inbox-index(1), public-inbox-extindex(1),
92       public-inbox-extindex-format(5)
93
94
95
96public-inbox.git                  1993-10-02               LEI-ADD-EXTERNAL(1)
Impressum