]> Sergey Matveev's repositories - public-inbox.git/commitdiff
doc: add manpage for public-inbox-init(1)
authorEric Wong <e@80x24.org>
Thu, 3 Oct 2019 07:21:58 +0000 (07:21 +0000)
committerEric Wong <e@80x24.org>
Sat, 5 Oct 2019 06:53:59 +0000 (06:53 +0000)
This old command was lacking a manpage, so (finally) create one.

Documentation/include.mk
Documentation/public-inbox-init.pod [new file with mode: 0644]
MANIFEST

index 9a132962d9f400a274965983a166808106916cdc..55c10b510b8f47679b9eeca66a62edb75148c1f8 100644 (file)
@@ -36,6 +36,7 @@ m1 += public-inbox-convert
 m1 += public-inbox-edit
 m1 += public-inbox-httpd
 m1 += public-inbox-index
 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
 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 (file)
index 0000000..377fb2a
--- /dev/null
@@ -0,0 +1,86 @@
+=head1 NAME
+
+public-inbox-init - create or reinitialize a public-inbox
+
+=head1 SYNOPSIS
+
+B<public-inbox-init> [OPTIONS] NAME INBOX_DIR HTTP_URL ADDRESS [ADDRESS..]
+
+=head1 DESCRIPTION
+
+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
+
+=over
+
+=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
+L<DBD::SQLite>.
+
+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
+
+=back
+
+=head1 ENVIRONMENT
+
+=over 8
+
+=item PI_CONFIG
+
+Used to override the default C<~/.public-inbox/config> value.
+
+=back
+
+=head1 LIMITATIONS
+
+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/>
+
+=head1 COPYRIGHT
+
+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)>,
+L<public-inbox-v2-format(5)>
index ecf239f43b234a1746319e6d1aa07db38226f3b6..b3046cf6158f88d491483525dedb7ed04ac57b6e 100644 (file)
--- a/MANIFEST
+++ b/MANIFEST
@@ -20,6 +20,7 @@ Documentation/public-inbox-daemon.pod
 Documentation/public-inbox-edit.pod
 Documentation/public-inbox-httpd.pod
 Documentation/public-inbox-index.pod
 Documentation/public-inbox-edit.pod
 Documentation/public-inbox-httpd.pod
 Documentation/public-inbox-index.pod
+Documentation/public-inbox-init.pod
 Documentation/public-inbox-mda.pod
 Documentation/public-inbox-nntpd.pod
 Documentation/public-inbox-overview.pod
 Documentation/public-inbox-mda.pod
 Documentation/public-inbox-nntpd.pod
 Documentation/public-inbox-overview.pod