]> Sergey Matveev's repositories - public-inbox.git/blob - Documentation/lei-ls-mail-source.pod
ds: share long_step between NNTP and IMAP
[public-inbox.git] / Documentation / lei-ls-mail-source.pod
1 =head1 NAME
2
3 lei-ls-mail-source - list IMAP or NNTP mail source folders
4
5 =head1 SYNOPSIS
6
7 lei ls-mail-source [OPTIONS] URL
8
9 =head1 DESCRIPTION
10
11 List information about the IMAP or NNTP mail source at C<URL>.
12 This command populates the cache used for Bash shell completion
13 and is handy for writing L<lei-import(1)> invocations.
14
15 =head1 OPTIONS
16
17 =over
18
19 =item -z
20
21 =item -0
22
23 Use C<\0> (NUL) instead of newline (CR) to delimit lines.
24
25 =item -l
26
27 Format output as JSON and include more information.
28
29 =item --pretty
30
31 Pretty print JSON output.  If stdout is opened to a tty, C<--pretty>
32 is enabled by default.
33
34 =item --ascii
35
36 Escape non-ASCII characters.
37
38 =item --url
39
40 Show full URL of newsgroup or IMAP folder.
41
42 =back
43
44 =head1 CONTACT
45
46 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
47
48 The mail archives are hosted at L<https://public-inbox.org/meta/> and
49 L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
50
51 =head1 COPYRIGHT
52
53 Copyright all contributors L<mailto:meta@public-inbox.org>
54
55 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
56
57 =head1 SEE ALSO
58
59 L<lei-import(1)>