cli/insert: add --try-decrypt=(true|false)

[notmuch] / doc / man1 / notmuch-config.rst

diff --git a/doc/man1/notmuch-config.rst b/doc/man1/notmuch-config.rst
index 3c9a5684d5877a93add80a8078534d513a8574f3..6961737f3d220b2b6478780acfd4bfe5c65db7c0 100644 (file)
--- a/doc/man1/notmuch-config.rst
+++ b/doc/man1/notmuch-config.rst
@@ -15,7 +15,11 @@ DESCRIPTION
 ===========
 
 The **config** command can be used to get or set settings in the notmuch
 ===========
 
 The **config** command can be used to get or set settings in the notmuch

-configuration file.
+configuration file and corresponding database.
+
+Items marked **[STORED IN DATABASE]** are only in the database.  They
+should not be placed in the configuration file, and should be accessed
+programmatically as described in the SYNOPSIS above.

 
     **get**
         The value of the specified configuration item is printed to
 
     **get**
         The value of the specified configuration item is printed to


@@ -49,19 +53,31 @@ The available configuration items are described below.
         within a sub-directory of the path configured here named
         ``.notmuch``.
 
         within a sub-directory of the path configured here named
         ``.notmuch``.
 

+        Default: ``$MAILDIR`` variable if set, otherwise ``$HOME/mail``.
+

     **user.name**
         Your full name.
 
     **user.name**
         Your full name.
 

+        Default: ``$NAME`` variable if set, otherwise read from
+        ``/etc/passwd``.
+

     **user.primary\_email**
         Your primary email address.
 
     **user.primary\_email**
         Your primary email address.
 

+        Default: ``$EMAIL`` variable if set, otherwise constructed from the
+        username and hostname of the current machine.
+

     **user.other\_email**
         A list of other email addresses at which you receive email.
 
     **user.other\_email**
         A list of other email addresses at which you receive email.
 

+        Default: not set.
+

     **new.tags**
         A list of tags that will be added to all messages incorporated
         by **notmuch new**.
 
     **new.tags**
         A list of tags that will be added to all messages incorporated
         by **notmuch new**.
 

+        Default: ``unread;inbox``.
+

     **new.ignore**
         A list of file and directory names, without path, that will not
         be searched for messages by **notmuch new**. All the files and
     **new.ignore**
         A list of file and directory names, without path, that will not
         be searched for messages by **notmuch new**. All the files and


@@ -69,11 +85,18 @@ The available configuration items are described below.
         ignored, regardless of the location in the mail store directory
         hierarchy.
 
         ignored, regardless of the location in the mail store directory
         hierarchy.
 

+        Default: empty list.
+

     **search.exclude\_tags**
         A list of tags that will be excluded from search results by
         default. Using an excluded tag in a query will override that
         exclusion.
 
     **search.exclude\_tags**
         A list of tags that will be excluded from search results by
         default. Using an excluded tag in a query will override that
         exclusion.
 

+        Default: empty list. Note that **notmuch-setup(1)** puts
+        ``deleted;spam`` here when creating new configuration file.
+
+
+

     **maildir.synchronize\_flags**
         If true, then the following maildir flags (in message filenames)
         will be synchronized with the corresponding notmuch tags:
     **maildir.synchronize\_flags**
         If true, then the following maildir flags (in message filenames)
         will be synchronized with the corresponding notmuch tags:


@@ -104,6 +127,43 @@ The available configuration items are described below.
         are properly synchronized to the maildir flags, as the commands
         expect the database and maildir to be in sync.
 
         are properly synchronized to the maildir flags, as the commands
         expect the database and maildir to be in sync.
 

+        Default: ``true``.
+
+    **crypto.gpg_path**
+
+        Name (or full path) of gpg binary to use in verification and
+        decryption of PGP/MIME messages.  NOTE: This configuration
+        item is deprecated, and will be ignored if notmuch is built
+        against GMime 3.0 or later.
+
+        Default: ``gpg``.
+
+    **index.try_decrypt**
+
+        **[STORED IN DATABASE]**
+        When indexing an encrypted e-mail message, if this variable is
+        set to true, notmuch will try to decrypt the message and index
+        the cleartext.  Be aware that the index is likely sufficient
+        to reconstruct the cleartext of the message itself, so please
+        ensure that the notmuch message index is adequately protected.
+        DO NOT USE ``index.try_decrypt=true`` without considering the
+        security of your index.
+
+        Default: ``false``.
+
+    **built_with.<name>**
+
+        Compile time feature <name>. Current possibilities include
+        "compact" (see **notmuch-compact(1)**)
+        and "field_processor" (see **notmuch-search-terms(7)**).
+
+    **query.<name>**
+
+        **[STORED IN DATABASE]**
+        Expansion for named query called <name>. See
+        **notmuch-search-terms(7)** for more information about named
+        queries.
+

 ENVIRONMENT
 ===========
 
 ENVIRONMENT
 ===========
 


@@ -117,7 +177,15 @@ of notmuch.
 SEE ALSO
 ========
 
 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)**
+**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)**