From: Richard Russon <rich@flatcap.org>
Date: Wed, 7 Jun 2017 15:14:24 +0000 (+0100)
Subject: docs: explain binding warnings
X-Git-Tag: neomutt-20170609~5
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=501f8698b5f40f30aae4a039fa2df0e503f0edf0;p=neomutt

docs: explain binding warnings
---

diff --git a/doc/manual.xml.head b/doc/manual.xml.head
index 46b664ff8..6f2d7413c 100644
--- a/doc/manual.xml.head
+++ b/doc/manual.xml.head
@@ -3671,6 +3671,23 @@ set alias_file=~/.mail_aliases
       brackets.</para>
       <para>The special function
       <literal>&lt;noop&gt;</literal>unbinds the specified key sequence.</para>
+
+      <sect2 id="bind-warnings">
+        <title>Warnings about Duplicated Bindings</title>
+        <para>Due to a limitation of Mutt, creating key bindings, or macros,
+        will overwrite existing mappings with similar, shorter, names.</para>
+        <screen>
+bind index g  group-reply
+bind index gg first-entry</screen>
+        <para>In this example, the <literal>g</literal> binding will be
+        overwritten and cannot be used.  Newer versions of Mutt will warn the
+        user about this.</para>
+        <para>To avoid warnings on startup, first set the shorter binding to
+        <literal>noop</literal> (no operation).</para>
+        <screen>
+bind index g  noop
+bind index gg first-entry</screen>
+      </sect2>
     </sect1>
 
     <sect1 id="charset-hook">