No description

Find a file

Emmanuel Garette f0c113e63a [tutorial 020] A family The "manual" mode structural descriptions are write in a new files to separate things. But Rougail will concatenate variables and families. We create a family, which will contain other variables. This family has: - a description - a type As there is no variable inside this family, the type is mandatory. Without it, Rougail will create a variable. In fact, this family will be deleted by Rougail too because it is empty.		2024-11-02 14:58:16 +01:00
firefox	[tutorial 020] A family	2024-11-02 14:58:16 +01:00
firefox.png	[tutorial 020] A family (config and doc)	2024-11-02 14:58:16 +01:00
foxyproxy.png	[init] Discover Rougail	2024-11-02 14:58:09 +01:00
README.md	[tutorial 020] A family (config and doc)	2024-11-02 14:58:16 +01:00

README.md

[tutorial 020] A family

View the diff

Screenshot

Structure

firefox/00-proxy.yml

---
proxy_mode:
  description: Configure Proxy Access to the Internet
  choices:
    - No proxy
    - Auto-detect proxy settings for this network
    - Use system proxy settings
    - Manual proxy configuration
    - Automatic proxy configuration URL
  default: No proxy

firefox/10-manual.yml

---
manual:
  description: Manual proxy configuration
  type: family

Generated documentation

foo@bar:~$ rougail -v 1.1 -m firefox/ -o doc -do github

Variables

Variable	Description
proxy_mode `choice` `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

[tutorial 021] A sub family (diff)