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 ms0.migadu.com with LMTPS id +NqZLsQbqGBuDwEAgWs5BA (envelope-from ) for ; Fri, 21 May 2021 22:44:52 +0200 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 iC44KsQbqGDvLgAAbx9fmQ (envelope-from ) for ; Fri, 21 May 2021 20:44:52 +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) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 4753E1A4A9 for ; Fri, 21 May 2021 22:44:52 +0200 (CEST) Received: from nmbug.tethera.net (localhost [127.0.0.1]) by mail.notmuchmail.org (Postfix) with ESMTP id 838DB29038; Fri, 21 May 2021 16:44:37 -0400 (EDT) Received: from mail-lf1-x136.google.com (mail-lf1-x136.google.com [IPv6:2a00:1450:4864:20::136]) by mail.notmuchmail.org (Postfix) with ESMTPS id 9230827E2B for ; Fri, 21 May 2021 16:44:31 -0400 (EDT) Received: by mail-lf1-x136.google.com with SMTP id a2so31512261lfc.9 for ; Fri, 21 May 2021 13:44:31 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=nikula-org.20150623.gappssmtp.com; s=20150623; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=cEZA/PWmsn8msZpmkuYDnudtAp/ybnGo48oWBU1/nVc=; b=DMAV9LVsXQluXifyOjlBWeKB7nZWSTeg3MJwSwKbVL96iiAztrbpUGhfQOSvbO2/s1 1h9UOLC64FOxtX75YagZdAthq5IB1BEsQQ0GISuBOZQ9MoYN3Z/+jxIFWeoJrvNnVCBL jMO4TY/lgjH1cVtC0b3anpKRVRA1eoPZDYrkHW/VoVw7wL+SvAzWVtf1+TLtT2p+AbaJ N88BXoPEZ+CiN4aWbr0rNv1MSb6ThdlgazYySmcoxS82Yj3oHNweyNiaUpIPiVHCX95U hGiWcCmR9+QpnoU8YzhnTbtdSLf/KE1FFkE3+ckNkAhqeGHNlGmOWewL9piVMa2uP6OI JMVA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=cEZA/PWmsn8msZpmkuYDnudtAp/ybnGo48oWBU1/nVc=; b=BMG0GKD0gbEZVQHg1lOpFETcdJlLsQ/d0vDojV2RUWbOb0/mMY8WNjRCM15If37wuB z+1RdAP9M3HpANTPYex2ED4/CFKw/gBaYcyehUBsK7LC9AsinL23d3+aHU9SEoL347kG aSDSw3Ccm0KPSS0sDwQfbhXaALQiGTLw/RYZ9I/qkk0k5QqklWrOdcIf+Z9qg7ShE/3N uNhHVxOEVLMTYa6VGkGk5GbCit4/TKNd3Rd4BxETSlW3erCnjDQsS1r5njNd032R0N88 UNFqXP/E+z+E/j7+EQAUq8yOP+mYA/MSPTvMWEi+pOVRpA1k4C5V6FxTYlt+5xeQSqFS LSBg== X-Gm-Message-State: AOAM531lYMosZjz+Sal/yseLNl3nvV6P9JELR6yY4+omztOHdC3fK7Jj Vfrzpyg5GYdMbLgxFQ0UNteWPZ1P8I5E2zL5bJE= X-Google-Smtp-Source: ABdhPJzB5Pki1TyVyEKhEtQ7miW56KPfDSkuW0q7K226bmPyDAOHJQAOqqQERDNx3o5mFtII7DJIGg== X-Received: by 2002:a19:ca44:: with SMTP id h4mr3234855lfj.19.1621629869587; Fri, 21 May 2021 13:44:29 -0700 (PDT) Received: from localhost (87-95-122-4.bb.dnainternet.fi. [87.95.122.4]) by smtp.gmail.com with ESMTPSA id x32sm723241lfu.235.2021.05.21.13.44.28 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 21 May 2021 13:44:29 -0700 (PDT) From: Jani Nikula To: notmuch@notmuchmail.org Cc: jani@nikula.org Subject: [PATCH 5/5] doc: example command-line option reference Date: Fri, 21 May 2021 23:44:13 +0300 Message-Id: <20210521204413.554563-6-jani@nikula.org> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20210521204413.554563-1-jani@nikula.org> References: <20210521204413.554563-1-jani@nikula.org> MIME-Version: 1.0 Message-ID-Hash: VQHCY3PKE3JKOKZG2AG6TSS7IRXYZTRY X-Message-ID-Hash: VQHCY3PKE3JKOKZG2AG6TSS7IRXYZTRY X-MailFrom: jani@nikula.org 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 ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1621629892; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post:dkim-signature; bh=3u77w2UDHg8Gvfm835bkANyCX1pPln0Z4apVXppTbbE=; b=l2aZhg2ETewhtMHkU8Ceh9o8/yyyPKqhru2Df04m9QA1LaOFmvHhjGmnPLQ+Cp3+S2hzBv sA+NnmYq1UaEiIxLXdv/LBFdkSHf6saT2dgPqC/gFXWAeiQtlTj1ZWq5lDi8Cb17xasBGY cFfhEHEiPGiv3mXBaUGQOH6gpEa/z7HmXkAC8NwSbJeLpb0QT4vIQAn9u4Cfys6FzNlKS/ EQe1bT0o5ffs/VzU0l/kWCXm8rcUfZR7Q86+6WChCYT7D+6Ns2tsN2JWSQZQmFQFe4nDmr YCPilryfi5AThubFqeFoy0Vuggq0OIu5tMPlErJJfM9Qg2DFZF0c20zzoTd6MQ== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1621629892; a=rsa-sha256; cv=none; b=m4QygLFLpJ414Idh9Mx1rp2afzXlhmrvoVCQ32SA83yQamjxllhsSGs1TktGM8VEmq0Qpk sGQOuqGUAKzRiNTUh5Ut1E9TTEC5b4tWRGad2q5X4hq+6fGbDTjwanDiRhlJ7RmK8GNTiX RhDB9uXIUdn6qo/8YPQCRVfmH+S6+6xQozFAgMY6RRJXNl5ibc7p+Ci2awSVQ+wx9UF99y VdytVi+tPpLTD6sdq0IJ+mn7jN1QOS4HNcG4skX9m9bDNisnTUdQLGBm6KlY3sE8tBRp3w UlDntkKWKaDqkyP3alfo4KcCFvbx1szK4jWOYLfhkVmYpEWIGEck0R7r0wwV8Q== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=fail ("body hash did not verify") header.d=nikula-org.20150623.gappssmtp.com header.s=20150623 header.b=DMAV9LVs; 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-Spam-Score: -0.07 Authentication-Results: aspmx1.migadu.com; dkim=fail ("body hash did not verify") header.d=nikula-org.20150623.gappssmtp.com header.s=20150623 header.b=DMAV9LVs; 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: 4753E1A4A9 X-Spam-Score: -0.07 X-Migadu-Scanner: scn0.migadu.com X-TUID: /7LrmeK8hGPw Example reference to a command-line option using the option role reference. This creates a hyperlink in html, and the usual boldface style in man page. This could be used throughout the man pages. --- doc/man1/notmuch-config.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/man1/notmuch-config.rst b/doc/man1/notmuch-config.rst index af126289a97f..56f4a1600153 100644 --- a/doc/man1/notmuch-config.rst +++ b/doc/man1/notmuch-config.rst @@ -248,7 +248,7 @@ CONFIGURATION Notmuch configuration file search order: -1. File specified by ``--config=FILE`` global option; see +1. File specified by :option:`notmuch --config` global option; see :any:`notmuch(1)`. 2. File specified by :envvar:`NOTMUCH_CONFIG` environment variable. -- 2.30.2