doc/manual.xml.head: Sort/Group command definitions

Also add, group and sort the hooks list in section “Using Hooks”.

diff --git a/doc/manual.xml.head b/doc/manual.xml.head
index 05d7f9118a8a9d9bc408e66bfba754975692b3d3..b99950d4f044393f0f5a5759d9e8ff20676f7763 100644 (file)
--- a/doc/manual.xml.head
+++ b/doc/manual.xml.head
@@ -5338,12 +5338,26 @@ my_hdr Organization: A Really Big Company, Anytown, USA
       <screen>unmy_hdr to cc</screen>
     </sect1>
 
-    <sect1 id="save-hook">
-      <title>Specify Default Save Mailbox</title>
+    <sect1 id="default-save-mailbox">
+      <title>Specify Default Fcc: and/or Save Mailbox</title>
       <para>
         Usage:
       </para>
       <cmdsynopsis>
+        <command>fcc-save-hook</command>
+        <arg choice="plain">
+          <replaceable class="parameter">pattern</replaceable>
+        </arg>
+        <arg choice="plain">
+          <replaceable class="parameter">mailbox</replaceable>
+        </arg>
+        <command>fcc-hook</command>
+        <arg choice="plain">
+          <replaceable class="parameter">pattern</replaceable>
+        </arg>
+        <arg choice="plain">
+          <replaceable class="parameter">mailbox</replaceable>
+        </arg>
         <command>save-hook</command>
         <arg choice="plain">
           <replaceable class="parameter">pattern</replaceable>
@@ -5352,98 +5366,55 @@ my_hdr Organization: A Really Big Company, Anytown, USA
           <replaceable class="parameter">mailbox</replaceable>
         </arg>
       </cmdsynopsis>
-      <para>
-        This command is used to override the default mailbox used when saving
-        messages. <emphasis>mailbox</emphasis> will be used as the default if
-        the message matches <emphasis>pattern</emphasis>, see
-        <xref linkend="pattern-hook" /> for information on the exact format.
+      <para><anchor id="fcc-save-hook" />
+        <command>fcc-save-hook</command> is a shortcut, equivalent to doing
+        both a <link linkend="fcc-hook"><command>fcc-hook</command></link> and
+        a <link linkend="save-hook"><command>save-hook</command></link> with
+        its arguments, including %-expansion on <emphasis>mailbox</emphasis>
+        according to <link linkend="index-format">$index_format</link>.
       </para>
+
+      <para><anchor id="fcc-hook" />
+        <command>fcc-hook</command> is used to save outgoing mail in a mailbox
+        other than <link linkend="record">$record</link>. NeoMutt searches the
+        initial list of message recipients for the first matching
+        <emphasis>pattern</emphasis> and uses <emphasis>mailbox</emphasis> as
+        the default <quote>Fcc:</quote> mailbox. If no match is found the
+        message will be saved to <link linkend="record">$record</link> mailbox.
+      </para>
+      <screen>fcc-hook [@.]aol\\.com$ +spammers</screen>
       <para>
-        To provide more flexibility and good defaults, NeoMutt applies the
-        expandos of <link linkend="index-format">$index_format</link> to
-        <emphasis>mailbox</emphasis> after it was expanded.
+        ...will save a copy of all messages going to the aol.com domain to the
+        <quote>+spammers</quote> mailbox by default.
       </para>
-      <example id="ex-save-hook-exando">
-        <title>Using %-expandos in
-        <command>save-hook</command></title>
 
-<screen>
+      <para><anchor id="save-hook" />
+        <command>save-hook</command> is used to override the default mailbox
+        used when saving messages. <emphasis>mailbox</emphasis> will be used
+        as the default if the message matches <emphasis>pattern</emphasis>.
+      </para>
+      <example id="ex-save-hook-exando">
+        <title>Using %-expandos in <command>save-hook</command></title>
+        <screen>
 <emphasis role="comment"># default: save all to ~/Mail/&lt;author name&gt;</emphasis>
 save-hook . ~/Mail/%F
 <emphasis role="comment"># save from me@turing.cs.hmc.edu and me@cs.hmc.edu to $folder/elkins</emphasis>
 save-hook me@(turing\\.)?cs\\.hmc\\.edu$ +elkins
 <emphasis role="comment"># save from aol.com to $folder/spam</emphasis>
 save-hook aol\\.com$ +spam
-</screen>
-
+        </screen>
       </example>
+
       <para>
         Also see the
         <link linkend="fcc-save-hook"><command>fcc-save-hook</command></link>
         command.
-      </para>
-    </sect1>
-
-    <sect1 id="fcc-hook">
-      <title>Specify Default Fcc: Mailbox When Composing</title>
-      <para>
-        Usage:
-      </para>
-      <cmdsynopsis>
-        <command>fcc-hook</command>
-        <arg choice="plain">
-          <replaceable class="parameter">pattern</replaceable>
-        </arg>
-        <arg choice="plain">
-          <replaceable class="parameter">mailbox</replaceable>
-        </arg>
-      </cmdsynopsis>
-      <para>
-        This command is used to save outgoing mail in a mailbox other than
-        <link linkend="record">$record</link>. NeoMutt searches the initial
-        list of message recipients for the first matching
-        <emphasis>pattern</emphasis> and uses <emphasis>mailbox</emphasis> as
-        the default Fcc: mailbox. If no match is found the message will be
-        saved to <link linkend="record">$record</link> mailbox.
-      </para>
-      <para>
+      </para><para>
         To provide more flexibility and good defaults, NeoMutt applies the
         expandos of <link linkend="index-format">$index_format</link> to
-        <emphasis>mailbox</emphasis> after it was expanded.
-      </para>
-      <para>
-        See <xref linkend="pattern-hook" /> for information on the exact format
-        of <emphasis>pattern</emphasis>.
-      </para>
-      <screen>fcc-hook [@.]aol\\.com$ +spammers</screen>
-      <para>
-        ...will save a copy of all messages going to the aol.com domain to the
-        `+spammers' mailbox by default. Also see the
-        <link linkend="fcc-save-hook"><command>fcc-save-hook</command></link>
-        command.
-      </para>
-    </sect1>
-
-    <sect1 id="fcc-save-hook">
-      <title>Specify Default Save Filename and Default Fcc: Mailbox at Once</title>
-      <para>
-        Usage:
-      </para>
-      <cmdsynopsis>
-        <command>fcc-save-hook</command>
-        <arg choice="plain">
-          <replaceable class="parameter">pattern</replaceable>
-        </arg>
-        <arg choice="plain">
-          <replaceable class="parameter">mailbox</replaceable>
-        </arg>
-      </cmdsynopsis>
-      <para>
-        This command is a shortcut, equivalent to doing both a
-        <link linkend="fcc-hook"><command>fcc-hook</command></link> and a
-        <link linkend="save-hook"><command>save-hook</command></link> with its
-        arguments, including %-expansion on <emphasis>mailbox</emphasis>
-        according to <link linkend="index-format">$index_format</link>.
+        <emphasis>mailbox</emphasis> after it was expanded. See
+        <xref linkend="pattern-hook" /> for information on the exact format of
+        <emphasis>pattern</emphasis>.
       </para>
     </sect1>
 
@@ -6050,21 +6021,21 @@ set spam_separator=", "
             </arg>
           </group>
           <arg choice="opt" rep="repeat"></arg>
-          <command>toggle</command>
+          <command>unset</command>
           <arg choice="plain">
             <replaceable class="parameter">variable</replaceable>
           </arg>
           <arg choice="opt" rep="repeat">
             <replaceable class="parameter">variable</replaceable>
           </arg>
-          <command>unset</command>
+          <command>reset</command>
           <arg choice="plain">
             <replaceable class="parameter">variable</replaceable>
           </arg>
           <arg choice="opt" rep="repeat">
             <replaceable class="parameter">variable</replaceable>
           </arg>
-          <command>reset</command>
+          <command>toggle</command>
           <arg choice="plain">
             <replaceable class="parameter">variable</replaceable>
           </arg>
@@ -8115,19 +8086,12 @@ set index_format="%4C %Z %{%b %d} %-15.15L (%?l?%4l&amp;%4c?)%*  %s"
             <link linkend="account-hook"><command>account-hook</command></link>
           </para>
         </listitem>
-        <listitem>
-          <para>
-            <link linkend="append-hook"><command>append-hook</command></link>
-          </para>
-        </listitem>
         <listitem>
           <para>
             <link linkend="charset-hook"><command>charset-hook</command></link>
           </para>
-        </listitem>
-        <listitem>
           <para>
-            <link linkend="close-hook"><command>close-hook</command></link>
+            <link linkend="iconv-hook"><command>iconv-hook</command></link>
           </para>
         </listitem>
         <listitem>
@@ -8137,22 +8101,18 @@ set index_format="%4C %Z %{%b %d} %-15.15L (%?l?%4l&amp;%4c?)%*  %s"
         </listitem>
         <listitem>
           <para>
-            <link linkend="fcc-hook"><command>fcc-hook</command></link>
+            <link linkend="fcc-save-hook"><command>fcc-save-hook</command></link>
           </para>
-        </listitem>
-        <listitem>
           <para>
-            <link linkend="fcc-save-hook"><command>fcc-save-hook</command></link>
+            <link linkend="fcc-hook"><command>fcc-hook</command></link>
           </para>
-        </listitem>
-        <listitem>
           <para>
-            <link linkend="folder-hook"><command>folder-hook</command></link>
+            <link linkend="save-hook"><command>save-hook</command></link>
           </para>
         </listitem>
         <listitem>
           <para>
-            <link linkend="iconv-hook"><command>iconv-hook</command></link>
+            <link linkend="folder-hook"><command>folder-hook</command></link>
           </para>
         </listitem>
         <listitem>
@@ -8169,25 +8129,38 @@ set index_format="%4C %Z %{%b %d} %-15.15L (%?l?%4l&amp;%4c?)%*  %s"
           <para>
             <link linkend="open-hook"><command>open-hook</command></link>
           </para>
+          <para>
+            <link linkend="close-hook"><command>close-hook</command></link>
+          </para>
+          <para>
+            <link linkend="append-hook"><command>append-hook</command></link>
+          </para>
         </listitem>
         <listitem>
           <para>
             <link linkend="reply-hook"><command>reply-hook</command></link>
           </para>
-        </listitem>
-        <listitem>
           <para>
-            <link linkend="save-hook"><command>save-hook</command></link>
+            <link linkend="send-hook"><command>send-hook</command></link>
+          </para>
+          <para>
+            <link linkend="send2-hook"><command>send2-hook</command></link>
           </para>
         </listitem>
         <listitem>
           <para>
-            <link linkend="send-hook"><command>send-hook</command></link>
+            <link linkend="global-hooks"><command>timeout-hook</command></link>
+          </para>
+          <para>
+            <link linkend="global-hooks"><command>startup-hook</command></link>
+          </para>
+          <para>
+            <link linkend="global-hooks"><command>shutdown-hook</command></link>
           </para>
         </listitem>
         <listitem>
           <para>
-            <link linkend="send2-hook"><command>send2-hook</command></link>
+            <link linkend="unhook"><command>unhook</command></link>
           </para>
         </listitem>
       </itemizedlist>
@@ -8506,8 +8479,9 @@ roessler@does-not-exist.org        Thomas Roessler mutt pgp
             <row>
               <entry><emphasis>@alias</emphasis></entry>
               <entry>
-                to the <link linkend="save-hook">default save folder</link> as
-                determined by the address of the alias
+                to the
+                <link linkend="default-save-mailbox">default save folder</link>
+                as determined by the address of the alias
               </entry>
             </row>
           </tbody>
@@ -16949,19 +16923,6 @@ neomutt mailto:some@one.org?subject=test&amp;cc=other@one.org
             </group>
           </cmdsynopsis>
         </listitem>
-        <listitem>
-          <cmdsynopsis>
-            <command>
-              <link linkend="append-hook">append-hook</link>
-            </command>
-            <arg choice="plain">
-              <replaceable class="parameter">regex</replaceable>
-            </arg>
-            <arg choice="plain">
-              <replaceable class="parameter">&quot;shell-command&quot;</replaceable>
-            </arg>
-          </cmdsynopsis>
-        </listitem>
         <listitem>
           <cmdsynopsis>
             <command>
@@ -17050,18 +17011,14 @@ neomutt mailto:some@one.org?subject=test&amp;cc=other@one.org
             <arg choice="plain">
               <replaceable class="parameter">charset</replaceable>
             </arg>
-          </cmdsynopsis>
-        </listitem>
-        <listitem>
-          <cmdsynopsis>
             <command>
-              <link linkend="close-hook">close-hook</link>
+              <link linkend="charset-hook">iconv-hook</link>
             </command>
             <arg choice="plain">
-              <replaceable class="parameter">regex</replaceable>
+              <replaceable class="parameter">charset</replaceable>
             </arg>
             <arg choice="plain">
-              <replaceable class="parameter">&quot;shell-command&quot;</replaceable>
+              <replaceable class="parameter">local-charset</replaceable>
             </arg>
           </cmdsynopsis>
         </listitem>
@@ -17167,7 +17124,7 @@ neomutt mailto:some@one.org?subject=test&amp;cc=other@one.org
         <listitem>
           <cmdsynopsis>
             <command>
-              <link linkend="fcc-hook">fcc-hook</link>
+              <link linkend="default-save-mailbox">fcc-save-hook</link>
             </command>
             <arg choice="plain">
               <replaceable class="parameter">pattern</replaceable>
@@ -17175,12 +17132,17 @@ neomutt mailto:some@one.org?subject=test&amp;cc=other@one.org
             <arg choice="plain">
               <replaceable class="parameter">mailbox</replaceable>
             </arg>
-          </cmdsynopsis>
-        </listitem>
-        <listitem>
-          <cmdsynopsis>
             <command>
-              <link linkend="fcc-save-hook">fcc-save-hook</link>
+              <link linkend="default-save-mailbox">fcc-hook</link>
+            </command>
+            <arg choice="plain">
+              <replaceable class="parameter">pattern</replaceable>
+            </arg>
+            <arg choice="plain">
+              <replaceable class="parameter">mailbox</replaceable>
+            </arg>
+            <command>
+              <link linkend="default-save-mailbox">save-hook</link>
             </command>
             <arg choice="plain">
               <replaceable class="parameter">pattern</replaceable>
@@ -17268,19 +17230,6 @@ neomutt mailto:some@one.org?subject=test&amp;cc=other@one.org
             </group>
           </cmdsynopsis>
         </listitem>
-        <listitem>
-          <cmdsynopsis>
-            <command>
-              <link linkend="iconv-hook">iconv-hook</link>
-            </command>
-            <arg choice="plain">
-              <replaceable class="parameter">charset</replaceable>
-            </arg>
-            <arg choice="plain">
-              <replaceable class="parameter">local-charset</replaceable>
-            </arg>
-          </cmdsynopsis>
-        </listitem>
         <listitem>
           <cmdsynopsis>
             <command>
@@ -17362,6 +17311,34 @@ neomutt mailto:some@one.org?subject=test&amp;cc=other@one.org
                 <replaceable>regex</replaceable>
               </arg>
             </group>
+            <command>
+              <link linkend="lists">subscribe</link>
+            </command>
+            <arg choice="opt" rep="repeat">
+              <option>-group</option>
+              <replaceable class="parameter">name</replaceable>
+            </arg>
+            <arg choice="plain">
+              <replaceable class="parameter">regex</replaceable>
+            </arg>
+            <arg choice="opt" rep="repeat">
+              <replaceable class="parameter">regex</replaceable>
+            </arg>
+            <command>
+              <link linkend="lists">unsubscribe</link>
+            </command>
+            <arg choice="opt" rep="repeat">
+              <option>-group</option>
+              <replaceable>name</replaceable>
+            </arg>
+            <group choice="req">
+              <arg choice="plain">
+                <replaceable class="parameter">*</replaceable>
+              </arg>
+              <arg choice="plain" rep="repeat">
+                <replaceable class="parameter">regex</replaceable>
+              </arg>
+            </group>
           </cmdsynopsis>
         </listitem>
         <listitem>
@@ -17582,6 +17559,24 @@ neomutt mailto:some@one.org?subject=test&amp;cc=other@one.org
             <arg choice="plain">
               <replaceable class="parameter">&quot;shell-command&quot;</replaceable>
             </arg>
+            <command>
+              <link linkend="close-hook">close-hook</link>
+            </command>
+            <arg choice="plain">
+              <replaceable class="parameter">regex</replaceable>
+            </arg>
+            <arg choice="plain">
+              <replaceable class="parameter">&quot;shell-command&quot;</replaceable>
+            </arg>
+            <command>
+              <link linkend="append-hook">append-hook</link>
+            </command>
+            <arg choice="plain">
+              <replaceable class="parameter">regex</replaceable>
+            </arg>
+            <arg choice="plain">
+              <replaceable class="parameter">&quot;shell-command&quot;</replaceable>
+            </arg>
           </cmdsynopsis>
         </listitem>
         <listitem>
@@ -17597,7 +17592,7 @@ neomutt mailto:some@one.org?subject=test&amp;cc=other@one.org
         <listitem>
           <cmdsynopsis>
             <command>
-              <link linkend="reply-hook">reply-hook</link>
+              <link linkend="send-hook">reply-hook</link>
             </command>
             <arg choice="plain">
               <replaceable class="parameter">pattern</replaceable>
@@ -17605,18 +17600,23 @@ neomutt mailto:some@one.org?subject=test&amp;cc=other@one.org
             <arg choice="plain">
               <replaceable class="parameter">command</replaceable>
             </arg>
-          </cmdsynopsis>
-        </listitem>
-        <listitem>
-          <cmdsynopsis>
             <command>
-              <link linkend="save-hook">save-hook</link>
+              <link linkend="send-hook">send-hook</link>
             </command>
             <arg choice="plain">
               <replaceable class="parameter">pattern</replaceable>
             </arg>
             <arg choice="plain">
-              <replaceable class="parameter">mailbox</replaceable>
+              <replaceable class="parameter">command</replaceable>
+            </arg>
+            <command>
+              <link linkend="send-hook">send2-hook</link>
+            </command>
+            <arg choice="plain">
+              <replaceable class="parameter">pattern</replaceable>
+            </arg>
+            <arg choice="plain">
+              <replaceable class="parameter">command</replaceable>
             </arg>
           </cmdsynopsis>
         </listitem>
@@ -17644,32 +17644,6 @@ neomutt mailto:some@one.org?subject=test&amp;cc=other@one.org
             </group>
           </cmdsynopsis>
         </listitem>
-        <listitem>
-          <cmdsynopsis>
-            <command>
-              <link linkend="send-hook">send-hook</link>
-            </command>
-            <arg choice="plain">
-              <replaceable class="parameter">pattern</replaceable>
-            </arg>
-            <arg choice="plain">
-              <replaceable class="parameter">command</replaceable>
-            </arg>
-          </cmdsynopsis>
-        </listitem>
-        <listitem>
-          <cmdsynopsis>
-            <command>
-              <link linkend="send2-hook">send2-hook</link>
-            </command>
-            <arg choice="plain">
-              <replaceable class="parameter">pattern</replaceable>
-            </arg>
-            <arg choice="plain">
-              <replaceable class="parameter">command</replaceable>
-            </arg>
-          </cmdsynopsis>
-        </listitem>
         <listitem>
           <cmdsynopsis>
             <command>
@@ -17699,7 +17673,7 @@ neomutt mailto:some@one.org?subject=test&amp;cc=other@one.org
             </group>
             <arg choice="opt" rep="repeat"></arg>
             <command>
-              <link linkend="set">toggle</link>
+              <link linkend="set">unset</link>
             </command>
             <arg choice="plain">
               <replaceable class="parameter">variable</replaceable>
@@ -17708,7 +17682,7 @@ neomutt mailto:some@one.org?subject=test&amp;cc=other@one.org
               <replaceable class="parameter">variable</replaceable>
             </arg>
             <command>
-              <link linkend="set">unset</link>
+              <link linkend="set">reset</link>
             </command>
             <arg choice="plain">
               <replaceable class="parameter">variable</replaceable>
@@ -17717,7 +17691,7 @@ neomutt mailto:some@one.org?subject=test&amp;cc=other@one.org
               <replaceable class="parameter">variable</replaceable>
             </arg>
             <command>
-              <link linkend="set">reset</link>
+              <link linkend="set">toggle</link>
             </command>
             <arg choice="plain">
               <replaceable class="parameter">variable</replaceable>
@@ -17833,33 +17807,23 @@ neomutt mailto:some@one.org?subject=test&amp;cc=other@one.org
         <listitem>
           <cmdsynopsis>
             <command>
-              <link linkend="subscribe">subscribe</link>
+              <link linkend="global-hooks">timeout-hook</link>
             </command>
-            <arg choice="opt" rep="repeat">
-              <option>-group</option>
-              <replaceable class="parameter">name</replaceable>
-            </arg>
             <arg choice="plain">
-              <replaceable class="parameter">regex</replaceable>
+              <replaceable class="parameter">command</replaceable>
             </arg>
-            <arg choice="opt" rep="repeat">
-              <replaceable class="parameter">regex</replaceable>
+            <command>
+              <link linkend="global-hooks">startup-hook</link>
+            </command>
+            <arg choice="plain">
+              <replaceable class="parameter">command</replaceable>
             </arg>
             <command>
-              <link linkend="subscribe">unsubscribe</link>
+              <link linkend="global-hooks">shutdown-hook</link>
             </command>
-            <arg choice="opt" rep="repeat">
-              <option>-group</option>
-              <replaceable>name</replaceable>
+            <arg choice="plain">
+              <replaceable class="parameter">command</replaceable>
             </arg>
-            <group choice="req">
-              <arg choice="plain">
-                <replaceable class="parameter">*</replaceable>
-              </arg>
-              <arg choice="plain" rep="repeat">
-                <replaceable class="parameter">regex</replaceable>
-              </arg>
-            </group>
           </cmdsynopsis>
         </listitem>
         <listitem>
@@ -17877,28 +17841,6 @@ neomutt mailto:some@one.org?subject=test&amp;cc=other@one.org
             </group>
           </cmdsynopsis>
         </listitem>
-        <listitem>
-          <cmdsynopsis>
-            <command>
-              <link linkend="global-hooks">shutdown-hook</link>
-            </command>
-            <arg choice="plain">
-              <replaceable class="parameter">command</replaceable>
-            </arg>
-            <command>
-              <link linkend="global-hooks">startup-hook</link>
-            </command>
-            <arg choice="plain">
-              <replaceable class="parameter">command</replaceable>
-            </arg>
-            <command>
-              <link linkend="global-hooks">timeout-hook</link>
-            </command>
-            <arg choice="plain">
-              <replaceable class="parameter">command</replaceable>
-            </arg>
-          </cmdsynopsis>
-        </listitem>
       </itemizedlist>
     </sect1>