From: Michael Elkins <me@sigpipe.org>
Date: Thu, 6 Dec 2012 15:56:54 +0000 (-0800)
Subject: additional documentation for $editor.  closes #3602
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=4d7c7884f5c6454b27d3fc35f746fee7fb9db15f;p=mutt

additional documentation for $editor.  closes #3602
---

diff --git a/init.h b/init.h
index 360886a1..75da9bf5 100644
--- a/init.h
+++ b/init.h
@@ -687,6 +687,16 @@ struct option_t MuttVars[] = {
   ** This variable specifies which editor is used by mutt.
   ** It defaults to the value of the \fC$$$VISUAL\fP, or \fC$$$EDITOR\fP, environment
   ** variable, or to the string ``vi'' if neither of those are set.
+  ** .pp
+  ** The \fC$$editor\fP string may contain a \fI%s\fP escape, which will be replaced by the name
+  ** of the file to be edited.  If the \fI%s\fP escape does not appear in \fC$$editor\fP, a
+  ** space and the name to be edited are appended.
+  ** .pp
+  ** The resulting string is then executed by running
+  ** .ts
+  ** sh -c 'string'
+  ** .te
+  ** where \fIstring\fP is the expansion of \fC$$editor\fP described above.
   */
   { "encode_from",	DT_BOOL, R_NONE, OPTENCODEFROM, 0 },
   /*