]> granicus.if.org Git - neomutt/commitdiff
doc: Document new mutt functions in manual
authorReis Radomil <reisradomil@fake-box.com>
Wed, 15 Nov 2017 20:53:03 +0000 (21:53 +0100)
committerReis Radomil <reisradomil@fake-box.com>
Wed, 15 Nov 2017 20:58:37 +0000 (21:58 +0100)
Document the new mutt functions `edit-or-view-raw-message` and
`view-raw-message`.

Amend description of `edit` function to mention the two new functions.

doc/manual.xml.head

index 07ab5db694fb3a202c9d9454a6903317afd94d8b..973375ae9e6858b694a0809665fd064385353064 100644 (file)
@@ -2069,8 +2069,8 @@ color sidebar_divider   color8  default
           </varlistentry>
           <varlistentry>
             <term>
-            <literal>&lt;edit&gt;</literal>
-            <anchor id="edit" />(default: e)</term>
+            <literal>&lt;edit-raw-message&gt;</literal>
+            <anchor id="edit-raw-message" /></term>
             <listitem>
               <para>This command (available in the index and pager) allows you
               to edit the raw current message as it's present in the mail
@@ -2078,6 +2078,43 @@ color sidebar_divider   color8  default
               be appended to the current folder, and the original message will
               be marked for deletion; if the message is unchanged it won't be
               replaced.</para>
+              <para>
+              <link linkend="edit"><literal>&lt;edit&gt;</literal></link> is a
+              synonym of this for backwards compatibility.</para>
+              <para>See also
+              <link linkend="edit-or-view-raw-message">
+                <literal>&lt;edit-or-view-raw-message&gt;</literal>
+              </link>,
+              <link linkend="view-raw-message">
+                <literal>&lt;view-raw-message&gt;</literal>
+              </link>.</para>
+            </listitem>
+          </varlistentry>
+          <varlistentry>
+            <term>
+            <literal>&lt;edit&gt;</literal>
+            <anchor id="edit" /></term>
+            <listitem>
+              <para>Alias of
+              <link linkend="edit-raw-message">
+                <literal>&lt;edit-raw-message&gt;</literal>
+              </link> for backwards compatibility.</para>
+            </listitem>
+          </varlistentry>
+          <varlistentry>
+            <term>
+            <literal>&lt;edit-or-view-raw-message&gt;</literal>
+            <anchor id="edit-or-view-raw-message" />(default: e)</term>
+            <listitem>
+              <para>This command (available in the index and pager) is the same
+              as
+              <link linkend="edit-raw-message">
+                <literal>&lt;edit-raw-message&gt;</literal>
+              </link>
+              if the mailbox is writable, otherwise it the same as
+              <link linkend="view-raw-message">
+                <literal>&lt;view-raw-message&gt;</literal>
+              </link>.</para>
             </listitem>
           </varlistentry>
           <varlistentry>
@@ -2211,6 +2248,26 @@ color sidebar_divider   color8  default
               way.</para>
             </listitem>
           </varlistentry>
+          <varlistentry>
+            <term>
+            <literal>&lt;view-raw-message&gt;</literal>
+            <anchor id="view-raw-message" /></term>
+            <listitem>
+              <para>This command (available in the index and pager) opens the
+              raw message read-only in an editor. This command does not allow
+              editing the message, use
+              <link linkend="edit-raw-message">
+                <literal>&lt;edit-raw-message&gt;</literal>
+              </link> for this.</para>
+              <para>See also
+              <link linkend="edit-raw-message">
+                <literal>&lt;edit-raw-message&gt;</literal>
+              </link>,
+              <link linkend="edit-or-view-raw-message">
+                <literal>&lt;edit-or-view-raw-message&gt;</literal>
+              </link>.</para>
+            </listitem>
+          </varlistentry>
           <varlistentry>
             <term>
             <literal>&lt;skip-quoted&gt;</literal>