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.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.pod')
-rw-r--r-- | Documentation/lei.pod | 90 |
1 files changed, 90 insertions, 0 deletions
diff --git a/Documentation/lei.pod b/Documentation/lei.pod new file mode 100644 index 00000000..e12a157d --- /dev/null +++ b/Documentation/lei.pod @@ -0,0 +1,90 @@ +=head1 NAME + +lei - local email interface for public-inbox + +=head1 SYNOPSIS + +lei COMMAND + +=head1 DESCRIPTION + +Unlike the C10K-oriented L<public-inbox-daemon(8)>, lei is designed +exclusively to handle trusted local clients with read/write access to +the file system, using as many system resources as the local user has +access to. lei supports a local, writable store built on top of +L<public-inbox-v2-format(5)> and L<public-inbox-extindex(1)>. +L<lei-q(1)> provides an interface for querying messages across the lei +store and read-only local and remote "externals" (inboxes and external +indices). + +Available in public-inbox 1.7.0+. + +=head1 COMMANDS + +Subcommands for initializing and managing local, writable storage: + +=over + +=item * L<lei-init(1)> + +=back + +TODO: Add commands like lei-import once they're implemented. + +The following subcommands can be used to manage and inspect external +locations: + +=over + +=item * L<lei-add-external(1)> + +=item * L<lei-forget-external(1)> + +=item * L<lei-ls-external(1)> + +=back + +Subcommands related to searching and inspecting messages from the lei +store and configured externals are + +=over + +=item * L<lei-q(1)> + +=back + +TODO: Add lei-show (and perhaps others) once implemented. + +Other subcommands include + +=over + +=item * L<lei-config(1)> + +=item * L<lei-daemon-kill(1)> + +=item * L<lei-daemon-pid(1)> + +=back + +=head1 FILES + +By default storage is located at C<$XDG_DATA_HOME/lei/store>. 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-overview(7)> |