Changes between Version 50 and Version 51 of ConfigOptions


Ignore:
Timestamp:
Dec 2, 2019, 8:31:20 AM (22 months ago)
Author:
Even Rouault
Comment:

Partial migration of ConfigOptions to official site

Legend:

Unmodified
Added
Removed
Modified
  • ConfigOptions

    v50 v51  
    33= Configuration Options =
    44
    5 
    6 
    7 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.
    8 
    9 !ConfigOptions are normally used to alter the default behavior of GDAL and OGR drivers and in some cases the GDAL and OGR core.  They are essentially global variables the user can set. 
    10 
    11 == Setting !ConfigOptions ==
    12 
    13 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:
    14 {{{
    15 export GDAL_CACHEMAX=64
    16 }}}
    17 
    18 In a DOS/Windows command shell it is done like this:
    19 
    20 {{{
    21 set GDAL_CACHEMAX=64
    22 }}}
    23 
    24 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.
    25 
    26 {{{
    27 gdal_translate --config GDAL_CACHEMAX 64 in.tif out.tif
    28 }}}
    29 
    30 In C/C++ configuration switches can be set programmatically like this:
    31 
    32 {{{
    33 #include "cpl_conv.h"
    34 ...
    35     CPLSetConfigOption( "GDAL_CACHEMAX", "64" );
    36 }}}
    37 
    38 Normally a configuration option applies to all threads active in a program, but they can be limited to only the current thread this way:
    39 
    40 {{{
    41     CPLSetThreadLocalConfigOption( "GDAL_CACHEMAX", "64" );
    42 }}}
    43 
    44 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.
     5For general description refer to GDAL official website, consult https://gdal.org/user/configoptions.html
     6
     7Help appreciated to get the following content migrated as well to the official doc.
     8See https://gdal.org/user/configoptions.html#list-of-configuration-options-and-where-they-apply
    459
    4610== What Configuration Options Exist? ==