summaryrefslogtreecommitdiffstats
path: root/specs/spf-2.0/substvars.mdwn
diff options
context:
space:
mode:
authorP. J. McDermott <pjm@nac.net>2012-10-24 18:25:21 (EDT)
committer P. J. McDermott <pjm@nac.net>2012-10-24 18:25:21 (EDT)
commitdcd17c203cbcde19ff026fc05bba7e79350165eb (patch)
tree7d28944600a30f06dc783adee91d908777b76271 /specs/spf-2.0/substvars.mdwn
parent599102d3268edc737a11c3ff4b641a8a4969b2c1 (diff)
Document substitution variables.
Diffstat (limited to 'specs/spf-2.0/substvars.mdwn')
-rw-r--r--specs/spf-2.0/substvars.mdwn19
1 files changed, 19 insertions, 0 deletions
diff --git a/specs/spf-2.0/substvars.mdwn b/specs/spf-2.0/substvars.mdwn
new file mode 100644
index 0000000..bbe2853
--- /dev/null
+++ b/specs/spf-2.0/substvars.mdwn
@@ -0,0 +1,19 @@
+Variable Names [substvars-name]
+===============================
+
+Variable names may only consist of uppercase and lowercase Latin letters,
+digits, and hyphens. Names must be at least one character long. (A regular
+expression for this is `[A-Za-z0-9-]+`.)
+
+
+Variable Substitutions [substvars-exp]
+======================================
+
+Variable substitutions are performed on certain binary control field values, as
+explained in $[sectlink][fields-bin].
+
+The format for variable substitutions is as follows:
+
+ ${<var-name>}
+
+`<var-name>` is the name of the variable.