custom-index(1)

custom-index1

Add a custom index to a local ncbi entrez archive

Usage

custom-index helper field ...

Overview

custom-index adds a custom index for one or more specified fields to a local NCBI Entrez Archive on the basis of a supplied helper command that produces an Entrez-style XML index. On Debian systems, some such helpers are /usr/share/doc/ncbi-entrez-direct/examples/idx-*.

Options

helper

Helper command into which to pipe each uncompressed document.

field

Name of a field being indexed (e.g., ANUM).

Environment

EDIRECT_LOCAL_ARCHIVE

Local archive directory to use; expected to hold an absolute path.

EDIRECT_LOCAL_WORKING

Directory to hold intermediate subtrees; expected to hold an absolute path. Defaults to the local archive directory when not set.

Releases

2 releases since Debian 12 (Bookworm); the text changed 1 time.

  1. 12
  2. 13

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