]> Sergey Matveev's repositories - public-inbox.git/blob - Documentation/lei-lcat.pod
doc lei: add manpages for new commands
[public-inbox.git] / Documentation / lei-lcat.pod
1 =head1 NAME
2
3 lei-lcat - display local copy of messages(s)
4
5 =head1 SYNOPSIS
6
7 lei lcat [OPTIONS] MSGID_OR_URL [MSGID_OR_URL...]
8
9 lei lcat [OPTIONS] (--stdin|-)
10
11 =head1 DESCRIPTION
12
13 lcat (local cat) is a wrapper around L<lei-q(1)> that displays local
14 messages by Message-ID.  It is able to extract Message-IDs from URLs
15 as well as from common formats such as C<E<lt>$MSGIDE<gt>> and
16 C<id:$MSGID>.  When reading from stdin, input that isn't understood is
17 discarded, so the caller doesn't have to bother extracting the
18 Message-ID or link from surrounding text (e.g., a "Link: $URL" line).
19
20 =head1 OPTIONS
21
22 The following options, described in L<lei-q(1)>, are supported.
23
24 =over
25
26 =item --[no-]remote
27
28 =item --no-local
29
30 =item --no-external
31
32 =item --no-import-remote
33
34 =item --torsocks=auto|no|yes, --no-torsocks
35
36 =item --proxy=PROTO://HOST[:PORT]
37
38 =item -o MFOLDER, --output=MFOLDER
39
40 =item -d STRATEGY, --dedupe=STRATEGY
41
42 =item -t, --threads
43
44 =item -s KEY, --sort=KEY
45
46 =item -r, --reverse
47
48 =item --offset=NUMBER
49
50 =item -g, --globoff
51
52 =item -a, --augment
53
54 =item --lock=METHOD
55
56 =item --alert=COMMAND
57
58 =item --mua=COMMAND
59
60 =item --no-color
61
62 =back
63
64 =head1 CONTACT
65
66 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
67
68 The mail archives are hosted at L<https://public-inbox.org/meta/>
69 and L<http://hjrcffqmbrq6wope.onion/meta/>
70
71 =head1 COPYRIGHT
72
73 Copyright 2021 all contributors L<mailto:meta@public-inbox.org>
74
75 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
76
77 =head1 SEE ALSO
78
79 L<lei-q(1)>, L<lei-blob(1)>