No description
| locale | ||
| src/rougail/output_display | ||
| tests | ||
| CHANGELOG.md | ||
| LICENSE | ||
| pyproject.toml | ||
| README.fr.md | ||
| README.md | ||
| test.md | ||
Table of Contents
Display variables and values
Note
Find all the variables and their values in your configuration (structural and user data). Additional informations are available, such as the default value, the location where the value is loaded, etc.
Path: display
disabled
Disabled: if display is not set in "Select for output"
| Variable | Description | Default value | Type | Validator |
|---|---|---|---|---|
| display.output_format Command line: --display.output_format Environment variable: DISPLAY.OUTPUT_FORMAT |
The output format for displaying variables. | console | choice mandatory |
Choices: • console • github |
| display.show_secrets Command line: • --display.show_secrets • --display.no-show_secrets Environment variable: DISPLAY.SHOW_SECRETS |
Show secrets instead of obscuring them. | false | boolean mandatory |
|
| display.mandatory Command line: • --display.mandatory • --display.no-mandatory Environment variable: DISPLAY.MANDATORY |
Test mandatories variables before display in display. | do not test if "Configuration in output step is in read_write mode" is true | boolean mandatory |
Specific configuration for console output
Note
Path: display.console
disabled
Disabled: when the variable "The output format for displaying variables" hasn't the value "console"
| Variable | Description | Type | Validator |
|---|---|---|---|
| display.console.max_width Command line: --display.console.max_width Environment variable: DISPLAY.CONSOLE.MAX_WIDTH |
Maximum number of characters per line. Null means unlimited. |
integer |
The minimum value is 50. |