LEI-ADD-EXTERNAL(1)

📦
version 2.1.0 · 5 versions
, in arch rolling, nixos 26.05, nixpkgs unstable

💅 lei-add-external(1) — the public-inbox user manual, but make it make sense

okay bestie, so this is lei-add-external(1) from the public-inbox user manual, and honestly? it's giving "let me introduce you to my little friend: the external index." 🦋

🌸 NAME 🌸

lei-add-external — add an inbox or an external index, periodt

✨ SYNOPSIS ✨

lei add-external [OPTIONS] LOCATION

💖 DESCRIPTION 💖

so what this does is it tells lei to search against an external — which is either an inbox or an external index, no cap. 🔥

when LOCATION is an existing local path, that path lowkey needs to point to a directory that's a publicinbox.$NAME.inboxdir or extindex.$NAME.topdir value in ~/.public-inbox/config. that's it, that's the vibe check. 💅

🎀 OPTIONS 🎀

  • --boost=NUMBER — sets the priority of a new or existing location. slay. Default: 0
  • --mirror=URL — makes LOCATION by mirroring the public-inbox over at URL. the resulting LOCATION gets a Makefile with a make update target so you can update the external later. iconic. ✨
  • --epoch=RANGE — restricts clones of public-inbox-v2-format(5) inboxes to the given range of epochs. the range can be a single non-negative integer, or a (possibly open-ended) LOW..HIGH range of non-negative integers. you can prefix ~ to either integer value (or both!) to mean the offset from the maximum possible value.

for example, --epoch=~0 on its own clones only the latest epoch, and --epoch=~2.. clones the three latest epochs. obsessed. 🫶

Default: 0..~0 or 0.. or ..~0 (all epochs — and yes, all three examples are equivalent, don't let anyone tell you otherwise)

  • -v, --verbose — gives you more feedback on stderr. she's chatty 💬
  • -q, --quiet — suppresses feedback messages. she's mysterious 🤫

🌈 MIRRORING 🌈

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

whether to wrap git(1) and curl(1) commands with torsocks(1). big privacy main character energy. 🧚

Default: auto

  • --inbox-version=NUM — forces a remote public-inbox version (has to be 1 or 2). this gets auto-detected by default, and honestly this option is mainly there for testing. ngl, it's a debug girlie. 💀

the following options get passed straight to public-inbox-init(1):

  • -j JOBS, --jobs=JOBS
  • -L LEVEL, --indexlevel=LEVEL

and the following options get 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 lives at $XDG_CONFIG_HOME/lei/config. it's her home. 🏠

💌 CONTACT 💌

feedback is welcome via plain-text mail to <mailto:meta@public-inbox.org> — say hi, she doesn't bite 🫶

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

Copyright 2021 all contributors <mailto:meta@public-inbox.org>

License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>

🌟 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)

and that's the page, bestie 🎀 this cutie came from public-inbox.git, dated 1993-10-02 — yeah, she's been around. 💜

📦 where this page comes from