stove/rougail-tutorials
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

[tutorial v1.1_041)] An hidden family (config and doc)

Browse source
This commit is contained in:
egarette@silique.fr 2025-11-07 06:16:21 +01:00
parent 8a955d765c
commit af71f89ce0
14 changed files with 69 additions and 236 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

192
README.md
View file

@ -1,9 +1,9 @@
- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md) - [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
- [[tutorial v1.1_030] A disabled family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_030/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_030~1..v1.1_030)) - [[tutorial v1.1_031] A conditional disabled family with a variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_031/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_031~1..v1.1_031))
# [tutorial v1.1_031)] A conditional disabled family with a variable # [tutorial v1.1_041)] An hidden family
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_031~1..v1.1_031) [View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_041~1..v1.1_041)
## Screenshot ## Screenshot
@ -76,7 +76,9 @@ manual:
use_for_https: true # Also use this proxy for HTTPS use_for_https: true # Also use this proxy for HTTPS
https_proxy: # HTTPS Proxy https_proxy:
description: HTTPS Proxy
hidden: true
address: address:
description: HTTPS address description: HTTPS address
@ -94,7 +96,7 @@ manual:
### Let's generate the documentation ### Let's generate the documentation
```console ```console
foo@bar:~$ git switch --detach v1.1_031 foo@bar:~$ git switch --detach v1.1_041
foo@bar:~$ rougail -m firefox/ -o doc foo@bar:~$ rougail -m firefox/ -o doc
``` ```
| Variable                                                                                        | Description                                                                                     | | Variable                                                                                        | Description                                                                                     |
@ -124,34 +126,17 @@ foo@bar:~$ rougail -m firefox/ -o doc
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **manual.use_for_https**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Also use this proxy for HTTPS.<br/>**Default**: true | | **manual.use_for_https**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Also use this proxy for HTTPS.<br/>**Default**: true |
##### HTTPS Proxy
**manual.https_proxy**
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **manual.https_proxy.address**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS address.<br/>**Validator**: the domain name can be an IP |
| **manual.https_proxy.port**<br/>[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS Port.<br/>**Validators**: <br/>- well-known ports (1 to 1023) are allowed<br/>- registred ports (1024 to 49151) are allowed<br/>- private ports (greater than 49152) are allowed<br/>**Default**: 8080 |
### Let's generate the changelog ### Let's generate the changelog
```console ```console
foo@bar:~$ git switch --detach v1.1_031 foo@bar:~$ git switch --detach v1.1_041
foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog
``` ```
#### New variables #### Deleted variables
| Variable&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; | Description&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **manual.http_proxy.address**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP address.<br/>**Validator**: the domain name can be an IP |
| **manual.http_proxy.port**<br/>[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTP Port.<br/>**Validators**: <br/>- well-known ports (1 to 1023) are allowed<br/>- registred ports (1024 to 49151) are allowed<br/>- private ports (greater than 49152) are allowed<br/>**Default**: 8080 |
| **manual.use_for_https**<br/>[`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Also use this proxy for HTTPS.<br/>**Default**: true |
| **manual.https_proxy.address**<br/>[`domainname`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS address.<br/>**Validator**: the domain name can be an IP |
| **manual.https_proxy.port**<br/>[`port`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | HTTPS Port.<br/>**Validators**: <br/>- well-known ports (1 to 1023) are allowed<br/>- registred ports (1024 to 49151) are allowed<br/>- private ports (greater than 49152) are allowed<br/>**Default**: 8080 |
- manual.https_proxy.address
- manual.https_proxy.port
## User datas ## User datas
### Example 1 ### Example 1
@ -166,7 +151,7 @@ foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog
#### Output #### Output
```console ```console
foo@bar:~$ git switch --detach v1.1_031 foo@bar:~$ git switch --detach v1.1_041
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml
``` ```
<pre>╭─────── Caption ────────╮ <pre>╭─────── Caption ────────╮
@ -175,18 +160,6 @@ foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml
Variables: Variables:
<span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: <span style="color: #ffd700">No proxy</span> <span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: <span style="color: #ffd700">No proxy</span>
</pre> </pre>
#### Output in read write mode
```console
foo@bar:~$ git switch --detach v1.1_031
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml --cli.read_write
```
<pre>╭─────── Caption ────────╮
│ Variable <span style="color: #ffd700">Default value</span> │
╰────────────────────────╯
Variables:
<span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: <span style="color: #ffd700">No proxy</span>
</pre>
### Example 2 ### Example 2
#### config/02/config.yaml #### config/02/config.yaml
@ -194,36 +167,21 @@ Variables:
```yml ```yml
--- ---
proxy_mode: Manual proxy configuration proxy_mode: No proxy
``` ```
#### Output #### Output
```console ```console
foo@bar:~$ git switch --detach v1.1_031 foo@bar:~$ git switch --detach v1.1_041
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/config.yaml foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/config.yaml
``` ```
<pre><span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span> <pre>╭────────────── Caption ───────────────╮
<span style="color: #ff0000">┗━━ </span>The following variables are mandatory but have no value: │ Variable Modified value │
<span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>Manual proxy configuration │ (<span style="color: #00aa00">⏳ Original default value</span>) │
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┣━━ </span>HTTP Proxy ╰──────────────────────────────────────╯
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┃ </span><span style="color: #ff0000">┗━━ </span>HTTP address Variables:
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTPS Proxy <span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: No proxy ◀ loaded from the YAML file "config/02/config.yaml" (⏳ <span style="color: #00aa00">No proxy</span>)
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTPS address
</pre>
#### Output in read write mode
```console
foo@bar:~$ git switch --detach v1.1_031
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/config.yaml --cli.read_write
```
<pre><span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span>
<span style="color: #ff0000">┗━━ </span>The following variables are mandatory but have no value:
<span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>Manual proxy configuration
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┣━━ </span>HTTP Proxy
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┃ </span><span style="color: #ff0000">┗━━ </span>HTTP address
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTPS Proxy
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTPS address
</pre> </pre>
### Example 3 ### Example 3
@ -233,34 +191,19 @@ foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/config.yaml --cli.read_writ
```yml ```yml
--- ---
proxy_mode: Manual proxy configuration proxy_mode: Manual proxy configuration
manual:
http_proxy:
address: example.net
``` ```
#### Output #### Output
```console ```console
foo@bar:~$ git switch --detach v1.1_031 foo@bar:~$ git switch --detach v1.1_041
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/03/config.yaml foo@bar:~$ rougail -m firefox/ -u yaml -ff config/03/config.yaml
``` ```
<pre><span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span> <pre><span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span>
<span style="color: #ff0000">┗━━ </span>The following variables are mandatory but have no value: <span style="color: #ff0000">┗━━ </span>The following variables are mandatory but have no value:
<span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>Manual proxy configuration <span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>Manual proxy configuration
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTPS Proxy <span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTP Proxy
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTPS address <span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTP address
</pre>
#### Output in read write mode
```console
foo@bar:~$ git switch --detach v1.1_031
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/03/config.yaml --cli.read_write
```
<pre><span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span>
<span style="color: #ff0000">┗━━ </span>The following variables are mandatory but have no value:
<span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>Manual proxy configuration
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTPS Proxy
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTPS address
</pre> </pre>
### Example 4 ### Example 4
@ -269,36 +212,23 @@ foo@bar:~$ rougail -m firefox/ -u yaml -ff config/03/config.yaml --cli.read_writ
```yml ```yml
--- ---
proxy_mode: Manual proxy configuration proxy_mode: foo
manual:
http_proxy:
address: example.net
port: '3128'
``` ```
#### Output #### Output
```console ```console
foo@bar:~$ git switch --detach v1.1_031 foo@bar:~$ git switch --detach v1.1_041
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/04/config.yaml foo@bar:~$ rougail -m firefox/ -u yaml -ff config/04/config.yaml
``` ```
<pre><span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span> <pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span>
<span style="color: #ff0000">┗━━ </span>The following variables are mandatory but have no value: <span style="color: #ffff00">┗━━ </span>the value "foo" is an invalid choice for "proxy_mode" (Configure Proxy Access to the Internet), only "Auto-detect proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy
<span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>Manual proxy configuration <span style="color: #ffff00"> </span>configuration", "No proxy" and "Use system proxy settings" are allowed, it will be ignored when loading from the YAML file "config/04/config.yaml"
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTPS Proxy ╭─────── Caption ────────╮
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTPS address │ Variable <span style="color: #ffd700">Default value</span> │
</pre> ╰────────────────────────╯
#### Output in read write mode Variables:
<span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: <span style="color: #ffd700">No proxy</span>
```console
foo@bar:~$ git switch --detach v1.1_031
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/04/config.yaml --cli.read_write
```
<pre><span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span>
<span style="color: #ff0000">┗━━ </span>The following variables are mandatory but have no value:
<span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>Manual proxy configuration
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTPS Proxy
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTPS address
</pre> </pre>
### Example 5 ### Example 5
@ -307,60 +237,24 @@ foo@bar:~$ rougail -m firefox/ -u yaml -ff config/04/config.yaml --cli.read_writ
```yml ```yml
--- ---
proxy_mode: Manual proxy configuration proxy_mode: 1
manual:
http_proxy:
address: http.proxy.net
port: '3128'
use_for_https: false
https_proxy:
address: https.proxy.net
``` ```
#### Output #### Output
```console ```console
foo@bar:~$ git switch --detach v1.1_031 foo@bar:~$ git switch --detach v1.1_041
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/05/config.yaml foo@bar:~$ rougail -m firefox/ -u yaml -ff config/05/config.yaml
``` ```
<pre>╭────────────── Caption ───────────────╮ <pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span>
│ Variable <span style="color: #ffd700">Default value</span> │ <span style="color: #ffff00">┗━━ </span>the value "1" is an invalid choice for "proxy_mode" (Configure Proxy Access to the Internet), only "Auto-detect proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy
│ Modified value │ <span style="color: #ffff00"> </span>configuration", "No proxy" and "Use system proxy settings" are allowed, it will be ignored when loading from the YAML file "config/05/config.yaml"
│ (<span style="color: #00aa00">⏳ Original default value</span>) │ ╭─────── Caption ────────╮
╰──────────────────────────────────────╯ │ Variable <span style="color: #ffd700">Default value</span> │
╰────────────────────────╯
Variables: Variables:
<span style="color: #5c5cff">┣━━ </span>📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/05/config.yaml" (⏳ <span style="color: #00aa00">No proxy</span>) <span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: <span style="color: #ffd700">No proxy</span>
<span style="color: #5c5cff">┗━━ </span>📂 Manual proxy configuration
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┣━━ </span>📂 HTTP Proxy
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┣━━ </span>📓 HTTP address: http.proxy.net ◀ loaded from the YAML file "config/05/config.yaml"
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┗━━ </span>📓 HTTP Port: 3128 ◀ loaded from the YAML file "config/05/config.yaml" (⏳ <span style="color: #00aa00">8080</span>)
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┣━━ </span>📓 Also use this proxy for HTTPS: false ◀ loaded from the YAML file "config/05/config.yaml" (⏳ <span style="color: #00aa00">true</span>)
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📂 HTTPS Proxy
<span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┣━━ </span>📓 HTTPS address: https.proxy.net ◀ loaded from the YAML file "config/05/config.yaml"
<span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 HTTPS Port: <span style="color: #ffd700">8080</span>
</pre>
#### Output in read write mode
```console
foo@bar:~$ git switch --detach v1.1_031
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/05/config.yaml --cli.read_write
```
<pre>╭────────────── Caption ───────────────╮
│ Variable <span style="color: #ffd700">Default value</span> │
│ Modified value │
│ (<span style="color: #00aa00">⏳ Original default value</span>) │
╰──────────────────────────────────────╯
Variables:
<span style="color: #5c5cff">┣━━ </span>📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/05/config.yaml" (⏳ <span style="color: #00aa00">No proxy</span>)
<span style="color: #5c5cff">┗━━ </span>📂 Manual proxy configuration
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┣━━ </span>📂 HTTP Proxy
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┣━━ </span>📓 HTTP address: http.proxy.net ◀ loaded from the YAML file "config/05/config.yaml"
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┗━━ </span>📓 HTTP Port: 3128 ◀ loaded from the YAML file "config/05/config.yaml" (⏳ <span style="color: #00aa00">8080</span>)
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┣━━ </span>📓 Also use this proxy for HTTPS: false ◀ loaded from the YAML file "config/05/config.yaml" (⏳ <span style="color: #00aa00">true</span>)
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📂 HTTPS Proxy
<span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┣━━ </span>📓 HTTPS address: https.proxy.net ◀ loaded from the YAML file "config/05/config.yaml"
<span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 HTTPS Port: <span style="color: #ffd700">8080</span>
</pre> </pre>
- [[tutorial v1.1_041] An hidden family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_041/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_041~1..v1.1_041)) - [[tutorial v1.1_042] A conditional hidden family with a variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_042/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_042~1..v1.1_042))

6
config/01/output_rw.html
View file

@ -1,6 +0,0 @@
<pre>╭─────── Caption ────────╮
│ Variable <span style="color: #ffd700">Default value</span> │
╰────────────────────────╯
Variables:
<span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: <span style="color: #ffd700">No proxy</span>
</pre>

2
config/02/config.yaml
View file

@ -1,2 +1,2 @@
--- ---
proxy_mode: Manual proxy configuration proxy_mode: No proxy

13
config/02/output_ro.html
View file

@ -1,8 +1,7 @@
<pre><span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span> <pre>╭────────────── Caption ───────────────╮
<span style="color: #ff0000">┗━━ </span>The following variables are mandatory but have no value: │ Variable Modified value │
<span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>Manual proxy configuration │ (<span style="color: #00aa00">⏳ Original default value</span>) │
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┣━━ </span>HTTP Proxy ╰──────────────────────────────────────╯
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┃ </span><span style="color: #ff0000">┗━━ </span>HTTP address Variables:
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTPS Proxy <span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: No proxy ◀ loaded from the YAML file "config/02/config.yaml" (⏳ <span style="color: #00aa00">No proxy</span>)
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTPS address
</pre> </pre>

8
config/02/output_rw.html
View file

@ -1,8 +0,0 @@
<pre><span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span>
<span style="color: #ff0000">┗━━ </span>The following variables are mandatory but have no value:
<span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>Manual proxy configuration
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┣━━ </span>HTTP Proxy
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┃ </span><span style="color: #ff0000">┗━━ </span>HTTP address
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTPS Proxy
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTPS address
</pre>

3
config/03/config.yaml
View file

@ -1,5 +1,2 @@
--- ---
proxy_mode: Manual proxy configuration proxy_mode: Manual proxy configuration
manual:
http_proxy:
address: example.net

4
config/03/output_ro.html
View file

@ -1,6 +1,6 @@
<pre><span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span> <pre><span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span>
<span style="color: #ff0000">┗━━ </span>The following variables are mandatory but have no value: <span style="color: #ff0000">┗━━ </span>The following variables are mandatory but have no value:
<span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>Manual proxy configuration <span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>Manual proxy configuration
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTPS Proxy <span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTP Proxy
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTPS address <span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTP address
</pre> </pre>

6
config/03/output_rw.html
View file

@ -1,6 +0,0 @@
<pre><span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span>
<span style="color: #ff0000">┗━━ </span>The following variables are mandatory but have no value:
<span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>Manual proxy configuration
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTPS Proxy
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTPS address
</pre>

6
config/04/config.yaml
View file

@ -1,6 +1,2 @@
--- ---
proxy_mode: Manual proxy configuration proxy_mode: foo
manual:
http_proxy:
address: example.net
port: '3128'

13
config/04/output_ro.html
View file

@ -1,6 +1,9 @@
<pre><span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span> <pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span>
<span style="color: #ff0000">┗━━ </span>The following variables are mandatory but have no value: <span style="color: #ffff00">┗━━ </span>the value "foo" is an invalid choice for "proxy_mode" (Configure Proxy Access to the Internet), only "Auto-detect proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy
<span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>Manual proxy configuration <span style="color: #ffff00"> </span>configuration", "No proxy" and "Use system proxy settings" are allowed, it will be ignored when loading from the YAML file "config/04/config.yaml"
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTPS Proxy ╭─────── Caption ────────╮
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTPS address │ Variable <span style="color: #ffd700">Default value</span> │
╰────────────────────────╯
Variables:
<span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: <span style="color: #ffd700">No proxy</span>
</pre> </pre>

6
config/04/output_rw.html
View file

@ -1,6 +0,0 @@
<pre><span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span>
<span style="color: #ff0000">┗━━ </span>The following variables are mandatory but have no value:
<span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>Manual proxy configuration
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTPS Proxy
<span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000"> </span><span style="color: #ff0000">┗━━ </span>HTTPS address
</pre>

9
config/05/config.yaml
View file

@ -1,9 +1,2 @@
--- ---
proxy_mode: Manual proxy configuration proxy_mode: 1
manual:
http_proxy:
address: http.proxy.net
port: '3128'
use_for_https: false
https_proxy:
address: https.proxy.net

21
config/05/output_ro.html
View file

@ -1,16 +1,9 @@
<pre>╭────────────── Caption ───────────────╮ <pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span>
│ Variable <span style="color: #ffd700">Default value</span> │ <span style="color: #ffff00">┗━━ </span>the value "1" is an invalid choice for "proxy_mode" (Configure Proxy Access to the Internet), only "Auto-detect proxy settings for this network", "Automatic proxy configuration URL", "Manual proxy
│ Modified value │ <span style="color: #ffff00"> </span>configuration", "No proxy" and "Use system proxy settings" are allowed, it will be ignored when loading from the YAML file "config/05/config.yaml"
│ (<span style="color: #00aa00">⏳ Original default value</span>) │ ╭─────── Caption ────────╮
╰──────────────────────────────────────╯ │ Variable <span style="color: #ffd700">Default value</span> │
╰────────────────────────╯
Variables: Variables:
<span style="color: #5c5cff">┣━━ </span>📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/05/config.yaml" (⏳ <span style="color: #00aa00">No proxy</span>) <span style="color: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: <span style="color: #ffd700">No proxy</span>
<span style="color: #5c5cff">┗━━ </span>📂 Manual proxy configuration
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┣━━ </span>📂 HTTP Proxy
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┣━━ </span>📓 HTTP address: http.proxy.net ◀ loaded from the YAML file "config/05/config.yaml"
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┗━━ </span>📓 HTTP Port: 3128 ◀ loaded from the YAML file "config/05/config.yaml" (⏳ <span style="color: #00aa00">8080</span>)
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┣━━ </span>📓 Also use this proxy for HTTPS: false ◀ loaded from the YAML file "config/05/config.yaml" (⏳ <span style="color: #00aa00">true</span>)
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📂 HTTPS Proxy
<span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┣━━ </span>📓 HTTPS address: https.proxy.net ◀ loaded from the YAML file "config/05/config.yaml"
<span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 HTTPS Port: <span style="color: #ffd700">8080</span>
</pre> </pre>

16
config/05/output_rw.html
View file

@ -1,16 +0,0 @@
<pre>╭────────────── Caption ───────────────╮
│ Variable <span style="color: #ffd700">Default value</span> │
│ Modified value │
│ (<span style="color: #00aa00">⏳ Original default value</span>) │
╰──────────────────────────────────────╯
Variables:
<span style="color: #5c5cff">┣━━ </span>📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/05/config.yaml" (⏳ <span style="color: #00aa00">No proxy</span>)
<span style="color: #5c5cff">┗━━ </span>📂 Manual proxy configuration
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┣━━ </span>📂 HTTP Proxy
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┣━━ </span>📓 HTTP address: http.proxy.net ◀ loaded from the YAML file "config/05/config.yaml"
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┃ </span><span style="color: #5c5cff">┗━━ </span>📓 HTTP Port: 3128 ◀ loaded from the YAML file "config/05/config.yaml" (⏳ <span style="color: #00aa00">8080</span>)
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┣━━ </span>📓 Also use this proxy for HTTPS: false ◀ loaded from the YAML file "config/05/config.yaml" (⏳ <span style="color: #00aa00">true</span>)
<span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📂 HTTPS Proxy
<span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┣━━ </span>📓 HTTPS address: https.proxy.net ◀ loaded from the YAML file "config/05/config.yaml"
<span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 HTTPS Port: <span style="color: #ffd700">8080</span>
</pre>