From: Richard Russon Date: Wed, 3 Feb 2016 17:33:27 +0000 (+0000) Subject: add docs X-Git-Tag: neomutt-20160404~21^2~1 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=5c59eb5b7dd20edebb093dc8c2d2af97e5cb9f9f;p=neomutt add docs --- diff --git a/README.quasi-delete b/README.quasi-delete new file mode 100644 index 000000000..f010c5b5d --- /dev/null +++ b/README.quasi-delete @@ -0,0 +1,49 @@ +Quasi-Delete Patch +================== + + Mark emails that should be hidden, but not deleted + +Patch +----- + + To check if Mutt supports "Quasi-Delete", look for "patch-quasi-delete" in + the mutt version. + + Dependencies + * mutt-1.5.24 + +Introduction +------------ + + The "quasi-delete" function marks an email that should be hidden from the + index, but NOT deleted. + + On its own, this patch isn't very useful. It forms a useful part of the + notmuch plugin. + +Functions +--------- + + Quasi-Delete Functions + + | Menus | Default Key | Function | Description | + |-------------|-------------|------------------|---------------------------------------| + | index,pager | (none) | '' | delete from mutt, don't touch on disk | + +See Also +-------- + + * NeoMutt project + * notmuch patch + +Known Bugs +---------- + + None + +Credits +------- + + * Karel Zak + * Richard Russon + diff --git a/doc/manual.xml.head b/doc/manual.xml.head index b90908f00..85ce4c02d 100644 --- a/doc/manual.xml.head +++ b/doc/manual.xml.head @@ -8081,6 +8081,126 @@ please have a look at the mixmaster documentation. + + Quasi-Delete Patch + Mark emails that should be hidden, but not deleted + + + Patch + + + To check if Mutt supports Quasi-Delete, look for + patch-quasi-delete in the mutt version. + See: . + + + + Dependencies: + mutt-1.5.24 + + + This patch is part of the NeoMutt Project. + + + + Introduction + + + The quasi-delete function marks an email that should be + hidden from the index, but NOT deleted. + + + + On its own, this patch isn't very useful. It forms a useful part of + the notmuch plugin. + + + + + + + Functions + + Quasi-Delete Functions + + + + Menus + Default Key + Function + Description + + + + + index,pager + (none) + <quasi-delete> + delete from mutt, don't touch on disk + + + +
+ + + + + + Muttrc + +# Example Mutt config file for the 'quasi-delete' feature. + +# The 'quasi-delete' function marks an email that should be hidden +# from the index, but NOT deleted. +bind index,pager Q quasi-delete + +# vim: syntax=muttrc + + + + + See Also + + + NeoMutt Project + notmuch patch + + + + + Known Bugs + None + + + + Credits + + Karel Zak kzak@redhat.com + Richard Russon rich@flatcap.org + + + + diff --git a/doc/muttrc.quasi-delete b/doc/muttrc.quasi-delete new file mode 100644 index 000000000..67031ffbb --- /dev/null +++ b/doc/muttrc.quasi-delete @@ -0,0 +1,7 @@ +# Example Mutt config file for the 'quasi-delete' feature. + +# The 'quasi-delete' function marks an email that should be hidden +# from the index, but NOT deleted. +bind index,pager Q quasi-delete + +# vim: syntax=muttrc diff --git a/doc/vimrc.quasi-delete b/doc/vimrc.quasi-delete new file mode 100644 index 000000000..f8a69e758 --- /dev/null +++ b/doc/vimrc.quasi-delete @@ -0,0 +1,5 @@ +" Vim syntax file for the mutt quasi-delete patch + +syntax match muttrcFunction contained "\" + +" vim: syntax=vim