diff options
Diffstat (limited to 'Documentation/lei-ls-mail-source.pod')
| -rw-r--r-- | Documentation/lei-ls-mail-source.pod | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/Documentation/lei-ls-mail-source.pod b/Documentation/lei-ls-mail-source.pod new file mode 100644 index 00000000..0e485923 --- /dev/null +++ b/Documentation/lei-ls-mail-source.pod @@ -0,0 +1,59 @@ +=head1 NAME + +lei-ls-mail-source - list IMAP or NNTP mail source folders + +=head1 SYNOPSIS + +lei ls-mail-source [OPTIONS] URL + +=head1 DESCRIPTION + +List information about the IMAP or NNTP mail source at C<URL>. +This command populates the cache used for Bash shell completion +and is handy for writing L<lei-import(1)> invocations. + +=head1 OPTIONS + +=over + +=item -z + +=item -0 + +Use C<\0> (NUL) instead of newline (CR) to delimit lines. + +=item -l + +Format output as JSON and include more information. + +=item --pretty + +Pretty-print JSON output. If stdout is opened to a tty, C<--pretty> +is enabled by default. + +=item --ascii + +Escape non-ASCII characters. + +=item --url + +Show full URL of newsgroup or IMAP folder. + +=back + +=head1 CONTACT + +Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org> + +The mail archives are hosted at L<https://public-inbox.org/meta/> and +L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/> + +=head1 COPYRIGHT + +Copyright all contributors L<mailto:meta@public-inbox.org> + +License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt> + +=head1 SEE ALSO + +L<lei-import(1)> |