153 lines
8.2 KiB
Markdown
153 lines
8.2 KiB
Markdown
- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md)
|
|
- [[tutorial 010] A first variable with only a name](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_010/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_010~1..v1.1_010))
|
|
|
|
# [tutorial 011] The variable description
|
|
|
|
[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_011~1..v1.1_011)
|
|
|
|
|
|
## Screenshot
|
|
|
|
|
|
<img src="firefox.png" width=50% height=50% alt="Firefox Proxy setting"/>
|
|
|
|
|
|
## Structure
|
|
|
|
|
|
### firefox/00-proxy.yml
|
|
|
|
|
|
```yml
|
|
---
|
|
proxy_mode:
|
|
description: Configure Proxy Access to the Internet
|
|
|
|
```
|
|
### Generated documentation
|
|
|
|
```console
|
|
foo@bar:~$ rougail -v 1.1 -m firefox/ -o doc -do github
|
|
```
|
|
### Variables
|
|
|
|
| Variable | Description |
|
|
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
| **proxy_mode**<br/>[`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | Configure Proxy Access to the Internet. |
|
|
|
|
|
|
## User data
|
|
|
|
### Example 1
|
|
|
|
#### config/01/config.yaml
|
|
|
|
|
|
```yml
|
|
---
|
|
|
|
```
|
|
#### Output
|
|
|
|
```console
|
|
foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/01/config.yaml
|
|
```
|
|
<pre>🛑 ERRORS
|
|
<span style="color: #ff0000">┣━━ </span>The following variables are mandatory but have no value:
|
|
<span style="color: #ff0000">┗━━ </span> - proxy_mode (Configure Proxy Access to the Internet)
|
|
</pre>
|
|
### Example 2
|
|
|
|
#### config/02/config.yaml
|
|
|
|
|
|
```yml
|
|
---
|
|
proxy_mode: No proxy
|
|
|
|
```
|
|
#### Output
|
|
|
|
```console
|
|
foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/02/config.yaml
|
|
```
|
|
<pre>╭────────────────────────── Caption ──────────────────────────╮
|
|
│ Variable <span style="color: #ffd700">Default value</span> │
|
|
│ <span style="color: #5c5cff">Undocumented variable</span> Modified value │
|
|
│ <span style="color: #ff0000">Undocumented but modified variable</span> (<span style="color: #00aa00">Original default value</span>) │
|
|
│ <span style="color: #ffaf00">Unmodifiable variable</span> │
|
|
╰─────────────────────────────────────────────────────────────╯
|
|
Variables:
|
|
<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: No proxy
|
|
</pre>
|
|
### Example 3
|
|
|
|
#### config/03/config.yaml
|
|
|
|
|
|
```yml
|
|
---
|
|
proxy_mode: Manual proxy configuration
|
|
|
|
```
|
|
#### Output
|
|
|
|
```console
|
|
foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/03/config.yaml
|
|
```
|
|
<pre>╭────────────────────────── Caption ──────────────────────────╮
|
|
│ Variable <span style="color: #ffd700">Default value</span> │
|
|
│ <span style="color: #5c5cff">Undocumented variable</span> Modified value │
|
|
│ <span style="color: #ff0000">Undocumented but modified variable</span> (<span style="color: #00aa00">Original default value</span>) │
|
|
│ <span style="color: #ffaf00">Unmodifiable variable</span> │
|
|
╰─────────────────────────────────────────────────────────────╯
|
|
Variables:
|
|
<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: Manual proxy configuration
|
|
</pre>
|
|
### Example 4
|
|
|
|
#### config/04/config.yaml
|
|
|
|
|
|
```yml
|
|
---
|
|
proxy_mode: foo
|
|
|
|
```
|
|
#### Output
|
|
|
|
```console
|
|
foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/04/config.yaml
|
|
```
|
|
<pre>╭────────────────────────── Caption ──────────────────────────╮
|
|
│ Variable <span style="color: #ffd700">Default value</span> │
|
|
│ <span style="color: #5c5cff">Undocumented variable</span> Modified value │
|
|
│ <span style="color: #ff0000">Undocumented but modified variable</span> (<span style="color: #00aa00">Original default value</span>) │
|
|
│ <span style="color: #ffaf00">Unmodifiable variable</span> │
|
|
╰─────────────────────────────────────────────────────────────╯
|
|
Variables:
|
|
<span style="color: #5c5cff">┗━━ </span>📓 proxy_mode: foo
|
|
</pre>
|
|
### Example 5
|
|
|
|
#### config/05/config.yaml
|
|
|
|
|
|
```yml
|
|
---
|
|
proxy_mode: 1
|
|
|
|
```
|
|
#### Output
|
|
|
|
```console
|
|
foo@bar:~$ rougail -v 1.1 -m firefox/ -u file -ff config/05/config.yaml
|
|
```
|
|
<pre>🛑 ERRORS
|
|
<span style="color: #ff0000">┣━━ </span>"1" is an invalid string for "proxy_mode (Configure Proxy Access to the Internet)"
|
|
<span style="color: #ff0000">┣━━ </span>The following variables are mandatory but have no value:
|
|
<span style="color: #ff0000">┗━━ </span> - proxy_mode (Configure Proxy Access to the Internet)
|
|
</pre>
|
|
|
|
|
|
- [[tutorial 012] A default value](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))
|