user/dev discussion of public-inbox itself
 help / color / mirror / code / Atom feed
From: Eric Wong <>
Subject: [PATCH 2/3] doc: add manpage for public-inbox-init(1)
Date: Thu,  3 Oct 2019 07:21:58 +0000	[thread overview]
Message-ID: <> (raw)
In-Reply-To: <>

This old command was lacking a manpage, so (finally) create one.
 Documentation/            |  1 +
 Documentation/public-inbox-init.pod | 86 +++++++++++++++++++++++++++++
 MANIFEST                            |  1 +
 3 files changed, 88 insertions(+)
 create mode 100644 Documentation/public-inbox-init.pod

diff --git a/Documentation/ b/Documentation/
index 9a132962..55c10b51 100644
--- a/Documentation/
+++ b/Documentation/
@@ -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<>
+The mail archives are hosted at L<>
+and L<http://hjrcffqmbrq6wope.onion/meta/>
+Copyright 2019 all contributors L<>
+License: AGPL-3.0+ L<>
+=head1 SEE ALSO
+L<git-init(1)>, L<git-config(1)>, L<public-inbox-v1-format(5)>,
diff --git a/MANIFEST b/MANIFEST
index ecf239f4..b3046cf6 100644
@@ -20,6 +20,7 @@ Documentation/public-inbox-daemon.pod

  parent reply	other threads:[~2019-10-03  7:22 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-10-03  7:21 [PATCH 0/3] init: add manpage and locking Eric Wong
2019-10-03  7:21 ` [PATCH 1/3] init: favor --skip-epoch instead of --skip Eric Wong
2019-10-03  7:21 ` Eric Wong [this message]
2019-10-03  7:21 ` [PATCH 3/3] init: implement locking Eric Wong

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:

  List information:

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \ \ \ \

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).