From 24c5768d6d0cf52f3a550e4cca93097b3d7ce607 Mon Sep 17 00:00:00 2001
From: Oleg Broytman <phd@phdru.name>
Date: Thu, 7 Apr 2016 07:34:39 +0300
Subject: [PATCH] .muttrc: add descriptions to macros

---
 .muttrc | 58 ++++++++++++++++++++++++++++++++++++++-------------------
 1 file changed, 39 insertions(+), 19 deletions(-)

diff --git a/.muttrc b/.muttrc
index f5647c0..e119315 100644
--- a/.muttrc
+++ b/.muttrc
@@ -283,39 +283,59 @@ bind index,pager <Esc>S decode-save
 # Macros
 #
 
-# Go to the first folder with unread messages
-macro index,pager C <Enter><exit><Home><change-folder><Enter>
+macro index,pager C \
+   <Enter><exit><Home><change-folder><Enter> \
+   "Go to the first folder with unread messages"
 
-# Move current message to inbox
-macro index,pager S <save-message>!<Enter>
+macro index,pager S \
+   <save-message>!<Enter> \
+   "Move current message to inbox"
 
-macro index,pager <Esc>h ":auto_view text/html<Enter>"
-macro index,pager <Esc>H ":unauto_view text/html<Enter>"
+macro index,pager <Esc>h \
+   ":auto_view text/html<Enter>" \
+   "View HTML attachments"
+macro index,pager <Esc>H \
+   ":unauto_view text/html<Enter>" \
+   "Don't show HTML attachments"
 
-# Pipe spam
 macro index,pager <Esc>s \
-   "<Enter><exit><pipe-message>spamassassin -d | ~/mail/bin/spamcop.py<Enter><next-undeleted>"
+   "<Enter><exit><pipe-message>spamassassin -d | ~/mail/bin/spamcop.py<Enter><next-undeleted>" \
+   "Send spam to SpamCop"
 macro index,pager <Esc>z \
-   "<Enter><exit>:set editor='vim -s ~/mail/misc/spamcop.vim'<Enter><reply>:set editor=vim.sh<Enter><exit>n"
+   "<Enter><exit>:set editor='vim -s ~/mail/misc/spamcop.vim'<Enter><reply>:set editor=vim.sh<Enter><exit>n" \
+   "Process message from SpamCop"
 
-# Go to main mailboxes
-macro index,pager H <Enter><exit><Home><change-folder>!<Enter>
-macro index,pager M <Enter><exit><Home><change-folder>=sent-mail<Enter>
+macro index,pager H \
+   <Enter><exit><Home><change-folder>!<Enter> \
+   "Go to inbox"
+macro index,pager M \
+   <Enter><exit><Home><change-folder>=sent-mail<Enter> \
+   "Go to sent-mail"
 
 # Go to python mailbox
-macro index,pager Y <Enter><exit><Home><change-folder>=lists/python<Enter>
+macro index,pager Y \
+   <Enter><exit><Home><change-folder>=lists/python<Enter> \
+   "Go to python"
 
 # Go to STCnet "Atlas"/STM mailboxes
-macro index,pager A      <Enter><exit><Home><change-folder>=stcnet<Enter>
-macro index,pager <Esc>a <Enter><exit><Home><change-folder>=sent-stcnet<Enter>
+macro index,pager A \
+   <Enter><exit><Home><change-folder>=stcnet<Enter> \
+   "Go to stcnet inbox"
+macro index,pager <Esc>a \
+   <Enter><exit><Home><change-folder>=sent-stcnet<Enter> \
+   "Go to sent-stcnet"
 
 # Recode base64 to 8bit, html to plain text, mustdie-1251 to koi8-r, etc.
-macro index,pager <Esc>m "<pipe-message>mimedecode.py | less<Enter>"
+macro index,pager \
+   <Esc>m "<pipe-message>mimedecode.py | less<Enter>" \
+   "View MIME-decoded message"
 macro index,pager E \
-   ":set editor=mimedecode.sh<Enter><edit>:set editor=vim.sh<Enter>"
+   ":set editor=mimedecode.sh<Enter><edit>:set editor=vim.sh<Enter>" \
+   "MIME-decode and save"
 
-# Convert X-Face header to an image and display it
-macro index,pager <Esc>f <pipe-message>~/mail/bin/view-x-face<Enter>
+macro index,pager <Esc>f \
+   <pipe-message>~/mail/bin/view-x-face<Enter> \
+   "Convert X-Face header to an image and display it"
 
 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 #
-- 
2.39.5