diff options
author | David Bremner <david@tethera.net> | 2014-01-28 12:12:37 -0400 |
---|---|---|
committer | David Bremner <david@tethera.net> | 2014-03-09 10:41:08 -0300 |
commit | d736260385a689b5c77d8121f48e29440e3adfa4 (patch) | |
tree | 4d5c4279405a012f6f312fbb8c003226c618bb78 /doc/man1/notmuch-compact.rst | |
parent | 029790d3ff6e9fccfed2214efac777b8c438e318 (diff) |
doc: convert sphinx based docs
This is the output from sphinx-quickstart, massaged a bit, along with
our existing man pages converted to rst.
A skeleton notmuch-emacs manual is also included. It is not suitable
for end user use yet.
Diffstat (limited to 'doc/man1/notmuch-compact.rst')
-rw-r--r-- | doc/man1/notmuch-compact.rst | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/doc/man1/notmuch-compact.rst b/doc/man1/notmuch-compact.rst new file mode 100644 index 00000000..e0109dce --- /dev/null +++ b/doc/man1/notmuch-compact.rst @@ -0,0 +1,52 @@ +=============== +notmuch-compact +=============== + +SYNOPSIS +======== + +**notmuch** **compact** [--quiet] [--backup=<*directory*>] + +DESCRIPTION +=========== + +The **compact** 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 ``--backup=``\ <directory> option is +used. + +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 **compact** include + + ``--backup=``\ <directory> + Save the current database to the given directory before + replacing it with the compacted database. The backup directory + must not exist and it must reside on the same mounted filesystem + as the current database. + + ``--quiet`` + Do not report database compaction progress to stdout. + +ENVIRONMENT +=========== + +The following environment variables can be used to control the behavior +of notmuch. + +**NOTMUCH\_CONFIG** + Specifies the location of the notmuch configuration file. Notmuch + will use ${HOME}/.notmuch-config if this variable is not set. + +SEE ALSO +======== + +**notmuch(1)**, **notmuch-count(1)**, **notmuch-dump(1)**, +**notmuch-hooks(5)**, **notmuch-insert(1)**, **notmuch-new(1)**, +**notmuch-reply(1)**, **notmuch-restore(1)**, **notmuch-search(1)**, +**notmuch-search-terms(7)**, **notmuch-show(1)**, **notmuch-tag(1)** |