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 -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.
  23
  24 =head1 OPTIONS
  25
  26 =over
  27
  28 =item -q
  29
  30 =item --quiet
  31
  32 Quiets down progress messages, also passed to L<git-fetch(1)>.
  33
  34 =item -v
  35
  36 =item --verbose
  37
  38 Increases verbosity, also passed to L<git-fetch(1)>.
  39
  40 =item --torsocks=auto|no|yes
  41
  42 =item --no-torsocks
  43
  44 Whether to wrap L<git(1)> and L<curl(1)> commands with torsocks.
  45
  46 Default: C<auto>
  47
  48 =head1 CONTACT
  49
  50 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
  51
  52 The mail archives are hosted at L<https://public-inbox.org/meta/> and
  53 L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
  54
  55 =head1 COPYRIGHT
  56
  57 Copyright all contributors L<mailto:meta@public-inbox.org>
  58
  59 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
  60
  61 =head1 SEE ALSO
  62
  63 L<public-inbox-index(1)>