aboutsummaryrefslogtreecommitdiffstats
path: root/doc/aerc-templates.7.scd
diff options
context:
space:
mode:
authorReto Brunner <reto@labrat.space>2020-04-26 12:33:26 +0200
committerReto Brunner <reto@labrat.space>2020-04-26 12:44:48 +0200
commit94ce215e583d3fb9ae907bfd0b308c51ff6d717b (patch)
tree9bc6c4215e6c38e45f97ed28045d4d33d8133558 /doc/aerc-templates.7.scd
parent2632a1a8ad035667a96a47a56ecc92cbc9233850 (diff)
downloadaerc-94ce215e583d3fb9ae907bfd0b308c51ff6d717b.tar.gz
add template structure to aerc-templates(7)
Diffstat (limited to 'doc/aerc-templates.7.scd')
-rw-r--r--doc/aerc-templates.7.scd21
1 files changed, 19 insertions, 2 deletions
diff --git a/doc/aerc-templates.7.scd b/doc/aerc-templates.7.scd
index dc3ee306..557ad102 100644
--- a/doc/aerc-templates.7.scd
+++ b/doc/aerc-templates.7.scd
@@ -6,8 +6,25 @@ aerc-templates - template file specification for *aerc*(1)
# SYNOPSIS
-aerc uses the go "text/template" package for the template parsing
-which supports basic go lang operations.
+aerc uses the go "text/template" package for the template parsing.
+Refer to the go documentation for the general syntax.
+
+Template files are composed of headers, followed by a newline, followed by the
+body text.
+
+Example:
+
+```
+X-Clacks-Overhead: GNU Terry Pratchett
+
+Hello,
+
+Greetings,
+Chuck
+```
+
+If you have a template that doesn't add any header, it *must* be preceded by a
+newline, to avoid parsing parts of the body as header text.
# MESSAGE DATA