1PUBLIC-INBOX-CLONE(1)      public-inbox user manual      PUBLIC-INBOX-CLONE(1)
2
3
4

NAME

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

SYNOPSIS

9       public-inbox-clone INBOX_URL [INBOX_DIR]
10

DESCRIPTION

12       public-inbox-clone is a wrapper around "git clone --mirror" for making
13       the initial clone of a remote HTTP(S) public-inbox.  It allows cloning
14       multi-epoch v2 inboxes with a single command and zero configuration.
15
16       It does not run public-inbox-init(1) nor public-inbox-index(1).  Those
17       commands must be run separately if serving/searching the mirror is
18       required.  As-is, public-inbox-clone is suitable for creating a git-
19       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 public-inbox-fetch(1) unless it is removed
24       completely.
25
26       public-inbox-clone does not use nor require any extra configuration
27       files (not even "~/.public-inbox/config").
28
29       public-inbox-fetch(1) may be used to keep "INBOX_DIR" up-to-date.
30
31       For v2 inboxes, it will create a "$INBOX_DIR/manifest.js.gz" file to
32       speed up subsequent public-inbox-fetch(1).
33

OPTIONS

35       --epoch=RANGE
36           Restrict clones of public-inbox-v2-format(5) inboxes to the given
37           range of epochs.  The range may be a single non-negative integer or
38           a (possibly open-ended) "LOW..HIGH" range of non-negative integers.
39           "~" may be prefixed to either (or both) integer values to represent
40           the offset from the maximum possible value.
41
42           For example, "--epoch=~0" alone clones only the latest epoch,
43           "--epoch=~2.." clones the three latest epochs.
44
45           Default: "0..~0" or 0.. or "..~0" (all epochs, all three examples
46           are equivalent)
47
48       -q
49       --quiet
50           Quiets down progress messages, also passed to git-fetch(1).
51
52       -v
53       --verbose
54           Increases verbosity, also passed to git-fetch(1).
55
56       --torsocks=auto|no|yes
57       --no-torsocks
58           Whether to wrap git(1) and curl(1) commands with torsocks(1).
59
60           Default: "auto"
61

CONTACT

63       Feedback welcome via plain-text mail to <mailto:meta@public-inbox.org>
64
65       The mail archives are hosted at <https://public-inbox.org/meta/> and
66       <http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
67

69       Copyright all contributors <mailto:meta@public-inbox.org>
70
71       License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
72

SEE ALSO

74       public-inbox-fetch(1), public-inbox-init(1), public-inbox-index(1)
75
76
77
78public-inbox.git                  1993-10-02             PUBLIC-INBOX-CLONE(1)
Impressum