RCHIVE(1)

💖 rchive — bestie's guide to your very own local Entrez archive 💖

okay so this is from the NCBI Entrez Direct User's Manual, and it's giving main character energy for anyone who's ever wanted a little archive of Entrez document summaries living rent-free on their own machine. no cap. 🌸

---

✨ NAME ✨

rchive — work with a local archive of Entrez document summaries 🗂️💅

---

🎀 SYNOPSIS 🎀

rchive [-help] [-strict] [-mixed] [-input filename]
[-archive archive indices increment] [-delete archive indices increment]
[-index element] [-fetch directory] [-stream directory] [-flag strict|
mixed|none] [-gzip] [-hash] [-trie [type]] [-padz] [-e2index [extras]]
[-e2invert archive] [-join] [-fuse] [-merge directory field]
[-promote directory field] [-path directory] [-query query] [-exact
query] [-title query] [-count query] [-counts query] [-version]

---

🌈 DESCRIPTION 🌈

So basically, rchive creates, updates, or extracts records from a local archive of Entrez document summaries. Like, it's the whole archive situation — building it, refreshing it, pulling stuff back out of it. Obsessed. ✨

---

👑 OPTIONS 👑

🧚 Processing Flags 🧚

• -strict — strips out the HTML and MathML tags. bye babes 💀
• -mixed — allows mixed content XML. she's flexible like that.

🍓 Data Source 🍓

• -input filename — read the XML from a file instead of from standard input. iconic behavior honestly.

💜 Local Record Cache 💜

• -archive archive indices increment — the base path where the individual XML files get saved, plus the paths for the first-level and second-level inverted index caches. three paths, one flag, slay. 🔥
• -delete archive indices increment — literally the same paths as -archive, except this one is for deleting the inverted caches. use with intention bestie 🫶
• -index element — use [parent/element@attribute^version] as the identifier. yes, with the brackets, yes, exactly like that.
• -fetch directory — base path for retrieving XML files.
• -stream directory — path for retrieving compressed XML files, and they get left compressed, so don't come for me about it.
• -flag strict|mixed|none — an alternative syntax for specifying the corresponding options. same vibe, different outfit. 💅
• -gzip — use compression for the local XML files.
• -hash — prints UIDs and checksum values to standard output.
• -trie [type] — prints the file path for archive (that's the default), or indices, increment, or posting[s].
• -padz — pads the PMIDs with leading zeros until they're eight characters long. tiny but mighty. 🎀

🌟 Local Record Index 🌟

• -e2index [extras] — creates Entrez index XML. extras is true or false, and it tells you whether to index the extra fields — false is the default.
• -e2invert archive — this is the combined -e2index and -invert in archive. two for one, ate.
• -join — collects subsets of inverted index files. gathering the girlies. 🫶
• -fuse — combines subsets of inverted index files. now they're one. 💖
• -merge directory field — combines inverted indices, dividing by term prefix.
• -promote directory field — creates the term lists and the posting files.
• -path directory — path to the postings directory.
• -query query — searches on words or phrases inside Boolean formulas.
• -exact query — a strict search, for article round-tripping.
• -title query — exact search, but limited to the indexed title field.
• -count query — prints terms and counts, merging the wildcards.
• -counts query — expands the wildcards and prints individual term counts instead.

📖 Documentation 📖

• -help — prints usage info plus some example argument combinations. if you're lost, start here bestie 🦋
• -version — prints the version number. ⭐

---

🔗 SEE ALSO 🔗

archive-nihocc(1), archive-nlmnlp(1), archive-nmcds(1), archive-pids(1), archive-pmc(1), archive-pubmed(1), archive-taxonomy(1), custom-index(1), download-flatfile(1), download-pubmed(1), pm-clean(1), pm-collect(1), pm-prepare(1), pm-refresh(1), pm-setup(1), xfetch(1), xfilter(1), xinfo(1), xlink(1), xsearch(1), xtract(1).

go read the whole friend group, iykyk 🫶

---

and that's the whole thing, bestie — brought to you by NCBI, dated 2025-05-26. mwah 💋