]> git.cworth.org Git - notmuch-wiki/blobdiff - manpages/notmuch-compact-1.mdwn
0.20.1 manpages update
[notmuch-wiki] / manpages / notmuch-compact-1.mdwn
index d93f7dc9a477609b230bf231684312af414c3b80..1f5207287da0780ded94c3407506b877d7ade105 100644 (file)
@@ -7,34 +7,32 @@
 
 <h2>SYNOPSIS</h2>
 <pre>
-       <b>notmuch</b> <b>compact</b> [ --quiet ] [ --backup=&lt;<u>directory</u>&gt; ]
+       <b>notmuch</b> <b>compact</b> [--quiet] [--backup=&lt;<u>directory</u>&gt;]
 </pre>
 
 <h2>DESCRIPTION</h2>
 <pre>
-       The  <b>compact</b>  command can be used to compact the notmuch database. This
+       The  <b>compact</b> command can be used to compact the notmuch database.  This
        can both reduce the space required by the database and  improve  lookup
        performance.
 
        The  compacted  database is built in a temporary directory and is later
        moved into the place of the origin database. The  original  uncompacted
-       database  is discarded, unless the <b>--backup=</b>&lt;directory&gt; option is used.
+       database is discarded, unless the <b>--backup=</b>&lt;directory&gt; option is used.
 
-       Note that the database write lock will be held  during  the  compaction
+       Note  that  the  database write lock will be held during the compaction
        process (which may be quite long) to protect data integrity.
 
        Supported options for <b>compact</b> include
 
-           <b>--backup=</b>&lt;directory&gt;
+          <b>--backup=&lt;directory&gt;</b>
+                 Save the current  database  to  the  given  directory  before
+                 replacing  it  with the compacted database. The backup direc‐
+                 tory must not exist and it must reside on  the  same  mounted
+                 filesystem as the current database.
 
-               Save the current database to the given directory before replac-
-               ing it with the compacted database. The backup  directory  must
-               not  exist and it must reside on the same mounted filesystem as
-               the current database.
-
-           <b>--quiet</b>
-
-               Do not report database compaction progress to stdout.
+          <b>--quiet</b>
+                 Do not report database compaction progress to stdout.
 </pre>
 
 <h2>ENVIRONMENT</h2>
        of notmuch.
 
        <b>NOTMUCH</b>_<b>CONFIG</b>
-              Specifies  the  location of the notmuch configuration file. Not-
-              much will use ${HOME}/.notmuch-config if this  variable  is  not
+              Specifies the location of the notmuch configuration  file.  Not‐
+              much  will  use  ${HOME}/.notmuch-config if this variable is not
               set.
 </pre>
 
 <h2>SEE ALSO</h2>
 <pre>
-       <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>
-       <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),
-       <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/'>notmuch-</a>
-       <a href='../notmuch-tag-1/'>tag</a>(1)
+       <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>
+       <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),
+       <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>
+       <a href='../notmuch-tag-1/'>much-tag</a>(1)
+</pre>
+
+<h2>AUTHOR</h2>
+<pre>
+       Carl Worth and many others
+</pre>
+
+<h2>COPYRIGHT</h2>
+<pre>
+       2014, Carl Worth and many others
 </pre>
 
-<h2>Notmuch 0.17</h2>
+<h2>0.20.1</h2>