Skip to content

overview.md

Latest commit

 

History

History
111 lines (104 loc) · 14 KB

overview.md

File metadata and controls

111 lines (104 loc) · 14 KB
Raw

9.4.1. Overview

The following table shall give a brief overview over the expected data types and the default values for the Argparser's environment variables.

Note that ARGPARSER_ARGS is for internal usage only and thus locally declared. It is not part of the Argparser's command line, but listed here for reference, like when you erroneously have it set in a configuration file. Its default value is seen as implementation detail and thus shown as "None" here.

Tab. 10: Overview over the Argparser environment variables.

Variable name Type1 Default value23
ARGPARSER_ADD_HELP bool true
ARGPARSER_ADD_USAGE bool true
ARGPARSER_ADD_VERSION bool true
ARGPARSER_ALLOW_ARG_INTERMIXING bool true
ARGPARSER_ALLOW_FLAG_INVERSION bool true
ARGPARSER_ALLOW_FLAG_NEGATION bool true
ARGPARSER_ALLOW_OPTION_ABBREVIATION bool false
ARGPARSER_ALLOW_OPTION_MERGING bool false
ARGPARSER_ALLOW_POSITIONAL_DELIMITER_END bool false
ARGPARSER_ALLOW_POSITIONAL_DELIMITER_START bool false
ARGPARSER_ARG_ARRAY_NAME str4 "args"
ARGPARSER_ARG_DEF_FILE file ""
ARGPARSER_ARG_DELIMITER_1 char "|"5
ARGPARSER_ARG_DELIMITER_2 char ","5
ARGPARSER_ARGS arr None (unset)
ARGPARSER_CHECK_ARG_DEF bool false
ARGPARSER_CHECK_ENV_VARS bool false
ARGPARSER_CONFIG_FILE file ""
ARGPARSER_COUNT_FLAGS bool false
ARGPARSER_CREATE_ARG_DEF bool false
ARGPARSER_DEBUG bool false
ARGPARSER_ERROR_EXIT_CODE int 1
ARGPARSER_ERROR_STYLE 6 str "red,bold,reverse"
ARGPARSER_FLAG_NEGATION_PREFIXES str "no"
ARGPARSER_HELP_ARG_GROUP str "Help options"
ARGPARSER_HELP_DESCRIPTION str ""
ARGPARSER_HELP_EXIT_CODE int 0
ARGPARSER_HELP_FILE file ""
ARGPARSER_HELP_FILE_INCLUDE_CHAR char "@"
ARGPARSER_HELP_FILE_KEEP_COMMENTS bool false
ARGPARSER_HELP_OPTIONS str "h,?,help"
ARGPARSER_HELP_STYLE 6 str "italic"
ARGPARSER_LANGUAGE str "en"
ARGPARSER_MAX_COL_WIDTH_1 uint 97
ARGPARSER_MAX_COL_WIDTH_2 uint 337
ARGPARSER_MAX_COL_WIDTH_3 uint 07
ARGPARSER_MAX_WIDTH uint 79
ARGPARSER_POSITIONAL_ARG_GROUP str "Positional arguments"
ARGPARSER_READ_ARGS bool true
ARGPARSER_SCRIPT_NAME str "${0##*/}"
ARGPARSER_SET_ARGS bool true
ARGPARSER_SET_ARRAYS bool true
ARGPARSER_SILENCE_ERRORS bool false
ARGPARSER_SILENCE_WARNINGS bool false
ARGPARSER_STYLE_FILE file ""
ARGPARSER_TRANSLATION_FILE file ""
ARGPARSER_UNSET_ARGS bool true
ARGPARSER_UNSET_ENV_VARS bool true
ARGPARSER_UNSET_FUNCTIONS bool true
ARGPARSER_USAGE_EXIT_CODE int 0
ARGPARSER_USAGE_FILE file ""
ARGPARSER_USAGE_FILE_INCLUDE_CHAR char "@"
ARGPARSER_USAGE_FILE_KEEP_COMMENTS bool false
ARGPARSER_USAGE_MESSAGE_OPTION_TYPE str "short"
ARGPARSER_USAGE_MESSAGE_ORIENTATION str "row"
ARGPARSER_USAGE_OPTIONS str "u,usage"
ARGPARSER_USAGE_STYLE 6 str "italic"
ARGPARSER_USE_COLORS bool true
ARGPARSER_USE_LONG_OPTIONS bool true
ARGPARSER_USE_SHORT_OPTIONS bool true
ARGPARSER_USE_STYLES str "tty"
ARGPARSER_USE_STYLES_IN_FILES 6 bool false
ARGPARSER_USE_UNICODE bool false
ARGPARSER_VERSION_EXIT_CODE int 0
ARGPARSER_VERSION_NUMBER str "1.0.0"
ARGPARSER_VERSION_OPTIONS str "V,version"
ARGPARSER_VERSION_STYLE 6 str "bold"
ARGPARSER_WARNING_STYLE 6 str "red,bold"
ARGPARSER_WRITE_ARGS bool false

🡄 Table of contents (Environment variables)           9.4.2. ARGPARSER_ADD_HELP 🡆

Footnotes

  1. Bash is weakly typed, hence the denoted types are just a guidance. ↩

  2. Strings can optionally be enclosed by quotes. ↩

  3. Booleans must be lowercase, i.e., true or false. ↩

  4. In fact, any legit Bash variable identifier. ↩

  5. Values must be different from each other. ↩ ↩2

  6. Deprecated environment variable. ↩ ↩2 ↩3 ↩4 ↩5 ↩6

  7. Sum of values is recommended to be 77, except when ARGPARSER_MAX_COL_WIDTH_3 is 0. ↩ ↩2 ↩3