From: Richard Russon Date: Tue, 2 Aug 2016 09:17:33 +0000 (+0100) Subject: docs: notmuch X-Git-Tag: neomutt-20160822~24^2~8 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=5a34b7208ccdc4560a974758b42e3ddd47572d66;p=neomutt docs: notmuch --- diff --git a/doc/manual.xml.head b/doc/manual.xml.head index 554c5bef3..bb393cbbd 100644 --- a/doc/manual.xml.head +++ b/doc/manual.xml.head @@ -10936,6 +10936,530 @@ bind index \CG get-message + + Notmuch Patch + Email search engine + + + Patch + + + To check if Mutt supports Notmuch, look for + +USE_NOTMUCH in the mutt version. + See: . + + + + Dependencies: + mutt-1.6.2 + sidebar patch + quasi-delete patch + index-color patch + Notmuch libraries + + + This patch is part of the NeoMutt Project. + + + + Introduction + + + Notmuch is an email fulltext indexing and tagging engine. + + + + For more information, see: + http://notmuchmail.org/ + + Home page (wiki) and git: + https://github.com/karelzak/mutt-kz + + Mailing list: + https://admin.fedoraproject.org/mailman/listinfo/mutt-kz + + + More examples: + http://notmuchmail.org/mutttips/ + + + + + + + Using NotMuch + + + Folders URI + + + notmuch://[<path>][?<item>=<name>[& ...]] + + + + The <path> is an absolute path to the directory where the notmuch database + is found as returned by notmuch config get database.path command. Note that + the <path> should NOT include .notmuch directory name. + + + + If the "<path>" is not defined then + $nm_default_uri or $folder is + used, for example: + + + +set nm_default_uri = "notmuch:///home/foo/maildir" +virtual-mailboxes "My INBOX" "notmuch://?query=tag:inbox" + + + + + Items + + + query=<string> + + + + See SEARCH SYNTAX in notmuch man page. Don't forget to use + and and or operators in your queries. + + + + Note that proper URI should not contain blank space and all + bad chars should be encoded, for example + + + + tag:AAA and tag:BBB --encoding-> tag:AAA%20and%20tag:BBB + + + + but mutt config file parser is smart enough to accept space in quoted + strings. It means that you can use + + + + notmuch:///foo?query=tag:AAA and tag:BBB + + + + in your config files to keep things readable. + + + + For more details about Xapian queries, see: + http://xapian.org/docs/queryparser.html + + + + limit=<number> + + + + Restricts number of messages/threads in the result. The default limit + is nm_db_limit. + + + + type=<threads|messages> + + + + Reads all matching messages or whole-threads. The default is 'messages' + or nm_query_type. + + + + + + + Variables + + + Notmuch Variables + + + + Name + Type + Default + + + + + nm_db_limit + number + 0 + + + nm_default_uri + string + (empty) + + + nm_exclude_tags + string + (empty) + + + nm_hidden_tags + string + unread,draft,flagged,passed,replied,attachment,signed,encrypted + + + nm_open_timeout + number + 5 + + + nm_query_type + string + messages + + + nm_record + boolean + no + + + nm_record_tags + string + (empty) + + + nm_unread_tag + string + unread + + + vfolder_format + string + %6n(%6N) %f + + + virtual_spoolfile + boolean + no + + + +
+ + + + Functions + + + Notmuch adds the following functions to Mutt. + By default, none of them are bound to keys. + + + + Notmuch Functions + + + + Menus + Function + Description + + + + + index,pager + <change-vfolder> + open a different virtual folder + + + index,pager + <entire-thread> + read entire thread of the current message + + + index,pager + <modify-labels> + modify (notmuch) tags + + + index,pager + <modify-labels-then-hide> + modify labels and then hide message + + + index,pager + <sidebar-toggle-virtual> + toggle between mailboxes and virtual mailboxes + + + index,pager + <vfolder-from-query> + generate virtual folder from query + + + +
+ + + + Commands + + + virtual-mailboxes + + description + + notmuch-URI + + + + + description + + notmuch-URI + + + + + tag-transforms + + tag + + transformed-string + + + + + tag + + transformed-string + + + + + tag-formats + + tag + + format-string + + + + + tag + + format-string + + + + + + + + + Colors + + Adds these to index-color patch: + + + Index Colors + + + + Object + Pattern + Highlights + + + + + index_tag + yes + an individual message tag, %G, uses tag name + + + index_tags + no + the transformed message tags, %g + + + +
+ + + + + + Muttrc + + +# This is a complete list of notmuch-related configuration. + +# -------------------------------------------------------------------------- +# VARIABLES - shown with their default values +# -------------------------------------------------------------------------- + +# This variable specifies notmuch query limit. +set nm_db_limit = 0 + +# This variable specifies the default Notmuch database in format: +# notmuch://<absolute path> +set nm_default_uri = "" + +# The messages tagged with these tags are excluded and not loaded +# from notmuch DB to mutt unless specified explicitly. +set nm_exclude_tags = "" + +# This variable specifies private notmuch tags which should not be printed +# on screen (index, pager). +set nm_hidden_tags = "unread,draft,flagged,passed,replied,attachment,signed,encrypted" + +# This option specifies timeout for Notmuch database. Default is 5 seconds. +set nm_open_timeout = 5 + +# This variable specifies notmuch query type, supported types: 'threads' and +# 'messages'. +set nm_query_type = messages + +# Add messages stored to the mutt record (see $record in the mutt docs) +# also to notmuch DB. +set nm_record = no + +# Tags that should be removed or added to the to the messages stored in the mutt record. +set nm_record_tags = "" + +# This variable specifies notmuch tag which is used for unread messages. +set nm_unread_tag = unread + +# This variable allows you to customize the file browser display for virtual +# folders to your personal taste. +set vfolder_format = "%6n(%6N) %f" + +# When set, mutt will use the first virtual mailbox (see virtual-mailboxes) +# as a spoolfile. +set virtual_spoolfile = no + +# -------------------------------------------------------------------------- +# FUNCTIONS - shown with an example mapping +# -------------------------------------------------------------------------- + +# open a different virtual folder +bind index,pager X change-vfolder + +# read entire thread of the current message +bind index,pager + entire-thread + +# modify (notmuch) tags +bind index,pager ` modify-labels + +# generate virtual folder from query +bind index,pager \eX vfolder-from-query + +# modify labels and then hide message +# bind index,pager ??? modify-labels-then-hide + +# toggle between mailboxes and virtual mailboxes +# bind index,pager ??? sidebar-toggle-virtual + +# -------------------------------------------------------------------------- +# COMMANDS - shown with an example +# -------------------------------------------------------------------------- + +# virtual-mailboxes description notmuch-URI { description notmuch-URI ...} +# virtual-mailboxes "Climbing" "notmuch://?query=climbing" + +# Replace some tags with icons +# tag-transforms tag transformed-string { tag transformed-string ...} +# tag-transforms "inbox" "i" \ +# "unread" "u" \ +# "replied" "↻ " \ +# "sent" "➥ " \ +# "todo" "T" \ +# "deleted" "DEL" \ +# "invites" "CAL" + +# See README.notmuch for an explanation +# tag-formats tag format-string { tag format-string ...} +# tag-formats "inbox" "GI" \ +# "unread" "GU" \ +# "replied" "GR" \ +# "sent" "GS" \ +# "todo" "Gt" \ +# "deleted" "GD" \ +# "invites" "Gi" + +# set index_format='4C %S %[%y.%m.%d] %-18.18n %?GU?%GU& ? %?GR?%GR& ? %?GI?%GI& ? %s' + +# -------------------------------------------------------------------------- +# COLORS - some unpleasant examples are given +# -------------------------------------------------------------------------- + +# These symbols are added to the index-color patch: + +# an individual message tag, %G, uses tag name +# this symbol uses a pattern +color index_tag red white "inbox" + +# the transformed message tags, %g +# this symbol does not use a pattern +color index_tags green default + +# -------------------------------------------------------------------------- + +# vim: syntax=muttrc + + + + + See Also + + + NeoMutt Project + Compile-Time Features + + + + + Known Bugs + None + + + + Credits + + Karel Zak kzak@redhat.com + Chris Mason clm@fb.com + Christoph Rissner cri@visotech.at + David Riebenbauer davrieb@liegesta.at + David Sterba dsterba@suse.cz + David Wilson dw@botanicus.net + Don Zickus dzickus@redhat.com + Eric Davis edavis@insanum.com + Jan Synacek jsynacek@redhat.com + Jeremiah C. Foster jeremiah@jeremiahfoster.com + Josh Poimboeuf jpoimboe@redhat.com + Kirill A. Shutemov kirill@shutemov.name + Luke Macken lmacken@redhat.com + Mantas Mikulėnas grawity@gmail.com + Patrick Brisbin pbrisbin@gmail.com + Philippe Le Brouster plb@nebkha.net + Raghavendra D Prabhu rprabhu@wnohang.net + Sami Farin hvtaifwkbgefbaei@gmail.com + Stefan Assmann sassmann@kpanic.de + Stefan Kuhn p_regius@gmx.ch + Tim Stoakes tim@stoakes.net + Vladimir Marek Vladimir.Marek@oracle.com + Víctor Manuel Jáquez Leal vjaquez@igalia.com + Richard Russon rich@flatcap.org + + + + Sidebar Overview of mailboxes diff --git a/doc/muttrc.notmuch b/doc/muttrc.notmuch new file mode 100644 index 000000000..c752395db --- /dev/null +++ b/doc/muttrc.notmuch @@ -0,0 +1,114 @@ +# This is a complete list of notmuch-related configuration. + +# -------------------------------------------------------------------------- +# VARIABLES - shown with their default values +# -------------------------------------------------------------------------- + +# This variable specifies notmuch query limit. +set nm_db_limit = 0 + +# This variable specifies the default Notmuch database in format: +# notmuch:// +set nm_default_uri = "" + +# The messages tagged with these tags are excluded and not loaded +# from notmuch DB to mutt unless specified explicitly. +set nm_exclude_tags = "" + +# This variable specifies private notmuch tags which should not be printed +# on screen (index, pager). +set nm_hidden_tags = "unread,draft,flagged,passed,replied,attachment,signed,encrypted" + +# This option specifies timeout for Notmuch database. Default is 5 seconds. +set nm_open_timeout = 5 + +# This variable specifies notmuch query type, supported types: 'threads' and +# 'messages'. +set nm_query_type = messages + +# Add messages stored to the mutt record (see $record in the mutt docs) +# also to notmuch DB. +set nm_record = no + +# Tags that should be removed or added to the to the messages stored in the mutt record. +set nm_record_tags = "" + +# This variable specifies notmuch tag which is used for unread messages. +set nm_unread_tag = unread + +# This variable allows you to customize the file browser display for virtual +# folders to your personal taste. +set vfolder_format = "%6n(%6N) %f" + +# When set, mutt will use the first virtual mailbox (see virtual-mailboxes) +# as a spoolfile. +set virtual_spoolfile = no + +# -------------------------------------------------------------------------- +# FUNCTIONS - shown with an example mapping +# -------------------------------------------------------------------------- + +# open a different virtual folder +bind index,pager X change-vfolder + +# read entire thread of the current message +bind index,pager + entire-thread + +# modify (notmuch) tags +bind index,pager ` modify-labels + +# generate virtual folder from query +bind index,pager \eX vfolder-from-query + +# modify labels and then hide message +# bind index,pager ??? modify-labels-then-hide + +# toggle between mailboxes and virtual mailboxes +# bind index,pager ??? sidebar-toggle-virtual + +# -------------------------------------------------------------------------- +# COMMANDS - shown with an example +# -------------------------------------------------------------------------- + +# virtual-mailboxes description notmuch-URI { description notmuch-URI ...} +# virtual-mailboxes "Climbing" "notmuch://?query=climbing" + +# Replace some tags with icons +# tag-transforms tag transformed-string { tag transformed-string ...} +# tag-transforms "inbox" "i" \ +# "unread" "u" \ +# "replied" "↻ " \ +# "sent" "➥ " \ +# "todo" "T" \ +# "deleted" "DEL" \ +# "invites" "CAL" + +# See README.notmuch for an explanation +# tag-formats tag format-string { tag format-string ...} +# tag-formats "inbox" "GI" \ +# "unread" "GU" \ +# "replied" "GR" \ +# "sent" "GS" \ +# "todo" "Gt" \ +# "deleted" "GD" \ +# "invites" "Gi" + +# set index_format='4C %S %[%y.%m.%d] %-18.18n %?GU?%GU& ? %?GR?%GR& ? %?GI?%GI& ? %s' + +# -------------------------------------------------------------------------- +# COLORS - some unpleasant examples are given +# -------------------------------------------------------------------------- + +# These symbols are added to the index-color patch: + +# an individual message tag, %G, uses tag name +# this symbol uses a pattern +color index_tag red white "inbox" + +# the transformed message tags, %g +# this symbol does not use a pattern +color index_tags green default + +# -------------------------------------------------------------------------- + +# vim: syntax=muttrc diff --git a/doc/vimrc.notmuch b/doc/vimrc.notmuch new file mode 100644 index 000000000..918d23d5e --- /dev/null +++ b/doc/vimrc.notmuch @@ -0,0 +1,28 @@ +" Vim syntax file for the mutt notmuch patch + +syntax keyword muttrcVarBool contained skipwhite nm_record nextgroup=muttrcSetBoolAssignment,muttrcVPrefix,muttrcVarBool,muttrcVarQuad,muttrcVarNum,muttrcVarStr +syntax keyword muttrcVarBool contained skipwhite virtual_spoolfile nextgroup=muttrcSetBoolAssignment,muttrcVPrefix,muttrcVarBool,muttrcVarQuad,muttrcVarNum,muttrcVarStr + +syntax keyword muttrcVarNum contained skipwhite nm_db_limit nextgroup=muttrcSetNumAssignment,muttrcVPrefix,muttrcVarBool,muttrcVarQuad,muttrcVarNum,muttrcVarStr +syntax keyword muttrcVarNum contained skipwhite nm_open_timeout nextgroup=muttrcSetNumAssignment,muttrcVPrefix,muttrcVarBool,muttrcVarQuad,muttrcVarNum,muttrcVarStr + +syntax keyword muttrcVarStr contained skipwhite nm_default_uri nextgroup=muttrcVarEqualsIdxFmt +syntax keyword muttrcVarStr contained skipwhite nm_exclude_tags nextgroup=muttrcVarEqualsIdxFmt +syntax keyword muttrcVarStr contained skipwhite nm_hidden_tags nextgroup=muttrcVarEqualsIdxFmt +syntax keyword muttrcVarStr contained skipwhite nm_query_type nextgroup=muttrcVarEqualsIdxFmt +syntax keyword muttrcVarStr contained skipwhite nm_record_tags nextgroup=muttrcVarEqualsIdxFmt +syntax keyword muttrcVarStr contained skipwhite nm_unread_tag nextgroup=muttrcVarEqualsIdxFmt +syntax keyword muttrcVarStr contained skipwhite vfolder_format nextgroup=muttrcVarEqualsIdxFmt + +syntax keyword muttrcCommand virtual-mailboxes +syntax keyword muttrcCommand tag-transforms +syntax keyword muttrcCommand tag-formats + +syntax match muttrcFunction contained "" +syntax match muttrcFunction contained "" +syntax match muttrcFunction contained "" +syntax match muttrcFunction contained "" +syntax match muttrcFunction contained "" +syntax match muttrcFunction contained "" + +" vim: syntax=vim