diff options
author | Kyle Meyer <kyle@kyleam.com> | 2021-02-01 00:57:02 -0500 |
---|---|---|
committer | Eric Wong <e@80x24.org> | 2021-02-01 11:26:18 +0000 |
commit | 82691a35fcf3b8945539084a029722b3458d72c8 (patch) | |
tree | ed942cdf732ea55f0df3375e605323e6d22bfb14 /Documentation/lei-add-external.pod | |
parent | dd1a1bceb56692722b1fb4a27391c80307403d86 (diff) | |
download | public-inbox-82691a35fcf3b8945539084a029722b3458d72c8.tar.gz |
Add manpages for lei and the currently implemented subcommands. The included options and their descriptions follow to a large degree the --help output, dropping some options that are not currently wired up.
Diffstat (limited to 'Documentation/lei-add-external.pod')
-rw-r--r-- | Documentation/lei-add-external.pod | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/Documentation/lei-add-external.pod b/Documentation/lei-add-external.pod new file mode 100644 index 00000000..dd87be62 --- /dev/null +++ b/Documentation/lei-add-external.pod @@ -0,0 +1,49 @@ +=head1 NAME + +lei-add-external - add inbox or external index + +=head1 SYNOPSIS + +lei add-external [OPTIONS] URL_OR_PATHNAME + +=head1 DESCRIPTION + +Configure lei to search against an external (an inbox or external +index). When C<URL_OR_PATHNAME> is a local path, it should point to a +directory that is a C<public.<name>.inboxdir> or +C<extindex.<name>.topdir> value in ~/.public-inbox/config. + +=head1 OPTIONS + +=over + +=item --boost=NUMBER + +Set priority of a new or existing location. + +Default: 0 + +=back + +=head1 FILES + +The configuration for lei resides at C<$XDG_CONFIG_HOME/lei/config>. + +=head1 CONTACT + +Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org> + +The mail archives are hosted at L<https://public-inbox.org/meta/> +and L<http://hjrcffqmbrq6wope.onion/meta/> + +=head1 COPYRIGHT + +Copyright 2021 all contributors L<mailto:meta@public-inbox.org> + +License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt> + +=head1 SEE ALSO + +L<lei-forget-external(1)>, L<lei-ls-external(1)>, +L<public-inbox-index(1)>, L<public-inbox-extindex(1)>, +L<public-inbox-extindex-format(5)> |