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 One deviation from L<lei-q(1)> is the default output format is
  24 C<-f text> when writing to stdout.
  25
  26 =over
  27
  28 =item --format=FORMAT
  29
  30 =item -f FORMAT
  31
  32 Most commonly C<text> (the default) or C<reply> to
  33 display the message(s) in a format suitable for trimming
  34 and sending as a email reply.
  35
  36 =item --stdin
  37
  38 =item -
  39
  40 C<lei lcat> implicitly reads from stdin if it is a L<pipe(7)>
  41 or regular file.  This is handy for invoking C<lei lcat> from
  42 inside an C<$EDITOR> session (assuming you use an C<$EDITOR>
  43 which lets you pipe arbitrary lines to arbitrary commands).
  44
  45 =item --[no-]remote
  46
  47 =item --no-local
  48
  49 =item --no-external
  50
  51 =item --no-import-remote
  52
  53 =item --torsocks=auto|no|yes, --no-torsocks
  54
  55 =item --proxy=PROTO://HOST[:PORT]
  56
  57 =item -o MFOLDER, --output=MFOLDER
  58
  59 =item -d STRATEGY, --dedupe=STRATEGY
  60
  61 =item -t, --threads
  62
  63 =item -s KEY, --sort=KEY
  64
  65 =item -r, --reverse
  66
  67 =item --offset=NUMBER
  68
  69 =item -g, --globoff
  70
  71 =item -a, --augment
  72
  73 =item --lock=METHOD
  74
  75 =item --alert=COMMAND
  76
  77 =item --mua=COMMAND
  78
  79 =item --no-color
  80
  81 =back
  82
  83 =head1 CONTACT
  84
  85 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
  86
  87 The mail archives are hosted at L<https://public-inbox.org/meta/>
  88 and L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
  89
  90 =head1 COPYRIGHT
  91
  92 Copyright 2021 all contributors L<mailto:meta@public-inbox.org>
  93
  94 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
  95
  96 =head1 SEE ALSO
  97
  98 L<lei-q(1)>, L<lei-blob(1)>