aboutsummaryrefslogtreecommitdiff
path: root/docs/source/resource_files.rst
diff options
context:
space:
mode:
authorEven Rouault <even.rouault@spatialys.com>2019-12-01 17:45:05 +0100
committerEven Rouault <even.rouault@spatialys.com>2019-12-01 19:00:53 +0100
commitc645218219b7ff55578ec376caeed53c47bcde7e (patch)
tree6997240d3c74991569eb3b67d30426f075266b25 /docs/source/resource_files.rst
parentc3aa3fe4e9ba17737bb013ed6e7a647fdd5303fe (diff)
downloadPROJ-c645218219b7ff55578ec376caeed53c47bcde7e.tar.gz
PROJ-c645218219b7ff55578ec376caeed53c47bcde7e.zip
Doc: resource_files.rst: document where resource files are looked for (without recent Win32 specific addition)
Diffstat (limited to 'docs/source/resource_files.rst')
-rw-r--r--docs/source/resource_files.rst22
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/source/resource_files.rst b/docs/source/resource_files.rst
index 40eb9731..46d36805 100644
--- a/docs/source/resource_files.rst
+++ b/docs/source/resource_files.rst
@@ -14,6 +14,28 @@ In addition to the bundled init-files the PROJ project also distributes a number
of packages containing transformation grids and additional init-files not included
in the main PROJ package.
+Where are PROJ resource files looked for ?
+-------------------------------------------------------------------------------
+
+PROJ will attempt to locate its resource files - database, transformation grids
+or init-files - from several dictionaries.
+The following paths are checked in order:
+
+- For transformation grids that have an explict relative or absolute path,
+ the directory specified in the grid filename.
+- Path resolved by the callback function set with
+ the :c:func:`proj_context_set_file_finder`. If it is set, the next tests
+ will not be run.
+- Path(s) set with the :c:func:`proj_context_set_search_paths`. If set, the
+ next tests will not be run.
+- Path(s) set with by the environment variable :envvar:`PROJ_LIB`.
+ On Linux/MacOSX/Unix, use ``:`` to separate paths. On Windows, ``;``
+- A path built into PROJ as its resource installation directory (whose value is
+ $(pkgdatadir)), for builds using the Makefile build system. Note, however,
+ that since this is a hard-wired path setting, it only works if the whole
+ PROJ installation is not moved somewhere else.
+- The current directory
+
.. _proj-db:
proj.db