doc

txthinking · txthinking · commit e4075ca8a797 · 2023-05-14T13:22:39.000+08:00
diff --git a/README.md b/README.md
@@ -71,7 +71,6 @@ Table of Contents
    * [Configuration Introduction](#configuration-introduction)
    * [Programmable](#programmable)
       * [Introduction to incoming variables](#introduction-to-incoming-variables)
-      * [in_guiconfig](#in_guiconfig)
       * [in_dnsquery](#in_dnsquery)
       * [in_address](#in_address)
       * [in_httprequest](#in_httprequest)
@@ -92,7 +91,6 @@ Table of Contents
    * [配置介绍](#配置介绍)
    * [Programmable](#programmable-1)
       * [传入变量介绍](#传入变量介绍)
-      * [in_guiconfig](#in_guiconfig-1)
       * [in_dnsquery](#in_dnsquery-1)
       * [in_address](#in_address-1)
       * [in_httprequest](#in_httprequest-1)
@@ -1046,31 +1044,11 @@ Take full control of your own network
 
 | variable                       | type | condition   | timing                            | description                                       | out type |
 | ------------------------------ | ---- | ----------- | --------------------------------- | ------------------------------------------------- | -------- |
-| in_guiconfig                   | map  | /           | before connected                  | to override GUI configuration                     | map      |
 | in_dnsquery                    | map  | FakeDNS: On | When a DNS query occurs           | Script can decide how to handle this request      | map      |
 | in_address                     | map  | /           | When connecting to an address     | script can decide how to connect                  | map      |
 | in_httprequest                 | map  | /           | When an HTTP(S) request comes in  | the script can decide how to handle this request  | map      |
 | in_httprequest,in_httpresponse | map  | /           | when an HTTP(S) response comes in | the script can decide how to handle this response | map      |
 
-### in_guiconfig
-
-| Key | Type | Description                                       |
-| --- | ---- | ------------------------------------------------- |
-| \_  | bool | For future compatibility, this key can be ignored |
-
-`out`, if it is `error` type will be recorded in the log. Ignored if not of type `map`, if it is `map` then explicitly specify each configuration item.
-
-| Key        | Type   | Description       |
-| ---------- | ------ | ----------------- |
-| systemdns4 | string | System DNS v4     |
-| systemdns6 | string | System DNS v6     |
-| fakedns    | bool   | Fake DNS switch   |
-| block      | bool   | GUI Block switch  |
-| bypass     | bool   | GUI Bypass switch |
-| bypassdns4 | string | Bypass DNS v4     |
-| bypassdns6 | string | Bypass DNS v6     |
-| hosts      | bool   | GUI Hosts switch  |
-
 ### in_dnsquery
 
 | Key    | Type   | Description | Example    |
@@ -1325,31 +1303,11 @@ Brook GUI 会在不同时机向脚本传入不同的全局变量，脚本只需
 
 | 变量                           | 类型 | 条件          | 时机                   | 描述                       | out 类型 |
 | ------------------------------ | ---- | ------------- | ---------------------- | -------------------------- | -------- |
-| in_guiconfig                   | map  | /             | 开启之前               | 用以覆盖 GUI 的配置        | map      |
 | in_dnsquery                    | map  | FakeDNS: 开启 | 当 DNS 查询发生时      | 脚本可以决定如何处理此请求 | map      |
 | in_address                     | map  | /             | 当要连接某地址时       | 脚本可以决定如何进行连接   | map      |
 | in_httprequest                 | map  | /             | 当有 HTTP(S)请求传入时 | 脚本可以决定如何处理此请求 | map      |
 | in_httprequest,in_httpresponse | map  | /             | 当有 HTTP(S)响应传入时 | 脚本可以决定如何处理此响应 | map      |
 
-### in_guiconfig
-
-| Key | 类型 | 描述                     |
-| --- | ---- | ------------------------ |
-| \_  | bool | 向未来兼容，可忽略此 key |
-
-`out`, 如果是 `error` 类型会被记录在日志。如果不是 `map` 类型则会被忽略, 如果是`map`那么明确指定每一个配置项
-
-| Key        | 类型   | 描述            |
-| ---------- | ------ | --------------- |
-| systemdns4 | string | System DNS v4   |
-| systemdns6 | string | System DNS v6   |
-| fakedns    | bool   | Fake DNS 开关   |
-| block      | bool   | GUI Block 开关  |
-| bypass     | bool   | GUI Bypass 开关 |
-| bypassdns4 | string | Bypass DNS v4   |
-| bypassdns6 | string | Bypass DNS v6   |
-| hosts      | bool   | GUI Hosts 开关  |
-
 ### in_dnsquery
 
 | Key    | 类型   | 描述     | 示例       |
diff --git a/docs/gui-zh.md b/docs/gui-zh.md
@@ -82,31 +82,11 @@ Brook GUI 会在不同时机向脚本传入不同的全局变量，脚本只需
 
 | 变量                           | 类型 | 条件          | 时机                   | 描述                       | out 类型 |
 | ------------------------------ | ---- | ------------- | ---------------------- | -------------------------- | -------- |
-| in_guiconfig                   | map  | /             | 开启之前               | 用以覆盖 GUI 的配置        | map      |
 | in_dnsquery                    | map  | FakeDNS: 开启 | 当 DNS 查询发生时      | 脚本可以决定如何处理此请求 | map      |
 | in_address                     | map  | /             | 当要连接某地址时       | 脚本可以决定如何进行连接   | map      |
 | in_httprequest                 | map  | /             | 当有 HTTP(S)请求传入时 | 脚本可以决定如何处理此请求 | map      |
 | in_httprequest,in_httpresponse | map  | /             | 当有 HTTP(S)响应传入时 | 脚本可以决定如何处理此响应 | map      |
 
-### in_guiconfig
-
-| Key | 类型 | 描述                     |
-| --- | ---- | ------------------------ |
-| \_  | bool | 向未来兼容，可忽略此 key |
-
-`out`, 如果是 `error` 类型会被记录在日志。如果不是 `map` 类型则会被忽略, 如果是`map`那么明确指定每一个配置项
-
-| Key        | 类型   | 描述            |
-| ---------- | ------ | --------------- |
-| systemdns4 | string | System DNS v4   |
-| systemdns6 | string | System DNS v6   |
-| fakedns    | bool   | Fake DNS 开关   |
-| block      | bool   | GUI Block 开关  |
-| bypass     | bool   | GUI Bypass 开关 |
-| bypassdns4 | string | Bypass DNS v4   |
-| bypassdns6 | string | Bypass DNS v6   |
-| hosts      | bool   | GUI Hosts 开关  |
-
 ### in_dnsquery
 
 | Key    | 类型   | 描述     | 示例       |
diff --git a/docs/gui.md b/docs/gui.md
@@ -82,31 +82,11 @@ Take full control of your own network
 
 | variable                       | type | condition   | timing                            | description                                       | out type |
 | ------------------------------ | ---- | ----------- | --------------------------------- | ------------------------------------------------- | -------- |
-| in_guiconfig                   | map  | /           | before connected                  | to override GUI configuration                     | map      |
 | in_dnsquery                    | map  | FakeDNS: On | When a DNS query occurs           | Script can decide how to handle this request      | map      |
 | in_address                     | map  | /           | When connecting to an address     | script can decide how to connect                  | map      |
 | in_httprequest                 | map  | /           | When an HTTP(S) request comes in  | the script can decide how to handle this request  | map      |
 | in_httprequest,in_httpresponse | map  | /           | when an HTTP(S) response comes in | the script can decide how to handle this response | map      |
 
-### in_guiconfig
-
-| Key | Type | Description                                       |
-| --- | ---- | ------------------------------------------------- |
-| \_  | bool | For future compatibility, this key can be ignored |
-
-`out`, if it is `error` type will be recorded in the log. Ignored if not of type `map`, if it is `map` then explicitly specify each configuration item.
-
-| Key        | Type   | Description       |
-| ---------- | ------ | ----------------- |
-| systemdns4 | string | System DNS v4     |
-| systemdns6 | string | System DNS v6     |
-| fakedns    | bool   | Fake DNS switch   |
-| block      | bool   | GUI Block switch  |
-| bypass     | bool   | GUI Bypass switch |
-| bypassdns4 | string | Bypass DNS v4     |
-| bypassdns6 | string | Bypass DNS v6     |
-| hosts      | bool   | GUI Hosts switch  |
-
 ### in_dnsquery
 
 | Key    | Type   | Description | Example    |
diff --git a/docs/index.html b/docs/index.html
@@ -1200,7 +1200,6 @@
 <li><a href="#configuration-introduction" rel="nofollow">Configuration Introduction</a></li>
 <li><a href="#programmable" rel="nofollow">Programmable</a></li>
 <li><a href="#introduction-to-incoming-variables" rel="nofollow">Introduction to incoming variables</a></li>
-<li><a href="#in-guiconfig" rel="nofollow">in_guiconfig</a></li>
 <li><a href="#in-dnsquery" rel="nofollow">in_dnsquery</a></li>
 <li><a href="#in-address" rel="nofollow">in_address</a></li>
 <li><a href="#in-httprequest" rel="nofollow">in_httprequest</a></li>
@@ -1224,7 +1223,6 @@
 <li><a href="#%E9%85%8D%E7%BD%AE%E4%BB%8B%E7%BB%8D" rel="nofollow">配置介绍</a></li>
 <li><a href="#programmable-1" rel="nofollow">Programmable</a></li>
 <li><a href="#%E4%BC%A0%E5%85%A5%E5%8F%98%E9%87%8F%E4%BB%8B%E7%BB%8D" rel="nofollow">传入变量介绍</a></li>
-<li><a href="#in-guiconfig-1" rel="nofollow">in_guiconfig</a></li>
 <li><a href="#in-dnsquery-1" rel="nofollow">in_dnsquery</a></li>
 <li><a href="#in-address-1" rel="nofollow">in_address</a></li>
 <li><a href="#in-httprequest-1" rel="nofollow">in_httprequest</a></li>
@@ -1346,7 +1344,6 @@ <h1><a name="brook" class="anchor" href="#brook" rel="nofollow" aria-hidden="tru
 <li><a href="#configuration-introduction" rel="nofollow">Configuration Introduction</a></li>
 <li><a href="#programmable" rel="nofollow">Programmable</a></li>
 <li><a href="#introduction-to-incoming-variables" rel="nofollow">Introduction to incoming variables</a></li>
-<li><a href="#in-guiconfig" rel="nofollow">in_guiconfig</a></li>
 <li><a href="#in-dnsquery" rel="nofollow">in_dnsquery</a></li>
 <li><a href="#in-address" rel="nofollow">in_address</a></li>
 <li><a href="#in-httprequest" rel="nofollow">in_httprequest</a></li>
@@ -1370,7 +1367,6 @@ <h1><a name="brook" class="anchor" href="#brook" rel="nofollow" aria-hidden="tru
 <li><a href="#%E9%85%8D%E7%BD%AE%E4%BB%8B%E7%BB%8D" rel="nofollow">配置介绍</a></li>
 <li><a href="#programmable-1" rel="nofollow">Programmable</a></li>
 <li><a href="#%E4%BC%A0%E5%85%A5%E5%8F%98%E9%87%8F%E4%BB%8B%E7%BB%8D" rel="nofollow">传入变量介绍</a></li>
-<li><a href="#in-guiconfig-1" rel="nofollow">in_guiconfig</a></li>
 <li><a href="#in-dnsquery-1" rel="nofollow">in_dnsquery</a></li>
 <li><a href="#in-address-1" rel="nofollow">in_address</a></li>
 <li><a href="#in-httprequest-1" rel="nofollow">in_httprequest</a></li>
@@ -2531,15 +2527,6 @@ <h3><a name="introduction-to-incoming-variables" class="anchor" href="#introduct
 </thead>
 
 <tbody>
-<tr>
-<td>in_guiconfig</td>
-<td>map</td>
-<td>/</td>
-<td>before connected</td>
-<td>to override GUI configuration</td>
-<td>map</td>
-</tr>
-
 <tr>
 <td>in_dnsquery</td>
 <td>map</td>
@@ -2577,88 +2564,6 @@ <h3><a name="introduction-to-incoming-variables" class="anchor" href="#introduct
 </tr>
 </tbody>
 </table>
-<h3><a name="in-guiconfig" class="anchor" href="#in-guiconfig" rel="nofollow" aria-hidden="true"><span class="octicon octicon-link"></span></a>
-in_guiconfig</h3>
-
-<table>
-<thead>
-<tr>
-<th>Key</th>
-<th>Type</th>
-<th>Description</th>
-</tr>
-</thead>
-
-<tbody>
-<tr>
-<td>_</td>
-<td>bool</td>
-<td>For future compatibility, this key can be ignored</td>
-</tr>
-</tbody>
-</table>
-
-<p><code>out</code>, if it is <code>error</code> type will be recorded in the log. Ignored if not of type <code>map</code>, if it is <code>map</code> then explicitly specify each configuration item.</p>
-
-<table>
-<thead>
-<tr>
-<th>Key</th>
-<th>Type</th>
-<th>Description</th>
-</tr>
-</thead>
-
-<tbody>
-<tr>
-<td>systemdns4</td>
-<td>string</td>
-<td>System DNS v4</td>
-</tr>
-
-<tr>
-<td>systemdns6</td>
-<td>string</td>
-<td>System DNS v6</td>
-</tr>
-
-<tr>
-<td>fakedns</td>
-<td>bool</td>
-<td>Fake DNS switch</td>
-</tr>
-
-<tr>
-<td>block</td>
-<td>bool</td>
-<td>GUI Block switch</td>
-</tr>
-
-<tr>
-<td>bypass</td>
-<td>bool</td>
-<td>GUI Bypass switch</td>
-</tr>
-
-<tr>
-<td>bypassdns4</td>
-<td>string</td>
-<td>Bypass DNS v4</td>
-</tr>
-
-<tr>
-<td>bypassdns6</td>
-<td>string</td>
-<td>Bypass DNS v6</td>
-</tr>
-
-<tr>
-<td>hosts</td>
-<td>bool</td>
-<td>GUI Hosts switch</td>
-</tr>
-</tbody>
-</table>
 <h3><a name="in-dnsquery" class="anchor" href="#in-dnsquery" rel="nofollow" aria-hidden="true"><span class="octicon octicon-link"></span></a>
 in_dnsquery</h3>
 
@@ -3346,15 +3251,6 @@ <h3><a name="传入变量介绍" class="anchor" href="#%E4%BC%A0%E5%85%A5%E5%8F%
 </thead>
 
 <tbody>
-<tr>
-<td>in_guiconfig</td>
-<td>map</td>
-<td>/</td>
-<td>开启之前</td>
-<td>用以覆盖 GUI 的配置</td>
-<td>map</td>
-</tr>
-
 <tr>
 <td>in_dnsquery</td>
 <td>map</td>
@@ -3392,88 +3288,6 @@ <h3><a name="传入变量介绍" class="anchor" href="#%E4%BC%A0%E5%85%A5%E5%8F%
 </tr>
 </tbody>
 </table>
-<h3><a name="in-guiconfig" class="anchor" href="#in-guiconfig" rel="nofollow" aria-hidden="true"><span class="octicon octicon-link"></span></a>
-in_guiconfig</h3>
-
-<table>
-<thead>
-<tr>
-<th>Key</th>
-<th>类型</th>
-<th>描述</th>
-</tr>
-</thead>
-
-<tbody>
-<tr>
-<td>_</td>
-<td>bool</td>
-<td>向未来兼容，可忽略此 key</td>
-</tr>
-</tbody>
-</table>
-
-<p><code>out</code>, 如果是 <code>error</code> 类型会被记录在日志。如果不是 <code>map</code> 类型则会被忽略, 如果是<code>map</code>那么明确指定每一个配置项</p>
-
-<table>
-<thead>
-<tr>
-<th>Key</th>
-<th>类型</th>
-<th>描述</th>
-</tr>
-</thead>
-
-<tbody>
-<tr>
-<td>systemdns4</td>
-<td>string</td>
-<td>System DNS v4</td>
-</tr>
-
-<tr>
-<td>systemdns6</td>
-<td>string</td>
-<td>System DNS v6</td>
-</tr>
-
-<tr>
-<td>fakedns</td>
-<td>bool</td>
-<td>Fake DNS 开关</td>
-</tr>
-
-<tr>
-<td>block</td>
-<td>bool</td>
-<td>GUI Block 开关</td>
-</tr>
-
-<tr>
-<td>bypass</td>
-<td>bool</td>
-<td>GUI Bypass 开关</td>
-</tr>
-
-<tr>
-<td>bypassdns4</td>
-<td>string</td>
-<td>Bypass DNS v4</td>
-</tr>
-
-<tr>
-<td>bypassdns6</td>
-<td>string</td>
-<td>Bypass DNS v6</td>
-</tr>
-
-<tr>
-<td>hosts</td>
-<td>bool</td>
-<td>GUI Hosts 开关</td>
-</tr>
-</tbody>
-</table>
 <h3><a name="in-dnsquery" class="anchor" href="#in-dnsquery" rel="nofollow" aria-hidden="true"><span class="octicon octicon-link"></span></a>
 in_dnsquery</h3>
 
