cli/new: document new exit code
[notmuch] / doc / man1 / notmuch-new.rst
1 ===========
2 notmuch-new
3 ===========
4
5 SYNOPSIS
6 ========
7
8 **notmuch** **new** [options]
9
10 DESCRIPTION
11 ===========
12
13 Find and import any new messages to the database.
14
15 The **new** command scans all sub-directories of the database,
16 performing full-text indexing on new messages that are found. Each new
17 message will automatically be tagged with both the **inbox** and
18 **unread** tags.
19
20 You should run **notmuch new** once after first running **notmuch
21 setup** to create the initial database. The first run may take a long
22 time if you have a significant amount of mail (several hundred thousand
23 messages or more). Subsequently, you should run **notmuch new** whenever
24 new mail is delivered and you wish to incorporate it into the database.
25 These subsequent runs will be much quicker than the initial run.
26
27 Invoking ``notmuch`` with no command argument will run **new** if
28 **notmuch setup** has previously been completed, but **notmuch new** has
29 not previously been run.
30
31 **notmuch new** updates tags according to maildir flag changes if the
32 **maildir.synchronize\_flags** configuration option is enabled. See
33 **notmuch-config(1)** for details.
34
35 The **new** command supports hooks. See **notmuch-hooks(5)** for more
36 details on hooks.
37
38 Supported options for **new** include
39
40     ``--no-hooks``
41         Prevents hooks from being run.
42
43     ``--quiet``
44         Do not print progress or results.
45
46 EXIT STATUS
47 ===========
48
49 This command supports the following special exit status code
50
51 ``75 (EX_TEMPFAIL)``
52     A temporary failure occured; the user is invited to retry.
53
54 SEE ALSO
55 ========
56
57 **notmuch(1)**, **notmuch-config(1)**, **notmuch-count(1)**,
58 **notmuch-dump(1)**, **notmuch-hooks(5)**, **notmuch-insert(1)**,
59 **notmuch-reply(1)**, **notmuch-restore(1)**, **notmuch-search(1)**,
60 **notmuch-search-terms(7)**, **notmuch-show(1)**, **notmuch-tag(1)**