3 public-inbox-fetch - "git fetch" wrapper for v2 inbox mirrors
7 public-inbox-fetch [--exit-code] -C INBOX_DIR
11 public-inbox-fetch updates git storage of public-inbox mirrors.
12 With v2 inboxes, it allows detection of new epochs and avoids
13 unnecessary traffic on old epochs.
15 public-inbox-fetch does not use nor require any configuration
18 It does not run L<public-inbox-index(1)>, making it suitable
19 for maintaining git-only backups.
21 For v2 inboxes, it will maintain C<$INBOX_DIR/manifest.js.gz>
22 file to speed up future invocations. It always safe to remove
23 manifest.js.gz, it is merely an optimization and will be
24 restored on the next invocation.
26 To prevent fetches on any v2 epoch, use L<chmod(1)> to remove
27 write permissions to the top-level of the epoch. For example,
28 to disable fetches on epoch 4:
30 chmod a-w $INBOX_DIR/git/4.git
32 If you wish to re-enable fetches to the epoch:
34 chmod u+w $INBOX_DIR/git/4.git
44 Quiets down progress messages, also passed to L<git-fetch(1)>.
48 =item --try-remote REMOTE
50 Try a given remote name instead of C<origin> or C<_grokmirror>.
51 May be specified more than once.
53 Default: C<origin>, C<_grokmirror>
57 Exit with C<127> if no updates are done. This can be used in
58 shell scripts to avoid invoking L<public-inbox-index(1)> when
61 public-inbox-fetch -q --exit-code && public-inbox-index
62 test $? -eq 0 || exit $?
68 Pass the C<--prune> and C<--prune-tags> flags to L<git-fetch(1)> calls.
74 Increases verbosity, also passed to L<git-fetch(1)>.
76 =item --torsocks=auto|no|yes
80 Whether to wrap L<git(1)> and L<curl(1)> commands with L<torsocks(1)>.
92 no updates when L</--exit-code> is used above
96 public-inbox-fetch will also exit with curl L<curl(1)/EXIT CODES>
97 as documented in the L<curl(1)> manpage (e.g. C<7> when curl cannot
98 reach a host). Likewise, L<git-fetch(1)> failures are also
99 propagated to the user.
103 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
105 The mail archives are hosted at L<https://public-inbox.org/meta/> and
106 L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
110 Copyright all contributors L<mailto:meta@public-inbox.org>
112 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
116 L<public-inbox-index(1)>, L<curl(1)>