about summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorbptato <nincsnevem662@gmail.com>2025-05-13 00:31:48 +0200
committerbptato <nincsnevem662@gmail.com>2025-05-13 00:37:53 +0200
commit5223a6e86f53dd47a5de33f5e8f1fe6206174329 (patch)
treea9b4480c50dfbf6036c840dd7136056fbe81e931
parentde7ff7388f6882ec2b1def33b25656cb81d7c3cf (diff)
downloadchawan-5223a6e86f53dd47a5de33f5e8f1fe6206174329.tar.gz
Update docs
-rw-r--r--doc/api.md5
-rw-r--r--doc/cha-api.722
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.
?h=devel&id=03ba0f3e251a08587a12a340949bb2de49178af9'>03ba0f3e2 ^
92b8fac94 ^
03ba0f3e2 ^

8c0e27e8d ^


39049e151 ^
03ba0f3e2 ^





39049e151 ^
e7cdb1d69 ^
39049e151 ^

03ba0f3e2 ^

e7cdb1d69 ^

7d6500f1d ^

39049e151 ^
03ba0f3e2 ^

39049e151 ^
e65c296bc ^
39049e151 ^
03ba0f3e2 ^


39049e151 ^
03ba0f3e2 ^
eea2a6360 ^
03ba0f3e2 ^

e4081a720 ^

03ba0f3e2 ^
e6c5622aa ^
03ba0f3e2 ^


153441db1 ^
a42545ea3 ^
39049e151 ^
153441db1 ^
a42545ea3 ^
153441db1 ^




03ba0f3e2 ^

3a13706d7 ^


e7cdb1d69 ^
03ba0f3e2 ^
92b8fac94 ^
7d6500f1d ^
39049e151 ^
03ba0f3e2 ^
df1ec0939 ^
56b4e3ad9 ^

46b672a6c ^
56b4e3ad9 ^
73c6efdf6 ^
03ba0f3e2 ^
39049e151 ^
03ba0f3e2 ^
39049e151 ^
03ba0f3e2 ^

153441db1 ^
df1ec0939 ^
39049e151 ^
153441db1 ^
39049e151 ^
153441db1 ^




39049e151 ^
b234b082b ^

03ba0f3e2 ^

b234b082b ^
f7f3a25be ^

39049e151 ^
03ba0f3e2 ^


39049e151 ^
b234b082b ^
39049e151 ^
03ba0f3e2 ^
39049e151 ^


03ba0f3e2 ^
438703f59 ^
03ba0f3e2 ^
39049e151 ^
03ba0f3e2 ^
b234b082b ^
5c33f7651 ^
39049e151 ^
5c33f7651 ^
39049e151 ^







c6235920c ^

39049e151 ^
ab6f79340 ^

6ddd4e6a3 ^
4b0ba5e3f ^
39049e151 ^
6ddd4e6a3 ^

fab69661a ^
39049e151 ^
ab6f79340 ^

b234b082b ^
6ddd4e6a3 ^
39049e151 ^





1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176