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

   1 .TH NOTMUCH-COMPACT 1 2013-12-07 "Notmuch 0.17~rc3"
   2 .SH NAME
   3 notmuch-compact \- compact the notmuch database
   4 .SH SYNOPSIS
   5
   6 .B notmuch compact
   7 .RI "[ --quiet ]"
   8 .RI "[ --backup=<" directory "> ]"
   9
  10 .SH DESCRIPTION
  11
  12 The
  13 .B compact
  14 command can be used to compact the notmuch database. This can both reduce
  15 the space required by the database and improve lookup performance.
  16
  17 The compacted database is built in a temporary directory and is later
  18 moved into the place of the origin database. The original uncompacted
  19 database is discarded, unless the
  20 .BR "\-\-backup=" <directory>
  21 option is used.
  22
  23 Note that the database write lock will be held during the compaction
  24 process (which may be quite long) to protect data integrity.
  25
  26 Supported options for
  27 .B compact
  28 include
  29
  30 .RS 4
  31 .TP 4
  32 .BR "\-\-backup=" <directory>
  33
  34 Save the current database to the given directory before replacing it
  35 with the compacted database. The backup directory must not exist and
  36 it must reside on the same mounted filesystem as the current database.
  37
  38 .RE
  39
  40 .RS 4
  41 .TP 4
  42 .BR \-\-quiet
  43
  44 Do not report database compaction progress to stdout.
  45
  46 .RE
  47
  48 .RE
  49 .SH ENVIRONMENT
  50 The following environment variables can be used to control the
  51 behavior of notmuch.
  52 .TP
  53 .B NOTMUCH_CONFIG
  54 Specifies the location of the notmuch configuration file. Notmuch will
  55 use ${HOME}/.notmuch\-config if this variable is not set.
  56 .SH SEE ALSO
  57
  58 \fBnotmuch\fR(1), \fBnotmuch-count\fR(1), \fBnotmuch-dump\fR(1),
  59 \fBnotmuch-hooks\fR(5), \fBnotmuch-insert\fR(1), \fBnotmuch-new\fR(1),
  60 \fBnotmuch-reply\fR(1), \fBnotmuch-restore\fR(1), \fBnotmuch-search\fR(1),
  61 \fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1),
  62 \fBnotmuch-tag\fR(1)