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 -v
  34
  35 =item --verbose
  36
  37 Provide more feedback on stderr.
  38
  39 =item -q
  40
  41 =item --quiet
  42
  43 Suppress feedback messages.
  44
  45 =back
  46
  47 =head2 MIRRORING
  48
  49 =over
  50
  51 =item --torsocks=auto|no|yes
  52
  53 =item --no-torsocks
  54
  55 Whether to wrap L<git(1)> and L<curl(1)> commands with torsocks.
  56
  57 Default: C<auto>
  58
  59 =item --inbox-version=NUM
  60
  61 Force a public-inbox version (must be C<1> or C<2>).
  62
  63 =back
  64
  65 The following options are passed to L<public-inbox-init(1)>:
  66
  67 =over
  68
  69 =item -j JOBS, --jobs=JOBS
  70
  71 =item -L LEVEL, --indexlevel=LEVEL
  72
  73 =back
  74
  75 The following options are passed to L<public-inbox-index(1)>:
  76
  77 =over
  78
  79 =item --batch-size=SIZE
  80
  81 =item --compact
  82
  83 =item -j JOBS, --jobs=JOBS
  84
  85 =item --max-size=SIZE
  86
  87 =item --sequential-shard
  88
  89 =item --skip-docdata
  90
  91 =back
  92
  93 =head1 FILES
  94
  95 The configuration for lei resides at C<$XDG_CONFIG_HOME/lei/config>.
  96
  97 =head1 CONTACT
  98
  99 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
 100
 101 The mail archives are hosted at L<https://public-inbox.org/meta/> and
 102 L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
 103
 104 =head1 COPYRIGHT
 105
 106 Copyright 2021 all contributors L<mailto:meta@public-inbox.org>
 107
 108 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
 109
 110 =head1 SEE ALSO
 111
 112 L<lei-forget-external(1)>, L<lei-ls-external(1)>, L<lei-import(1)>,
 113 L<public-inbox-index(1)>, L<public-inbox-extindex(1)>,
 114 L<public-inbox-extindex-format(5)>