Implement $ZYPP_LOCK_TIMEOUT: number of seconds to wait for a zypplock becoming avail...
[platform/upstream/libzypp.git] / doc / autoinclude / EnvironmentVariables.doc
1 /**
2
3 \page zypp-envars Environment Variables
4
5 \author Michael Andres <ma@suse.de>
6
7 \section zypp-envars-intro Environment Variables
8
9 Note that for Boolean variables we usually test whether the variable exists and not for the assigned value.
10
11 \subsection zypp-envars-config zypp config options
12
13 \li \c ZYPP_CONF=<PATH> Location of the zypp.conf file.
14 \li \c ZYPP_LOCK_TIMEOUT=<sec> If zypp is locked by another process wait this number of seconds for the lock becoming available.
15
16 \subsection zypp-envars-commit Variables related to commit
17
18 \li \c ZYPP_IS_RUNNING=1 Set during commit so packages pre/post/trigger scripts can detect whether rpm was called from within libzypp.
19
20 \subsection zypp-envars-logging Variables related to logging
21
22 \li \c ZYPP_LOGFILE=<PATH> Location of the logfile to write or \c - for stderr.
23 \li \c ZYPP_FULLLOG=1 Even more verbose logging (usually not needed).
24 \li \c ZYPP_LIBSOLV_FULLLOG=1 Verbose logging when resolving dependencies.
25 \li (\c ZYPP_LIBSAT_FULLLOG=1) deprecated since \c libzypp-10.x, prefer \c ZYPP_LIBSOLV_FULLLOG
26
27 \li \c ZYPP_MEDIA_CURL_DEBUG=<0|1> Log http headers, if \c 1 also log server responses.
28
29 \subsection zypp-envars-mediabackend Selecting the mediabackend to use.
30
31 \li \c ZYPP_MULTICURL=0 Turn off multicurl (metalink and zsync) and fall back to plain libcurl.
32 \li \c ZYPP_ARIA2C=1 Enable aria2c backend (deprecated).
33
34 \subsection zypp-envars-plugin Variables related to plugins
35
36 \li \c PLUGIN_DEBUG=1 Verbose logging from plugin framework.
37 \li \c PLUGIN_TIMEOUT=<sec> Send/receive timeout for plugin communication.
38 \li \c PLUGIN_SEND_TIMEOUT=<sec> Send timeout for plugin communication.
39 \li \c PLUGIN_RECEIVE_TIMEOUT=<sec> Receive timeout for plugin communication.
40
41 \subsection zypp-envars-misc Variables not for common use (test and debug)
42
43 \li \c ZYPP_MODALIAS_SYSFS=<PATH> Use this instead of \c /sys to evaluate modaliases.
44 \li \c ZYPP_COMMIT_NO_PACKAGE_CACHE=1
45 \li \c ZYPP_TESTSUITE_FAKE_ARCH Never use this!
46 \li \c ZYPPTMPDIR=<PATH>
47 \li \c ZYPP_LOCKFILE_ROOT=<PATH> Hack to circumvent the currently poor --root support.
48 \li \c ZYPP_PROFILING=1
49
50 */