git.notmuchmail.org Git - notmuch/blob - man/man1/notmuch-compact.1

   1 .TH NOTMUCH-COMPACT 1 2013-08-23 "Notmuch 0.16"
   2 .SH NAME
   3 notmuch-compact \- compact the notmuch database
   4 .SH SYNOPSIS
   5
   6 .B notmuch compact
   7
   8 .SH DESCRIPTION
   9
  10 The
  11 .B compact
  12 command can be used to compact the notmuch database. This can both reduce
  13 the space required by the database and improve lookup performance.
  14
  15 The compacted database is built in a temporary directory and is later
  16 moved into the place of the origin database. The original uncompacted
  17 database is preserved to be deleted by the user as desired.
  18
  19 Note that the database write lock will be held during the compaction
  20 process (which may be quite long) to protect data integrity.
  21
  22 .RE
  23 .SH ENVIRONMENT
  24 The following environment variables can be used to control the
  25 behavior of notmuch.
  26 .TP
  27 .B NOTMUCH_CONFIG
  28 Specifies the location of the notmuch configuration file. Notmuch will
  29 use ${HOME}/.notmuch\-config if this variable is not set.
  30 .SH SEE ALSO
  31
  32 \fBnotmuch\fR(1), \fBnotmuch-count\fR(1), \fBnotmuch-dump\fR(1),
  33 \fBnotmuch-hooks\fR(5), \fBnotmuch-insert\fR(1), \fBnotmuch-new\fR(1),
  34 \fBnotmuch-reply\fR(1), \fBnotmuch-restore\fR(1), \fBnotmuch-search\fR(1),
  35 \fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1),
  36 \fBnotmuch-tag\fR(1)