Documentation/lei-blob.pod

   1 =head1 NAME
   2
   3 lei-blob - display a git blob, reconstructing from mail if necessary
   4
   5 =head1 SYNOPSIS
   6
   7 lei blob [OPTIONS] OID
   8
   9 =head1 DESCRIPTION
  10
  11 Display a git blob.  The blob may correspond to a message from the
  12 local store, an existing blob in the current repository, or a
  13 not-yet-created blob in the current repository that can be
  14 reconstructed from a message.
  15
  16 =head1 OPTIONS
  17
  18 =over
  19
  20 =item --git-dir=DIR
  21
  22 Specify an additional .git/ directory to scan.  This option may be
  23 given multiple times.
  24
  25 =item --no-cwd
  26
  27 Do not look in the git repository of the current working directory.
  28
  29 =item --no-mail
  30
  31 Do not look in mail storage for C<OID>.  This is implied by
  32 C<--oid-a>, C<--path-a>, and C<--path-b>.
  33
  34 =item -A OID-A
  35
  36 =item --oid-a=OID-A
  37
  38 Provide pre-image object ID as a hint for reconstructing C<OID>.
  39
  40 =item -a PATH-A
  41
  42 =item --path-a=PATH-A
  43
  44 Provide pre-image pathname as a hint for reconstructing C<OID>.
  45
  46 =item -b PATH-B
  47
  48 =item --path-b=PATH-B
  49
  50 Provide post-image pathname as a hint for reconstructing C<OID>.
  51
  52 =for comment
  53 TODO: The below options are shared with lei-q.  Any good approaches to
  54 not repeating the text?
  55
  56 =item --[no-]remote
  57
  58 Whether to include results requiring network access.  When local
  59 externals are configured, C<--remote> must be explicitly passed to
  60 enable reporting of results from remote externals.
  61
  62 =item --no-local
  63
  64 Limit operations to those requiring network access.
  65
  66 =item --no-external
  67
  68 Don't include results from externals.
  69
  70 =item -I LOCATION
  71
  72 =item --include=LOCATION
  73
  74 Include specified external in search.  This option may be given
  75 multiple times.
  76
  77 =item --exclude=LOCATION
  78
  79 Exclude specified external from search.  This option may be given
  80 multiple times.
  81
  82 =item --only=LOCATION
  83
  84 Use only the specified external for search.  This option may be given
  85 multiple times, in which case the search uses only the specified set.
  86
  87 =item --no-import-remote
  88
  89 Disable the default behavior of memoizing remote messages into the
  90 local store.
  91
  92 =item -v
  93
  94 =item --verbose
  95
  96 Provide more feedback on stderr.
  97
  98 =item --torsocks=auto|no|yes
  99
 100 =item --no-torsocks
 101
 102 Whether to wrap L<git(1)> and L<curl(1)> commands with torsocks.
 103
 104 Default: C<auto>
 105
 106 =back
 107
 108 =head1 CONTACT
 109
 110 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
 111
 112 The mail archives are hosted at L<https://public-inbox.org/meta/> and
 113 L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
 114
 115 =head1 COPYRIGHT
 116
 117 Copyright 2021 all contributors L<mailto:meta@public-inbox.org>
 118
 119 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
 120
 121
 122 =head1 SEE ALSO
 123
 124 L<lei-add-external(1)>