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