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

[tutorial v1.1_027)] A conditional disabled family with a variable (config and doc)

Browse source
This commit is contained in:
egarette@silique.fr 2025-11-04 19:22:14 +01:00
parent ae8158d531
commit 48a193e553
9 changed files with 140 additions and 96 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

150
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_025] A variable with type "port"](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_025/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_025~1..v1.1_025)) - [[tutorial v1.1_026] A disabled family](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_026/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_026~1..v1.1_026))
# [tutorial v1.1_026)] A disabled family # [tutorial v1.1_027)] A conditional disabled family with a variable
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_026~1..v1.1_026) [View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_027~1..v1.1_027)
## Screenshot ## Screenshot
@ -45,7 +45,9 @@ version: 1.1
manual: manual:
description: Manual proxy configuration description: Manual proxy configuration
disabled: true disabled:
variable: _.proxy_mode
when_not: Manual proxy configuration
http_proxy: # HTTP Proxy http_proxy: # HTTP Proxy
@ -65,24 +67,46 @@ manual:
### Let's generate the documentation ### Let's generate the documentation
```console ```console
foo@bar:~$ git switch --detach v1.1_026 foo@bar:~$ git switch --detach v1.1_027
foo@bar:~$ rougail -m firefox/ -o doc -do github foo@bar:~$ rougail -m firefox/ -o doc -do github
``` ```
| Variable                                                                                        | Description                                                                                     | | Variable                                                                                        | Description                                                                                     |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **proxy_mode**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Configure Proxy Access to the Internet.<br/>**Choices**: <br/>- No proxy **← (default)**<br/>- Auto-detect proxy settings for this network<br/>- Use system proxy settings<br/>- Manual proxy configuration<br/>- Automatic proxy configuration URL | | **proxy_mode**<br/>[`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Configure Proxy Access to the Internet.<br/>**Choices**: <br/>- No proxy **← (default)**<br/>- Auto-detect proxy settings for this network<br/>- Use system proxy settings<br/>- Manual proxy configuration<br/>- Automatic proxy configuration URL |
#### Manual proxy configuration
**manual**
*`disabled`*
**Disabled**: when the variable "proxy_mode" hasn't the value "Manual proxy configuration"
##### HTTP Proxy
**manual.http_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.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 |
### Let's generate the changelog ### Let's generate the changelog
```console ```console
foo@bar:~$ git switch --detach v1.1_026 foo@bar:~$ git switch --detach v1.1_027
foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog -do github foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog -do github
``` ```
#### Deleted variables #### New 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.http_proxy.address
- manual.http_proxy.port
## User datas ## User datas
### Example 1 ### Example 1
@ -97,7 +121,7 @@ foo@bar:~$ rougail -m firefox/ -o doc --doc.contents changelog -do github
#### Output #### Output
```console ```console
foo@bar:~$ git switch --detach v1.1_026 foo@bar:~$ git switch --detach v1.1_027
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 ────────╮
@ -109,7 +133,7 @@ Variables:
#### Output in read write mode #### Output in read write mode
```console ```console
foo@bar:~$ git switch --detach v1.1_026 foo@bar:~$ git switch --detach v1.1_027
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml --cli.read_write foo@bar:~$ rougail -m firefox/ -u yaml -ff config/01/config.yaml --cli.read_write
``` ```
<pre>╭─────── Caption ────────╮ <pre>╭─────── Caption ────────╮
@ -131,28 +155,26 @@ proxy_mode: Manual proxy configuration
#### Output #### Output
```console ```console
foo@bar:~$ git switch --detach v1.1_026 foo@bar:~$ git switch --detach v1.1_027
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>╭────────────── Caption ───────────────╮ <pre><span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span>
│ Variable Modified value │ <span style="color: #ff0000">┗━━ </span>The following variables are mandatory but have no value:
│ (<span style="color: #00aa00">⏳ Original default value</span>) │ <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
Variables: <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: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/02/config.yaml" (⏳ <span style="color: #00aa00">No proxy</span>)
</pre> </pre>
#### Output in read write mode #### Output in read write mode
```console ```console
foo@bar:~$ git switch --detach v1.1_026 foo@bar:~$ git switch --detach v1.1_027
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/config.yaml --cli.read_write foo@bar:~$ rougail -m firefox/ -u yaml -ff config/02/config.yaml --cli.read_write
``` ```
<pre>╭────────────── Caption ───────────────╮ <pre><span style="font-weight: bold; color: #ff0000">🛑 ERRORS</span>
│ Variable Modified value │ <span style="color: #ff0000">┗━━ </span>The following variables are mandatory but have no value:
│ (<span style="color: #00aa00">⏳ Original default value</span>) │ <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
Variables: <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: #5c5cff">┗━━ </span>📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/02/config.yaml" (⏳ <span style="color: #00aa00">No proxy</span>)
</pre> </pre>
### Example 3 ### Example 3
@ -170,32 +192,38 @@ manual:
#### Output #### Output
```console ```console
foo@bar:~$ git switch --detach v1.1_026 foo@bar:~$ git switch --detach v1.1_027
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: #ffff00">🔔 WARNINGS</span> <pre>╭────────────── Caption ───────────────╮
<span style="color: #ffff00">┗━━ </span>family "manual" (Manual proxy configuration) is disabled, "manual.http_proxy.address" (HTTP address) will be ignored when loading from the YAML file "config/03/config.yaml" │ Variable <span style="color: #ffd700">Default value</span> │
╭────────────── Caption ───────────────╮ │ Modified value │
│ Variable Modified value │
│ (<span style="color: #00aa00">⏳ Original default value</span>) │ │ (<span style="color: #00aa00">⏳ Original 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/03/config.yaml" (⏳ <span style="color: #00aa00">No proxy</span>) <span style="color: #5c5cff">┣━━ </span>📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/03/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: example.net ◀ loaded from the YAML file "config/03/config.yaml"
<span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 HTTP Port: <span style="color: #ffd700">8080</span>
</pre> </pre>
#### Output in read write mode #### Output in read write mode
```console ```console
foo@bar:~$ git switch --detach v1.1_026 foo@bar:~$ git switch --detach v1.1_027
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/03/config.yaml --cli.read_write foo@bar:~$ rougail -m firefox/ -u yaml -ff config/03/config.yaml --cli.read_write
``` ```
<pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span> <pre>╭────────────── Caption ───────────────╮
<span style="color: #ffff00">┗━━ </span>family "manual" (Manual proxy configuration) is disabled, "manual.http_proxy.address" (HTTP address) will be ignored when loading from the YAML file "config/03/config.yaml" │ Variable <span style="color: #ffd700">Default value</span> │
╭────────────── Caption ───────────────╮ │ Modified value │
│ Variable Modified value │
│ (<span style="color: #00aa00">⏳ Original default value</span>) │ │ (<span style="color: #00aa00">⏳ Original 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/03/config.yaml" (⏳ <span style="color: #00aa00">No proxy</span>) <span style="color: #5c5cff">┣━━ </span>📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/03/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: example.net ◀ loaded from the YAML file "config/03/config.yaml"
<span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 HTTP Port: <span style="color: #ffd700">8080</span>
</pre> </pre>
### Example 4 ### Example 4
@ -214,34 +242,36 @@ manual:
#### Output #### Output
```console ```console
foo@bar:~$ git switch --detach v1.1_026 foo@bar:~$ git switch --detach v1.1_027
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: #ffff00">🔔 WARNINGS</span> <pre>╭────────────── Caption ───────────────╮
<span style="color: #ffff00">┣━━ </span>family "manual" (Manual proxy configuration) is disabled, "manual.http_proxy.address" (HTTP address) will be ignored when loading from the YAML file "config/04/config.yaml"
<span style="color: #ffff00">┗━━ </span>family "manual" (Manual proxy configuration) is disabled, "manual.http_proxy.port" (HTTP Port) will be ignored when loading from the YAML file "config/04/config.yaml"
╭────────────── Caption ───────────────╮
│ Variable Modified value │ │ Variable Modified value │
│ (<span style="color: #00aa00">⏳ Original default value</span>) │ │ (<span style="color: #00aa00">⏳ Original 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/04/config.yaml" (⏳ <span style="color: #00aa00">No proxy</span>) <span style="color: #5c5cff">┣━━ </span>📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/04/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: example.net ◀ loaded from the YAML file "config/04/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/04/config.yaml" (⏳ <span style="color: #00aa00">8080</span>)
</pre> </pre>
#### Output in read write mode #### Output in read write mode
```console ```console
foo@bar:~$ git switch --detach v1.1_026 foo@bar:~$ git switch --detach v1.1_027
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/04/config.yaml --cli.read_write foo@bar:~$ rougail -m firefox/ -u yaml -ff config/04/config.yaml --cli.read_write
``` ```
<pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span> <pre>╭────────────── Caption ───────────────╮
<span style="color: #ffff00">┣━━ </span>family "manual" (Manual proxy configuration) is disabled, "manual.http_proxy.address" (HTTP address) will be ignored when loading from the YAML file "config/04/config.yaml"
<span style="color: #ffff00">┗━━ </span>family "manual" (Manual proxy configuration) is disabled, "manual.http_proxy.port" (HTTP Port) will be ignored when loading from the YAML file "config/04/config.yaml"
╭────────────── Caption ───────────────╮
│ Variable Modified value │ │ Variable Modified value │
│ (<span style="color: #00aa00">⏳ Original default value</span>) │ │ (<span style="color: #00aa00">⏳ Original 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/04/config.yaml" (⏳ <span style="color: #00aa00">No proxy</span>) <span style="color: #5c5cff">┣━━ </span>📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/04/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: example.net ◀ loaded from the YAML file "config/04/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/04/config.yaml" (⏳ <span style="color: #00aa00">8080</span>)
</pre> </pre>
### Example 5 ### Example 5
@ -263,12 +293,10 @@ manual:
#### Output #### Output
```console ```console
foo@bar:~$ git switch --detach v1.1_026 foo@bar:~$ git switch --detach v1.1_027
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><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span> <pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span>
<span style="color: #ffff00">┣━━ </span>family "manual" (Manual proxy configuration) is disabled, "manual.http_proxy.address" (HTTP address) will be ignored when loading from the YAML file "config/05/config.yaml"
<span style="color: #ffff00">┣━━ </span>family "manual" (Manual proxy configuration) is disabled, "manual.http_proxy.port" (HTTP Port) will be ignored when loading from the YAML file "config/05/config.yaml"
<span style="color: #ffff00">┣━━ </span>variable or family "manual.use_for_https" does not exist, it will be ignored when loading from the YAML file "config/05/config.yaml" <span style="color: #ffff00">┣━━ </span>variable or family "manual.use_for_https" does not exist, it will be ignored when loading from the YAML file "config/05/config.yaml"
<span style="color: #ffff00">┗━━ </span>variable or family "manual.https_proxy" does not exist, it will be ignored when loading from the YAML file "config/05/config.yaml" <span style="color: #ffff00">┗━━ </span>variable or family "manual.https_proxy" does not exist, it will be ignored when loading from the YAML file "config/05/config.yaml"
╭────────────── Caption ───────────────╮ ╭────────────── Caption ───────────────╮
@ -276,17 +304,19 @@ foo@bar:~$ rougail -m firefox/ -u yaml -ff config/05/config.yaml
│ (<span style="color: #00aa00">⏳ Original default value</span>) │ │ (<span style="color: #00aa00">⏳ Original 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: 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>)
</pre> </pre>
#### Output in read write mode #### Output in read write mode
```console ```console
foo@bar:~$ git switch --detach v1.1_026 foo@bar:~$ git switch --detach v1.1_027
foo@bar:~$ rougail -m firefox/ -u yaml -ff config/05/config.yaml --cli.read_write foo@bar:~$ rougail -m firefox/ -u yaml -ff config/05/config.yaml --cli.read_write
``` ```
<pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span> <pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span>
<span style="color: #ffff00">┣━━ </span>family "manual" (Manual proxy configuration) is disabled, "manual.http_proxy.address" (HTTP address) will be ignored when loading from the YAML file "config/05/config.yaml"
<span style="color: #ffff00">┣━━ </span>family "manual" (Manual proxy configuration) is disabled, "manual.http_proxy.port" (HTTP Port) will be ignored when loading from the YAML file "config/05/config.yaml"
<span style="color: #ffff00">┣━━ </span>variable or family "manual.use_for_https" does not exist, it will be ignored when loading from the YAML file "config/05/config.yaml" <span style="color: #ffff00">┣━━ </span>variable or family "manual.use_for_https" does not exist, it will be ignored when loading from the YAML file "config/05/config.yaml"
<span style="color: #ffff00">┗━━ </span>variable or family "manual.https_proxy" does not exist, it will be ignored when loading from the YAML file "config/05/config.yaml" <span style="color: #ffff00">┗━━ </span>variable or family "manual.https_proxy" does not exist, it will be ignored when loading from the YAML file "config/05/config.yaml"
╭────────────── Caption ───────────────╮ ╭────────────── Caption ───────────────╮
@ -294,8 +324,12 @@ foo@bar:~$ rougail -m firefox/ -u yaml -ff config/05/config.yaml --cli.read_writ
│ (<span style="color: #00aa00">⏳ Original default value</span>) │ │ (<span style="color: #00aa00">⏳ Original 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: 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>)
</pre> </pre>
- [[tutorial v1.1_027] A conditional disabled family with a variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_027/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_027~1..v1.1_027)) - [[tutorial v1.1_030] A variable with type "boolean"](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))

11
config/02/output_ro.html
View file

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

11
config/02/output_rw.html
View file

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

13
config/03/output_ro.html
View file

@ -1,9 +1,12 @@
<pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span> <pre>╭────────────── Caption ───────────────╮
<span style="color: #ffff00">┗━━ </span>family "manual" (Manual proxy configuration) is disabled, "manual.http_proxy.address" (HTTP address) will be ignored when loading from the YAML file "config/03/config.yaml" │ Variable <span style="color: #ffd700">Default value</span> │
╭────────────── Caption ───────────────╮ │ Modified value │
│ Variable Modified value │
│ (<span style="color: #00aa00">⏳ Original default value</span>) │ │ (<span style="color: #00aa00">⏳ Original 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/03/config.yaml" (⏳ <span style="color: #00aa00">No proxy</span>) <span style="color: #5c5cff">┣━━ </span>📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/03/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: example.net ◀ loaded from the YAML file "config/03/config.yaml"
<span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 HTTP Port: <span style="color: #ffd700">8080</span>
</pre> </pre>

13
config/03/output_rw.html
View file

@ -1,9 +1,12 @@
<pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span> <pre>╭────────────── Caption ───────────────╮
<span style="color: #ffff00">┗━━ </span>family "manual" (Manual proxy configuration) is disabled, "manual.http_proxy.address" (HTTP address) will be ignored when loading from the YAML file "config/03/config.yaml" │ Variable <span style="color: #ffd700">Default value</span> │
╭────────────── Caption ───────────────╮ │ Modified value │
│ Variable Modified value │
│ (<span style="color: #00aa00">⏳ Original default value</span>) │ │ (<span style="color: #00aa00">⏳ Original 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/03/config.yaml" (⏳ <span style="color: #00aa00">No proxy</span>) <span style="color: #5c5cff">┣━━ </span>📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/03/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: example.net ◀ loaded from the YAML file "config/03/config.yaml"
<span style="color: #5c5cff"> </span><span style="color: #5c5cff"> </span><span style="color: #5c5cff">┗━━ </span>📓 HTTP Port: <span style="color: #ffd700">8080</span>
</pre> </pre>

11
config/04/output_ro.html
View file

@ -1,10 +1,11 @@
<pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span> <pre>╭────────────── Caption ───────────────╮
<span style="color: #ffff00">┣━━ </span>family "manual" (Manual proxy configuration) is disabled, "manual.http_proxy.address" (HTTP address) will be ignored when loading from the YAML file "config/04/config.yaml"
<span style="color: #ffff00">┗━━ </span>family "manual" (Manual proxy configuration) is disabled, "manual.http_proxy.port" (HTTP Port) will be ignored when loading from the YAML file "config/04/config.yaml"
╭────────────── Caption ───────────────╮
│ Variable Modified value │ │ Variable Modified value │
│ (<span style="color: #00aa00">⏳ Original default value</span>) │ │ (<span style="color: #00aa00">⏳ Original 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/04/config.yaml" (⏳ <span style="color: #00aa00">No proxy</span>) <span style="color: #5c5cff">┣━━ </span>📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/04/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: example.net ◀ loaded from the YAML file "config/04/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/04/config.yaml" (⏳ <span style="color: #00aa00">8080</span>)
</pre> </pre>

11
config/04/output_rw.html
View file

@ -1,10 +1,11 @@
<pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span> <pre>╭────────────── Caption ───────────────╮
<span style="color: #ffff00">┣━━ </span>family "manual" (Manual proxy configuration) is disabled, "manual.http_proxy.address" (HTTP address) will be ignored when loading from the YAML file "config/04/config.yaml"
<span style="color: #ffff00">┗━━ </span>family "manual" (Manual proxy configuration) is disabled, "manual.http_proxy.port" (HTTP Port) will be ignored when loading from the YAML file "config/04/config.yaml"
╭────────────── Caption ───────────────╮
│ Variable Modified value │ │ Variable Modified value │
│ (<span style="color: #00aa00">⏳ Original default value</span>) │ │ (<span style="color: #00aa00">⏳ Original 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/04/config.yaml" (⏳ <span style="color: #00aa00">No proxy</span>) <span style="color: #5c5cff">┣━━ </span>📓 Configure Proxy Access to the Internet: Manual proxy configuration ◀ loaded from the YAML file "config/04/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: example.net ◀ loaded from the YAML file "config/04/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/04/config.yaml" (⏳ <span style="color: #00aa00">8080</span>)
</pre> </pre>

8
config/05/output_ro.html
View file

@ -1,6 +1,4 @@
<pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span> <pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span>
<span style="color: #ffff00">┣━━ </span>family "manual" (Manual proxy configuration) is disabled, "manual.http_proxy.address" (HTTP address) will be ignored when loading from the YAML file "config/05/config.yaml"
<span style="color: #ffff00">┣━━ </span>family "manual" (Manual proxy configuration) is disabled, "manual.http_proxy.port" (HTTP Port) will be ignored when loading from the YAML file "config/05/config.yaml"
<span style="color: #ffff00">┣━━ </span>variable or family "manual.use_for_https" does not exist, it will be ignored when loading from the YAML file "config/05/config.yaml" <span style="color: #ffff00">┣━━ </span>variable or family "manual.use_for_https" does not exist, it will be ignored when loading from the YAML file "config/05/config.yaml"
<span style="color: #ffff00">┗━━ </span>variable or family "manual.https_proxy" does not exist, it will be ignored when loading from the YAML file "config/05/config.yaml" <span style="color: #ffff00">┗━━ </span>variable or family "manual.https_proxy" does not exist, it will be ignored when loading from the YAML file "config/05/config.yaml"
╭────────────── Caption ───────────────╮ ╭────────────── Caption ───────────────╮
@ -8,5 +6,9 @@
│ (<span style="color: #00aa00">⏳ Original default value</span>) │ │ (<span style="color: #00aa00">⏳ Original 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: 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>)
</pre> </pre>

8
config/05/output_rw.html
View file

@ -1,6 +1,4 @@
<pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span> <pre><span style="font-weight: bold; color: #ffff00">🔔 WARNINGS</span>
<span style="color: #ffff00">┣━━ </span>family "manual" (Manual proxy configuration) is disabled, "manual.http_proxy.address" (HTTP address) will be ignored when loading from the YAML file "config/05/config.yaml"
<span style="color: #ffff00">┣━━ </span>family "manual" (Manual proxy configuration) is disabled, "manual.http_proxy.port" (HTTP Port) will be ignored when loading from the YAML file "config/05/config.yaml"
<span style="color: #ffff00">┣━━ </span>variable or family "manual.use_for_https" does not exist, it will be ignored when loading from the YAML file "config/05/config.yaml" <span style="color: #ffff00">┣━━ </span>variable or family "manual.use_for_https" does not exist, it will be ignored when loading from the YAML file "config/05/config.yaml"
<span style="color: #ffff00">┗━━ </span>variable or family "manual.https_proxy" does not exist, it will be ignored when loading from the YAML file "config/05/config.yaml" <span style="color: #ffff00">┗━━ </span>variable or family "manual.https_proxy" does not exist, it will be ignored when loading from the YAML file "config/05/config.yaml"
╭────────────── Caption ───────────────╮ ╭────────────── Caption ───────────────╮
@ -8,5 +6,9 @@
│ (<span style="color: #00aa00">⏳ Original default value</span>) │ │ (<span style="color: #00aa00">⏳ Original 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: 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>)
</pre> </pre>