]> Sergey Matveev's repositories - public-inbox.git/blob - Documentation/lei-inspect.pod
19dd8ab5edef210ee658af664405c52af400a382
[public-inbox.git] / Documentation / lei-inspect.pod
1 =head1 NAME
2
3 lei-inspect - general purpose inspector
4
5 =head1 SYNOPSIS
6
7 lei inspect [OPTIONS] ITEM [ITEM...]
8
9 lei inspect [OPTIONS] (--stdin|-)
10
11 =head1 DESCRIPTION
12
13 This is a diagnostic command that provides a general purpose inspector
14 of various things, including blobs, message IDs, Xapian document IDs,
15 and mail sync sources.
16
17 =head1 OPTIONS
18
19 =over
20
21 =item -d DIR
22
23 =item --dir=DIR
24
25 An inboxdir, extindex topdir, or Xapian shard
26
27 =item --pretty
28
29 Pretty print output.  If stdout is opened to a tty, C<--pretty> is
30 enabled by default.
31
32 =item -
33
34 =item --stdin
35
36 Read message from stdin.  This is implicit if no arguments are given
37 and stdin is a pipe or regular file.
38
39 =back
40
41 =head1 CONTACT
42
43 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
44
45 The mail archives are hosted at L<https://public-inbox.org/meta/> and
46 L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
47
48 =head1 COPYRIGHT
49
50 Copyright 2021 all contributors L<mailto:meta@public-inbox.org>
51
52 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
53
54
55 =head1 SEE ALSO
56
57 L<lei-mail-diff(1)>