X-Git-Url: https://git.madduck.net/code/mailplate.git/blobdiff_plain/872a6c420ffb2a831287b00dfd991cbeebe233a7..2e14575539d313d75020defedcdb115b8792e1c0:/mailplate.xml

diff --git a/mailplate.xml b/mailplate.xml
index 992714f..b76723c 100644
--- a/mailplate.xml
+++ b/mailplate.xml
@@ -97,6 +97,23 @@ and docbook-xsl in your Build-Depends control field.
       <arg choice="plain"><replaceable>template-name</replaceable></arg>
       <arg choice="plain"><replaceable>message-file</replaceable></arg>
     </cmdsynopsis>
+    <cmdsynopsis>
+      <command>&dhpackage;</command>
+      <group>
+	<arg choice="plain"><option>--keep-unknown</option></arg>
+	<arg choice="plain"><option>-k</option></arg>
+      </group>
+      <group>
+	<arg choice="plain"><option>--verbose</option></arg>
+	<arg choice="plain"><option>-v</option></arg>
+      </group>
+      <group>
+	<arg choice="plain"><option>--debug</option></arg>
+	<arg choice="plain"><option>-d</option></arg>
+      </group>
+      <arg choice="plain"><replaceable>template-name</replaceable></arg>
+      <arg choice="plain">&lt; <replaceable>message-data</replaceable></arg>
+    </cmdsynopsis>
     <cmdsynopsis>
       <command>&dhpackage;</command>
       <group>
@@ -321,8 +338,55 @@ and docbook-xsl in your Build-Depends control field.
     </variablelist>
   </refsect1>
 
+  <refsect1>
+    <title>MUTT INTEGRATION</title>
+
+    <para>I use mailplate as my <!--TODO: verbatim-->$editor for mutt, with the following setting
+      in my ~/.mutt/muttrc:</para>
+
+    <!--TODO: verbatim
+    <para>set editor="~/.bin/mail/mailplate -\-edit -\-auto -\-keep-unknown"</para>
+    -->
+
+    <para>mailplate currently has a bit of a limitation, or at least I have
+      not figured out a way how to work around it sensibly yet. If you re-edit
+      a message from mutt’s compose menu, it causes mailplate to reprocess the
+      message, which you may not want.</para>
+
+    <para>Similarly, if you find yourself editing messages from the index or
+      pager, you probably also don’t want mailplate to get in the way. For
+      these cases, I currently use the following two keybindings:</para>
+
+    <!--TODO: verbatim
+    <para>macro compose     e ':set my_editor="$editor"<enter>:set editor=sensible-editor<enter><edit-headers>:set editor="$my_editor"<enter>' "invoke normal editor to edit message"</para>
+    <para>macro index,pager e ':set my_editor="$editor"<enter>:set editor=sensible-editor<enter><edit>:set editor="$my_editor"<enter>' "invoke normal editor to edit message"</para>
+    -->
+
+  </refsect1>
+
+  <refsect1>
+    <title>VIM INTEGRATION</title>
+
+    <para>I am often editing a message with vim and find that I need to use
+      a different identity. For this purpose, I have the following keybindings
+      in my ~/.vimrc:</para>
+
+    <!--TODO: verbatim
+    <para>nmap <buffer> <F1>      :w<CR>:%!mailplate -\-keep-unknown -\-auto<CR></para>
+    <para>nmap <buffer> <C-P><F1> :w<CR>:%!mailplate -\-keep-unknown private<CR></para>
+    <para>nmap <buffer> <C-P><F2> :w<CR>:%!mailplate -\-keep-unknown debian<CR></para>
+    -->
+
+    <para>Now when I reply to a message, mailplate automatically choses the
+      right template, and if I later change my mind, I can press C-p, to
+      override the choice and select the private template, or just hit to have
+      it re-run the auto-detection.</para>
+
+  </refsect1>
+
   <refsect1>
     <title>SEE ALSO</title>
+    <!--TODO: format paths properly -->
     <para>http://madduck.net/code/mailplate/</para>
     <para>/usr/share/doc/mailplate/README</para>
   </refsect1>