.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (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 .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . 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 .\" ======================================================================== .\" .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 [OPTIONS] LOCATION .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 MIRRORING .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 JOBS, \-\-jobs=JOBS" 4 .IX Item "-j JOBS, --jobs=JOBS" .PD 0 .IP "\-L LEVEL, \-\-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 JOBS, \-\-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: AGPL\-3.0+ .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)