diff options
author | Kyle Meyer <kyle@kyleam.com> | 2021-02-27 13:03:26 -0500 |
---|---|---|
committer | Eric Wong <e@80x24.org> | 2021-02-27 16:18:43 -0400 |
commit | 82e81eeb8925580728a6b73aae7d960ab271cffc (patch) | |
tree | 4c0694e681e596590d12f1b22f6d95c7343269f3 | |
parent | 903eac79aa86d17c0b8f888d160d44977899515b (diff) | |
download | public-inbox-82e81eeb8925580728a6b73aae7d960ab271cffc.tar.gz |
Catch up with recent developments.
-rw-r--r-- | Documentation/lei-import.pod | 19 | ||||
-rw-r--r-- | Documentation/lei-q.pod | 32 | ||||
-rw-r--r-- | Documentation/lei.pod | 15 | ||||
-rwxr-xr-x | Documentation/txt2pre | 1 |
4 files changed, 53 insertions, 14 deletions
diff --git a/Documentation/lei-import.pod b/Documentation/lei-import.pod index ef20e2f6..7d5b2576 100644 --- a/Documentation/lei-import.pod +++ b/Documentation/lei-import.pod @@ -11,12 +11,14 @@ lei import [OPTIONS] --stdin =head1 DESCRIPTION Import messages into the local storage of L<lei(1)>. C<LOCATION> is a -source of messages: a directory (Maildir) or a file. 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>, C<mboxcl2>, -C<mboxcl>, or C<mboxo>. +source of messages: a directory (Maildir), a file, or a URL +(C<imap://>, C<imaps://>, C<nntp://>, or C<nntps://>). URLs requiring +authentication must use L<netrc(5)> and/or L<git-credential(1)> to +fill in the username and password. -TODO: Update when URL support is added. +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>, +C<mboxcl2>, C<mboxcl>, or C<mboxo>. =head1 OPTIONS @@ -31,6 +33,13 @@ format prefix with C<LOCATION> is preferred. Read messages from stdin. +=item --lock + +L<mbox(5)> locking method(s) to use: C<dotlock>, C<fcntl>, C<flock> or +C<none>. + +Default: fcntl,dotlock + =item --no-kw, --no-keywords, --no-flags Don't import message keywords (or "flags" in IMAP terminology). diff --git a/Documentation/lei-q.pod b/Documentation/lei-q.pod index 0959beac..e878157d 100644 --- a/Documentation/lei-q.pod +++ b/Documentation/lei-q.pod @@ -26,18 +26,22 @@ Read search terms from stdin. =item -o MFOLDER, --output=MFOLDER, --mfolder=MFOLDER -Destination for results (e.g., C<path/to/Maildir> or -C<mboxcl2:path/to/mbox>). The format can be specified by adding a -C<E<lt>formatE<gt>:> prefix with any of these values: C<maildir>, +Destination for results (e.g., C<path/to/Maildir>, +C<imaps://user@mail.example.com/INBOX.test>, or +C<mboxcl2:path/to/mbox>). The prefix may be a supported protocol: +C<imap://>, C<imaps://>, C<nntp://>, or C<nntps://>. URLs requiring +authentication must use L<netrc(5)> and/or L<git-credential(1)> to +fill in the username and password. + +The prefix can instead specify the format of the output: C<maildir>, C<mboxrd>, C<mboxcl2>, C<mboxcl>, C<mboxo>, C<json>, C<jsonl>, or -C<concatjson>. +C<concatjson>. When a format isn't specified, it's chosen based on +the destination. C<json> is used for the default destination +(stdout), and C<maildir> is used for an existing directory or +non-existing path. TODO: Provide description of formats? -When a format isn't specified, it's chosen based on the destination. -C<json> is used for the default destination (stdout), and C<maildir> -is used for an existing directory or non-existing path. - Default: - =item -f FORMAT, --format=FORMAT @@ -130,6 +134,18 @@ multiple times, in which case the search uses only the specified set. Do not match locations using C<*?> wildcards and C<[]> ranges. This option applies to C<--include>, C<--exclude>, and C<--only>. +=item --no-import-remote + +Disable the default behavior of memoizing remote messages into the +local store. + +=item --lock + +L<mbox(5)> locking method(s) to use: C<dotlock>, C<fcntl>, C<flock> or +C<none>. + +Default: fcntl,dotlock + =item -NUMBER, -n NUMBER, --limit=NUMBER Limit the number of matches. diff --git a/Documentation/lei.pod b/Documentation/lei.pod index 9ce9e9a4..e1502122 100644 --- a/Documentation/lei.pod +++ b/Documentation/lei.pod @@ -4,7 +4,7 @@ lei - local email interface for public-inbox =head1 SYNOPSIS -lei COMMAND +lei [OPTIONS] COMMAND =head1 DESCRIPTION @@ -19,6 +19,19 @@ indices). Available in public-inbox 1.7.0+. +=head1 OPTIONS + +=over + +=item -C DIR + +Change current working directory to the specified directory before +running the command. This option can be given before or after +C<COMMAND> and is accepted by all lei subcommands except +L<lei-daemon-kill(1)>. + +=back + =head1 COMMANDS Subcommands for initializing and managing local, writable storage: diff --git a/Documentation/txt2pre b/Documentation/txt2pre index 8421cad7..3277531f 100755 --- a/Documentation/txt2pre +++ b/Documentation/txt2pre @@ -102,6 +102,7 @@ $xurls{'git-filter-repo(1)'} = 'https://github.com/newren/git-filter-repo'. $xurls{'ssoma(1)'} = 'https://ssoma.public-inbox.org/ssoma.txt'; $xurls{'cgitrc(5)'} = 'https://git.zx2c4.com/cgit/tree/cgitrc.5.txt'; $xurls{'prove(1)'} = 'https://perldoc.perl.org/prove.html'; +$xurls{'mbox(5)'} = 'https://manpages.debian.org/stable/mutt/mbox.5.en.html'; my $str = do { local $/; <STDIN> }; my ($title) = ($str =~ /\A([^\n]+)/); |