From 94ce215e583d3fb9ae907bfd0b308c51ff6d717b Mon Sep 17 00:00:00 2001
From: Reto Brunner <reto@labrat.space>
Date: Sun, 26 Apr 2020 12:33:26 +0200
Subject: add template structure to aerc-templates(7)

---
 doc/aerc-templates.7.scd | 21 +++++++++++++++++++--
 1 file changed, 19 insertions(+), 2 deletions(-)

(limited to 'doc')

diff --git a/doc/aerc-templates.7.scd b/doc/aerc-templates.7.scd
index dc3ee30..557ad10 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
 
-- 
cgit 1.4.1-2-gfad0