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