.TH INDEX-PUBMED 1 2019-02-06 NCBI "NCBI Entrez Direct User's Manual"
.SH NAME
index\-pubmed \- populate and index a local NCBI PubMed archive from scratch
.SH SYNOPSIS
.B index\-pubmed
[\|[\|\fB\-path\fP\|]\ \fIdir\fP
[\|[\|\fB\-temp\fP|\fB\-work\fP|\fB\-working\fP\|]\ \fIdir\fP\|]\|]
.SH DESCRIPTION
\fBindex\-pubmed\fP prepares a directory
to hold a local PubMed archive,
then downloads a full database dump from NCBI's servers,
organizes it into an \fBrchive\fP(1) trie,
refreshes the versioned records,
and fully indexes the resulting archive.
.SH OPTIONS
.TP
[\|\fB\-path\fP\|]\ \fIdir\fP
Place the local archive in \fIdir\fP.
.TP
[\|\fB\-temp\fP|\fB\-work\fP|\fB\-working\fP\|]\ \fIdir\fP
Place intermediate subtrees in \fIdir\fP.
.SH ENVIRONMENT
.TP
.B EDIRECT_PUBMED_MASTER
Local archive directory to use in the absence of \fB\-path\fP.
Expected to hold an absolute path;
mandatory when not supplying a path on the command line.
.TP
.B EDIRECT_PUBMED_WORKING
Directory to hold intermediate subtrees
in the absence of \fB\-temp\fP|\fB\-work\fP|\fB\-working\fP.
Expected to hold an absolute path.
Defaults to the primary local archive directory when not set.
.SH SEE ALSO
.BR archive\-pubmed (1),
.BR download\-pubmed (1),
.BR fetch\-pubmed (1),
.BR phrase\-search (1),
.BR pm\-index (1),
.BR pm\-invert (1),
.BR pm\-merge (1),
.BR pm\-prepare (1),
.BR pm\-promote (1),
.BR pm\-refresh (1),
.BR pm\-stash (1),
.BR rchive (1).