aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorbptato <nincsnevem662@gmail.com>2024-11-26 20:10:56 +0100
committerbptato <nincsnevem662@gmail.com>2024-11-26 20:11:39 +0100
commit14c4a11eaaea5dfa13afb6f44ab9531a90445f36 (patch)
tree7156dc27d8d8599414b4d80da83ce3b921a67da5 /doc
parent8adbe5443a35c6e00cf7b2c4929c8fbcd72be91e (diff)
downloadchawan-14c4a11eaaea5dfa13afb6f44ab9531a90445f36.tar.gz
Update docs
Diffstat (limited to 'doc')
-rw-r--r--doc/api.md24
-rw-r--r--doc/config.md2
2 files changed, 25 insertions, 1 deletions
diff --git a/doc/api.md b/doc/api.md
index 58ba9a6d..0d2b34a7 100644
--- a/doc/api.md
+++ b/doc/api.md
@@ -71,6 +71,30 @@ SIGTSTP signal.<br>
Note: this suspends the entire process group.</td>
</tr>
+<tr>
+<td>`pager`</td>
+<td>The pager object. Implements `Pager`, as described below.</td>
+</tr>
+
+<tr>
+<td>`line`</td>
+<td>The line editor. Implements `Line`, as described below.</td>
+
+<tr>
+<td>`config`</td>
+<td>The config object.<br>
+A currently incomplete interface for retrieving and setting
+configuration options. In general, names are the same as in config.toml,
+except for `-` (ASCII hyphen) characters being replaced with `_`
+(underscore). e.g. `external.cgi-dir` can be queried as
+`config.external.cgi_dir`, etc.<br>
+Setting individual options sometimes works, but sometimes they do not
+get propagated as expected. Consider this an experimental API.<br>
+Currently, `siteconf`, `protocol` and `omnirule` values are not exposed
+to JS.<br>
+The configuration directory itself can be queried as `config.dir`.</td>
+</tr>
+
</table>
`Client` also implements various web standards normally available on the
diff --git a/doc/config.md b/doc/config.md
index 5389f4cc..f95e7da0 100644
--- a/doc/config.md
+++ b/doc/config.md
@@ -153,7 +153,7 @@ enable JavaScript with `[[siteconf]]` instead of using this setting.</td>
<tr>
<td>images</td>
<td>boolean</td>
-<td>Enable/disable experimental image support.<br>
+<td>Enable/disable inline image display.<br>
Defaults to false.</td>
</tr>