The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

Name

sqitch-environment - Environment variables recognized by Sqitch

Description

Sqitch supports a number of environment variables that affect its functionality. This document lists them all, along with brief descriptions of their purposes and pointers to relevant documentation.

SQITCH_CONFIG

Path to the project configuration file. Overrides the default, which is ./sqitch.conf. See sqitch-config for details.

SQITCH_USER_CONFIG

Path to the user's configuration file. Overrides the default, which is ./.sqitch/sqitch.conf. See sqitch-config for details.

SQITCH_SYSTEM_CONFIG

Path to the system's configuration file. Overrides the default, which is a file named sqitch.conf in the directory identified by sqitch --etc. See sqitch-config for details.

SQITCH_PASSWORD

Password to use when connecting to a database, for those database engines that support it. See sqitch-passwords for details.

SQITCH_EDITOR

The editor that Sqitch will launch when the user needs to edit some text (a change note, for example). If unset, the core.editor configuration variable will be used. If it's not set, $VISUAL or $EDITOR will be consulted (in that order). Finally, if none of these are set, Sqitch will invoke notepad.exe on Windows and vi elsewhere.

SQITCH_PAGER

The pager program that Sqitch will use when a command (like sqitch log) produces multi-page output. If unset, the core.pager configuration variable will be used. If this is also not set, the PAGER environment variable will be used. Finally, if none of these are set, Sqitch will attempt to find and use one of the commonly used pager programs like less and more.

See Also

Sqitch

Part of the sqitch suite.