Blame src/api/doxy/env.dp

Packit 3ff1e7
/** @page env Environment variables
Packit 3ff1e7
Packit 3ff1e7
@section LIBQUVI_EXCLUSIVE_SCRIPTS_DIR
Packit 3ff1e7
Packit 3ff1e7
When defined, the library will *only* use those scripts found at the
Packit 3ff1e7
directories specified by the LIBQUVI_SCRIPTS_DIR.
Packit 3ff1e7
Packit 3ff1e7
@note Useful, for example, when the current set of the scripts at
Packit 3ff1e7
      $top_srcdir/share/ (of libquvi-scripts) are being tested by the
Packit 3ff1e7
      testsuite of the libquvi-scripts.  The library would, otherwise,
Packit 3ff1e7
      include the scripts from the libquvi-scripts instance built with
Packit 3ff1e7
      the library and likely interfere with the tests.
Packit 3ff1e7
Packit 3ff1e7
@section LIBQUVI_SCRIPTS_DIR
Packit 3ff1e7
Packit 3ff1e7
When defined, the library will additionally look in the colon-separated list of
Packit 3ff1e7
directories specified by the LIBQUVI_SCRIPTS_DIR environment variable.
Packit 3ff1e7
Packit 3ff1e7
@section LIBQUVI_SHOW_DIR
Packit 3ff1e7
Packit 3ff1e7
When defined, the library will output the paths of the searched directories to
Packit 3ff1e7
the stderr.
Packit 3ff1e7
Packit 3ff1e7
@section LIBQUVI_SHOW_SCRIPT
Packit 3ff1e7
Packit 3ff1e7
When defined, the library will output the file names of the found scripts to stderr.
Packit 3ff1e7
The output will also indicate whether the script was accepted by the library.
Packit 3ff1e7
Packit 3ff1e7
@section LIBQUVI_SCRIPTS_VERBOSE
Packit 3ff1e7
Packit 3ff1e7
When defined, scripts using the 'quvi/debug' module messaging functions will output
Packit 3ff1e7
to stderr.
Packit 3ff1e7
Packit 3ff1e7
@section Proxy
Packit 3ff1e7
Packit 3ff1e7
Refer to the libcurl C API, or curl(1), documentation for a complete list of the
Packit 3ff1e7
supported environment variables. libquvi uses libcurl to access the Internet.
Packit 3ff1e7
Packit 3ff1e7
@sa http://curl.haxx.se/libcurl/c/curl_easy_setopt.html#CURLOPTPROXY
Packit 3ff1e7
*/