.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) .\" .\" 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-CONFIG 5" .TH PUBLIC-INBOX-CONFIG 5 "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\-config \- public\-inbox config file description .SH "SYNOPSIS" .IX Header "SYNOPSIS" ~/.public\-inbox/config .SH "DESCRIPTION" .IX Header "DESCRIPTION" The public-inbox config file is parseable by \fBgit\-config\fR\|(1). This is a global configuration file for mapping/discovering all public-inboxes used by a particular user. .SH "CONFIGURATION FILE" .IX Header "CONFIGURATION FILE" .SS "\s-1EXAMPLE\s0" .IX Subsection "EXAMPLE" .Vb 7 \& [publicinbox "test"] \& inboxdir = /home/user/path/to/test.git \& ; multiple addresses are supported \& address = test@example.com \& ; address = alternate@example.com \& url = http://example.com/test \& newsgroup = inbox.test \& \& ; backwards compatibility with public\-inbox pre\-1.2.0, \& ; "inboxdir" takes precedence over "mainrepo" \& mainrepo = /home/user/path/to/test.git .Ve .SS "\s-1VARIABLES\s0" .IX Subsection "VARIABLES" .IP "publicinbox..address" 8 .IX Item "publicinbox..address" The email address of the public-inbox. May be specified more than once for merging multiple mailing lists (or migrating to new addresses). This must be specified at least once, the first value will be considered the primary address for informational purposes. .Sp Default: none, required .IP "publicinbox..inboxdir" 8 .IX Item "publicinbox..inboxdir" The absolute path to the directory which hosts the public-inbox. This must be specified once. .Sp This was previously known as \*(L"mainrepo\*(R", which remains supported, but \*(L"inboxdir\*(R" takes precedence. .Sp Default: none, required .IP "publicinbox..url" 8 .IX Item "publicinbox..url" The primary \s-1URL\s0 for hosting the \s-1HTTP/HTTPS\s0 archives. Additional \s-1HTTP/HTTPS\s0 URLs may be specified via \&\f(CW\*(C`$GIT_DIR/cloneurl\*(C'\fR as documented in \fBgitweb\fR\|(1) .Sp Default: none, optional .IP "publicinbox..newsgroup" 8 .IX Item "publicinbox..newsgroup" The \s-1NNTP\s0 group name for use with \fBpublic\-inbox\-nntpd\fR\|(1). 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 It also configures the folder hierarchy used by \fBpublic\-inbox\-imapd\fR\|(1) as well as \fBpublic\-inbox\-pop3d\fR\|(1) .Sp Omitting this for a given inbox will prevent the inbox from being served by \fBpublic\-inbox\-nntpd\fR\|(1), \&\fBpublic\-inbox\-imapd\fR\|(1), and/or \fBpublic\-inbox\-pop3d\fR\|(1) .Sp Default: none, optional .IP "publicinbox..watch" 8 .IX Item "publicinbox..watch" See \fBpublic\-inbox\-watch\fR\|(1) .IP "publicinbox..watchheader" 8 .IX Item "publicinbox..watchheader" See \fBpublic\-inbox\-watch\fR\|(1) .IP "publicinbox..listid" 8 .IX Item "publicinbox..listid" The rfc2919 header without angle brackets for \fBpublic\-inbox\-mda\fR\|(1) deliveries and \&\fBpublic\-inbox\-watch\fR\|(1). .Sp For public-inbox-watch users, this is a shortcut for specifying \&\f(CW\*(C`publicinbox.$NAME.watchheader=List\-Id:\*(C'\fR .Sp For public-inbox-mda users, this may be used to avoid recipient matching via \f(CW\*(C`ORIGINAL_RECIPIENT\*(C'\fR environment variable. .Sp This may be specified multiple times for merging multiple mailing lists into a single public-inbox, only one \f(CW\*(C`List\-Id\*(C'\fR header needs to match. .Sp Default: none .IP "publicinbox..imapmirror" 8 .IX Item "publicinbox..imapmirror" This may be the full \s-1IMAP URL\s0 of an independently-run \s-1IMAP\s0 mirror. .Sp Default: none .IP "publicinbox..nntpmirror" 8 .IX Item "publicinbox..nntpmirror" This may be the full \s-1NNTP URL\s0 of an independently-run mirror. For example, the https://public\-inbox.org/meta/ inbox is mirrored by Gmane at \&\f(CW\*(C`nntp://news.gmane.io/gmane.mail.public\-inbox.general\*(C'\fR .Sp Default: none .IP "publicinbox..indexlevel" 8 .IX Item "publicinbox..indexlevel" The indexing level for \fBpublic\-inbox\-index\fR\|(1) .Sp \&\f(CW\*(C`basic\*(C'\fR only requires \fBDBD::SQLite\fR\|(3pm) and provides all \&\s-1NNTP\s0 functionality along with thread-awareness in the \s-1WWW\s0 interface. .Sp \&\f(CW\*(C`medium\*(C'\fR requires \fBSearch::Xapian\fR\|(3pm) to provide full-text term search functionality in the \s-1WWW UI.\s0 .Sp \&\f(CW\*(C`full\*(C'\fR also includes positional information used by Xapian to allow for searching for phrases using quoted text. (e.g. \f(CW"looking for a complete sentence"\fR) .Sp Default: \f(CW\*(C`full\*(C'\fR .IP "publicinbox..boost" 8 .IX Item "publicinbox..boost" Control indexing order for \fBpublic\-inbox\-extindex\fR\|(1), with ties broken by config file order. This only affects indexing and does not affect messages which are already indexed. .Sp Default: \f(CW0\fR .IP "publicinbox..indexSequentialShard" 8 .IX Item "publicinbox..indexSequentialShard" See \*(L"publicInbox.indexSequentialShard\*(R" in \fBpublic\-inbox\-index\fR\|(1) .IP "publicinbox..httpbackendmax" 8 .IX Item "publicinbox..httpbackendmax" If a digit, the maximum number of parallel \&\fBgit\-http\-backend\fR\|(1) processes to allow for cloning this particular inbox. .Sp If an alphanumeric value starting with a lowercase alphabetic character is specified, the inbox will use a \*(L"\s-1NAMED LIMITER\*(R"\s0 which can be shared by multiple inboxes. .Sp Default: 32 (using a default limiter shared by all inboxes) .IP "publicinbox..coderepo" 8 .IX Item "publicinbox..coderepo" The nickname of a \*(L"coderepo\*(R" section associated with the inbox. May be specified more than once for M:N mapping of code repos to inboxes. If enabled, diff hunk headers in patch emails will link to the line numbers of blobs. .Sp Default: none .IP "publicinbox..replyto" 8 .IX Item "publicinbox..replyto" May be used to control how reply instructions in the \s-1PSGI\s0 interface are displayed. .Sp \&\*(L":none=dead inbox\*(R" may be specified to denote an inactive list (\*(L"dead inbox\*(R" may be replaced with another phrase). .Sp A list of comma-delimited email addresses may be specified. This can be useful for dedicated inboxes for bot emails, but discussion happens on a separate mailing list/inbox. .Sp Mirrors of existing centralized mailing lists may use \*(L":list\*(R" here to redirect mail only to the configured inbox address. The use of \*(L":list\*(R" is discouraged for new mailing lists, as it leads to centralization. .Sp Default: :all .IP "publicinbox.css" 8 .IX Item "publicinbox.css" The local path name of a \s-1CSS\s0 file for the \s-1PSGI\s0 web interface. May contain the attributes \*(L"media\*(R", \*(L"title\*(R" and \*(L"href\*(R" which match the associated attributes of the \s-1HTML\s0