]> Sergey Matveev's repositories - public-inbox.git/blob - Documentation/public-inbox-clone.pod
103260913d92a41c400e47441d8483b3b43ac851
[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 creates a Makefile with handy targets to update the
22 inbox once indexed.  This Makefile may be edited by the user; it will
23 not be rewritten by L<public-inbox-fetch(1)> unless it is removed
24 completely.
25
26 public-inbox-clone does not use nor require any extra
27 configuration files (not even C<~/.public-inbox/config>).
28
29 L<public-inbox-fetch(1)> may be used to keep C<INBOX_DIR>
30 up-to-date.
31
32 For v2 inboxes, it will create a C<$INBOX_DIR/manifest.js.gz>
33 file to speed up subsequent L<public-inbox-fetch(1)>.
34
35 =head1 OPTIONS
36
37 =over
38
39 =item --epoch=RANGE
40
41 Restrict clones of L<public-inbox-v2-format(5)> inboxes to the
42 given range of epochs.  The range may be a single non-negative
43 integer or a (possibly open-ended) C<LOW..HIGH> range of
44 non-negative integers.  C<~> may be prefixed to either (or both)
45 integer values to represent the offset from the maximum possible
46 value.
47
48 For example, C<--epoch=~0> alone clones only the latest epoch,
49 C<--epoch=~2..> clones the three latest epochs.
50
51 Default: C<0..~0> or C<0..> or C<..~0>
52 (all epochs, all three examples are equivalent)
53
54 =item -q
55
56 =item --quiet
57
58 Quiets down progress messages, also passed to L<git-fetch(1)>.
59
60 =item -v
61
62 =item --verbose
63
64 Increases verbosity, also passed to L<git-fetch(1)>.
65
66 =item --torsocks=auto|no|yes
67
68 =item --no-torsocks
69
70 Whether to wrap L<git(1)> and L<curl(1)> commands with torsocks.
71
72 Default: C<auto>
73
74 =back
75
76 =head1 CONTACT
77
78 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
79
80 The mail archives are hosted at L<https://public-inbox.org/meta/> and
81 L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
82
83 =head1 COPYRIGHT
84
85 Copyright all contributors L<mailto:meta@public-inbox.org>
86
87 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
88
89 =head1 SEE ALSO
90
91 L<public-inbox-fetch(1)>, L<public-inbox-init(1)>, L<public-inbox-index(1)>