document the GUC postgis.gdal_enabled_drivers

git-svn-id: http://svn.osgeo.org/postgis/trunk@12475 b70326c6-7e19-0410-871a-916f4a2858ee

diff --git a/doc/reference_guc.xml b/doc/reference_guc.xml
index e7eeaae85d3fcd1001fa19d15125f8d1c5774ce7..f42e45d48363a52aac4b1e3b5e024a6789d10c11 100644 (file)
--- a/doc/reference_guc.xml
+++ b/doc/reference_guc.xml
@@ -78,4 +78,84 @@ SET postgis.gdal_datapath = 'C:/Program Files/PostgreSQL/9.3/gdal-data';</progra
                        </refsection>\r
        </refentry>\r
 \r
+  <refentry id="postgis_gdal_enabled_drivers">\r
+                       <refnamediv>\r
+                               <refname>postgis.gdal_enabled_drivers</refname>\r
+                               <refpurpose>\r
+                                       A configuration option to set the enabled GDAL drivers in the PostGIS environment. Affects the GDAL configuration variable GDAL_SKIP.\r
+                               </refpurpose>\r
+                       </refnamediv>\r
+\r
+                       <refsection>\r
+                               <title>Description</title>\r
+                               <para>\r
+                                       A configuration option to set the enabled GDAL drivers in the PostGIS environment. Affects the GDAL configuration variable GDAL_SKIP.\r
+                               </para>\r
+                               <para>\r
+                                       Enabled GDAL specified drivers can be specified by the driver's short-name or code. Driver short-names or codes can be found at <ulink url='http://www.gdal.org/formats_list.html'>GDAL Raster Formats</ulink>. Multiple drivers can be specified by putting a space between each driver.\r
+                               </para>\r
+\r
+                               <note>\r
+                                       <para>\r
+                                               This option can be set in PostgreSQL's configuration file: postgresql.conf. It can also be set by connection or transaction.\r
+                                       </para>\r
+                               </note>\r
+\r
+                               <note>\r
+                                       <para>\r
+                                               There are two special codes available to enable or disable all GDAL drivers: ENABLE_ALL and DISABLE_ALL. The codes are case-sensitive.\r
+                                       </para>\r
+                                       <para>\r
+                                               When <varname>postgis.gdal_enabled_drivers</varname> is set to DISABLE_ALL, attempts to use out-db rasters, ST_FromGDALRaster(), ST_AsGDALRaster(), ST_AsTIFF(), ST_AsJPEG() and ST_AsPNG() will result in error messages.\r
+                                       </para>\r
+                               </note>\r
+\r
+                               <note>\r
+                                       <para>\r
+                                               In the standard PostGIS installation, <varname>postgis.gdal_enabled_drivers</varname> is set to DISABLE_ALL.\r
+                                       </para>\r
+                               </note>\r
+\r
+                               <note>\r
+                                       <para>\r
+                                               Additional information about GDAL_SKIP is available at GDAL's <ulink url="http://trac.osgeo.org/gdal/wiki/ConfigOptions">Configuration Options</ulink>.\r
+                                       </para>\r
+                               </note>\r
+\r
+                               <para>Availability: 2.2.0</para>\r
+\r
+                       </refsection>\r
+\r
+                       <refsection>\r
+                               <title>Examples</title>\r
+                               <para>Set and reset <varname>postgis.gdal_enabled_drivers</varname></para>\r
+\r
+                               <programlisting>\r
+SET postgis.gdal_enabled_drivers TO 'GTiff PNG JPEG';\r
+SET postgis.gdal_enabled_drivers = default;\r
+                               </programlisting>\r
+                               \r
+                               <para>Enable all GDAL Drivers</para>\r
+                               <programlisting>\r
+SET postgis.gdal_enabled_drivers = 'ENABLE_ALL';\r
+                               </programlisting>\r
+\r
+                               <para>Disable all GDAL Drivers</para>\r
+                               <programlisting>\r
+SET postgis.gdal_enabled_drivers = 'DISABLE_ALL';\r
+                               </programlisting>\r
+                       </refsection>\r
+\r
+                       <refsection>\r
+                               <title>See Also</title>\r
+                               <para>\r
+                                       <xref linkend="RT_ST_FromGDALRaster" />, \r
+                                       <xref linkend="RT_ST_AsGDALRaster" />, \r
+                                       <xref linkend="RT_ST_AsTIFF" />, \r
+                                       <xref linkend="RT_ST_AsPNG" />, \r
+                                       <xref linkend="RT_ST_AsJPEG" />\r
+                               </para>\r
+                       </refsection>\r
+       </refentry>\r
+\r
 </sect1>\r