Documentation/public-inbox-clone.pod

   1 =head1 NAME
   2
   3 public-inbox-clone - "git clone --mirror" wrapper
   4
   5 =head1 SYNOPSIS
   6
   7 public-inbox-clone INBOX_URL [INBOX_DIR]
   8
   9 =head1 DESCRIPTION
  10
  11 public-inbox-clone is a wrapper around C<git clone --mirror> for
  12 making the initial clone of a remote HTTP(S) public-inbox.  It
  13 allows cloning multi-epoch v2 inboxes with a single command and
  14 zero configuration.
  15
  16 It does not run L<public-inbox-init(1)> nor
  17 L<public-inbox-index(1)>.  Those commands must be run separately
  18 if serving/searching the mirror is required.  As-is,
  19 public-inbox-clone is suitable for creating a git-only backup.
  20
  21 public-inbox-clone does not use nor require any extra
  22 configuration files (not even C<~/.public-inbox/config>).
  23
  24 L<public-inbox-fetch(1)> may be used to keep C<INBOX_DIR>
  25 up-to-date.
  26
  27 For v2 inboxes, it will create a C<$INBOX_DIR/manifest.js.gz>
  28 file to speed up subsequent L<public-inbox-fetch(1)>.
  29
  30 =head1 OPTIONS
  31
  32 =over
  33
  34 =item -q
  35
  36 =item --quiet
  37
  38 Quiets down progress messages, also passed to L<git-fetch(1)>.
  39
  40 =item -v
  41
  42 =item --verbose
  43
  44 Increases verbosity, also passed to L<git-fetch(1)>.
  45
  46 =item --torsocks=auto|no|yes
  47
  48 =item --no-torsocks
  49
  50 Whether to wrap L<git(1)> and L<curl(1)> commands with torsocks.
  51
  52 Default: C<auto>
  53
  54 =back
  55
  56 =head1 CONTACT
  57
  58 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
  59
  60 The mail archives are hosted at L<https://public-inbox.org/meta/> and
  61 L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
  62
  63 =head1 COPYRIGHT
  64
  65 Copyright all contributors L<mailto:meta@public-inbox.org>
  66
  67 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
  68
  69 =head1 SEE ALSO
  70
  71 L<public-inbox-fetch(1)>, L<public-inbox-init(1)>, L<public-inbox-index(1)>