From 08697bf9f7358ac905e7df69e6e2f5333227b016 Mon Sep 17 00:00:00 2001 From: David Bremner Date: Sun, 29 May 2022 07:04:46 -0300 Subject: [PATCH] replace most wikilinks to manpages with external links to docs The external html docs are (should be!) nicer to read --- bindings.mdwn | 9 +++++---- excluding.mdwn | 2 +- faq.mdwn | 8 ++++---- frontends.mdwn | 2 +- getting-started.mdwn | 24 ++++++++++++++---------- index.mdwn | 9 +++++---- initial_tagging.mdwn | 2 +- notmuch-emacs.mdwn | 7 ++++--- searching.mdwn | 14 ++++++++------ 9 files changed, 43 insertions(+), 34 deletions(-) diff --git a/bindings.mdwn b/bindings.mdwn index 9352aba..8871028 100644 --- a/bindings.mdwn +++ b/bindings.mdwn @@ -1,10 +1,11 @@ [[!img notmuch-logo.png alt="Notmuch logo" class="left"]] # Notmuch Language Bindings [DRAFT] -The Notmuch library, `libnotmuch`, can be used from many programming languages -using the Notmuch language bindings. The [[command line interface|manpages]] and -the [[email clients and frontends|frontends]] are based on the language -bindings. +The Notmuch library, `libnotmuch`, can be used from many programming +languages using the Notmuch language bindings. The [command line +interface](https://notmuchmail.org/doc/latest/man1/notmuch.html) and +the [[email clients and frontends|frontends]] are based on the +language bindings. [[!toc levels=2]] diff --git a/excluding.mdwn b/excluding.mdwn index 785d477..d7b030c 100644 --- a/excluding.mdwn +++ b/excluding.mdwn @@ -73,7 +73,7 @@ procedure: ## **killing threads** -In a [[hook|manpages/notmuch-hooks-5]] +In a [hook](https://notmuchmail.org/doc/latest/man5/notmuch-hooks.html) notmuch tag +muted $(notmuch search --output=threads tag:muted)" diff --git a/faq.mdwn b/faq.mdwn index 71c9ff8..7e41e96 100644 --- a/faq.mdwn +++ b/faq.mdwn @@ -59,8 +59,8 @@ Next, use that to query the messages: ## How do I search for punctuation, specific special characters, or regexp? -Please see the [[notmuch-search-terms manual -page|manpages/notmuch-search-terms-7]] first. +Please see the [notmuch-search-terms manual +page](https://notmuchmail.org/doc/latest/man7/notmuch-search-terms.html) first. The main thing to understand is that Xapian, and therefore Notmuch, searches are closer to natural language searches than regular expression @@ -106,8 +106,8 @@ This is required in order to run the `pre-new` and `post-new` hooks. No. Tagging is message based. It is possible, however, to make tags propagate to all messages in a thread -using a little bit of scripting in the [[post-new -hook|manpages/notmuch-hooks-5]]. For example, to add the muted tag to all +using a little bit of scripting in the [post-new +hook](https://notmuchmail.org/doc/latest/man5/notmuch-hooks.html). For example, to add the muted tag to all messages in threads that have at least one message with the muted tag: THREAD_TAGS="muted" diff --git a/frontends.mdwn b/frontends.mdwn index 9e571e2..0d8a24a 100644 --- a/frontends.mdwn +++ b/frontends.mdwn @@ -3,7 +3,7 @@ ## Shipping with Notmuch -* [[notmuch-cli|manpages]], the CLI bindings provided with Notmuch. +* [notmuch-cli](https://notmuchmail.org/doc/latest/man1/notmuch.html), the CLI bindings provided with Notmuch. * [[notmuch-emacs|notmuch-emacs]], the Emacs email client. * [notmuch-vim](https://git.notmuchmail.org/git/notmuch/blob/HEAD:/vim/README), the vim frontend. * [[notmuch-mutt]], mutt interoperability script. diff --git a/getting-started.mdwn b/getting-started.mdwn index 7cc7c31..b853453 100644 --- a/getting-started.mdwn +++ b/getting-started.mdwn @@ -8,7 +8,8 @@ This is your friendly guide and tutorial to getting started with Notmuch. It will help you through the first steps of setting up Notmuch. -All Notmuch commands have [[manual pages|manpages]]. Please refer to them for +All Notmuch commands have [manual +pages](https://notmuchmail.org/doc/latest/) Please refer to them for details. ## Prerequisites @@ -64,8 +65,9 @@ Depending on the amount of mail you have the initial indexing process can take a long time, so expect that. Also, the resulting database will require roughly the same amount of storage space as your current collection of email. -After this step, you can try out the [[Notmuch command-line -interface|manpages]], or [[Notmuch Emacs interface|notmuch-emacs]]. +After this step, you can try out the [Notmuch command line +interface](https://notmuchmail.org/doc/latest/man1/notmuch.html), or +[[Notmuch Emacs interface|notmuch-emacs]]. ## Converting Existing mbox to Maildir @@ -93,13 +95,15 @@ There are two ways to deliver and index messages: ## Automation Via Hooks -Notmuch supports running [[user defined hooks|manpages/notmuch-hooks-5]] before -or after certain commands. Hooks can be arbitrary executable programs or -scripts. For example, if you always run your mail delivery tool first and -`notmuch new` after that, you can run the tool from Notmuch `pre-new` hook, and -simply run `notmuch new` to do both. If you always do some tagging after -indexing of new messages, you may want to set up a `post-new` or `post-insert` -hook to do that automatically. +Notmuch supports running [user defined +hooks](https://notmuchmail.org/doc/latest/man5/notmuch-hooks.html) +before or after certain commands. Hooks can be arbitrary executable +programs or scripts. For example, if you always run your mail delivery +tool first and `notmuch new` after that, you can run the tool from +Notmuch `pre-new` hook, and simply run `notmuch new` to do both. If +you always do some tagging after indexing of new messages, you may +want to set up a `post-new` or `post-insert` hook to do that +automatically. ## Backing Up and Restoring the Database diff --git a/index.mdwn b/index.mdwn index d55273c..dd06815 100644 --- a/index.mdwn +++ b/index.mdwn @@ -64,9 +64,10 @@ Notmuch|getting-started]]. ## Email Clients and Front Ends -Notmuch ships with a powerful set of [[command-line tools|manpages]], an -[[email client for Emacs|notmuch-emacs]], another -[client for vim](https://git.notmuchmail.org/git/notmuch/blob/HEAD:/vim/README), +Notmuch ships with a powerful set of [command-line +tools](https://notmuchmail.org/doc/latest/man1/notmuch.html), an +[[email client for Emacs|notmuch-emacs]], another [client for +vim](https://git.notmuchmail.org/git/notmuch/blob/HEAD:/vim/README), and a [[Mutt integration script|notmuch-mutt]]. There are also many other [[email clients, frontends and tools|frontends]] based @@ -74,7 +75,7 @@ on Notmuch. ## Documentation - * [[Notmuch manual pages|manpages]] + * [Notmuch official documentation (manual pages)](https://notmuchmail.org/doc/latest/) * [[Email clients and frontends|frontends]] * [[General how-tos|howto]] * [[Frequently Asked Questions|faq]] diff --git a/initial_tagging.mdwn b/initial_tagging.mdwn index fa86b4d..44243e0 100644 --- a/initial_tagging.mdwn +++ b/initial_tagging.mdwn @@ -92,6 +92,6 @@ the 'new' tag approach discussed above. ## Notmuch MDA -- `notmuch-insert` -The [[notmuch insert command|manpages/notmuch-insert-1]] is a tool for +The [notmuch insert command](https://notmuchmail.org/doc/latest/man1/notmuch-insert.html) is a tool for delivering emails to maildir, indexing them to the Notmuch database, and tagging them as desired. diff --git a/notmuch-emacs.mdwn b/notmuch-emacs.mdwn index bc42d1a..5ced0cf 100644 --- a/notmuch-emacs.mdwn +++ b/notmuch-emacs.mdwn @@ -13,9 +13,10 @@ the [[tips and tricks page|emacstips]] for more advanced details. ## Prerequisites -The Notmuch Emacs interface uses the Notmuch [[command line interface|manpages]] -to interact with the Notmuch database and your mail store. Please make sure -you've [[set up Notmuch|getting-started]] first. +The Notmuch Emacs interface uses the Notmuch [command line +interface](https://notmuchmail.org/doc/latest/man1/notmuch.html) to +interact with the Notmuch database and your mail store. Please make +sure you've [[set up Notmuch|getting-started]] first. ## Installation diff --git a/searching.mdwn b/searching.mdwn index 8f2b07a..0564f72 100644 --- a/searching.mdwn +++ b/searching.mdwn @@ -4,9 +4,10 @@ What good is an advanced indexing mail client if we don't know how to use it to actually find e-mail? -The [[notmuch-search-terms manual page|manpages/notmuch-search-terms-7]] should -cover everything in a fairly concise manner. Please refer to that for any -details. +The [notmuch-search-terms manual +pages](https://notmuchmail.org/doc/latest/man7/notmuch-search-terms.html) +should cover everything in a fairly concise manner. Please refer to +that for any details. Notmuch uses the [Xapian](http://xapian.org/) search engine. The [Xapian QueryParser](http://xapian.org/docs/queryparser.html) documentation has @@ -171,6 +172,7 @@ work: For `` and ``, notmuch understands a variety of standard and natural ways of expressing dates and times, both in absolute terms -("2012-10-24") and in relative terms ("yesterday"). Please refer to the -[[notmuch-search-terms manual page|manpages/notmuch-search-terms-7]] for -details. +("2012-10-24") and in relative terms ("yesterday"). Please refer to +the [notmuch-search-terms +manual](https://notmuchmail.org/doc/latest/man7/notmuch-search-terms.html) +for details. -- 2.43.0