]> Sergey Matveev's repositories - public-inbox.git/blob - Documentation/public-inbox-clone.pod
mbox_reader: do not blindly pass --rsyncable to gzip
[public-inbox.git] / 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 --epoch=RANGE
35
36 Restrict clones of L<public-inbox-v2-format(5)> inboxes to the
37 given range of epochs.  The range may be a single non-negative
38 integer or a (possibly open-ended) C<LOW..HIGH> range of
39 non-negative integers.  C<~> may be prefixed to either (or both)
40 integer values to represent the offset from the maximum possible
41 value.
42
43 For example, C<--epoch=~0> alone clones only the latest epoch,
44 C<--epoch=~2..> clones the three latest epochs.
45
46 Default: C<0..~0> or C<0..> or C<..~0>
47 (all epochs, all three examples are equivalent)
48
49 =item -q
50
51 =item --quiet
52
53 Quiets down progress messages, also passed to L<git-fetch(1)>.
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 CONTACT
72
73 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
74
75 The mail archives are hosted at L<https://public-inbox.org/meta/> and
76 L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
77
78 =head1 COPYRIGHT
79
80 Copyright all contributors L<mailto:meta@public-inbox.org>
81
82 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
83
84 =head1 SEE ALSO
85
86 L<public-inbox-fetch(1)>, L<public-inbox-init(1)>, L<public-inbox-index(1)>