]> Sergey Matveev's repositories - public-inbox.git/commitdiff
lei p2q: document --uri, add examples
authorEric Wong <e@80x24.org>
Mon, 25 Oct 2021 19:31:47 +0000 (19:31 +0000)
committerEric Wong <e@80x24.org>
Tue, 26 Oct 2021 03:16:24 +0000 (03:16 +0000)
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.

Documentation/lei-p2q.pod
lib/PublicInbox/LEI.pm

index 1068ff0beb27141a7cd074b61a75f8fd3907aa15..2e0b1ab676edd6ca3d0199fde3b2f22194b877ea 100644 (file)
@@ -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)>
index cb1e5433cc2dd07432af454970ba2427f0c8ed08..32d4b9f3b42793ffb89cf040e0bc775ab1863bee 100644 (file)
@@ -353,6 +353,7 @@ my %OPTDESC = (
 
 'want|w=s@' => [ 'PREFIX|dfpost|dfn', # common ones in help...
                'search prefixes to extract (default: dfpost7)' ],
+'uri   p2q' => [ 'URI escape output' ],
 
 'alert=s@' => ['CMD,:WINCH,:bell,<any command>',
        'run command(s) or perform ops when done writing to output ' .