about summary refs log tree commit homepage
path: root/Documentation
diff options
context:
space:
mode:
authorEric Wong <e@80x24.org>2021-10-25 19:31:47 +0000
committerEric Wong <e@80x24.org>2021-10-26 03:16:24 +0000
commitbddffde95e686b20f78403ce8817f892e6467b31 (patch)
treebe9768ebff3ffdcb2c33709c3b627732cdd44999 /Documentation
parent00db45c43436dde25f63abcaa969e29479204b82 (diff)
downloadpublic-inbox-bddffde95e686b20f78403ce8817f892e6467b31.tar.gz
This is useful for users lacking in local storage.  Also,
referencing lei-add-external(1) seems to make less sense
than referencing lei-q(1).

We'll also start dropping years from the copyright statement
to reduce future churn.
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/lei-p2q.pod17
1 files changed, 14 insertions, 3 deletions
diff --git a/Documentation/lei-p2q.pod b/Documentation/lei-p2q.pod
index 1068ff0b..2e0b1ab6 100644
--- a/Documentation/lei-p2q.pod
+++ b/Documentation/lei-p2q.pod
@@ -57,6 +57,10 @@ Dump output that shows the information collected for every prefix.
 This information can be useful for seeing how a patch is processed,
 but the format should not be considered stable.
 
+=item --uri
+
+URI escape output for interacting with HTTP(S) public-inbox instances.
+
 =item -q
 
 =item --quiet
@@ -65,6 +69,14 @@ Suppress feedback messages.
 
 =back
 
+=head1 EXAMPLES
+
+  # to search for all threads which touch a given thread:
+  lei p2q $COMMIT_OID | lei q -t -o /tmp/results
+
+  # to view results on a remote HTTP(S) public-inbox instance
+  $BROWSER https://example.com/pub-inbox/?q=$(lei p2q --uri $COMMIT_OID)
+
 =head1 CONTACT
 
 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
@@ -74,11 +86,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-q(1)>