Documentation/public-inbox-fetch.pod

   1 =head1 NAME
   2
   3 public-inbox-fetch - "git fetch" wrapper for v2 inbox mirrors
   4
   5 =head1 SYNOPSIS
   6
   7 public-inbox-fetch [--exit-code] -C INBOX_DIR
   8
   9 =head1 DESCRIPTION
  10
  11 public-inbox-fetch updates git storage of public-inbox mirrors.
  12 With v2 inboxes, it allows detection of new epochs and avoids
  13 unnecessary traffic on old epochs.
  14
  15 public-inbox-fetch does not use nor require any configuration
  16 files of its own.
  17
  18 It does not run L<public-inbox-index(1)>, making it suitable
  19 for maintaining git-only backups.
  20
  21 For v2 inboxes, it will maintain C<$INBOX_DIR/manifest.js.gz>
  22 file to speed up future invocations.  It always safe to remove
  23 manifest.js.gz, it is merely an optimization and will be
  24 restored on the next invocation.
  25
  26 To prevent fetches on any v2 epoch, use L<chmod(1)> to remove
  27 write permissions to the top-level of the epoch.  For example,
  28 to disable fetches on epoch 4:
  29
  30         chmod a-w $INBOX_DIR/git/4.git
  31
  32 If you wish to re-enable fetches to the epoch:
  33
  34         chmod u+w $INBOX_DIR/git/4.git
  35
  36 =head1 OPTIONS
  37
  38 =over
  39
  40 =item -q
  41
  42 =item --quiet
  43
  44 Quiets down progress messages, also passed to L<git-fetch(1)>.
  45
  46 =item --exit-code
  47
  48 Exit with C<127> if no updates are done.  This can be used in
  49 shell scripts to avoid invoking L<public-inbox-index(1)> when
  50 there are no updates:
  51
  52         public-inbox-fetch -q --exit-code && public-inbox-index
  53         test $? -eq 0 || exit $?
  54
  55 =item -v
  56
  57 =item --verbose
  58
  59 Increases verbosity, also passed to L<git-fetch(1)>.
  60
  61 =item --torsocks=auto|no|yes
  62
  63 =item --no-torsocks
  64
  65 Whether to wrap L<git(1)> and L<curl(1)> commands with torsocks.
  66
  67 Default: C<auto>
  68
  69 =back
  70
  71 =head1 EXIT CODES
  72
  73 =over
  74
  75 =item 127
  76
  77 no updates when L</--exit-code> is used above
  78
  79 =back
  80
  81 public-inbox-fetch will also exit with curl L<curl(1)/EXIT CODES>
  82 as documented in the L<curl(1)> manpage (e.g. C<7> when curl cannot
  83 reach a host).  Likewise, L<git-fetch(1)> failures are also
  84 propagated to the user.
  85
  86 =head1 CONTACT
  87
  88 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
  89
  90 The mail archives are hosted at L<https://public-inbox.org/meta/> and
  91 L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
  92
  93 =head1 COPYRIGHT
  94
  95 Copyright all contributors L<mailto:meta@public-inbox.org>
  96
  97 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
  98
  99 =head1 SEE ALSO
 100
 101 L<public-inbox-index(1)>, L<curl(1)>