git.cworth.org Git - notmuch-wiki/blob - manpages/notmuch-compact-1.mdwn

   1 <h1>NOTMUCH-COMPACT(1)</h1>
   2
   3 <h2>NAME</h2>
   4 <pre>
   5        notmuch-compact - compact the notmuch database
   6 </pre>
   7
   8 <h2>SYNOPSIS</h2>
   9 <pre>
  10        <b>notmuch</b> <b>compact</b> [--quiet] [--backup=&lt;<u>directory</u>&gt;]
  11 </pre>
  12
  13 <h2>DESCRIPTION</h2>
  14 <pre>
  15        The  <b>compact</b> command can be used to compact the notmuch database.  This
  16        can both reduce the space required by the database and  improve  lookup
  17        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 <b>--backup=</b>&lt;directory&gt; 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 <b>compact</b> include
  27
  28           <b>--backup=&lt;directory&gt;</b>
  29                  Save the current  database  to  the  given  directory  before
  30                  replacing  it  with the compacted database. The backup direc‐
  31                  tory must not exist and it must reside on  the  same  mounted
  32                  filesystem as the current database.
  33
  34           <b>--quiet</b>
  35                  Do not report database compaction progress to stdout.
  36 </pre>
  37
  38 <h2>ENVIRONMENT</h2>
  39 <pre>
  40        The following environment variables can be used to control the behavior
  41        of notmuch.
  42
  43        <b>NOTMUCH</b>_<b>CONFIG</b>
  44               Specifies the location of the notmuch configuration  file.  Not‐
  45               much  will  use  ${HOME}/.notmuch-config if this variable is not
  46               set.
  47 </pre>
  48
  49 <h2>SEE ALSO</h2>
  50 <pre>
  51        <a href='../notmuch-1/'>notmuch</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1),  <a href='../notmuch-hooks-5/'>notmuch-hooks</a>(5),  <a href='../notmuch-insert-1/'>not‐</a>
  52        <a href='../notmuch-insert-1/'>much-insert</a>(1),  <a href='../notmuch-new-1/'>notmuch-new</a>(1),  <a href='../notmuch-reply-1/'>notmuch-reply</a>(1), <a href='../notmuch-restore-1/'>notmuch-restore</a>(1),
  53        <a href='../notmuch-search-1/'>notmuch-search</a>(1),   <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7),   <a href='../notmuch-show-1/'>notmuch-show</a>(1),   <a href='../notmuch-tag-1/'>not‐</a>
  54        <a href='../notmuch-tag-1/'>much-tag</a>(1)
  55 </pre>
  56
  57 <h2>AUTHOR</h2>
  58 <pre>
  59        Carl Worth and many others
  60 </pre>
  61
  62 <h2>COPYRIGHT</h2>
  63 <pre>
  64        2014, Carl Worth and many others
  65 </pre>
  66
  67 <h2>0.19</h2>