diff options
| -rw-r--r-- | doc/api.md | 5 | ||||
| -rw-r--r-- | doc/cha-api.7 | 22 |
2 files changed, 24 insertions, 3 deletions
diff --git a/doc/api.md b/doc/api.md index 6eb0dd77..3eb30ca1 100644 --- a/doc/api.md +++ b/doc/api.md @@ -109,6 +109,7 @@ size exceeded an OS-specified limit.) <tr> <td>`line`</td> <td>The line editor. Implements `LineEdit`, as described below.</td> +</tr> <tr> <td>`config`</td> @@ -116,7 +117,7 @@ size exceeded an OS-specified limit.) A currently incomplete interface for retrieving and setting configuration options. In general, names are the same as in config.toml, except all `-` (ASCII hyphen) characters are stripped and the next -character is upper-cased (underscore). e.g. `external.cgi-dir` can be +character is upper-cased. e.g. `external.cgi-dir` can be queried as `config.external.cgiDir`, etc.<br> Setting individual options sometimes works, but sometimes they do not get propagated as expected. Consider this an experimental API.<br> @@ -297,7 +298,7 @@ this using the `env` option.<br> `options.suspend` suspends the pager while the command is being executed, and `options.wait` makes it so the user must press a key before the pager is resumed.<br> -Returns true if the command exit successfully, false otherwise.<br> +Returns true if the command exited successfully, false otherwise.<br> Warning: this has a bug where the output is written to stdout even if suspend is true. Redirect to /dev/null in the command if this is not desired. (This will be fixed in the future.)</td> diff --git a/doc/cha-api.7 b/doc/cha-api.7 index 777720a6..2f446065 100644 --- a/doc/cha-api.7 +++ b/doc/cha-api.7 @@ -127,7 +127,27 @@ T}@T{ The line editor. Implements \f[CR]LineEdit\f[R], as described below. T}@T{ +T} +_ +T{ \f[CR]config\f[R] +T}@T{ +The config object. +A currently incomplete interface for retrieving and setting +configuration options. +In general, names are the same as in config.toml, except all +\f[CR]\-\f[R] (ASCII hyphen) characters are stripped and the next +character is upper\-cased. +e.g.\ \f[CR]external.cgi\-dir\f[R] can be queried as +\f[CR]config.external.cgiDir\f[R], etc. +Setting individual options sometimes works, but sometimes they do not +get propagated as expected. +Consider this an experimental API. +Currently, \f[CR]siteconf\f[R], \f[CR]protocol\f[R] and +\f[CR]omnirule\f[R] values are not exposed to JS. +The configuration directory itself can be queried as +\f[CR]config.dir\f[R]. +T}@T{ T} .TE .PP @@ -350,7 +370,7 @@ variables are set; change this using the \f[CR]env\f[R] option. \f[CR]options.suspend\f[R] suspends the pager while the command is being executed, and \f[CR]options.wait\f[R] makes it so the user must press a key before the pager is resumed. -Returns true if the command exit successfully, false otherwise. +Returns true if the command exited successfully, false otherwise. Warning: this has a bug where the output is written to stdout even if suspend is true. Redirect to /dev/null in the command if this is not desired. |