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

169 lines
17 KiB
Bash
Raw 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 "proxy_mode" 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 Proxy
▌ 🛈 Informations
▌ 
▌ Path: manual.https_proxy
▌  standard   hidden 
▌ Hidden: when the variable "manual.use_for_https" has the value "true"
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
 Variable  ┃ Description  ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
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 │
│ │ "manual.http_proxy.address" │
├───────────────────────────────────────┼──────────────────────────────────────┤
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 │
│ │ "manual.http_proxy.port" │
└───────────────────────────────────────┴──────────────────────────────────────┘
SOCKS Proxy
▌ 🛈 Informations
▌ 
▌ Path: manual.socks_proxy
▌  standard 
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
 Variable  ┃ Description  ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
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 │
│ │ "manual.http_proxy.address" │
├───────────────────────────────────────┼──────────────────────────────────────┤
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 │
│ │ "manual.http_proxy.port" │
├───────────────────────────────────────┼──────────────────────────────────────┤
manual.socks_proxy.version │ SOCKS host version used by proxy. │
 choice   standard   mandatory  │ Choices: │
│ │ • v4 │
│ │ • v5 ← (default) │
└───────────────────────────────────────┴──────────────────────────────────────┘
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
 Variable  ┃ Description  ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
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 │
│ │ "proxy_mode" hasn't the value │
│ │ "Automatic proxy configuration URL"
├───────────────────────────────────────┼──────────────────────────────────────┤
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 │
│ │ "proxy_mode" has the value "No │
│ │ proxy"
├───────────────────────────────────────┼──────────────────────────────────────┤
prompt_authentication │ Prompt for authentication if
 boolean   standard   mandatory    │ password is saved. │
disabled  │ Default: true
│ │ Disabled: when the variable │
│ │ "proxy_mode" has the value "No │
│ │ proxy"
├───────────────────────────────────────┼──────────────────────────────────────┤
proxy_dns_socks5 │ Use proxy DNS when using SOCKS v5. │
 boolean   standard   mandatory    │ Default: false
disabled  │ Disabled: if "proxy_mode" is not │
│ │ "Manual proxy configuration"
│ │ or "manual.socks_proxy.version" is │
│ │ "v4"
└───────────────────────────────────────┴──────────────────────────────────────┘