From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp0 ([2001:41d0:2:bcc0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms0.migadu.com with LMTPS id wGSMAa8bqGDlEQEAgWs5BA (envelope-from ) for ; Fri, 21 May 2021 22:44:31 +0200 Received: from aspmx1.migadu.com ([2001:41d0:2:bcc0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp0 with LMTPS id iF9EOK4bqGAKSgAA1q6Kng (envelope-from ) for ; Fri, 21 May 2021 20:44:30 +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) server-digest SHA256) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 20FCD1B13B for ; Fri, 21 May 2021 22:44:30 +0200 (CEST) Received: from nmbug.tethera.net (localhost [127.0.0.1]) by mail.notmuchmail.org (Postfix) with ESMTP id 71239271EB; Fri, 21 May 2021 16:44:23 -0400 (EDT) Received: from mail-lf1-x130.google.com (mail-lf1-x130.google.com [IPv6:2a00:1450:4864:20::130]) by mail.notmuchmail.org (Postfix) with ESMTPS id 3BBE727169 for ; Fri, 21 May 2021 16:44:20 -0400 (EDT) Received: by mail-lf1-x130.google.com with SMTP id q7so30196607lfr.6 for ; Fri, 21 May 2021 13:44:20 -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:mime-version :content-transfer-encoding; bh=kFpk/0B6A+VIgjE28+/XhzgZtJ9qPhLux4QTLuZW8vQ=; b=VzwJknltu8AZMsgfkp61ED1iZ8EK65bwGW8FdbCeBRf1t2PW8p4g+suZBCkYwzpkCR ah2Dg8nCV1c/FcHVYARFY+AXDEQTxIoigUjCXhLn32a3HquTNDQUXy2KaiYYfBKTgYg5 tk0/N0Mq08R8PlBvMn5Hda77ISYO5f3wzf3L7FI9DuS2TIFpyZKhefQIu31IP9+mtmW6 81NvKHZyPQNggFnzzwLmMO4EISlokjGkdns0SPDrnGJK2p7tEyJRTCj9IIENVitejKs1 q3EmDVKnLJeVB9Td2zK8KycV81VNv5Gpb6ij+6ZV3cF22CJ/yTUuNf72Sg8PPmDkQ+YI pwZA== 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:mime-version :content-transfer-encoding; bh=kFpk/0B6A+VIgjE28+/XhzgZtJ9qPhLux4QTLuZW8vQ=; b=gVjz/sbaSSQXuf0yX5kUiCuZY0DMXzq31/2GCYWVpH+JlD6aPq8QeVd5+fi0VsgqrY PwtQAsT9x34xCkDRClPQIYdS60KyJ1/Rkgx+OHk//Pl8yoUF9ixGhHKIu2qv9jQ12Bi5 4a3d9+S3VjoJ49AnryctMcuzriYqnA7bmhIp7Len5DkE7OH+uIpCMpQHbZc1YRjZhMVJ niBcO/zg8wrPt4sy5rcP0F4FmM7LdNzBHPMT2lx5NxT5iRroMRJDvoFf6NmReDK1tnS1 Jc7j8KsFtCcARWA52JMOTq6QqdrMz6gFnCSa+fKRNratbMqc2IyRLBb8a/eW0eecJwYT 9jPw== X-Gm-Message-State: AOAM533QaUnyXtTX5jhIE2gizeGbz/7Cpk6DHc3TjLyrtLIJiB7yqSqp KpPj7qugaeCtljyBtC25zu0untwcfH93jgmEiXo= X-Google-Smtp-Source: ABdhPJzpfMwIVkbA2IkfQ/wEq1l4TJLEh9+pcPWU2XlL64GWSfliGvDXi03C/A6z8rBuD+BWimfI7w== X-Received: by 2002:ac2:5df0:: with SMTP id z16mr3228044lfq.413.1621629858107; Fri, 21 May 2021 13:44:18 -0700 (PDT) Received: from localhost (87-95-122-4.bb.dnainternet.fi. [87.95.122.4]) by smtp.gmail.com with ESMTPSA id n8sm723611lfe.48.2021.05.21.13.44.17 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 21 May 2021 13:44:17 -0700 (PDT) From: Jani Nikula To: notmuch@notmuchmail.org Cc: jani@nikula.org Subject: [PATCH 0/5] doc: man page cleanup Date: Fri, 21 May 2021 23:44:08 +0300 Message-Id: <20210521204413.554563-1-jani@nikula.org> X-Mailer: git-send-email 2.30.2 MIME-Version: 1.0 Message-ID-Hash: UARH7LMX54QAWKOZ2RFGEYHPVQTZWSN5 X-Message-ID-Hash: UARH7LMX54QAWKOZ2RFGEYHPVQTZWSN5 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=1621629870; 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:list-id:list-help: list-unsubscribe:list-subscribe:list-post:dkim-signature; bh=saC64T3kbmdHoIoyT7/HbDriT35MtHk7MgcU531eLaQ=; b=sRWjn5qB7YOiNDJfT312Qyjcr9vbzvxwVaa7GGMzcBpwTX3jEblCOBAeg/lzmR3eEKyP3l c86vkrzVO/bdieg4x2K7m9uBaw3nsrPucMSpHTskbyVGT2YA1UvqvjCsrgHD4uCLsNV/r2 a5ORKvTS7djIQjN29cvK6WlP8YqvQOYek37yY1leX+WSkJcRz0cUQqZE5iXbIiVF1prZfo VftXI25sKxsMXSAFVoINrJ4jIbnP+pVaLH13T+u3xN8vfOEjiai6sdjimeQ/RrgmKHB0fq RxjRLbYGyB6lYpWqwJOnWigc70Ng3FC++aGFod4SYcr4aJOjI0EE3qLHfde2kw== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1621629870; a=rsa-sha256; cv=none; b=VNDMXllnAzelIL3GiouzNvWoysy6TtW3fmglg2yKRCM4NV3/vopwynvhulK7hq8pxuLea1 z3LgQpkryYE8W5A3/gL5F5Rq9dSMHg1YrXqHnI/uMs/J2fRVjRFUzB7id6BPha0EmeUuya xTNH1RvB/HQy4MjDMjuORvF1whgbyNtqmPrw7VKAIGsAPDsPo0zTDi6Mm08yxJjLv83aCt R+89mJyTzF7pThTpBW02qJ4p4iMh6/eCRjDtMN1rXZB9PthfNII3M80kGqybb5uGbNG0zm qerhm/r2FW0jVmKf/31d4r8l+Ursb+jMDejGgC7QL/wCWDv77C8fBETTAegZgg== 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=VzwJknlt; 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=VzwJknlt; 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: 20FCD1B13B X-Spam-Score: -0.07 X-Migadu-Scanner: scn1.migadu.com X-TUID: mW8xo+0X4VQR I saw [1] and decided to give it some love. :) Mostly this is all about adding html cross-references all over the place while trying to keep the roff man pages roughly the same. Also updating the man page rst becomes easier by setting a clean example. BR, Jani. [1] https://notmuchmail.org/doc/latest/ Jani Nikula (5): doc: use manpage role references to external man pages doc: cross-reference notmuch man pages with actual links doc: use envvar directive and role for environment variables doc: use program and option directives to document options doc: example command-line option reference doc/conf.py | 5 + doc/man1/notmuch-address.rst | 204 ++++++++-------- doc/man1/notmuch-compact.rst | 48 ++-- doc/man1/notmuch-config.rst | 147 ++++++------ doc/man1/notmuch-count.rst | 87 ++++--- doc/man1/notmuch-dump.rst | 176 +++++++------- doc/man1/notmuch-emacs-mua.rst | 101 ++++---- doc/man1/notmuch-insert.rst | 128 +++++----- doc/man1/notmuch-new.rst | 102 ++++---- doc/man1/notmuch-reindex.rst | 71 +++--- doc/man1/notmuch-reply.rst | 121 +++++----- doc/man1/notmuch-restore.rst | 154 ++++++------ doc/man1/notmuch-search.rst | 264 +++++++++++---------- doc/man1/notmuch-show.rst | 380 ++++++++++++++++-------------- doc/man1/notmuch-tag.rst | 63 ++--- doc/man1/notmuch.rst | 139 ++++++----- doc/man5/notmuch-hooks.rst | 54 +++-- doc/man7/notmuch-properties.rst | 36 +-- doc/man7/notmuch-search-terms.rst | 50 ++-- 19 files changed, 1245 insertions(+), 1085 deletions(-) -- 2.30.2