]> Sergey Matveev's repositories - public-inbox.git/blob - Documentation/lei-add-external.pod
doc: lei-add-watch: add warning about unreliability
[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
33 =item --epoch=RANGE
34
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
40 value.
41
42 For example, C<--epoch=~0> alone clones only the latest epoch,
43 C<--epoch=~2..> clones the three latest epochs.
44
45 Default: C<0..~0> or C<0..> or C<..~0>
46 (all epochs, all three examples are equivalent)
47
48 =item -v
49
50 =item --verbose
51
52 Provide more feedback on stderr.
53
54 =item -q
55
56 =item --quiet
57
58 Suppress feedback messages.
59
60 =back
61
62 =head2 MIRRORING
63
64 =over
65
66 =item --torsocks=auto|no|yes
67
68 =item --no-torsocks
69
70 Whether to wrap L<git(1)> and L<curl(1)> commands with torsocks.
71
72 Default: C<auto>
73
74 =item --inbox-version=NUM
75
76 Force a public-inbox version (must be C<1> or C<2>).
77
78 =back
79
80 The following options are passed to L<public-inbox-init(1)>:
81
82 =over
83
84 =item -j JOBS, --jobs=JOBS
85
86 =item -L LEVEL, --indexlevel=LEVEL
87
88 =back
89
90 The following options are passed to L<public-inbox-index(1)>:
91
92 =over
93
94 =item --batch-size=SIZE
95
96 =item --compact
97
98 =item -j JOBS, --jobs=JOBS
99
100 =item --max-size=SIZE
101
102 =item --sequential-shard
103
104 =item --skip-docdata
105
106 =back
107
108 =head1 FILES
109
110 The configuration for lei resides at C<$XDG_CONFIG_HOME/lei/config>.
111
112 =head1 CONTACT
113
114 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
115
116 The mail archives are hosted at L<https://public-inbox.org/meta/> and
117 L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
118
119 =head1 COPYRIGHT
120
121 Copyright 2021 all contributors L<mailto:meta@public-inbox.org>
122
123 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
124
125 =head1 SEE ALSO
126
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)>