---
name: "rchive"
section: "1"
platform: "linux"
package: "ncbi-entrez-direct"
version: "24.0.20250523+dfsg-1+b1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/rchive"
---

# rchive(1)

work with a local archive of Entrez document summaries

## 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

**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.

## SEE ALSO

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