rougail-output-doc/tests/result_tutorial/210/doc.sh

317 lines
31 KiB
Bash
Raw Normal View History

2026-03-29 11:01:15 +02:00
Firefox
▌ 🛈 Informations
▌ 
▌ This family is a namespace.
▌ Path: firefox
▌  basic 
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
 Variable  ┃ Description  ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
firefox.proxy_mode │ Configure Proxy Access to the │
 choice   standard   mandatory  │ 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
▌ 🛈 Informations
▌ 
▌ Path: firefox.manual
▌  basic   disabled 
▌ Disabled: when the variable "firefox.proxy_mode" hasn't the value "Manual 
proxy configuration"
HTTP Proxy
▌ 🛈 Informations
▌ 
▌ Path: firefox.manual.http_proxy
▌  basic 
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
 Variable  ┃ Description  ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
firefox.manual.http_proxy.address │ Proxy address. │
 domainname   basic   mandatory  │ Validators: │
│ │ • type domainname │
│ │ • the domain name can be an IP │
├───────────────────────────────────────┼──────────────────────────────────────┤
firefox.manual.http_proxy.port │ Proxy port. │
 port   standard   mandatory  │ Validators: │
│ │ • well-known ports (1 to 1023) are │
│ │ allowed │
│ │ • registred ports (1024 to 49151)
│ │ are allowed │
│ │ • private ports (greater than 49152)
│ │ are allowed │
│ │ Default: 8080
└───────────────────────────────────────┴──────────────────────────────────────┘
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
 Variable  ┃ Description  ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
firefox.manual.use_for_https │ Also use this proxy for HTTPS. │
 boolean   standard   mandatory  │ Default: true
└───────────────────────────────────────┴──────────────────────────────────────┘
HTTPS Proxy
▌ 🛈 Informations
▌ 
▌ Path: firefox.manual.https_proxy
▌  standard   hidden 
▌ Hidden: when the variable "firefox.manual.use_for_https" has the value "true"
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
 Variable  ┃ Description  ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
firefox.manual.https_proxy.address │ Proxy address. │
 domainname   standard   mandatory  │ Validators: │
│ │ • type domainname │
│ │ • the domain name can be an IP │
│ │ Default: the value of the variable │
│ │ "firefox.manual.http_proxy.address"
├───────────────────────────────────────┼──────────────────────────────────────┤
firefox.manual.https_proxy.port │ Proxy port. │
 port   standard   mandatory  │ Validators: │
│ │ • well-known ports (1 to 1023) are │
│ │ allowed │
│ │ • registred ports (1024 to 49151)
│ │ are allowed │
│ │ • private ports (greater than 49152)
│ │ are allowed │
│ │ Default: the value of the variable │
│ │ "firefox.manual.http_proxy.port"
└───────────────────────────────────────┴──────────────────────────────────────┘
SOCKS Proxy
▌ 🛈 Informations
▌ 
▌ Path: firefox.manual.socks_proxy
▌  standard 
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
 Variable  ┃ Description  ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
firefox.manual.socks_proxy.address │ Proxy address. │
 domainname   standard   mandatory  │ Validators: │
│ │ • type domainname │
│ │ • the domain name can be an IP │
│ │ Default: the value of the variable │
│ │ "firefox.manual.http_proxy.address"
├───────────────────────────────────────┼──────────────────────────────────────┤
firefox.manual.socks_proxy.port │ Proxy port. │
 port   standard   mandatory  │ Validators: │
│ │ • well-known ports (1 to 1023) are │
│ │ allowed │
│ │ • registred ports (1024 to 49151)
│ │ are allowed │
│ │ • private ports (greater than 49152)
│ │ are allowed │
│ │ Default: the value of the variable │
│ │ "firefox.manual.http_proxy.port"
├───────────────────────────────────────┼──────────────────────────────────────┤
firefox.manual.socks_proxy.version │ SOCKS host version used by proxy. │
 choice   standard   mandatory  │ Choices: │
│ │ • v4 │
│ │ • v5 ← (default) │
└───────────────────────────────────────┴──────────────────────────────────────┘
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
 Variable  ┃ Description  ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
firefox.auto │ Automatic proxy configuration URL. │
 web address   basic   mandatory    │ Validators: │
disabled  │ • well-known ports (1 to 1023) are │
│ │ allowed │
│ │ • registred ports (1024 to 49151)
│ │ are allowed │
│ │ • type domainname │
│ │ • the domain name can be a hostname │
│ │ Disabled: when the variable │
│ │ "firefox.proxy_mode" hasn't the │
│ │ value "Automatic proxy configuration │
│ │ URL"
├───────────────────────────────────────┼──────────────────────────────────────┤
firefox.no_proxy │ Address for which proxy will be │
 domainname   multiple   standard    │ desactivated. │
disabled   unique  │ Connections to localhost, │
│ │ 127.0.0.1/8 and ::1 are never │
│ │ proxied. │
│ │ Validators: │
│ │ • type domainname │
│ │ • the domain name can starts by a │
│ │ dot │
│ │ • the domain name can be a hostname │
│ │ • the domain name can be an IP │
│ │ • the domain name can be network in │
│ │ CIDR format │
│ │ Examples: │
│ │ • .mozilla.org │
│ │ • .net.nz │
│ │ • 192.168.1.0/24 │
│ │ Disabled: when the variable │
│ │ "firefox.proxy_mode" has the value │
│ │ "No proxy"
├───────────────────────────────────────┼──────────────────────────────────────┤
firefox.prompt_authentication │ Prompt for authentication if
 boolean   standard   mandatory    │ password is saved. │
disabled  │ Default: true
│ │ Disabled: when the variable │
│ │ "firefox.proxy_mode" has the value │
│ │ "No proxy"
├───────────────────────────────────────┼──────────────────────────────────────┤
firefox.proxy_dns_socks5 │ Use proxy DNS when using SOCKS v5. │
 boolean   advanced   mandatory    │ Default: false
disabled  │ Disabled: if "firefox.proxy_mode" is │
│ │ not "Manual proxy configuration"
│ │ or │
│ │ "firefox.manual.socks_proxy.version"
│ │ is "v4"
└───────────────────────────────────────┴──────────────────────────────────────┘
DNS over HTTPS
▌ 🛈 Informations
▌ 
▌ Path: firefox.dns_over_https
▌  basic 
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
 Variable  ┃ Description  ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
firefox.dns_over_https.enable_dns_ov… │ Enable DNS over HTTPS. │
 boolean   standard   mandatory  │ Default: false
├───────────────────────────────────────┼──────────────────────────────────────┤
firefox.dns_over_https.provider │ Use Provider. │
 choice   standard   mandatory    │ Choices: │
disabled  │ • Cloudflare ← (default) │
│ │ • NextDNS │
│ │ • Custom │
│ │ Disabled: when the variable │
│ │ "firefox.dns_over_https.enable_dns_… │
│ │ has the value "false"
├───────────────────────────────────────┼──────────────────────────────────────┤
firefox.dns_over_https.custom_dns_url │ Custom DNS URL. │
 web address   basic   mandatory    │ Validators: │
disabled  │ • well-known ports (1 to 1023) are │
│ │ allowed │
│ │ • registred ports (1024 to 49151)
│ │ are allowed │
│ │ • type domainname │
│ │ • the domain name can be a hostname │
│ │ • must starts with 'https://' only │
│ │ Disabled: if
│ │ "firefox.dns_over_https.provider" is │
│ │ not "Custom"
└───────────────────────────────────────┴──────────────────────────────────────┘
Foxyproxy
▌ 🛈 Informations
▌ 
▌ This family is a namespace.
▌ Path: foxyproxy
▌  basic 
Proxy configuration
▌ 🛈 Informations
▌ 
▌ This family contains lists of variable blocks.
▌ Path: foxyproxy.proxies
▌  basic 
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
 Variable  ┃ Description  ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
foxyproxy.proxies.title │ Title or Description. │
 string   multiple   standard    │ │
unique  │ │
├───────────────────────────────────────┼──────────────────────────────────────┤
foxyproxy.proxies.type │ Proxy Type. │
 choice   standard   mandatory  │ Choices: │
│ │ • HTTP │
│ │ • HTTPS/SSL │
│ │ • SOCKS4 │
│ │ • SOCKS5 │
│ │ • PAC URL │
│ │ • WPAD │
│ │ • System (use system settings)
│ │ • Direct (no proxy) ← (default) │
├───────────────────────────────────────┼──────────────────────────────────────┤
foxyproxy.proxies.color │ Color. │
 regexp   basic   mandatory   auto  │ Validator: text based with regular │
modified  │ expressions │
│ │ "^#(?:[0-9a-f]{3}){1,2}$"
│ │ Default: random color value │
├───────────────────────────────────────┼──────────────────────────────────────┤
foxyproxy.proxies.address │ IP address, DNS name, server name. │
 domainname   standard   mandatory    │ Validators: │
disabled  │ • type domainname │
│ │ • the domain name can be a hostname │
│ │ • the domain name can be an IP │
│ │ Default: copy HTTP address if proxy │
│ │ is not "Manual"
│ │ Disabled: if type not in: │
│ │ - HTTP │
│ │ - HTTPS/SSL │
│ │ - SOCKS4 │
│ │ - SOCKS5 │
├───────────────────────────────────────┼──────────────────────────────────────┤
foxyproxy.proxies.port │ Port. │
 port   standard   mandatory    │ Validators: │
disabled  │ • well-known ports (1 to 1023) are │
│ │ allowed │
│ │ • registred ports (1024 to 49151)
│ │ are allowed │
│ │ • private ports (greater than 49152)
│ │ are allowed │
│ │ Default: copy HTTP port if proxy is │
│ │ not "Manual"
│ │ Disabled: if type not in: │
│ │ - HTTP │
│ │ - HTTPS/SSL │
│ │ - SOCKS4 │
│ │ - SOCKS5 │
├───────────────────────────────────────┼──────────────────────────────────────┤
foxyproxy.proxies.username │ Username. │
 UNIX user   standard   mandatory    │ Mandatory: if a password is set
disabled  │ Disabled: if type not in: │
│ │ - HTTP │
│ │ - HTTPS/SSL │
│ │ - SOCKS4 │
│ │ - SOCKS5 │
├───────────────────────────────────────┼──────────────────────────────────────┤
foxyproxy.proxies.password │ Password. │
 secret   standard   disabled  │ Disabled: if type not in: │
│ │ - HTTP │
│ │ - HTTPS/SSL │
│ │ - SOCKS4 │
│ │ - SOCKS5 │
├───────────────────────────────────────┼──────────────────────────────────────┤
foxyproxy.proxies.url │ URL. │
 web address   standard   mandatory  │ Validators: │
disabled  │ • well-known ports (1 to 1023) are │
│ │ allowed │
│ │ • registred ports (1024 to 49151)
│ │ are allowed │
│ │ • type domainname │
│ │ • the domain name can be a hostname │
│ │ Default: copy HTTP address if proxy │
│ │ is "Auto"
│ │ Disabled: if type is not in: │
│ │ - PAC URL │
│ │ - WPAD │
└───────────────────────────────────────┴──────────────────────────────────────┘