]> git.madduck.net Git - code/mailplate.git/blobdiff - mailplate.xml

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

projects / code / mailplate.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
hacks to make it py3 compatible
[code/mailplate.git] / mailplate.xml
diff --git a/mailplate.xml b/mailplate.xml
index b76723c8369e841358b23779c218cabc125d4a88..b59b2e281d65d7b2e71d4036e9ea96618a099a23 100644 (file)
--- a/mailplate.xml
+++ b/mailplate.xml
@@ -219,8 +219,9 @@ and docbook-xsl in your Build-Depends control field.
       parts: headers, body, and signature. </para>
 
     <para> When <option>--new</option> is given, an empty instantiation of the
       parts: headers, body, and signature. </para>
 
     <para> When <option>--new</option> is given, an empty instantiation of the
-      template is written to stdout. At the moment, <option>--new</option>
-      cannot be combined with <option>--editor</option>.</para>
+      template is written to <filename>stdout</filename>. At the moment,
+      <option>--new</option> cannot be combined with
+      <option>--editor</option>.</para>
 
     <para> The template can define two types of headers: mandatory and
       preservatory. Mandatory headers take precedence over headers in the
 
     <para> The template can define two types of headers: mandatory and
       preservatory. Mandatory headers take precedence over headers in the
@@ -239,16 +240,17 @@ and docbook-xsl in your Build-Depends control field.
     <para> This script can be run in multiple ways: </para>
 
     <itemizedlist>
     <para> This script can be run in multiple ways: </para>
 
     <itemizedlist>
-      <listitem><para> As a filter, it applies a template to data from stdin
-          and writes the result to stdout. </para></listitem>
+      <listitem><para> As a filter, it applies a template to data from
+          <filename>stdin</filename> and writes the result to
+          <filename>stdout</filename>. </para></listitem>
 
       <listitem><para> When <option>--editor</option> is passed, the script
           spawns <command>sensible-editor</command> on the result. It may thus
           be used as the editor for your mail user agent. </para></listitem>
 
       <listitem><para> Given a file, it modifies the file, unless it cannot
 
       <listitem><para> When <option>--editor</option> is passed, the script
           spawns <command>sensible-editor</command> on the result. It may thus
           be used as the editor for your mail user agent. </para></listitem>
 
       <listitem><para> Given a file, it modifies the file, unless it cannot
-          write to the file, in which case it writes to stdout.
-          </para></listitem>
+          write to the file, in which case it writes to
+          <filename>stdout</filename>. </para></listitem>
 
     </itemizedlist>
 
 
     </itemizedlist>
 
@@ -306,7 +308,7 @@ and docbook-xsl in your Build-Depends control field.
          <option>-v</option>
         </term>
         <listitem>
          <option>-v</option>
         </term>
         <listitem>
-         <para>Write informational messages to stderr.</para>
+         <para>Write informational messages to <filename>stderr</filename>.</para>
         </listitem>
       </varlistentry>
       <varlistentry>
         </listitem>
       </varlistentry>
       <varlistentry>
@@ -341,12 +343,13 @@ and docbook-xsl in your Build-Depends control field.
   <refsect1>
     <title>MUTT INTEGRATION</title>
 
   <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>
+    <para>I use mailplate as my <varname>$editor</varname> for
+      <application>mutt</application>, with the following setting in my
+      <filename>~/.mutt/muttrc</filename>:</para>
 
 
-    <!--TODO: verbatim
-    <para>set editor="~/.bin/mail/mailplate -\-edit -\-auto -\-keep-unknown"</para>
-    -->
+    <programlisting><![CDATA[
+      set editor="~/.bin/mail/mailplate --edit --auto --keep-unknown"
+    ]]></programlisting>
 
     <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
 
     <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
@@ -357,25 +360,26 @@ and docbook-xsl in your Build-Depends control field.
       pager, you probably also don’t want mailplate to get in the way. For
       these cases, I currently use the following two keybindings:</para>
 
       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>
-    -->
+    <programlisting><![CDATA[
+      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"
+      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"
+    ]]></programlisting>
 
   </refsect1>
 
   <refsect1>
     <title>VIM INTEGRATION</title>
 
 
   </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>
+    <para>I am often editing a message with <application>vim</application> and
+      find that I need to use a different identity. For this purpose, I have
+      the following keybindings in my
+      <filename>~/.vim/ftplugin/mail.vim</filename>:</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>
-    -->
+    <programlisting><![CDATA[
+      nmap <buffer> <F1>      :w<CR>:%!mailplate --keep-unknown --auto<CR>
+      nmap <buffer> <C-P><F1> :w<CR>:%!mailplate --keep-unknown private<CR>
+      nmap <buffer> <C-P><F2> :w<CR>:%!mailplate --keep-unknown debian<CR>
+    ]]></programlisting>
 
     <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
 
     <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
@@ -386,9 +390,18 @@ and docbook-xsl in your Build-Depends control field.
 
   <refsect1>
     <title>SEE ALSO</title>
 
   <refsect1>
     <title>SEE ALSO</title>
-    <!--TODO: format paths properly -->
-    <para>http://madduck.net/code/mailplate/</para>
-    <para>/usr/share/doc/mailplate/README</para>
+    <varlistentry>
+      <listitem>
+        <para>
+          <link>http://madduck.net/code/mailplate/</link>
+        </para>
+      </listitem>
+      <listitem>
+        <para>
+          <filename>/usr/share/doc/mailplate/README</filename>
+        </para>
+      </listitem>
+    </varlistentry>
   </refsect1>
 
   <refsect1>
   </refsect1>
 
   <refsect1>
reformat mail drafts according to templates

Legalese

All content available in this repository is copyright © martin f. krafft, unless otherwise noted.

All files and their content are released under the terms of the Artistic Licence 2.0, unless otherwise noted.

The operator of this repository shall not be held liable for offending content in pages linking to or linked from these page, nor does he endorse their content unless stated otherwise.