additional documentation for $editor. closes #3602

diff --git a/init.h b/init.h
index 360886a1e2bc937e5f03f2bb8dcc65063c11a012..75da9bf58ae6c658484be63b4c1eabece415c794 100644 (file)
--- 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 },
   /*