1GROK-PI-PIPER(1)                                              GROK-PI-PIPER(1)
2
3
4

NAME

6       GROK-PI-PIPER  -  Hook script for piping new messages from public-inbox
7       repos
8

SYNOPSIS

10          grok-pi-piper [-h] [-v] [-d] -c  CONFIG  [-l  PIPELAST]  [--version]
11          repo
12

DESCRIPTION

14       This  is a ready-made hook script that can be called from pull.post_up‐
15       date_hook when mirroring public-inbox repositories. It  will  pipe  all
16       newly  received  messages  to  arbitrary commands defined in the config
17       file. The simplest configuration for lore.kernel.org is:
18
19          ~/.config/pi-piper.conf
20          -----------------------
21          [DEFAULT]
22          pipe = /usr/bin/procmail
23          # Prune successfully processed messages
24          shallow = yes
25
26          ~/.procmailrc
27          -------------
28          DEFAULT=$HOME/Maildir/
29
30          # Don't deliver cross-posted duplicates
31          :0 Wh: .msgid.lock
32          | formail -D 8192 .msgid.cache
33
34          ~/.config/lore.conf
35          -------------------
36          [core]
37          toplevel = ~/.local/share/grokmirror/lore
38          log = ${toplevel}/grokmirror.log
39
40          [remote]
41          site = https://lore.kernel.org
42          manifest = https://lore.kernel.org/manifest.js.gz
43
44          [pull]
45          post_update_hook = ~/.local/bin/grok-pi-piper -c ~/.config/pi-piper.conf
46          include = /list-you-want/*
47                    /another-list/*
48
49       It assumes that grokmirror was installed from pip. If you installed  it
50       via  some  other  means,  please  check  the path for the grok-pi-piper
51       script.
52
53       Note, that initial clone may take a long time, even if  you  set  shal‐
54       low=yes.
55
56       See pi-piper.conf for other config options.
57

OPTIONS

59          -h, --help
60                 show this help message and exit
61
62          -v, --verbose
63                 Be verbose and tell us what you are doing (default: False)
64
65          -d, --dry-run
66                 Do  a  dry-run  and  just  show  what would be done (default:
67                 False)
68
69          -c CONFIG, --config CONFIG
70                 Location of the configuration file (default: None)
71
72          -l PIPELAST, --pipe-last PIPELAST
73                 Force pipe last NN messages in the list, regardless of track‐
74                 ing (default: None)
75
76          --version
77                 show program's version number and exit
78

SEE ALSO

80       • grok-pull(1)
81
82       • git(1)
83

SUPPORT

85       Email tools@linux.kernel.org.
86

AUTHOR

88       mricon@kernel.org
89
90       License: GPLv3+
91

93       The Linux Foundation and contributors
94
95
96
97
982.0.2                             2020-10-07                  GROK-PI-PIPER(1)
Impressum