aboutsummaryrefslogtreecommitdiff
path: root/doc/ikiwiki-prefix-directives.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ikiwiki-prefix-directives.mdwn')
-rw-r--r--doc/ikiwiki-prefix-directives.mdwn26
1 files changed, 26 insertions, 0 deletions
diff --git a/doc/ikiwiki-prefix-directives.mdwn b/doc/ikiwiki-prefix-directives.mdwn
new file mode 100644
index 000000000..df4b88b1c
--- /dev/null
+++ b/doc/ikiwiki-prefix-directives.mdwn
@@ -0,0 +1,26 @@
+# NAME
+
+ikiwiki-prefix-directives - convert ikiwiki pages to prefixed directive syntax
+
+# SYNOPSIS
+
+ikiwiki-prefix-directives page.mdwn...
+
+# DESCRIPTION
+
+`ikiwiki-prefix-directives` converts an ikiwiki page from the old
+preprocessor directive syntax, requiring a space, to the new syntax,
+prefixed by '!'.
+
+Preprocessor directives which already use the new syntax will remain
+unchanged.
+
+Note that if the page contains wiki links with spaces, which some
+older versions of ikiwiki accepted, ikiwiki-prefix-directives will
+treat these as preprocessor directives and convert them.
+
+# AUTHOR
+
+Josh Triplett <josh@freedesktop.org>
+
+Warning: this page is automatically made into ikiwiki-prefix-directives's man page, edit with care