Configuration options¶
This page discussed runtime configuration options for GDAL, and is distinct from options to the build-time configure script. Runtime configuration options apply on all platforms, and are evaluated at runtime. They can be set programmatically, by commandline switches or in the environment by the user.
Configuration options are normally used to alter the default behavior of GDAL/OGR drivers and in some cases the GDAL/OGR core. They are essentially global variables the user can set.
How to set configuration options ?¶
One example of a config option is the GDAL_CACHEMAX option. It controls the size of the GDAL block cache, in megabytes. It can be set in the environment on Unix (bash/bourne) shell like this:
export GDAL_CACHEMAX=64
In a DOS/Windows command shell it is done like this:
set GDAL_CACHEMAX=64
It can also be set on the commandline for most GDAL and OGR utilities with the
--config
switch, though in a few cases these switches are not evaluated in
time to affect behavior.
gdal_translate --config GDAL_CACHEMAX 64 in.tif out.tif
In C/C++ configuration switches can be set programmatically with
CPLSetConfigOption()
:
#include "cpl_conv.h"
...
CPLSetConfigOption( "GDAL_CACHEMAX", "64" );
Normally a configuration option applies to all threads active in a program, but
they can be limited to only the current thread with
CPLSetThreadLocalConfigOption()
CPLSetThreadLocalConfigOption( "GTIFF_DIRECT_IO", "YES" );
For boolean options, the values YES, TRUE or ON can be used to turn the option on; NO, FALSE or OFF to turn it off.
List of configuration options and where they apply¶
Note
This list is known to be incomplete. It depends on proper annotation of configuration
options where they are mentionned elsewhere in the documentation.
If you want to help to extend it, use the :decl_configoption:`NAME`
syntax in places where a configuration option is mentionned.
AWS_CONFIG_FILE: GDAL Virtual File Systems (compressed, network hosted, etc...): /vsimem, /vsizip, /vsitar, /vsicurl, ...
AWS_NO_SIGN_REQUEST=YES: GDAL Virtual File Systems (compressed, network hosted, etc...): /vsimem, /vsizip, /vsitar, /vsicurl, ...
AWS_REGION: GDAL Virtual File Systems (compressed, network hosted, etc...): /vsimem, /vsizip, /vsitar, /vsicurl, ...
AWS_REQUEST_PAYER: GDAL Virtual File Systems (compressed, network hosted, etc...): /vsimem, /vsizip, /vsitar, /vsicurl, ...
AWS_S3_ENDPOINT: GDAL Virtual File Systems (compressed, network hosted, etc...): /vsimem, /vsizip, /vsitar, /vsicurl, ...
AWS_SECRET_ACCESS_KEY: GDAL Virtual File Systems (compressed, network hosted, etc...): /vsimem, /vsizip, /vsitar, /vsicurl, ...
AWS_VIRTUAL_HOSTING: GDAL Virtual File Systems (compressed, network hosted, etc...): /vsimem, /vsizip, /vsitar, /vsicurl, ...
AZURE_STORAGE_ACCOUNT: GDAL Virtual File Systems (compressed, network hosted, etc...): /vsimem, /vsizip, /vsitar, /vsicurl, ...
AZURE_STORAGE_CONNECTION_STRING: GDAL Virtual File Systems (compressed, network hosted, etc...): /vsimem, /vsizip, /vsitar, /vsicurl, ...
COMPRESS_OVERVIEW: gdaladdo
CPL_AWS_CREDENTIALS_FILE: GDAL Virtual File Systems (compressed, network hosted, etc...): /vsimem, /vsizip, /vsitar, /vsicurl, ...
CPL_GS_CREDENTIALS_FILE: GDAL Virtual File Systems (compressed, network hosted, etc...): /vsimem, /vsizip, /vsitar, /vsicurl, ...
CPL_MACHINE_IS_GCE: GDAL Virtual File Systems (compressed, network hosted, etc...): /vsimem, /vsizip, /vsitar, /vsicurl, ...
CPL_VSIL_CURL_CACHE_SIZE: GDAL Virtual File Systems (compressed, network hosted, etc...): /vsimem, /vsizip, /vsitar, /vsicurl, ...
CPL_VSIL_CURL_CHUNK_SIZE: GDAL Virtual File Systems (compressed, network hosted, etc...): /vsimem, /vsizip, /vsitar, /vsicurl, ...
CPL_VSIL_CURL_IGNORE_GLACIER_STORAGE: GDAL Virtual File Systems (compressed, network hosted, etc...): /vsimem, /vsizip, /vsitar, /vsicurl, ...
CPL_VSIL_CURL_NON_CACHED: GDAL Virtual File Systems (compressed, network hosted, etc...): /vsimem, /vsizip, /vsitar, /vsicurl, ...
CPL_VSIL_CURL_USE_HEAD: GDAL Virtual File Systems (compressed, network hosted, etc...): /vsimem, /vsizip, /vsitar, /vsicurl, ...
CPL_VSIL_CURL_USE_S3_REDIRECT: GDAL Virtual File Systems (compressed, network hosted, etc...): /vsimem, /vsizip, /vsitar, /vsicurl, ...
CPL_VSIL_GZIP_WRITE_PROPERTIES: GDAL Virtual File Systems (compressed, network hosted, etc...): /vsimem, /vsizip, /vsitar, /vsicurl, ...
CURL_CA_BUNDLE: GDAL Virtual File Systems (compressed, network hosted, etc...): /vsimem, /vsizip, /vsitar, /vsicurl, ...
ESRI_XML_PAM: GTiff -- GeoTIFF File Format
GDAL_ENABLE_TIFF_SPLIT: GTiff -- GeoTIFF File Format
GDAL_GEOREF_SOURCES: GTiff -- GeoTIFF File Format
GDAL_HTTP_HEADER_FILE: GDAL Virtual File Systems (compressed, network hosted, etc...): /vsimem, /vsizip, /vsitar, /vsicurl, ...
GDAL_HTTP_MAX_RETRY: GDAL Virtual File Systems (compressed, network hosted, etc...): /vsimem, /vsizip, /vsitar, /vsicurl, ...
GDAL_HTTP_PROXY: GDAL Virtual File Systems (compressed, network hosted, etc...): /vsimem, /vsizip, /vsitar, /vsicurl, ...
GDAL_HTTP_RETRY_DELAY: GDAL Virtual File Systems (compressed, network hosted, etc...): /vsimem, /vsizip, /vsitar, /vsicurl, ...
GDAL_NUM_THREADS:
GDAL_TIFF_INTERNAL_MASK: GTiff -- GeoTIFF File Format
GDAL_TIFF_INTERNAL_MASK_TO_8BIT: GTiff -- GeoTIFF File Format
GDAL_TIFF_OVR_BLOCKSIZE: GTiff -- GeoTIFF File Format
GDAL_TRY_PDS3_WITH_VICAR:
GOOGLE_APPLICATION_CREDENTIALS: GDAL Virtual File Systems (compressed, network hosted, etc...): /vsimem, /vsizip, /vsitar, /vsicurl, ...
GS_OAUTH2_PRIVATE_KEY: GDAL Virtual File Systems (compressed, network hosted, etc...): /vsimem, /vsizip, /vsitar, /vsicurl, ...
GS_OAUTH2_REFRESH_TOKEN: GDAL Virtual File Systems (compressed, network hosted, etc...): /vsimem, /vsizip, /vsitar, /vsicurl, ...
GS_SECRET_ACCESS_KEY: GDAL Virtual File Systems (compressed, network hosted, etc...): /vsimem, /vsizip, /vsitar, /vsicurl, ...
GTIFF_DIRECT_IO: GTiff -- GeoTIFF File Format
GTIFF_IGNORE_READ_ERRORS: GTiff -- GeoTIFF File Format
GTIFF_LINEAR_UNITS: GTiff -- GeoTIFF File Format
GTIFF_POINT_GEO_IGNORE: GTiff -- GeoTIFF File Format
GTIFF_REPORT_COMPD_CS: GTiff -- GeoTIFF File Format
GTIFF_VIRTUAL_MEM_IO: GTiff -- GeoTIFF File Format
GTIFF_WRITE_TOWGS84: GTiff -- GeoTIFF File Format
INTERLEAVE_OVERVIEW: gdaladdo
JPEG_QUALITY_OVERVIEW: GTiff -- GeoTIFF File Format
MITAB_SET_TOWGS84_ON_KNOWN_DATUM: MapInfo TAB and MIF/MID
OGR_PDF_READ_NON_STRUCTURED: PDF -- Geospatial PDF
OGR_SQL_LIKE_AS_ILIKE: OGR SQL dialect
OSS_SECRET_ACCESS_KEY: GDAL Virtual File Systems (compressed, network hosted, etc...): /vsimem, /vsizip, /vsitar, /vsicurl, ...
PHOTOMETRIC_OVERVIEW: gdaladdo
SHAPE_ENCODING: ESRI Shapefile / DBF
SWIFT_AUTH_V1_URL: GDAL Virtual File Systems (compressed, network hosted, etc...): /vsimem, /vsizip, /vsitar, /vsicurl, ...
SWIFT_STORAGE_URL: GDAL Virtual File Systems (compressed, network hosted, etc...): /vsimem, /vsizip, /vsitar, /vsicurl, ...
TAB_APPROX_GEOTRANSFORM: GTiff -- GeoTIFF File Format
TIFF_USE_OVR: GTiff -- GeoTIFF File Format
USE_RRD:
VSIOSS_CHUNK_SIZE: GDAL Virtual File Systems (compressed, network hosted, etc...): /vsimem, /vsizip, /vsitar, /vsicurl, ...
VSIS3_CHUNK_SIZE: GDAL Virtual File Systems (compressed, network hosted, etc...): /vsimem, /vsizip, /vsitar, /vsicurl, ...
WEBHDFS_DATANODE_HOST: GDAL Virtual File Systems (compressed, network hosted, etc...): /vsimem, /vsizip, /vsitar, /vsicurl, ...
WEBHDFS_DELEGATION: GDAL Virtual File Systems (compressed, network hosted, etc...): /vsimem, /vsizip, /vsitar, /vsicurl, ...
WEBHDFS_PERMISSION: GDAL Virtual File Systems (compressed, network hosted, etc...): /vsimem, /vsizip, /vsitar, /vsicurl, ...
WEBHDFS_REPLICATION: GDAL Virtual File Systems (compressed, network hosted, etc...): /vsimem, /vsizip, /vsitar, /vsicurl, ...
WEBHDFS_USERNAME: GDAL Virtual File Systems (compressed, network hosted, etc...): /vsimem, /vsizip, /vsitar, /vsicurl, ...