.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "PUBLIC-INBOX-INIT 1" .TH PUBLIC-INBOX-INIT 1 "1993-10-02" "public-inbox.git" "public-inbox user manual" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" public\-inbox\-init \- create or reinitialize a public\-inbox .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBpublic-inbox-init\fR [\s-1OPTIONS\s0] \s-1NAME INBOX_DIR HTTP_URL ADDRESS\s0 [\s-1ADDRESS..\s0] .SH "DESCRIPTION" .IX Header "DESCRIPTION" Creates an empty public-inbox or reinitializes an existing one. It updates \f(CW\*(C`~/.public\-inbox/config\*(C'\fR by creating a \&\f(CW\*(C`[publicinbox "NAME"]\*(C'\fR section where \&\f(CW\*(C`publicinbox.NAME.inboxdir\*(C'\fR is \f(CW\*(C`INBOX_DIR\*(C'\fR, \&\f(CW\*(C`publicinbox.NAME.url\*(C'\fR is \f(CW\*(C`HTTP_URL\*(C'\fR, and \&\f(CW\*(C`publicinbox.NAME.address\*(C'\fR is \f(CW\*(C`ADDRESS\*(C'\fR. Multiple addresses may be specified for inboxes with multiple addresses. .SH "OPTIONS" .IX Header "OPTIONS" .IP "\-V \s-1FORMAT_VERSION\s0" 4 .IX Item "-V FORMAT_VERSION" .PD 0 .IP "\-\-version \s-1FORMAT_VERSION\s0" 4 .IX Item "--version FORMAT_VERSION" .PD Specify \f(CW2\fR here to use the scalable \fBpublic\-inbox\-v2\-format\fR\|(5) if you have DBD::SQLite installed. .Sp The default is \f(CW1\fR for the old \fBpublic\-inbox\-v1\-format\fR\|(5), but \f(CW2\fR is strongly recommended for scalability if you have DBD::SQLite. .Sp Default: \f(CW1\fR .IP "\-L " 4 .IX Item "-L " .PD 0 .IP "\-\-indexlevel " 4 .IX Item "--indexlevel " .PD Controls the indexing level for \fBpublic\-inbox\-index\fR\|(1) .Sp See \fBpublic\-inbox\-config\fR\|(5) for more information. .Sp Default: \f(CW\*(C`full\*(C'\fR .IP "\-\-ng \s-1NEWSGROUP\s0" 4 .IX Item "--ng NEWSGROUP" .PD 0 .IP "\-\-newsgroup \s-1NEWSGROUP\s0" 4 .IX Item "--newsgroup NEWSGROUP" .PD The \s-1NNTP\s0 group name for use with \fBpublic\-inbox\-nntpd\fR\|(8). This may be any newsgroup name with hierarchies delimited by \f(CW\*(C`.\*(C'\fR. For example, the newsgroup for is: \f(CW\*(C`inbox.comp.mail.public\-inbox.meta\*(C'\fR .Sp This may be set after-the-fact via \f(CW\*(C`publicinbox.$NAME.newsgroup\*(C'\fR in the configuration file. See \fBpublic\-inbox\-config\fR\|(5) for more info. .Sp Available in public-inbox 1.6.0+. .Sp Default: none. .IP "\-c KEY=VALUE" 4 .IX Item "-c KEY=VALUE" Allow setting arbitrary configs as \f(CW\*(C`publicinbox.$NAME.$KEY\*(C'\fR. This is idempotent for the same \f(CW\*(C`VALUE\*(C'\fR, but allows setting multiple values for keys such as \f(CW\*(C`publicinbox.$NAME.url\*(C'\fR and \&\f(CW\*(C`publicinbox.$NAME.watch\*(C'\fR. .IP "\-\-skip\-artnum" 4 .IX Item "--skip-artnum" This option allows archivists to publish incomplete archives with only new mail while allowing \s-1NNTP\s0 article numbers to be reserved for yet-to-be-archived old mail. .Sp This is mainly intended for users of \f(CW\*(C`\-\-skip\-epoch\*(C'\fR (documented below) but may be of use to \fBpublic\-inbox\-v1\-format\fR\|(5) users. .Sp There is no automatic way to use reserved \s-1NNTP\s0 article numbers when old mail is found, yet. .Sp Available in public-inbox 1.6.0+. .Sp Default: unset, no \s-1NNTP\s0 article numbers are skipped .IP "\-S" 4 .IX Item "-S" .PD 0 .IP "\-\-skip\-epoch" 4 .IX Item "--skip-epoch" .PD For \f(CW\*(C`\-V2\*(C'\fR (\fBpublic\-inbox\-v2\-format\fR\|(5)) inboxes only, this option allows archivists to publish incomplete archives with newer mail while allowing \*(L"0.git\*(R" (or \*(L"1.git\*(R" and so on) epochs to be added-after-the-fact (without affecting \*(L"git clone\*(R" followers). .Sp Available since public-inbox 1.2.0. .Sp Default: unset, no epochs are skipped .IP "\-j \s-1JOBS\s0" 4 .IX Item "-j JOBS" .PD 0 .IP "\-\-jobs=JOBS" 4 .IX Item "--jobs=JOBS" .PD Control the number of Xapian index shards in a \&\f(CW\*(C`\-V2\*(C'\fR (\fBpublic\-inbox\-v2\-format\fR\|(5)) inbox. .Sp It can be useful to use a single shard (\f(CW\*(C`\-j1\*(C'\fR) for inboxes on high-latency storage (e.g. rotational \s-1HDD\s0) unless the system has enough \s-1RAM\s0 to cache 5\-10x the size of the git repository. .Sp Another approach for HDDs is to use the \&\*(L"publicInbox.indexSequentialShard\*(R" in \fBpublic\-inbox\-index\fR\|(1) option and many shards, so each shard may fit into the kernel page cache. Unfortunately, excessive shards slows down read-only query performance. .Sp For fast storage, it is generally not useful to specify higher values than the default due to the top-level producer process being a bottleneck. .Sp Default: the number of online CPUs, up to 4 (3 shard workers, 1 producer) .IP "\-\-skip\-docdata" 4 .IX Item "--skip-docdata" Do not store document data in Xapian, reducing Xapian storage overhead by around 1.5%. .Sp Warning: this option prevents rollbacks to public-inbox 1.5.0 and earlier. .Sp Available in public-inbox 1.6.0+. .SH "ENVIRONMENT" .IX Header "ENVIRONMENT" .IP "\s-1PI_CONFIG\s0" 8 .IX Item "PI_CONFIG" Used to override the default \f(CW\*(C`~/.public\-inbox/config\*(C'\fR value. .SH "LIMITATIONS" .IX Header "LIMITATIONS" Some of the options documented in \fBpublic\-inbox\-config\fR\|(5) require editing the config file. Old versions lack the \&\f(CW\*(C`\-\-ng\*(C'\fR/\f(CW\*(C`\-\-newsgroup\*(C'\fR parameter .PP See \fBpublic\-inbox\-config\fR\|(5) for all the options which may be applied to a given inbox. .SH "CONTACT" .IX Header "CONTACT" Feedback welcome via plain-text mail to .PP The mail archives are hosted at and .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright 2019\-2021 all contributors .PP License: \s-1AGPL\-3.0+\s0 .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBgit\-init\fR\|(1), \fBgit\-config\fR\|(1), \fBpublic\-inbox\-v1\-format\fR\|(5), \&\fBpublic\-inbox\-v2\-format\fR\|(5)