]> Sergey Matveev's repositories - public-inbox.git/blob - Documentation/lei-add-external.pod
git: drop needless ENOENT import
[public-inbox.git] / Documentation / lei-add-external.pod
1 =head1 NAME
2
3 lei-add-external - add inbox or external index
4
5 =head1 SYNOPSIS
6
7 lei add-external [OPTIONS] LOCATION
8
9 =head1 DESCRIPTION
10
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.
15
16 =head1 OPTIONS
17
18 =for comment
19 TODO: mention curl options?
20
21 =over
22
23 =item --boost=NUMBER
24
25 Set priority of a new or existing location.
26
27 Default: 0
28
29 =item --mirror=URL
30
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.
34
35 =item --epoch=RANGE
36
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
42 value.
43
44 For example, C<--epoch=~0> alone clones only the latest epoch,
45 C<--epoch=~2..> clones the three latest epochs.
46
47 Default: C<0..~0> or C<0..> or C<..~0>
48 (all epochs, all three examples are equivalent)
49
50 =item -v
51
52 =item --verbose
53
54 Provide more feedback on stderr.
55
56 =item -q
57
58 =item --quiet
59
60 Suppress feedback messages.
61
62 =back
63
64 =head2 MIRRORING
65
66 =over
67
68 =item --torsocks=auto|no|yes
69
70 =item --no-torsocks
71
72 Whether to wrap L<git(1)> and L<curl(1)> commands with L<torsocks(1)>.
73
74 Default: C<auto>
75
76 =item --inbox-version=NUM
77
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
80 for testing.
81
82 =back
83
84 The following options are passed to L<public-inbox-init(1)>:
85
86 =over
87
88 =item -j JOBS, --jobs=JOBS
89
90 =item -L LEVEL, --indexlevel=LEVEL
91
92 =back
93
94 The following options are passed to L<public-inbox-index(1)>:
95
96 =over
97
98 =item --batch-size=SIZE
99
100 =item --compact
101
102 =item -j JOBS, --jobs=JOBS
103
104 =item --max-size=SIZE
105
106 =item --sequential-shard
107
108 =item --skip-docdata
109
110 =back
111
112 =head1 FILES
113
114 The configuration for lei resides at C<$XDG_CONFIG_HOME/lei/config>.
115
116 =head1 CONTACT
117
118 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
119
120 The mail archives are hosted at L<https://public-inbox.org/meta/> and
121 L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
122
123 =head1 COPYRIGHT
124
125 Copyright 2021 all contributors L<mailto:meta@public-inbox.org>
126
127 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
128
129 =head1 SEE ALSO
130
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)>