Skip to content

Standard Environment Variables

Paul Bunyan edited this page Jun 14, 2014 · 9 revisions

For environment variables from previous versions, see Standard Environment Variables (old versions).

This page lists all of the environment variables provided by iash. They cannot be removed. In any release of iash, they have the iash_ prefix.

Version: v0.2 "Firmament"

Valid environment variables

  • IASH_APP_NAME (string, defaults to "iash"): The name of the application.
  • IASH_APP_NAME_IN_PROMPT (boolean, defaults to true): Whether or not to display the application name in command prompts.
  • IASH_SYNC_ENV (boolean, defaults to true): This determines whether iash will sync its internal variables with their corresponding environment variables.
  • IASH_DEBUG_ACTIVE (boolean, defaults to false): This tells if the iash debug console is running.
    • WARNING: This should only be read from. Setting this variable manually can have unforeseen consequences.
  • IASH_CONFIG_PATH (string, see defaults below): The path to write configuration files to.
    • WARNING: Because iash uses this path to load the previous environment, only the configuration written to the default path will be read.
    • Defaults:
      • Unix-based platforms: $HOME/.config/$IASH_APP_NAME
      • Windows Vista+: %LOCALAPPDATA%\$IASH_APP_NAME
      • Windows 2000/XP: %APPDATA%\$IASH_APP_NAME

Phasing out

This lists all of the environment variables that were phased out by this release (but not yet removed). All environment variables that were phased out before and have not been removed are still being phased out.

  • IASH_SYNC_ENV: Its original intention, to change the prompt when the debugger is running, has been replaced by $IASH_DEBUG_ACTIVE.