From c5cae10553f431f401120654e8b8d6447e9aefe9 Mon Sep 17 00:00:00 2001 From: Michael Elkins Date: Thu, 6 Dec 2012 07:56:54 -0800 Subject: [PATCH] additional documentation for $editor. closes #3602 --- init.h | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/init.h b/init.h index 360886a1e..75da9bf58 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 }, /* -- 2.40.0