]> Sergey Matveev's repositories - public-inbox.git/blob - Documentation/lei-import.pod
dir_idle: do not add watches in ->new
[public-inbox.git] / Documentation / lei-import.pod
1 =head1 NAME
2
3 lei-import - one-time import of messages into local store
4
5 =head1 SYNOPSIS
6
7 lei import [OPTIONS] LOCATION [LOCATION...]
8
9 lei import [OPTIONS] (--stdin|-)
10
11 =head1 DESCRIPTION
12
13 Import messages into the local storage of L<lei(1)>.  C<LOCATION> is a
14 source of messages: a directory (Maildir), a file, or a URL
15 (C<imap://>, C<imaps://>, C<nntp://>, or C<nntps://>).  URLs requiring
16 authentication use L<git-credential(1)> to
17 fill in the username and password.
18
19 For a regular file, the location must have a C<E<lt>formatE<gt>:>
20 prefix specifying one of the following formats: C<eml>, C<mboxrd>,
21 C<mboxcl2>, C<mboxcl>, or C<mboxo>.
22
23 =head1 OPTIONS
24
25 =over
26
27 =item -F MAIL_FORMAT
28
29 =item --in-format=MAIL_FORMAT
30
31 Message input format.  Unless messages are given on stdin, using a
32 format prefix with C<LOCATION> is preferred.
33
34 =item --stdin
35
36 Read messages from stdin.
37
38 =item --lock
39
40 L<mbox(5)> locking method(s) to use: C<dotlock>, C<fcntl>, C<flock> or
41 C<none>.
42
43 Default: fcntl,dotlock
44
45 =item --no-kw
46
47 Don't import message keywords (or "flags" in IMAP terminology).
48
49 =item --no-incremental
50
51 Import already seen IMAP and NNTP articles.
52
53 =item --torsocks=auto|no|yes
54
55 =item --no-torsocks
56
57 Whether to wrap L<git(1)> and L<curl(1)> commands with torsocks.
58
59 Default: C<auto>
60
61 =item --proxy=PROTO://HOST[:PORT]
62
63 Use the specified proxy (e.g., C<socks5h://0:9050>).
64
65 =back
66
67 =head1 CONTACT
68
69 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
70
71 The mail archives are hosted at L<https://public-inbox.org/meta/> and
72 L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
73
74 =head1 COPYRIGHT
75
76 Copyright 2021 all contributors L<mailto:meta@public-inbox.org>
77
78 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
79
80
81 =head1 SEE ALSO
82
83 L<lei-add-external(1)>