X-Git-Url: https://git.cworth.org/git?p=notmuch-wiki;a=blobdiff_plain;f=getting-started.mdwn;h=05de920c5f15521c4c3a52fb15e2562f25132c5f;hp=09f49934a3e84b5bb94f9a0048e99caa00b179aa;hb=HEAD;hpb=19816dd3cd51c70e7a86a685b5b60c2e9059867a diff --git a/getting-started.mdwn b/getting-started.mdwn index 09f4993..05de920 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 @@ -27,9 +28,9 @@ already have messages in this format. On Linux, the easiest way to install Notmuch is through your distribution's package repository. If you're installing Notmuch from a [git -checkout](http://git.notmuchmail.org/git/notmuch) or a [source -release](http://notmuchmail.org/releases/), please refer to the -[INSTALL](http://git.notmuchmail.org/git/notmuch/blob/HEAD:/INSTALL) document. +checkout](https://git.notmuchmail.org/git/notmuch) or a [source +release](https://notmuchmail.org/releases/), please refer to the +[INSTALL](https://git.notmuchmail.org/git/notmuch/blob/HEAD:/INSTALL) document. ## Configuration @@ -64,11 +65,18 @@ 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 +The [`mb2md`](http://batleth.sapienti-sat.org/projects/mb2md/) tool can be used +to convert existing mbox files to Maildir. + +Beware that the source and destination directory options to `mb2md` are relative +to the user's home directory, not relative to the current working directory. + ## Delivering New Messages Notmuch itself does not receive messages. There is no IMAP or POP support. You @@ -87,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