treewide: update to v3 Tor onions

[public-inbox.git] / Documentation / lei-overview.pod

diff --git a/Documentation/lei-overview.pod b/Documentation/lei-overview.pod
index 7c7337ab4f3cda123ebc55e0145f8f442695166b..4a34bc16268e2ec5225225cbb71b59e4f0bbfafe 100644 (file)
--- a/Documentation/lei-overview.pod
+++ b/Documentation/lei-overview.pod
@@ -9,16 +9,23 @@ provides some basic examples.
 
 =head1 LEI STORE
 
 
 =head1 LEI STORE
 

-L<lei-init(1)> initializes writable local storage based on
-L<public-inbox-v2-format(5)>.
+lei has writable local storage based on L<public-inbox-v2-format(5)>.
+Commands will automatically initialize the store behind the scenes if
+needed, but you can call L<lei-init(1)> directly if you want to use a
+store location other than the default C<$XDG_DATA_HOME/lei/store>.
+
+The L<lei-import(1)> command provides the primary interface for
+importing messages into the local storage.  In addition, other
+commands, such as L<lei-q(1)> and L<lei-blob(1)>, use the local store
+to memoize messages from remotes.

 
 =head2 EXAMPLES
 
 =over
 
 
 =head2 EXAMPLES
 
 =over
 

-=item $ lei import mboxrd:t.mbox
+=item $ lei import mboxrd:t.mbox.gz

 
 

-Import the messages from an mbox into the local storage.
+Import the messages from a gzipped mboxrd into the local storage.

 
 =item $ lei blob 59ec517f9
 
 
 =item $ lei blob 59ec517f9
 


@@ -26,7 +33,7 @@ Show message with the git blob OID of 59ec517f9.  If a message with
 that OID isn't found, check if the current git repository has the
 blob, trying to reconstruct it from a message if needed.
 
 that OID isn't found, check if the current git repository has the
 blob, trying to reconstruct it from a message if needed.
 

-=item $ lei blob 59ec517f9 | lei mark - -F eml +kw:flagged +L:next
+=item $ lei blob 59ec517f9 | lei tag - -F eml +kw:flagged +L:next

 
 Set the "flagged" keyword and "next" label on the message with the
 blob OID of 59ec517f9.
 
 Set the "flagged" keyword and "next" label on the message with the
 blob OID of 59ec517f9.


@@ -75,16 +82,17 @@ Search for messages whose subject includes "lei" and "skeleton".
 Do the same, but also report unmatched messages that are in the same
 thread as a matched message.
 
 Do the same, but also report unmatched messages that are in the same
 thread as a matched message.
 

-=item $ lei q -t -o mboxcl2:t.mbox --mua=mutt s:lei s:skeleton
+=item $ lei q -t -o /tmp/mdir --mua=mutt s:lei s:skeleton

 
 

-Write mboxcl2-formatted results to t.mbox and enter mutt to view the
-file by invoking C<mutt -f %f>.
+Write results to a Maildir at "mdir".  Mutt will be invoked
+to open mfolder (C<mutt -f %f>) while results are being fetched
+and written.

 
 =item $ lei q kw:flagged L:next
 
 Search for all flagged messages that also have a "next" label.
 
 
 =item $ lei q kw:flagged L:next
 
 Search for all flagged messages that also have a "next" label.
 

-=item $ lei p2q HEAD | lei q --stdin -tt -o mdir
+=item $ lei p2q HEAD | lei q --stdin -tt -o /tmp/mdir

 
 Search for messages that have post-image git blob IDs that match those
 of the current repository's HEAD commit, writing them to the Maildir
 
 Search for messages that have post-image git blob IDs that match those
 of the current repository's HEAD commit, writing them to the Maildir


@@ -113,8 +121,8 @@ welcome.
 
 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
 
 
 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://hjrcffqmbrq6wope.onion/meta/>
+The mail archives are hosted at L<https://public-inbox.org/meta/> and
+L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>

 
 =head1 COPYRIGHT
 
 
 =head1 COPYRIGHT