]> Sergey Matveev's repositories - public-inbox.git/blobdiff - Documentation/lei-blob.pod
pop3: reduce memory use while generating the mailbox cache
[public-inbox.git] / Documentation / lei-blob.pod
index ecdd1e9974d3510eb0552e647926e0755d524960..e401bb4711a6abe9bc727f7deafa9723648137d6 100644 (file)
@@ -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.
@@ -31,62 +34,59 @@ Do not look in the git repository of the current working directory.
 Do not look in mail storage for C<OID>.  This is implied by
 C<--oid-a>, C<--path-a>, and C<--path-b>.
 
-=item -A OID-A, --oid-a=OID-A
+=item -A OID-A
 
-=item -a PATH-A, --path-a=PATH-A
+=item --oid-a=OID-A
 
-=item -b PATH-B, --path-b=PATH-B
+Provide pre-image object ID as a hint for reconstructing C<OID>.
 
-Provide pre-image object ID, pre-image pathname, or post-image
-pathname as a hint for reconstructing C<OID>.
+=item -a PATH-A
 
-=for comment
-TODO: The below options are shared with lei-q.  Any good approaches to
-not repeating the text?
+=item --path-a=PATH-A
 
-=item --[no-]remote
+Provide pre-image pathname as a hint for reconstructing C<OID>.
 
-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.
+=item -b PATH-B
 
-=item --no-local
+=item --path-b=PATH-B
 
-Limit operations to those requiring network access.
+Provide post-image pathname as a hint for reconstructing C<OID>.
 
-=item --no-external
+=item -v
 
-Don't include results from externals.
+=item --verbose
 
-=item -I LOCATION, --include=LOCATION
+Provide more feedback on stderr.
 
-Include specified external in search.  This option may be given
-multiple times.
+=back
 
-=item --exclude=LOCATION
+The following options are also supported and are described in
+L<lei-q(1)>.
 
-Exclude specified external from search.  This option may be given
-multiple times.
+=over
 
-=item --only=LOCATION
+=item --remote
 
-Use only the specified external for search.  This option may be given
-multiple times, in which case the search uses only the specified set.
+Remote externals only get queried when the blob needs to be
+reconstructed from patch emails.
 
-=item --no-import-remote
+=item --no-local
 
-Disable the default behavior of memoizing remote messages into the
-local store.
+=item --no-external
 
-=item -v, --verbose
+=item -I LOCATION, --include=LOCATION
 
-Provide more feedback on stderr.
+=item --exclude=LOCATION
+
+=item --only=LOCATION
+
+=item --no-import-remote
 
-=item --torsocks=auto|no|yes, --no-torsocks
+=item --torsocks=auto|no|yes
 
-Whether to wrap L<git(1)> and L<curl(1)> commands with torsocks.
+=item --no-torsocks
 
-Default: C<auto>
+=item --proxy=PROTO://HOST[:PORT]
 
 =back
 
@@ -94,8 +94,8 @@ Default: C<auto>
 
 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
 
@@ -106,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)>