Skip to content

punchplatform-env.sh

NAME

punchplatform-env.sh - list Punch environment variables used by other punch commands.

SYNOPSIS

punchplatform-env.sh

Description

punchplatform-env.sh is a tool that checks/defines common environment variable, and is called by others punchplatform-*.sh commands. If called directly from the command-line, this tool will check applicable configuration (see environment variables below, and punchplatform.properties man page)

NOTES

The following environment variables affect the execution of punchplatform commands :

  • PUNCHPLATFORM_CONF_DIR :

    • The PUNCHPLATFORM_CONF_DIR variable must point to the directory holding the punchplatform.properties file.
  • PATH :

    • The bin directory of you punchplatform standalone setup must be included in your system path. First encountered version will prevail.
  • PUNCHPLATFORM_LOG_DIR :

    • can be defined to override the log directory in which punchplatform-XXXXX.sh commands will write their log/debug file. By default, this parameter is provided in punchplatform.properties configuration file via parameter punchplatform_log_dir.
  • PUNCHPLATFORM_LOG_FILE :

    • can be defined to override the log file name used by punchplatform-XXXXX.sh. By default the log file will be called 'punchplatform.log' and placed in PUNCHPLATFORM_LOG_DIR (see above)
  • COMMONS_LOG_MAX_SIZE :

    • can be defined to specify an other max log file size in bytes than the default 1MB. Past this size, the log file will be rotated
  • MAX_LOG_HISTORY :

    • can be defined to change the maximum number of rotated log files to keep (2 by default)
  • NOCOLOR :

    • can be defined to any non-empty value to deactivate use of terminal colors capabilities by punchplatform-XXXXX console output.
  • DEFAULTFGCOLOR :

    • the color number (as used by term capabilities) to use for non-highlighted characters (default : white, numeric value depending on terminal)
  • DEFAULTBGCOLOR :

    • the color number (as used by terminal capabilities) to use for non-highlighted characters background (default : black, numeric value depending on terminal)