This is notmuch-compact.info, produced by makeinfo version 4.8 from
notmuch-compact.texi.

Generated by Sphinx 1.4.8.
INFO-DIR-SECTION Miscellaneous
START-INFO-DIR-ENTRY
* notmuch-compact: (notmuch-compact.info). compact the notmuch database
END-INFO-DIR-ENTRY

     notmuch 0.30, Oct 03, 2020

     Carl Worth and many others

     Copyright (C) 2009-2020, Carl Worth and many others


File: notmuch-compact.info,  Node: Top,  Next: SYNOPSIS,  Up: (dir)

notmuch-compact documentation
*****************************

     notmuch 0.30, Oct 03, 2020

     Carl Worth and many others

     Copyright (C) 2009-2020, Carl Worth and many others

* Menu:

* SYNOPSIS::
* DESCRIPTION::
* ENVIRONMENT::
* SEE ALSO::


File: notmuch-compact.info,  Node: SYNOPSIS,  Next: DESCRIPTION,  Prev: Top,  Up: Top

1 SYNOPSIS
**********

`notmuch' `compact' [-quiet] [-backup=<`directory'>]


File: notmuch-compact.info,  Node: DESCRIPTION,  Next: ENVIRONMENT,  Prev: SYNOPSIS,  Up: Top

2 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.


File: notmuch-compact.info,  Node: ENVIRONMENT,  Next: SEE ALSO,  Prev: DESCRIPTION,  Up: Top

3 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.


File: notmuch-compact.info,  Node: SEE ALSO,  Prev: ENVIRONMENT,  Up: Top

4 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)'



Tag Table:
Node: Top386
Ref: man1/notmuch-compact doc642
Ref: 0642
Node: SYNOPSIS710
Ref: man1/notmuch-compact notmuch-compact799
Ref: 1799
Ref: man1/notmuch-compact synopsis799
Ref: 2799
Node: DESCRIPTION876
Ref: man1/notmuch-compact description973
Ref: 3973
Node: ENVIRONMENT1867
Ref: man1/notmuch-compact environment1964
Ref: 41964
Node: SEE ALSO2234
Ref: man1/notmuch-compact see-also2311
Ref: 52311

End Tag Table
