about summary refs log tree commit homepage
path: root/Documentation
diff options
authorEric Wong <e@80x24.org>2019-10-03 07:21:58 +0000
committerEric Wong <e@80x24.org>2019-10-05 06:53:59 +0000
commit0e323a88eee90196392ef9a86bcd38159023550f (patch)
treeacc02b71e6ae1fef5afa44d97c473e428c2ad3e7 /Documentation
parent0069d1b85c45fd757e401cd018099c69b3ba9f24 (diff)
This old command was lacking a manpage, so (finally) create one.
Diffstat (limited to 'Documentation')
2 files changed, 87 insertions, 0 deletions
diff --git a/Documentation/include.mk b/Documentation/include.mk
index 9a132962..55c10b51 100644
--- a/Documentation/include.mk
+++ b/Documentation/include.mk
@@ -36,6 +36,7 @@ m1 += public-inbox-convert
 m1 += public-inbox-edit
 m1 += public-inbox-httpd
 m1 += public-inbox-index
+m1 += public-inbox-init
 m1 += public-inbox-mda
 m1 += public-inbox-nntpd
 m1 += public-inbox-watch
diff --git a/Documentation/public-inbox-init.pod b/Documentation/public-inbox-init.pod
new file mode 100644
index 00000000..377fb2a2
--- /dev/null
+++ b/Documentation/public-inbox-init.pod
@@ -0,0 +1,86 @@
+=head1 NAME
+public-inbox-init - create or reinitialize a public-inbox
+=head1 SYNOPSIS
+Creates an empty public-inbox or reinitializes an existing one.
+It updates C<~/.public-inbox/config> by creating a
+C<[publicinbox "NAME"]> section where
+C<publicinbox.NAME.mainrepo> is C<INBOX_DIR>,
+C<publicinbox.NAME.url> is C<HTTP_URL>, and
+C<publicinbox.NAME.address> is C<ADDRESS>.  Multiple addresses
+may be specified for inboxes with multiple addresses.
+=head1 OPTIONS
+=item -V, --version FORMAT_VERSION
+Specify C<2> here to use the scalable L<public-inbox-v2-format(5)>
+if you have L<DBD::SQLite> installed.
+The default is C<1> for the old L<public-inbox-v1-format(5)>,
+but C<2> is strongly recommended for scalability if you have
+Default: C<1>
+=item --indexlevel <basic|medium|full>
+Controls the indexing level for L<public-inbox-index(1)>
+See L<public-inbox-config(5)> for more information.
+Default: C<full>
+=item -S, --skip-epoch
+For C<-V2> (L<public-inbox-v2-format(5)>) inboxes only, this option
+allows archivists to publish incomplete archives with newer
+mail while allowing "0.git" (or "1.git" and so on) epochs to be
+added-after-the-fact (without affecting "git clone" followers).
+Default: unset, no epochs are skipped
+=over 8
+=item PI_CONFIG
+Used to override the default C<~/.public-inbox/config> value.
+This tool predates NNTP support in public-inbox and is missing
+C<newsgroup> and many of the options documented in
+L<public-inbox-config(5)>.  See L<public-inbox-config(5)> for all the
+options which may be applied to a given inbox.
+=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://hjrcffqmbrq6wope.onion/meta/>
+Copyright 2019 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<git-init(1)>, L<git-config(1)>, L<public-inbox-v1-format(5)>,