debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-11-22 10:58:10 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: added 'Init File' section to notmuch-emacs info source

Browse source 
While adding that fixed (also other) typos noticed by aspell(1) run,
and capitalized Emacs and (most) Notmuch terms to match how emacs
Info documentation seems to look in general.
This commit is contained in:
Tomi Ollila 2014-04-03 23:53:03 +03:00 committed by David Bremner
parent b6751cf875
commit 703dec7754
1 changed files with 23 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
doc/notmuch-emacs.rst
View file

@ -5,18 +5,18 @@ notmuch-emacs
About this Manual About this Manual
================= =================
This manual covers only the emacs interface to notmuch. For information This manual covers only the Emacs interface to Notmuch. For information
on the command line interface, see See section “Description” in Notmuch on the command line interface, see See section “Description” in Notmuch
Manual Pager. To save typing, we will sometimes use *notmuch* in this Manual Pager. To save typing, we will sometimes use *notmuch* in this
manual to refer to the Emacs interface to notmuch. If the distinction manual to refer to the Emacs interface to Notmuch. If the distinction
should every be important, we’ll refer to the Emacs inteface as should every be important, we’ll refer to the Emacs interface as
*notmuch-emacs*. *notmuch-emacs*.
Notmuch-emacs is highly customizable via the the Emacs customization Notmuch-emacs is highly customizable via the the Emacs customization
framework (or just by setting the appropriate variables). We try to framework (or just by setting the appropriate variables). We try to
point out relevant variables in this manual, but in order to avoid point out relevant variables in this manual, but in order to avoid
duplication of information, but you can usually find the most detailed duplication of information, but you can usually find the most detailed
description in the varables docstring. description in the variables docstring.
notmuch-hello notmuch-hello
============= =============
@ -25,7 +25,7 @@ notmuch-hello
single: notmuch-hello single: notmuch-hello
single: notmuch single: notmuch
``notmuch-hello`` is the main entry point for notmuch. You can start it ``notmuch-hello`` is the main entry point for Notmuch. You can start it
with ``M-x notmuch`` or ``M-x notmuch-hello``. The startup screen looks with ``M-x notmuch`` or ``M-x notmuch-hello``. The startup screen looks
something like the following. There are some hints at the bottom of the something like the following. There are some hints at the bottom of the
screen. There are three main parts to the notmuch-hello screen, screen. There are three main parts to the notmuch-hello screen,
@ -48,7 +48,7 @@ a mouse or by positioning the cursor and pressing ``<return>``
| ``=`` to refresh this screen. ``s`` to search messages. ``q`` to quit. | ``=`` to refresh this screen. ``s`` to search messages. ``q`` to quit.
| **Customize** this page. | **Customize** this page.
You can change the overall appearence of the notmuch-hello screen by You can change the overall appearance of the notmuch-hello screen by
customizing the variable :index:`notmuch-hello-sections`. customizing the variable :index:`notmuch-hello-sections`.
@ -59,7 +59,7 @@ notmuch-hello key bindings
``<tab>`` ``<tab>``
Move to the next widget (button or text entry field) Move to the next widget (button or text entry field)
``<backtab>`` ``<backspace>``
Move to the previous widget. Move to the previous widget.
``<return>`` ``<return>``
@ -91,12 +91,12 @@ Saved Searches
Notmuch replaces the static assignment of messages with the more dynamic Notmuch replaces the static assignment of messages with the more dynamic
notion of searching. Notmuch-hello presents the user with a customizable notion of searching. Notmuch-hello presents the user with a customizable
set of saved searchs. The initial defaults are ``tag:inbox`` and set of saved searches. The initial defaults are ``tag:inbox`` and
``tag:unread``, but you can customize the following variables ``tag:unread``, but you can customize the following variables
:index:`notmuch-saved-searches` :index:`notmuch-saved-searches`
A list of cons pairs, the first being the name to display, the A list of cons pairs, the first being the name to display, the
second being a query string for notmuch. See section “Description” second being a query string for Notmuch. See section “Description”
in Notmuch Query Syntax. in Notmuch Query Syntax.
:index:`notmuch-saved-searches-sort-function` :index:`notmuch-saved-searches-sort-function`
@ -110,8 +110,8 @@ set of saved searchs. The initial defaults are ``tag:inbox`` and
Search Box Search Box
---------- ----------
The search box lets the user enter an notmuch query. See section The search box lets the user enter a Notmuch query. See section
“Description” in Notmuch Query Syntax, for more info on notmuch query “Description” in Notmuch Query Syntax, for more info on Notmuch query
syntax. A history of recent searches is also displayed by default. The syntax. A history of recent searches is also displayed by default. The
latter is controlled by the variable :index:`notmuch-hello-recent-searches-max`. latter is controlled by the variable :index:`notmuch-hello-recent-searches-max`.
@ -190,3 +190,15 @@ Importing Mail
:index:`notmuch-poll` :index:`notmuch-poll`
:index:`notmuch-poll-script` :index:`notmuch-poll-script`
Init File
---------
When Notmuch is loaded, it will read the ``notmuch-init-file``
(``~/.emacs.d/notmuch-config`` by default) file. This is normal Emacs Lisp
file and can be used to avoid cluttering your ``~/.emacs`` with Notmuch
stuff. If the file with ``.elc``, ``.elc.gz``, ``.el`` or ``.el.gz``
suffix exist it will be read instead (just one of these, chosen in this
order). Most often users create ``~/.emacs.d/notmuch-config.el`` and just
work with it. If Emacs was invoked with the ``-q`` or ``--no-init-file``
options, ``notmuch-init-file`` is not read.