unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
blob e0109dce80e07015a9aec6daee36e9ac4c32363c 1603 bytes (raw)
name: doc/man1/notmuch-compact.rst 	 # note: path name is non-authoritative(*)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
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)**

debug log:

solving e0109dc ...
found e0109dc in https://yhetil.org/notmuch.git/

(*) Git path names are given by the tree(s) the blob belongs to.
    Blobs themselves have no identifier aside from the hash of its contents.^

Code repositories for project(s) associated with this public inbox

	https://yhetil.org/notmuch.git/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).