doc: lei-q: document SEARCH TERMS prefixes

[public-inbox.git] / Documentation / lei-mail-formats.pod

diff --git a/Documentation/lei-mail-formats.pod b/Documentation/lei-mail-formats.pod
index da723d2b83dbaf67c4dac7f5a56dc9cb5649d4d9..930c5d7660ea03e2113f7dc027977ceb76f7e5a1 100644 (file)
--- a/Documentation/lei-mail-formats.pod
+++ b/Documentation/lei-mail-formats.pod
@@ -51,7 +51,9 @@ with any number of C<E<gt>> characters and is thus fully
 reversible.
 
 This format is emitted by L<PublicInbox::WWW(3pm)> with gzip.
 reversible.
 
 This format is emitted by L<PublicInbox::WWW(3pm)> with gzip.

-It is supported by L<git-am(1)> since git 2.10.
+Since git 2.10, C<git am --patch-format=mboxrd> reads this
+format.  C<git log> and C<git format-patch --stdout> can also
+generate this format with the C<--pretty=mboxrd> switch.

 
 As with uncompressed L</mboxo>, uncompressed mboxrd are vulnerable
 to undetectable truncation.
 
 As with uncompressed L</mboxo>, uncompressed mboxrd are vulnerable
 to undetectable truncation.


@@ -94,7 +96,26 @@ it worth supporting.
 
 Depending on the IMAP server software and configuration, IMAP
 servers may use any (or combination) of the aforementioned
 
 Depending on the IMAP server software and configuration, IMAP
 servers may use any (or combination) of the aforementioned

-formats or a non-standard database backend.
+formats or a non-standard database backend.  Currently, lei
+uses L<Mail::IMAPClient> which has acceptable performance
+over low-latency links.  Performance over high-latency links
+is currently poor.
+
+=head1 eml
+
+A single raw message file.  C<eml> is not an output format for lei,
+but accepted by as an C<--input-format> (C<-F>) for read-only
+commands such as L<lei-tag(1)> and L<lei-import(1)>.
+
+Since C<eml> is the suffix for the C<message/rfc822> MIME type
+(according to the C<mime.types> file), lei will infer the type
+based on the C<.eml> suffix if C<--input-format> is unspecified
+
+C<.patch>-suffixed files generated by L<git-format-patch(1)>
+(without C<--stdout>) are C<eml> files with the addition of an
+mbox C<From > header.  L<lei(1)> removes C<From > lines to treat
+them as C<eml> when reading these for compatibility with
+C<git-am(1)> and similar tools.

 
 =head1 COPYRIGHT
 
 
 =head1 COPYRIGHT