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

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