user/dev discussion of public-inbox itself
 help / color / mirror / code / Atom feed
Search results ordered by [date|relevance]  view[summary|nested|Atom feed]
thread overview below | download mbox.gz: |
* [PATCH 2/3] doc: add manpage for public-inbox-init(1)
  2019-10-03  7:21  7% [PATCH 0/3] init: add manpage and locking Eric Wong
@ 2019-10-03  7:21  6% ` Eric Wong
  0 siblings, 0 replies; 2+ results
From: Eric Wong @ 2019-10-03  7:21 UTC (permalink / raw)
  To: meta

This old command was lacking a manpage, so (finally) create one.
---
 Documentation/include.mk            |  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/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
+
+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)>
diff --git a/MANIFEST b/MANIFEST
index ecf239f4..b3046cf6 100644
--- 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-init.pod
 Documentation/public-inbox-mda.pod
 Documentation/public-inbox-nntpd.pod
 Documentation/public-inbox-overview.pod
-- 
EW


^ permalink raw reply related	[relevance 6%]

* [PATCH 0/3] init: add manpage and locking
@ 2019-10-03  7:21  7% Eric Wong
  2019-10-03  7:21  6% ` [PATCH 2/3] doc: add manpage for public-inbox-init(1) Eric Wong
  0 siblings, 1 reply; 2+ results
From: Eric Wong @ 2019-10-03  7:21 UTC (permalink / raw)
  To: meta

And this reminds me, --skip-articles needs to be added for
--skip-epoch to make sense, too..

Eric Wong (3):
  init: favor --skip-epoch instead of --skip
  doc: add manpage for public-inbox-init(1)
  init: implement locking

 Documentation/include.mk            |  1 +
 Documentation/public-inbox-init.pod | 86 +++++++++++++++++++++++++++++
 MANIFEST                            |  1 +
 script/public-inbox-init            | 39 ++++++++++---
 t/init.t                            | 18 +++++-
 5 files changed, 135 insertions(+), 10 deletions(-)
 create mode 100644 Documentation/public-inbox-init.pod

-- 
EW


^ permalink raw reply	[relevance 7%]

Results 1-2 of 2 | reverse | options above
-- pct% links below jump to the message on this page, permalinks otherwise --
2019-10-03  7:21  7% [PATCH 0/3] init: add manpage and locking Eric Wong
2019-10-03  7:21  6% ` [PATCH 2/3] doc: add manpage for public-inbox-init(1) Eric Wong

Code repositories for project(s) associated with this public inbox

	https://80x24.org/public-inbox.git

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).