summaryrefslogtreecommitdiff
path: root/smp.1
diff options
context:
space:
mode:
authorQrius <[email protected]>2025-01-03 07:42:25 +0100
committerQrius <[email protected]>2025-01-03 07:42:25 +0100
commit2eedcdb983b9b62b497f26ea32714e84cda8e763 (patch)
tree8163f72141d6e795e802a9a93e9f2253c90b0c3d /smp.1
parentdaa2ebe4eb4394332ae3acaaa579b3cb18ea2f21 (diff)
downloadskaldpress-2eedcdb983b9b62b497f26ea32714e84cda8e763.tar.gz
skaldpress-2eedcdb983b9b62b497f26ea32714e84cda8e763.zip
Add comments about feature flags
Diffstat (limited to 'smp.1')
-rw-r--r--smp.128
1 files changed, 27 insertions, 1 deletions
diff --git a/smp.1 b/smp.1
index 913227a..91e76fd 100644
--- a/smp.1
+++ b/smp.1
@@ -9,7 +9,7 @@ Skaldpress Macro Processor \- Macro processor
smp is a macro processor, made specifically for a usecase when doing templating of websites.
-Macros
+.SS Macros
.IP "\fBinclude(<file>)\fR"
Includes a file in-place, performing macro-expansion on it.
NOTE, THERE IS NO LOOP PROTECTION HERE!
@@ -67,6 +67,32 @@ If compiled with \fBdeadlinks\fR, this macro will always return it's argument.
But it will also perform a request to the link, and emit a warning if it it doesn't return HTTP 200 OK.
This will significantly slow down compile times!
+.SS "\fBCompile-Time Feature Flags\fR"
+There are some compile-time flags that can enable/disable features, most are enabled by default,
+and exist either because they trigger a external dependency, or because they are unlikely to work without glibc.
+
+.IP "\fBreadline\fR" 2
+\fBEnabled by default\fR.
+Enables the use of libc readline in REPL mode. If not enabled, normal stdio will be used for input.
+
+.IP "\fBtime\fR" 2
+\fBEnabled by default\fR.
+Enables the \fIformat_time\fR-macro, this will compile the chrono dependency to format time.
+
+.IP "\fBmarkdown\fR" 2
+\fBEnabled by default\fR.
+Enabled the \fIhtml_from_markdown\fR-macro, this will compile the markdown dependency. And can convert markdown into html.
+
+.IP "\fBdeadlinks\fR" 2
+\fBEnabled by default\fR.
+Enabled the \fIwodl\fR-macro, this will compile the minreq dependency.
+Allows testing the return code of links, and warns when the request is unsuccessful.
+
+.IP "\fBguile\fR" 2
+If compiled with guile, the macro processor supports running guile-code inline.
+This is enabled with \fI%()%\fR in the input, and anything inside the parantheses will be evaluated as guile.
+
+\fBExperimental feature!\fR
.SH OPTIONS
If a input file is provided, that will be processed.
If not, a sort of interactive REPL will be started instead.