diff options
Diffstat (limited to 'Documentation/lei-import.pod')
| -rw-r--r-- | Documentation/lei-import.pod | 46 |
1 files changed, 37 insertions, 9 deletions
diff --git a/Documentation/lei-import.pod b/Documentation/lei-import.pod index 9322dfa8..31d6db13 100644 --- a/Documentation/lei-import.pod +++ b/Documentation/lei-import.pod @@ -4,20 +4,21 @@ lei-import - one-time import of messages into local store =head1 SYNOPSIS -lei import [OPTIONS] LOCATION [LOCATION...] +lei import [OPTIONS] LOCATION [LOCATION...] [+L:LABEL] lei import [OPTIONS] (--stdin|-) =head1 DESCRIPTION -Import messages into the local storage of L<lei(1)>. C<LOCATION> is a +Import messages into the local storage of L<lei(1)> +(aka L<leiE<sol>store|lei-store-format(5)>). C<LOCATION> is a source of messages: a directory (Maildir), a file, or a URL (C<imap://>, C<imaps://>, C<nntp://>, or C<nntps://>). URLs requiring authentication use L<git-credential(1)> to fill in the username and password. -For a regular file, the location must have a C<E<lt>formatE<gt>:> -prefix specifying one of the following formats: C<eml>, C<mboxrd>, +For a regular file, the C<LOCATION> must have a C<E<lt>formatE<gt>:> +prefix specifying one of the following formats: C<mboxrd>, C<mboxcl2>, C<mboxcl>, or C<mboxo>. =head1 OPTIONS @@ -42,6 +43,29 @@ C<none>. Default: fcntl,dotlock +=item +L:LABEL + +Add the given C<LABEL> to all messages imported, where C<LABEL> +is an arbitrary user-defined value consisting of lowercase and digits. +See L<lei-tag(1)> for more info on labels. + +For example, specifying C<+L:inbox> applies the C<inbox> label +to all messages being imported. + +May be specified multiple times to apply multiple labels. + +Default: none + +=item +kw:KEYWORD + +Apply C<KEYWORD> to all messages being imported in addition +to any per-message keywords from the store (unless C<--no-kw> +is specified). See L<lei-tag(1)> for more info on keywords. + +May be specified multiple times to apply multiple keywords. + +Default: none + =item --no-kw Don't import message keywords (or "flags" in IMAP terminology). @@ -54,16 +78,21 @@ Import already seen IMAP and NNTP articles. =item --no-torsocks -Whether to wrap L<git(1)> and L<curl(1)> commands with torsocks. +Whether to wrap L<git(1)> and L<curl(1)> commands with L<torsocks(1)>. Default: C<auto> -=item --proxy=PROTO://HOST[:PORT] +=item --proxy=PROTOCOL://HOST[:PORT] Use the specified proxy (e.g., C<socks5h://0:9050>). +Consider L<imap.proxy> and L<nntp.proxy> which can be persistently +configured on a per-host basis in L<lei-config(1)>. + =back +See L<lei-config(1)> for various C<imap.*> and C<nntp.*> options. + =head1 CONTACT Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org> @@ -73,11 +102,10 @@ L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/> =head1 COPYRIGHT -Copyright 2021 all contributors L<mailto:meta@public-inbox.org> +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-add-external(1)> +L<lei-config(1)>, L<lei-index(1)>, L<lei-store-format(5)> |