.\" 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 "LEI-ADD-EXTERNAL 1" .TH LEI-ADD-EXTERNAL 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" lei\-add\-external \- add inbox or external index .SH "SYNOPSIS" .IX Header "SYNOPSIS" lei add-external [\s-1OPTIONS\s0] \s-1LOCATION\s0 .SH "DESCRIPTION" .IX Header "DESCRIPTION" Configure lei to search against an external (an inbox or external index). When \f(CW\*(C`LOCATION\*(C'\fR is an existing local path, it should point to a directory that is a \f(CW\*(C`publicinbox.$NAME.inboxdir\*(C'\fR or \&\f(CW\*(C`extindex.$NAME.topdir\*(C'\fR value in ~/.public\-inbox/config. .SH "OPTIONS" .IX Header "OPTIONS" .IP "\-\-boost=NUMBER" 4 .IX Item "--boost=NUMBER" Set priority of a new or existing location. .Sp Default: 0 .IP "\-\-mirror=URL" 4 .IX Item "--mirror=URL" Create \f(CW\*(C`LOCATION\*(C'\fR by mirroring the public-inbox at \f(CW\*(C`URL\*(C'\fR. \&\f(CW\*(C`LOCATION\*(C'\fR will have a Makefile with a \f(CW\*(C`make update\*(C'\fR target to update the external. .IP "\-\-epoch=RANGE" 4 .IX Item "--epoch=RANGE" Restrict clones of \fBpublic\-inbox\-v2\-format\fR\|(5) inboxes to the given range of epochs. The range may be a single non-negative integer or a (possibly open-ended) \f(CW\*(C`LOW..HIGH\*(C'\fR range of non-negative integers. \f(CW\*(C`~\*(C'\fR may be prefixed to either (or both) integer values to represent the offset from the maximum possible value. .Sp For example, \f(CW\*(C`\-\-epoch=~0\*(C'\fR alone clones only the latest epoch, \&\f(CW\*(C`\-\-epoch=~2..\*(C'\fR clones the three latest epochs. .Sp Default: \f(CW\*(C`0..~0\*(C'\fR or \f(CW0..\fR or \f(CW\*(C`..~0\*(C'\fR (all epochs, all three examples are equivalent) .IP "\-v" 4 .IX Item "-v" .PD 0 .IP "\-\-verbose" 4 .IX Item "--verbose" .PD Provide more feedback on stderr. .IP "\-q" 4 .IX Item "-q" .PD 0 .IP "\-\-quiet" 4 .IX Item "--quiet" .PD Suppress feedback messages. .SS "\s-1MIRRORING\s0" .IX Subsection "MIRRORING" .IP "\-\-torsocks=auto|no|yes" 4 .IX Item "--torsocks=auto|no|yes" .PD 0 .IP "\-\-no\-torsocks" 4 .IX Item "--no-torsocks" .PD Whether to wrap \fBgit\fR\|(1) and \fBcurl\fR\|(1) commands with \fBtorsocks\fR\|(1). .Sp Default: \f(CW\*(C`auto\*(C'\fR .IP "\-\-inbox\-version=NUM" 4 .IX Item "--inbox-version=NUM" Force a public-inbox version (must be \f(CW1\fR or \f(CW2\fR). .PP The following options are passed to \fBpublic\-inbox\-init\fR\|(1): .IP "\-j \s-1JOBS,\s0 \-\-jobs=JOBS" 4 .IX Item "-j JOBS, --jobs=JOBS" .PD 0 .IP "\-L \s-1LEVEL,\s0 \-\-indexlevel=LEVEL" 4 .IX Item "-L LEVEL, --indexlevel=LEVEL" .PD .PP The following options are passed to \fBpublic\-inbox\-index\fR\|(1): .IP "\-\-batch\-size=SIZE" 4 .IX Item "--batch-size=SIZE" .PD 0 .IP "\-\-compact" 4 .IX Item "--compact" .IP "\-j \s-1JOBS,\s0 \-\-jobs=JOBS" 4 .IX Item "-j JOBS, --jobs=JOBS" .IP "\-\-max\-size=SIZE" 4 .IX Item "--max-size=SIZE" .IP "\-\-sequential\-shard" 4 .IX Item "--sequential-shard" .IP "\-\-skip\-docdata" 4 .IX Item "--skip-docdata" .PD .SH "FILES" .IX Header "FILES" The configuration for lei resides at \f(CW\*(C`$XDG_CONFIG_HOME/lei/config\*(C'\fR. .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 2021 all contributors .PP License: \s-1AGPL\-3.0+\s0 .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBlei\-forget\-external\fR\|(1), \fBlei\-ls\-external\fR\|(1), \fBlei\-import\fR\|(1), \&\fBpublic\-inbox\-index\fR\|(1), \fBpublic\-inbox\-extindex\fR\|(1), \&\fBpublic\-inbox\-extindex\-format\fR\|(5)