From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp1 ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms11 with LMTPS id sKonGfQcA2AXHwAA0tVLHw (envelope-from ) for ; Sat, 16 Jan 2021 17:05:56 +0000 Received: from aspmx1.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp1 with LMTPS id EGP1FPQcA2DnIwAAbx9fmQ (envelope-from ) for ; Sat, 16 Jan 2021 17:05:56 +0000 Received: from mail.notmuchmail.org (nmbug.tethera.net [144.217.243.247]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) server-signature RSA-PSS (2048 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id E065A9404CE for ; Sat, 16 Jan 2021 17:05:55 +0000 (UTC) Received: from nmbug.tethera.net (localhost [127.0.0.1]) by mail.notmuchmail.org (Postfix) with ESMTP id 39E642BF8E; Sat, 16 Jan 2021 12:04:55 -0500 (EST) Received: from fethera.tethera.net (fethera.tethera.net [IPv6:2607:5300:60:c5::1]) by mail.notmuchmail.org (Postfix) with ESMTP id BA3E72BF46 for ; Sat, 16 Jan 2021 12:04:31 -0500 (EST) Received: by fethera.tethera.net (Postfix, from userid 1001) id B179E5FF47; Sat, 16 Jan 2021 12:04:31 -0500 (EST) Received: (nullmailer pid 842455 invoked by uid 1000); Sat, 16 Jan 2021 17:04:16 -0000 From: David Bremner To: notmuch@notmuchmail.org Cc: David Bremner Subject: [PATCH 38/38] doc: describe new config framework Date: Sat, 16 Jan 2021 13:04:06 -0400 Message-Id: <20210116170406.842014-39-david@tethera.net> X-Mailer: git-send-email 2.29.2 In-Reply-To: <20210116170406.842014-1-david@tethera.net> References: <20210116170406.842014-1-david@tethera.net> MIME-Version: 1.0 Message-ID-Hash: AFFFUW2GFYSXMTNAJ7RNTFTAJ2PTCQJK X-Message-ID-Hash: AFFFUW2GFYSXMTNAJ7RNTFTAJ2PTCQJK X-MailFrom: bremner@tethera.net X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; header-match-notmuch.notmuchmail.org-0; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; suspicious-header X-Mailman-Version: 3.2.1 Precedence: list List-Id: "Use and development of the notmuch mail system." List-Help: List-Post: List-Subscribe: List-Unsubscribe: Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Migadu-Flow: FLOW_IN X-Migadu-Spam-Score: -1.08 Authentication-Results: aspmx1.migadu.com; dkim=none; dmarc=none; spf=pass (aspmx1.migadu.com: domain of notmuch-bounces@notmuchmail.org designates 144.217.243.247 as permitted sender) smtp.mailfrom=notmuch-bounces@notmuchmail.org X-Migadu-Queue-Id: E065A9404CE X-Spam-Score: -1.08 X-Migadu-Scanner: scn1.migadu.com X-TUID: blohcFYS81d5 Remove STORED IN DATABASE discussion, describe search rules. Currently profiles seem a bit pointless. They will make more sense when they apply to databases as well. --- doc/man1/notmuch-config.rst | 43 +++++++++++++++++++++++++++++-------- doc/man5/notmuch-hooks.rst | 6 +++--- 2 files changed, 37 insertions(+), 12 deletions(-) diff --git a/doc/man1/notmuch-config.rst b/doc/man1/notmuch-config.rst index 769f336a..bc597957 100644 --- a/doc/man1/notmuch-config.rst +++ b/doc/man1/notmuch-config.rst @@ -17,10 +17,6 @@ DESCRIPTION The **config** command can be used to get or set settings in the notmuch 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 stdout. If the item has multiple values (it is a list), each value @@ -54,6 +50,11 @@ The available configuration items are described below. Default: ``$MAILDIR`` variable if set, otherwise ``$HOME/mail``. +**database.hook_dir** + + Directory containing hooks run by notmuch commands. See + **notmuch-hooks(5)**. + **user.name** Your full name. @@ -134,7 +135,7 @@ The available configuration items are described below. Default: ``true``. -**index.decrypt** **[STORED IN DATABASE]** +**index.decrypt** Policy for decrypting encrypted messages during indexing. Must be one of: ``false``, ``auto``, ``nostash``, or ``true``. @@ -187,7 +188,7 @@ The available configuration items are described below. Default: ``auto``. -**index.header.** **[STORED IN DATABASE]** +**index.header.** Define the query prefix , based on a mail header. For example ``index.header.List=List-Id`` will add a probabilistic prefix ``List:`` that searches the ``List-Id`` field. User @@ -202,7 +203,7 @@ The available configuration items are described below. (since notmuch 0.30, "compact" and "field_processor" are always included.) -**query.** **[STORED IN DATABASE]** +**query.** Expansion for named query called . See **notmuch-search-terms(7)** for more information about named queries. @@ -214,8 +215,32 @@ 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. + Specifies the location of the notmuch configuration file. + +**NOTMUCH_PROFILE** + Selects among notmuch configurations. + +FILES +===== + +CONFIGURATION +------------- + +If ``NOTMUCH_CONFIG`` is unset, notmuch tries (in order) + +- ``$XDG_CONFIG_HOME/notmuch//config`` where ```` is + defined by ``$NOTMUCH_PROFILE`` or "default" +- ``${HOME}/.notmuch-config`` where ```` is + ``.$NOTMUCH_PROFILE`` or "" + +Hooks +----- + +If ``database.hook_dir`` is unset, notmuch tries (in order) + +- ``$XDG_CONFIG_HOME/notmuch//hooks`` where ```` is + defined by ``$NOTMUCH_PROFILE`` or "default" +- ``/.notmuch/hooks`` SEE ALSO ======== diff --git a/doc/man5/notmuch-hooks.rst b/doc/man5/notmuch-hooks.rst index de2ed0c2..c509afb3 100644 --- a/doc/man5/notmuch-hooks.rst +++ b/doc/man5/notmuch-hooks.rst @@ -5,15 +5,15 @@ notmuch-hooks SYNOPSIS ======== -$DATABASEDIR/.notmuch/hooks/* +/{pre-new, post-new, post-insert} DESCRIPTION =========== Hooks are scripts (or arbitrary executables or symlinks to such) that notmuch invokes before and after certain actions. These scripts reside -in the .notmuch/hooks directory within the database directory and must -have executable permissions. +in a directory defined as described in **notmuch-config(1)**. They +must have executable permissions. The currently available hooks are described below. -- 2.29.2