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 a local path, it should point to a
  13 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 =over
  19
  20 =item --boost=NUMBER
  21
  22 Set priority of a new or existing location.
  23
  24 Default: 0
  25
  26 =back
  27
  28 =head1 FILES
  29
  30 The configuration for lei resides at C<$XDG_CONFIG_HOME/lei/config>.
  31
  32 =head1 CONTACT
  33
  34 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
  35
  36 The mail archives are hosted at L<https://public-inbox.org/meta/>
  37 and L<http://hjrcffqmbrq6wope.onion/meta/>
  38
  39 =head1 COPYRIGHT
  40
  41 Copyright 2021 all contributors L<mailto:meta@public-inbox.org>
  42
  43 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
  44
  45 =head1 SEE ALSO
  46
  47 L<lei-forget-external(1)>, L<lei-ls-external(1)>, L<lei-import(1)>,
  48 L<public-inbox-index(1)>, L<public-inbox-extindex(1)>,
  49 L<public-inbox-extindex-format(5)>