git.notmuchmail.org Git - notmuch/blob - doc/man1/notmuch-compact.rst

   1 ===============
   2 notmuch-compact
   3 ===============
   4
   5 SYNOPSIS
   6 ========
   7
   8 **notmuch** **compact** [--quiet] [--backup=<*directory*>]
   9
  10 DESCRIPTION
  11 ===========
  12
  13 The **compact** command can be used to compact the notmuch database.
  14 This can both reduce the space required by the database and improve
  15 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 ``--backup=``\ <directory> option is
  20 used.
  21
  22 Note that the database write lock will be held during the compaction
  23 process (which may be quite long) to protect data integrity.
  24
  25 Supported options for **compact** include
  26
  27 ``--backup=``\ <directory>
  28     Save the current database to the given directory before replacing
  29     it with the compacted database. The backup directory must not
  30     exist and it must reside on the same mounted filesystem as the
  31     current database.
  32
  33 ``--quiet``
  34     Do not report database compaction progress to stdout.
  35
  36 ENVIRONMENT
  37 ===========
  38
  39 The following environment variables can be used to control the behavior
  40 of notmuch.
  41
  42 **NOTMUCH\_CONFIG**
  43     Specifies the location of the notmuch configuration file. Notmuch
  44     will use ${HOME}/.notmuch-config if this variable is not set.
  45
  46 SEE ALSO
  47 ========
  48
  49 **notmuch(1)**,
  50 **notmuch-count(1)**,
  51 **notmuch-dump(1)**,
  52 **notmuch-hooks(5)**,
  53 **notmuch-insert(1)**,
  54 **notmuch-new(1)**,
  55 **notmuch-reply(1)**,
  56 **notmuch-restore(1)**,
  57 **notmuch-search(1)**,
  58 **notmuch-search-terms(7)**,
  59 **notmuch-show(1)**,
  60 **notmuch-tag(1)**