From b41f368d5a71f787d594880fd4ccf8425aafc79d Mon Sep 17 00:00:00 2001 From: "martin f. krafft" Date: Sun, 30 Sep 2007 18:49:23 +0100 Subject: [PATCH] add manpage --- Makefile | 13 +++ mailplate.xml | 305 ++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 318 insertions(+) create mode 100644 Makefile create mode 100644 mailplate.xml diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..14359b2 --- /dev/null +++ b/Makefile @@ -0,0 +1,13 @@ +DB2MAN=/usr/share/sgml/docbook/stylesheet/xsl/nwalsh/manpages/docbook.xsl +XP=xsltproc -''-nonet + +%.1: %.xml + $(XP) $(DB2MAN) $< + +man: mailplate.1 + man -l $< +.PHONY: man + +clean: + rm -f mailplate.1 +.PHONY: clean diff --git a/mailplate.xml b/mailplate.xml new file mode 100644 index 0000000..7e7072c --- /dev/null +++ b/mailplate.xml @@ -0,0 +1,305 @@ + +.
will be generated. You may view the +manual page with: nroff -man .
| less'. A +typical entry in a Makefile or Makefile.am is: + +DB2MAN=/usr/share/sgml/docbook/stylesheet/xsl/nwalsh/\ +manpages/docbook.xsl +XP=xsltproc -''-nonet + +manpage.1: manpage.dbk + $(XP) $(DB2MAN) $< + +The xsltproc binary is found in the xsltproc package. The +XSL files are in docbook-xsl. Please remember that if you +create the nroff version in one of the debian/rules file +targets (such as build), you will need to include xsltproc +and docbook-xsl in your Build-Depends control field. + +--> + + + Martin F."> + Krafft"> + + September 30, 2007"> + + 1"> + madduck@madduck.net"> + + MAILPLATE"> + + + Debian"> + GNU"> + GPL"> +]> + + + +
+ &dhemail; +
+ + 2007 + &dhusername; + + &dhdate; + + + &dhucpackage; + + &dhsection; + + + &dhpackage; + + reformat mail drafts according to templates + + + + &dhpackage; + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + message file + + + &dhpackage; + + + + + + + + + + + + + + + + + + + + + + + + + + + < message data + + + &dhpackage; + + + + + + + &dhpackage; + + + + + + + + DESCRIPTION + + &dhpackage; is a programme that reformats mail + drafts according to a given template. The template may be specified on + the command line, but mailplate can also use control information from + the template files to automatically select an appropriate template + (). A selection menu feature is planned + (). + + Applying a template means obtainined select data from an existing + mail message (unless is specified) and to fill it + into appropriate slots in the template. Messages are processed in three + parts: headers, body, and signature. + + When is given, an empty instantiation of the + template is written to stdout. At the moment, + cannot be combined with . + + The template can define two types of headers: mandatory and + preservatory. Mandatory headers take precedence over headers in the + existing message and thus overwrite them. Preservatory headers instruct + mailplate to port their data from the existing mail message. Headers in + the existing message but not defined in the template are dropped, unless + is given. + + Body and signature are separated by '-- '. If this sentinel is not + found, no signature is extracted. Templates can be interpolated and data + filled into slots. Helper slots are filled with the output of helper + commands (which must be defined in the configuration), environment + variable slots are just that, and mail variable slots can be filled with + data obtained by running regexps or commands over the message. + + This script can be run in multiple ways: + + + As a filter, it applies a template to data from stdin + and writes the result to stdout. + + Given a file, it modifies the file, unless it cannot + write to the file, in which case it writes to stdout. + + + When is passed, the script + spawns sensible-editor on the result. It may thus + be used as the editor for your mail user agent. + + + + + + + OPTIONS + + These programs follow the usual &gnu; command line syntax, with + long options starting with two dashes (`--'): + + + + , + + + + Turn on template auto-discovery. + + + + , + + + + Choose from a list of templates (not yet implemented) + + + + , + + + + Create a new message. + + + + , + + + + Spawn editor once template is applied. + + + + , + + + + Preserve mail headers not specified in template. + + + + , + + + + Write informational messages to stderr. + + + + , + + + + Start a debugger after initialisation. + + + + + , + + + + Show summary of options. + + + + + , + + + + Show version of program. + + + + + + + SEE ALSO + /usr/share/doc/mailplate/README + + + + AUTHOR + + This manual page was written by &dhusername; &dhemail; with help + from Carl Fürstenberg. + + + -- 2.39.2