ds: share long_step between NNTP and IMAP

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

diff --git a/Documentation/lei-blob.pod b/Documentation/lei-blob.pod
index 7691832443f7d652ec74628203c1c85ae41dfb2f..e401bb4711a6abe9bc727f7deafa9723648137d6 100644 (file)
--- a/Documentation/lei-blob.pod
+++ b/Documentation/lei-blob.pod
@@ -9,9 +9,10 @@ lei blob [OPTIONS] OID
 =head1 DESCRIPTION
 
 Display a git blob.  The blob may correspond to a message from the
-local store, an existing blob in the current repository, or a
-not-yet-created blob in the current repository that can be
-reconstructed from a message.
+local store, any local external, or blobs associated with a
+project git repository (if run from a git (working) directory).
+For blobs which do not exist, it will attempt to recreate the blob
+using patch emails.
 
 =head1 OPTIONS
 
@@ -22,6 +23,8 @@ reconstructed from a message.
 Specify an additional .git/ directory to scan.  This option may be
 given multiple times.
 
+Default: the output of C<git rev-parse --git-dir>
+
 =item --no-cwd
 
 Do not look in the git repository of the current working directory.
@@ -49,59 +52,41 @@ Provide pre-image pathname as a hint for reconstructing C<OID>.
 
 Provide post-image pathname as a hint for reconstructing C<OID>.
 
-=for comment
-TODO: The below options are shared with lei-q.  Any good approaches to
-not repeating the text?
+=item -v
 
-=item --[no-]remote
+=item --verbose
 
-Whether to include results requiring network access.  When local
-externals are configured, C<--remote> must be explicitly passed to
-enable reporting of results from remote externals.
+Provide more feedback on stderr.
 
-=item --no-local
+=back
 
-Limit operations to those requiring network access.
+The following options are also supported and are described in
+L<lei-q(1)>.
 
-=item --no-external
+=over
 
-Don't include results from externals.
+=item --remote
 
-=item -I LOCATION
+Remote externals only get queried when the blob needs to be
+reconstructed from patch emails.
 
-=item --include=LOCATION
+=item --no-local
 
-Include specified external in search.  This option may be given
-multiple times.
+=item --no-external
 
-=item --exclude=LOCATION
+=item -I LOCATION, --include=LOCATION
 
-Exclude specified external from search.  This option may be given
-multiple times.
+=item --exclude=LOCATION
 
 =item --only=LOCATION
 
-Use only the specified external for search.  This option may be given
-multiple times, in which case the search uses only the specified set.
-
 =item --no-import-remote
 
-Disable the default behavior of memoizing remote messages into the
-local store.
-
-=item -v
-
-=item --verbose
-
-Provide more feedback on stderr.
-
 =item --torsocks=auto|no|yes
 
 =item --no-torsocks
 
-Whether to wrap L<git(1)> and L<curl(1)> commands with torsocks.
-
-Default: C<auto>
+=item --proxy=PROTO://HOST[:PORT]
 
 =back
 
@@ -121,4 +106,4 @@ License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
 
 =head1 SEE ALSO
 
-L<lei-add-external(1)>
+L<lei-add-external(1)>, L<lei-q(1)>