.\" 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-EXTINDEX 1" .TH PUBLIC-INBOX-EXTINDEX 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\-extindex \- create and update external search indices .SH "SYNOPSIS" .IX Header "SYNOPSIS" public-inbox-extindex [\s-1OPTIONS\s0] \s-1EXTINDEX_DIR INBOX_DIR...\s0 .PP public-inbox-extindex [\s-1OPTIONS\s0] [\s-1EXTINDEX_DIR\s0] \-\-all .SH "DESCRIPTION" .IX Header "DESCRIPTION" public-inbox-extindex creates and updates an external search and overview database used by the read-only public-inbox \s-1PSGI\s0 (\s-1HTTP\s0), \&\s-1NNTP,\s0 and \s-1IMAP\s0 interfaces. This requires either the Search::Xapian \s-1XS\s0 bindings \s-1OR\s0 the Xapian \s-1SWIG\s0 bindings, along with DBD::SQLite and \s-1DBI\s0 Perl modules. .SH "OPTIONS" .IX Header "OPTIONS" .IP "\-j \s-1JOBS\s0" 4 .IX Item "-j JOBS" .PD 0 .IP "\-\-jobs=JOBS" 4 .IX Item "--jobs=JOBS" .IP "\-\-no\-fsync" 4 .IX Item "--no-fsync" .IP "\-\-dangerous" 4 .IX Item "--dangerous" .IP "\-\-rethread" 4 .IX Item "--rethread" .IP "\-\-max\-size \s-1SIZE\s0" 4 .IX Item "--max-size SIZE" .IP "\-\-batch\-size \s-1SIZE\s0" 4 .IX Item "--batch-size SIZE" .PD These switches behave as they do for \fBpublic\-inbox\-index\fR\|(1) .IP "\-\-all" 4 .IX Item "--all" Index all \f(CW\*(C`publicinbox\*(C'\fR entries in \f(CW\*(C`PI_CONFIG\*(C'\fR. .Sp \&\f(CW\*(C`publicinbox\*(C'\fR entries indexed by \f(CW\*(C`public\-inbox\-extindex\*(C'\fR can have full Xapian searching abilities with the per\-\f(CW\*(C`publicinbox\*(C'\fR \&\f(CW\*(C`indexlevel\*(C'\fR set to \f(CW\*(C`basic\*(C'\fR and their respective Xapian (\f(CW\*(C`xap15\*(C'\fR or \f(CW\*(C`xapian15\*(C'\fR) directories removed. For multiple public-inboxes where cross-posting is common, this allows significant space savings on Xapian indices. .IP "\-\-gc" 4 .IX Item "--gc" Perform garbage collection instead of indexing. Use this if inboxes are removed from the extindex, or if messages are purged or removed from some inboxes. .IP "\-\-reindex" 4 .IX Item "--reindex" Forces a re-index of all messages in the extindex. This can be used for in-place upgrades and bugfixes while read-only server processes are utilizing the index. Keep in mind this roughly doubles the size of the already-large Xapian database. .Sp The extindex locks will be released roughly every 10s to allow \fBpublic\-inbox\-mda\fR\|(1) and \fBpublic\-inbox\-watch\fR\|(1) processes to write to the extindex. .IP "\-\-fast" 4 .IX Item "--fast" Used with \f(CW\*(C`\-\-reindex\*(C'\fR, it will only look for new and stale entries and not touch already-indexed messages. .SH "FILES" .IX Header "FILES" \&\fBpublic\-inbox\-extindex\-format\fR\|(5) .SH "CONFIGURATION" .IX Header "CONFIGURATION" public-inbox-extindex does not currently write to the \&\fBpublic\-inbox\-config\fR\|(5) file, configuration may be entered manually. The extindex name of \f(CW\*(C`all\*(C'\fR is a special case which corresponds to indexing \f(CW\*(C`\-\-all\*(C'\fR inboxes. An example for \&\f(CW\*(C`\-\-all\*(C'\fR is as follows: .PP .Vb 5 \& [extindex "all"] \& topdir = /path/to/extindex_dir \& url = all \& coderepo = foo \& coderepo = bar .Ve .PP See \fBpublic\-inbox\-config\fR\|(5) for more details. .SH "ENVIRONMENT" .IX Header "ENVIRONMENT" .IP "\s-1PI_CONFIG\s0" 8 .IX Item "PI_CONFIG" Used to override the default \*(L"~/.public\-inbox/config\*(R" value. .IP "\s-1XAPIAN_FLUSH_THRESHOLD\s0" 8 .IX Item "XAPIAN_FLUSH_THRESHOLD" The number of documents to update before committing changes to disk. This environment is handled directly by Xapian, refer to Xapian \s-1API\s0 documentation for more details. .Sp Setting \f(CW\*(C`XAPIAN_FLUSH_THRESHOLD\*(C'\fR or \&\f(CW\*(C`publicinbox.indexBatchSize\*(C'\fR for a large \f(CW\*(C`\-\-reindex\*(C'\fR may cause \&\fBpublic\-inbox\-mda\fR\|(1), \fBpublic\-inbox\-learn\fR\|(1) and \&\fBpublic\-inbox\-watch\fR\|(1) tasks to wait long and unpredictable periods of time during \f(CW\*(C`\-\-reindex\*(C'\fR. .Sp Default: none, uses \f(CW\*(C`publicinbox.indexBatchSize\*(C'\fR .SH "UPGRADING" .IX Header "UPGRADING" Occasionally, public-inbox will update it's schema version and require a full index by running this command. .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 all contributors .PP License: \s-1AGPL\-3.0+\s0 .SH "SEE ALSO" .IX Header "SEE ALSO" Search::Xapian, DBD::SQLite