]> git.cworth.org Git - notmuch-wiki/blobdiff - emacstips.mdwn
let's see whether ./ is enough...
[notmuch-wiki] / emacstips.mdwn
index f4c571288cd5fd831649dcc5385615b9dbd3e76a..8819e70c0929cf73e77d58fe61f7b0fa8836088c 100644 (file)
@@ -18,15 +18,24 @@ notmuch cli command!
 To use the Notmuch emacs mode, first add the following line to your
 `.emacs` rc file:
 
-        (require 'notmuch)
+        (autoload 'notmuch "notmuch" "notmuch mail" t)
 
-or you can load the package via autoload:
+or if you always want to load notmuch when you start emacs:
 
-        (autoload 'notmuch "notmuch" "notmuch mail" t)
+        (require 'notmuch)
 
 Then, either run "emacs -f notmuch", or execute the command `M-x
 notmuch` from within a running emacs.
 
+### <span id="notmuch_init_file"> Notmuch Emacs configuration file: </span>
+
+(Since Notmuch 0.18)
+
+After notmuch is loaded `notmuch-init-file` (typically
+ `~/.emacs.d/notmuch-config.el`) is checked out. If such file exists
+it is loaded. Most emacs lisp based configuration not suitable via
+customization can be put there instead of `~/.emacs`.
+
 ## Navigating & reading mails
 
 When first starting notmuch in emacs, you will be presented with the
@@ -67,9 +76,9 @@ that it will hide the sent mail in your emacs frame stack, but it will
 not close it. If you type several mails in an emacs session they will
 accumulate and make switching between buffers more annoying. You can
 avoid that behavior by adding `(setq message-kill-buffer-on-exit t)`
-in your `.emacs` file (or doing `M-x
-customize-variable<RET>message-kill-buffer-on-exit<RET>`) which will
-really close the mail window after sending it.
+in your `.emacs` file
+(or doing `M-x customize-variable<RET>message-kill-buffer-on-exit<RET>`)
+which will really close the mail window after sending it.
 
 ## Attaching files
 
@@ -93,7 +102,7 @@ mentioned as script arguments. (Note: The script expects that you have
 
         #!/bin/sh
         attach_cmds=""
-        while [ "$1" ]; do
+        while [ $# -gt 0 ]; do
             fullpath=$(readlink --canonicalize "$1")
             attach_cmds="$attach_cmds (mml-attach-file \"$fullpath\")"
             shift
@@ -116,38 +125,6 @@ to your .emacs file.
 
 # Advanced tips and tweaks
 
-## Use separate emacs lisp file for notmuch configuration
-
-Instead of adding notmuch configuration code to `.emacs`, there
-is an option to collect those to a separate file (which is only
-loaded when `notmuch` is invoked). To do this, write, for example
-a file called `~/.emacs.d/my-notmuch.el`:
-
-        ;;; my-notmuch.el -- my notmuch mail configuration
-        ;;;
-
-        ;;; add here stuff required to be configured *before*
-        ;;; notmuch is loaded;
-
-        ;; uncomment and modify in case some elisp files are not found in load-path
-        ;; (add-to-list 'load-path "~/vc/ext/notmuch/emacs")
-
-        ;;; load notmuch
-        (require 'notmuch)
-
-        ;;; add here stuff required to be configured *after*
-        ;;; notmuch is loaded;
-
-        ;; uncomment & modify if you want to use external smtp server to send mail
-        ;; (setq smtpmail-smtp-server "smtp.server.tld"
-        ;;       message-send-mail-function 'message-smtpmail-send-it)
-        ;; uncomment to debug smtp sending problems
-        ;; (setq smtpmail-debug-info t)
-
-Then, add to `.emacs`:
-
-        (autoload 'notmuch "~/.emacs.d/my-notmuch" "notmuch mail" t)
-
 ## Initial cursor position in notmuch 0.15 hello window
 
 In notmuch version 0.15 emacs client the handling of cursor position in
@@ -179,7 +156,7 @@ making quick tag key bindings.  The arguments to these functions have
 changed as notmuch has evolved but the following should work on all
 versions of notmuch from 0.13 on.  These functions take a list of
 tag changes as argument. For example, an argument of (list "+spam"
-"-inbox) adds the tag spam and deletes the tag inbox. Note the
+"-inbox") adds the tag spam and deletes the tag inbox. Note the
 argument must be a list even if there is only a single tag change
 e.g., use (list "+deleted") to add the deleted tag.
 
@@ -470,7 +447,7 @@ available:
     from notmuch.  It also includes a vim plugin.
 
 You can perform tab-completion using any of these programs.
-Just add the following to your .emacs:
+Just add the following to your [[notmuch init file|./#notmuch_init_file]]:
 
         (require 'notmuch-address)
         (setq notmuch-address-command "/path/to/address_fetching_program")
@@ -508,14 +485,14 @@ Create a ~/bin/akonadimailsearch.sh file with the following content and make it
         #!/bin/sh
         akonadimailsearch "$@" 2>/dev/null
 
-As described above, you can now add the following settings to your ~/.emacs file:
+As described above, you can now add the following settings to your
+[[notmuch init file|./#notmuch_init_file]]:
 
         (require 'notmuch-address)
         (setq notmuch-address-command "~/bin/akonadimailsearch.sh")
         (notmuch-address-message-insinuate)
 
 
-
 ## How to sign/encrypt messages with gpg
 
 Messages can by signed using gpg by invoking
@@ -613,8 +590,8 @@ See also the **Usage:** section in `gnus-alias.el`.
 
 ## Resending (or bouncing) messages
 
-Add the following to your `.emacs` to be able to resend the current message in
-show mode.
+Add the following to your [[notmuch init file|./#notmuch_init_file]] to be able
+to resend the current message in show mode.
 
         (define-key notmuch-show-mode-map "b"
           (lambda (&optional address)
@@ -625,9 +602,9 @@ show mode.
 
 ## `notmuch-hello` refresh status message
 
-Add the following to your `.emacs` to get a status message about the change in
-the number of messages in the mail store when refreshing the `notmuch-hello`
-buffer.
+Add the following to your [[notmuch init file|./#notmuch_init_file]] to get a
+status message about the change in the number of messages in the mail store
+when refreshing the `notmuch-hello` buffer.
 
         (defvar notmuch-hello-refresh-count 0)
 
@@ -655,8 +632,8 @@ buffer.
 
 Mailman mailing list software rewrites and rewraps long message subjects in
 a way that causes TABs to appear in the middle of the subject and header
-lines. Add this to your `.emacs` to replace tabs with spaces in subject
-lines:
+lines. Add this to your [[notmuch init file|./#notmuch_init_file]] to replace
+tabs with spaces in subject lines:
 
         (defun notmuch-show-subject-tabs-to-spaces ()
           "Replace tabs with spaces in subject line."