aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorbptato <nincsnevem662@gmail.com>2025-02-15 15:38:02 +0100
committerbptato <nincsnevem662@gmail.com>2025-02-15 16:52:57 +0100
commit342a82c3a9c3acc635916834d206028914979112 (patch)
treea222ec2330c567d5a9ce244bf4f9caaacf4d370c /doc
parent5feb2c37ee8d6e914f4d31e4db6ddc3e68b24c6a (diff)
downloadchawan-342a82c3a9c3acc635916834d206028914979112.tar.gz
buffer: wait for scripts in headless mode
Dump mode remains the same, except now it can be controlled in config.toml as well.
Diffstat (limited to 'doc')
-rw-r--r--doc/config.md14
1 files changed, 11 insertions, 3 deletions
diff --git a/doc/config.md b/doc/config.md
index 7354224d..9981c712 100644
--- a/doc/config.md
+++ b/doc/config.md
@@ -92,10 +92,18 @@ do not block loading.)</td>
<tr>
<td>headless</td>
-<td>boolean</td>
+<td>boolean / "dump"</td>
<td>false</td>
-<td>Whether Chawan should always start in headless mode. Automatically
-enabled when Chawan is called with -r.</td>
+<td>When set to true or "dump", the browser does not take input;
+instead, it prints a rendered version of all buffers in order, then
+exits.<br>
+The difference between `true` and "dump" is that `true` first waits
+for all scripts and network requests to run to completion, while "dump"
+does not. This means that `true` may never exit when scripting is
+enabled (e.g. if a script sets `setInterval`.)<br>
+Piping `cha` to an external program or passing the `-d` switch has the
+same effect as passing this option.
+</td>
</tr>
<tr>