rchive(1)

rchive1

Work with a local archive of entrez document summaries

Usage

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]

Overview

rchive creates, updates, or extracts records from a local archive of Entrez document summaries.

Options

Processing Flags

-strict

Remove HTML and MathML tags.

-mixed

Allow mixed content XML.

Data Source

-input filename

Read XML from file instead of standard input.

Local Record Cache

-archive archive indices increment

Base path for saving individual XML files, plus paths for first- and second-level inverted index caches.

-delete archive indices increment

Same paths as -archive, for deleting inverted caches.

-index element

Use [parent/element@attribute^version] for identifier.

-fetch directory

Base path for retrieving XML files.

-stream directory

Path for retrieving compressed XML files (left compressed).

-flag strict|mixed|none

Alternative syntax for specifying the corresponding options.

-gzip

Use compression for local XML files.

-hash

Print UIDs and checksum values to standard output.

-trie [type]

Print archive (default), indices, increment, or posting[s] file path.

-padz

Pad PMIDs with leading zeros to eight characters.

Local Record Index

-e2index [extras]

Create Entrez index XML. extras (true or false; false by default) indicates whether to index extra fields.

-e2invert archive

Combined -e2index and -invert in archive.

-join

Collect subsets of inverted index files.

-fuse

Combine subsets of inverted index files.

-merge directory field

Combine inverted indices, dividing by term prefix.

-promote directory field

Create term lists and posting files.

-path directory

Path to postings directory.

-query query

Search on words or phrases in Boolean formulas.

-exact query

Strict search for article round-tripping.

-title query

Exact search limited to indexed title field.

-count query

Print terms and counts, merging wildcards.

-counts query

Expand wildcards; print individual term counts.

Documentation

-help

Print usage information and some example argument combinations.

-version

Print version number.

Releases

4 releases since Debian 10 (Buster); the text changed 3 times.

  1. 10
  2. 11
  3. 12
  4. 13

-e2index since Debian 12 (Bookworm); -e2invert since Debian 12 (Bookworm); -fuse since Debian 11 (Bullseye); -join since Debian 11 (Bullseye); -padz since Debian 12 (Bookworm); -title since Debian 12 (Bookworm).

-archive until Debian 11 (Bullseye); -invert until Debian 11 (Bullseye).

From ncbi-entrez-direct 24.0.20250523+dfsg-1+b1 in Debian 13 (Trixie). Parsed by carta from the page's man source.