diff --git a/README.md b/README.md index 45f96ad0..fc5fdb1e 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,7 @@ include_toc: true - [[tutorial 012] Conditional desactived family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_012/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_012~1..v1.1_012)) - [[tutorial 013] A sub family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_013/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_013~1..v1.1_013)) - [[tutorial 014] Family in "shorthand" mode](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_014/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_014~1..v1.1_014)) +- [[tutorial 015] Family in "shorthand" mode](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_015/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_015~1..v1.1_015)) # Description @@ -71,6 +72,11 @@ manual: params: allow_ip: true + port: + description: HTTP Port + type: port + default: 8080 + ``` ## Generated documentation @@ -79,9 +85,9 @@ foo@bar:~$ rougail -v 1.1 -m firefox/ -o doc -do github ``` ### Variables -| Variable                                                                                                    | Description                                                                                                 | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **proxy_mode**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Configure Proxy Access to the Internet.
**Choices**:
- No proxy ← (default)
- Auto-detect proxy settings for this network
- Use system proxy settings
- Manual proxy configuration
- Automatic proxy configuration URL | +| Variable                                                                                                 | Description                                                                                              | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **proxy_mode**
[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | Configure Proxy Access to the Internet.
**Choices**:
- No proxy ← (default)
- Auto-detect proxy settings for this network
- Use system proxy settings
- Manual proxy configuration
- Automatic proxy configuration URL | #### Manual proxy configuration @@ -93,9 +99,10 @@ foo@bar:~$ rougail -v 1.1 -m firefox/ -o doc -do github `basic` -| Variable                                                                                                    | Description                                                                                                 | -|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| **manual.http_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | HTTP address.
**Validator**: the domain name can be an IP | +| Variable                                                                                                 | Description                                                                                              | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **manual.http_proxy.address**
[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `basic` `mandatory` | HTTP address.
**Validator**: the domain name can be an IP | +| **manual.http_proxy.port**
[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `standard` `mandatory` | HTTP Port.
**Default**: 8080 | # User data @@ -170,7 +177,8 @@ Variables: ┣━━ 📓 proxy_mode: Manual proxy configuration (No proxy) ┗━━ 📂 manual ┗━━ 📂 http_proxy - ┗━━ 📓 address: example.net + ┣━━ 📓 address: example.net + ┗━━ 📓 port: 8080 ### Output in read write mode @@ -186,7 +194,8 @@ Variables: ┣━━ 📓 proxy_mode: Manual proxy configuration (No proxy) ┗━━ 📂 manual ┗━━ 📂 http_proxy - ┗━━ 📓 address: example.net + ┣━━ 📓 address: example.net + ┗━━ 📓 port: 8080 ## Example 4 @@ -207,9 +216,7 @@ manual: ```console foo@bar:~$ rougail -v 1.1 -m firefox -u file -ff config/04/config.yaml ``` -
🛑 ERRORS
-┗━━ unknown option "port" in optiondescription "manual.http_proxy (HTTP Proxy)"
-╭────────────────────────── Caption ──────────────────────────╮
+
╭────────────────────────── Caption ──────────────────────────╮
 │ Variable                           Default value            │
 │ Undocumented variable              Modified value           │
 │ Undocumented but modified variable (Original default value) │
@@ -218,7 +225,8 @@ Variables:
 ┣━━ 📓 proxy_mode: Manual proxy configuration (No proxy)
 ┗━━ 📂 manual
     ┗━━ 📂 http_proxy
-        ┗━━ 📓 address: example.net
+        ┣━━ 📓 address: example.net
+        ┗━━ 📓 port: 3128 (8080)
 
## Example 5 @@ -249,7 +257,6 @@ If "use_for_https" is false, HTTPS variables are visible in read only mode and i foo@bar:~$ rougail -v 1.1 -m firefox -u file -ff config/05/config.yaml ```
🛑 ERRORS
-┣━━ unknown option "port" in optiondescription "manual.http_proxy (HTTP Proxy)"
 ┣━━ unknown option "use_for_https" in optiondescription "manual (Manual proxy configuration)"
 ┗━━ unknown option "https_proxy" in optiondescription "manual (Manual proxy configuration)"
 ╭────────────────────────── Caption ──────────────────────────╮
@@ -261,5 +268,6 @@ Variables:
 ┣━━ 📓 proxy_mode: Manual proxy configuration (No proxy)
 ┗━━ 📂 manual
     ┗━━ 📂 http_proxy
-        ┗━━ 📓 address: http.proxy.net
+        ┣━━ 📓 address: http.proxy.net
+        ┗━━ 📓 port: 3128 (8080)