diff options
author | Kyle Meyer <kyle@kyleam.com> | 2021-10-16 01:39:44 -0400 |
---|---|---|
committer | Eric Wong <e@80x24.org> | 2021-10-16 06:55:54 +0000 |
commit | 9d72cc3f876e3d2bd1ecb2fc0f33c43a9a72b933 (patch) | |
tree | 98c8f4d1d7410dd8b49d9b0199e9383fabd1bbd6 /Documentation/lei-inspect.pod | |
parent | 3fcef58a3d05ad82c089b081d8c31305f1b12317 (diff) | |
download | public-inbox-9d72cc3f876e3d2bd1ecb2fc0f33c43a9a72b933.tar.gz |
At this point all of the current lei commands, aside from -help and -sucks, should be covered.
Diffstat (limited to 'Documentation/lei-inspect.pod')
-rw-r--r-- | Documentation/lei-inspect.pod | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/Documentation/lei-inspect.pod b/Documentation/lei-inspect.pod new file mode 100644 index 00000000..19dd8ab5 --- /dev/null +++ b/Documentation/lei-inspect.pod @@ -0,0 +1,57 @@ +=head1 NAME + +lei-inspect - general purpose inspector + +=head1 SYNOPSIS + +lei inspect [OPTIONS] ITEM [ITEM...] + +lei inspect [OPTIONS] (--stdin|-) + +=head1 DESCRIPTION + +This is a diagnostic command that provides a general purpose inspector +of various things, including blobs, message IDs, Xapian document IDs, +and mail sync sources. + +=head1 OPTIONS + +=over + +=item -d DIR + +=item --dir=DIR + +An inboxdir, extindex topdir, or Xapian shard + +=item --pretty + +Pretty print output. If stdout is opened to a tty, C<--pretty> is +enabled by default. + +=item - + +=item --stdin + +Read message from stdin. This is implicit if no arguments are given +and stdin is a pipe or regular file. + +=back + +=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://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.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-mail-diff(1)> |