From 9d72cc3f876e3d2bd1ecb2fc0f33c43a9a72b933 Mon Sep 17 00:00:00 2001 From: Kyle Meyer Date: Sat, 16 Oct 2021 01:39:44 -0400 Subject: doc: lei: add manpages for remaining commands At this point all of the current lei commands, aside from -help and -sucks, should be covered. --- Documentation/lei-inspect.pod | 57 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 Documentation/lei-inspect.pod (limited to 'Documentation/lei-inspect.pod') 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 + +The mail archives are hosted at L and +L + +=head1 COPYRIGHT + +Copyright 2021 all contributors L + +License: AGPL-3.0+ L + + +=head1 SEE ALSO + +L -- cgit v1.2.3-24-ge0c7