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

98 lines
9.6 KiB
Bash
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
 Variable  ┃ Description  ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
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: manual
▌  basic   disabled 
▌ Disabled: when the variable "Configure Proxy Access to the Internet" hasn't
the value "Manual proxy configuration".
HTTP Proxy
▌ 🛈 Informations
▌ 
▌ Path: manual.http_proxy
▌  basic 
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
 Variable  ┃ Description  ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
manual.http_proxy.address │ Proxy address. │
 domainname   basic   mandatory  │ Validators: │
│ │ • type domainname │
│ │ • the domain name can be an IP │
├───────────────────────────────────────┼──────────────────────────────────────┤
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  ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
manual.use_for_https │ Also use this proxy for HTTPS. │
 boolean   standard   mandatory  │ Default: true
└───────────────────────────────────────┴──────────────────────────────────────┘
HTTPS or SOCKS Proxy
▌ 🛈 Informations
▌ 
▌ This family builds families dynamically.
▌ Path:
▌  • manual.https_proxy
▌  • manual.socks_proxy
▌  standard   hidden 
▌ Hidden: in HTTPS case if "Also use this proxy for HTTPS" is set to "true".
▌ Identifiers:
▌  • HTTPS
▌  • SOCKS
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
 Variable  ┃ Description  ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
manual.https_proxy.address │ HTTPS or SOCKS address. │
manual.socks_proxy.address │ Validators: │
 domainname   standard   mandatory  │ • type domainname │
│ │ • the domain name can be an IP │
│ │ Default: the value of the variable │
│ │ "Proxy address"
├───────────────────────────────────────┼──────────────────────────────────────┤
manual.https_proxy.port │ HTTPS or SOCKS port. │
manual.socks_proxy.port │ Validators: │
 port   standard   mandatory  │ • 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 │
│ │ "Proxy port"
├───────────────────────────────────────┼──────────────────────────────────────┤
manual.socks_proxy.version │ SOCKS host version used by proxy. │
 choice   standard   mandatory    │ Choices: │
disabled  │ • v4 │
│ │ • v5 ← (default) │
│ │ Disabled: when the identifier is │
│ │ "HTTPS". │
└───────────────────────────────────────┴──────────────────────────────────────┘