lei-add-external - Man Page

add inbox or external index

Synopsis

lei add-external [Options] LOCATION

Description

Configure lei to search against an external (an inbox or external index).  When LOCATION is an existing local path, it should point to a directory that is a publicinbox.$NAME.inboxdir or extindex.$NAME.topdir value in ~/.public-inbox/config.

Options

--boost=NUMBER

Set priority of a new or existing location.

Default: 0

--mirror=URL

Create LOCATION by mirroring the public-inbox at URL. LOCATION will have a Makefile with a make update target to update the external.

--epoch=RANGE

Restrict clones of public-inbox-v2-format(5) inboxes to the given range of epochs.  The range may be a single non-negative integer or a (possibly open-ended) LOW..HIGH range of non-negative integers.  ~ may be prefixed to either (or both) integer values to represent the offset from the maximum possible value.

For example, --epoch=~0 alone clones only the latest epoch, --epoch=~2.. clones the three latest epochs.

Default: 0..~0 or 0.. or ..~0 (all epochs, all three examples are equivalent)

-v
--verbose

Provide more feedback on stderr.

-q
--quiet

Suppress feedback messages.

Mirroring

--torsocks=auto|no|yes
--no-torsocks

Whether to wrap git(1) and curl(1) commands with torsocks(1).

Default: auto

--inbox-version=NUM

Force a public-inbox version (must be 1 or 2).

The following options are passed to public-inbox-init(1):

-j JOBS, --jobs=JOBS

-L LEVEL, --indexlevel=LEVEL

The following options are passed to public-inbox-index(1):

--batch-size=SIZE

--compact

-j JOBS, --jobs=JOBS

--max-size=SIZE

--sequential-shard

--skip-docdata

Files

The configuration for lei resides at $XDG_CONFIG_HOME/lei/config.

Contact

Feedback welcome via plain-text mail to <mailto:meta@public-inbox.org>

The mail archives are hosted at <https://public-inbox.org/meta/> and <http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>

See Also

lei-forget-external(1), lei-ls-external(1), lei-import(1), public-inbox-index(1), public-inbox-extindex(1), public-inbox-extindex-format(5)

Referenced By

lei(1), lei-blob(1), lei-config(1), lei-forget-external(1), lei-init(1), lei-ls-external(1), lei-ls-label(1), lei-overview(7), lei-q(1), lei-security(7), lei-tag(1).

1993-10-02 public-inbox.git public-inbox user manual