public-inbox-fetch(1)

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

NAME

6       public-inbox-fetch - "git fetch" wrapper for v2 inbox mirrors
7

SYNOPSIS

9       public-inbox-fetch [--exit-code] -C INBOX_DIR
10

DESCRIPTION

12       public-inbox-fetch updates git storage of public-inbox mirrors.  With
13       v2 inboxes, it allows detection of new epochs and avoids unnecessary
14       traffic on old epochs.
15
16       public-inbox-fetch does not use nor require any configuration files of
17       its own.
18
19       It does not run public-inbox-index(1), making it suitable for
20       maintaining git-only backups.
21
22       For v2 inboxes, it will maintain "$INBOX_DIR/manifest.js.gz" file to
23       speed up future invocations.  It always safe to remove manifest.js.gz,
24       it is merely an optimization and will be restored on the next
25       invocation.
26
27       To prevent fetches on any v2 epoch, use chmod(1) to remove write
28       permissions to the top-level of the epoch.  For example, to disable
29       fetches on epoch 4:
30
31               chmod a-w $INBOX_DIR/git/4.git
32
33       If you wish to re-enable fetches to the epoch:
34
35               chmod u+w $INBOX_DIR/git/4.git
36

OPTIONS

38       -q
39       --quiet
40           Quiets down progress messages, also passed to git-fetch(1).
41
42       -T REMOTE
43       --try-remote REMOTE
44           Try a given remote name instead of "origin" or "_grokmirror".  May
45           be specified more than once.
46
47           Default: "origin", "_grokmirror"
48
49       --exit-code
50           Exit with 127 if no updates are done.  This can be used in shell
51           scripts to avoid invoking public-inbox-index(1) when there are no
52           updates:
53
54                   public-inbox-fetch -q --exit-code && public-inbox-index
55                   test $? -eq 0 || exit $?
56
57       -p
58       --prune
59           Pass the "--prune" and "--prune-tags" flags to git-fetch(1) calls.
60
61           This is a new option in public-inbox 2.0+
62
63       -v
64       --verbose
65           Increases verbosity, also passed to git-fetch(1).
66
67       --torsocks=auto|no|yes
68       --no-torsocks
69           Whether to wrap git(1) and curl(1) commands with torsocks(1).
70
71           Default: "auto"
72

EXIT CODES

74       127 no updates when "--exit-code" is used above
75
76       public-inbox-fetch will also exit with curl "EXIT CODES" in curl(1) as
77       documented in the curl(1) manpage (e.g. 7 when curl cannot reach a
78       host).  Likewise, git-fetch(1) failures are also propagated to the
79       user.
80

CONTACT

82       Feedback welcome via plain-text mail to <mailto:meta@public-inbox.org>
83
84       The mail archives are hosted at <https://public-inbox.org/meta/> and
85       <http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
86

COPYRIGHT

88       Copyright all contributors <mailto:meta@public-inbox.org>
89
90       License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
91