about summary refs log tree commit homepage
path: root/Documentation/public-inbox-clone.pod
blob: fdb57663ceb97db93187ac02c0d27896f03f8256 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
=head1 NAME

public-inbox-clone - "git clone --mirror" wrapper

=head1 SYNOPSIS

public-inbox-clone INBOX_URL [INBOX_DIR]

=head1 DESCRIPTION

public-inbox-clone is a wrapper around C<git clone --mirror> for
making the initial clone of a remote HTTP(S) public-inbox.  It
allows cloning multi-epoch v2 inboxes with a single command and
zero configuration.

It does not run L<public-inbox-init(1)> nor
L<public-inbox-index(1)>.  Those commands must be run separately
if serving/searching the mirror is required.  As-is,
public-inbox-clone is suitable for creating a git-only backup.

public-inbox-clone does not use nor require any extra
configuration files (not even C<~/.public-inbox/config>).

L<public-inbox-fetch(1)> may be used to keep C<INBOX_DIR>
up-to-date.

For v2 inboxes, it will create a C<$INBOX_DIR/manifest.js.gz>
file to speed up subsequent L<public-inbox-fetch(1)>.

=head1 OPTIONS

=over

=item -q

=item --quiet

Quiets down progress messages, also passed to L<git-fetch(1)>.

=item -v

=item --verbose

Increases verbosity, also passed to L<git-fetch(1)>.

=item --torsocks=auto|no|yes

=item --no-torsocks

Whether to wrap L<git(1)> and L<curl(1)> commands with torsocks.

Default: C<auto>

=back

=head1 CONTACT

Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>

The mail archives are hosted at L<https://public-inbox.org/meta/> and
L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>

=head1 COPYRIGHT

Copyright all contributors L<mailto:meta@public-inbox.org>

License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>

=head1 SEE ALSO

L<public-inbox-fetch(1)>, L<public-inbox-init(1)>, L<public-inbox-index(1)>