summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJohn J. Camilleri <john@johnjcamilleri.com>2018-07-22 14:48:44 +0200
committerGitHub <noreply@github.com>2018-07-22 14:48:44 +0200
commit895b479564c36e5d686a16852556ba54dc84f2be (patch)
treea109720842569c61389f896627eecf427f157d2a /doc
parentcd1942a8454d569363b201f2345953e648ec9b53 (diff)
parent7f86bee8e708d88bd218b090eb23764ce37f50a6 (diff)
Merge pull request #8 from legalese/GF_LIB_PATH
GF_LIB_PATH can now be path1:path2:path3, not just 1path
Diffstat (limited to 'doc')
-rw-r--r--doc/gf-reference.t2t26
-rw-r--r--doc/gf-refman.html5
2 files changed, 23 insertions, 8 deletions
diff --git a/doc/gf-reference.t2t b/doc/gf-reference.t2t
index d9a994a84..aab828f0a 100644
--- a/doc/gf-reference.t2t
+++ b/doc/gf-reference.t2t
@@ -412,21 +412,33 @@ use on-line ``h -FLAG``.
-===File paths===
+===File import search paths===
-Colon-separated lists of directories searched in the
+Colon-separated list of directories searched in the
given order:
```
--# -path=.:../abstract:../common:prelude
```
-This can be (in order of growing preference), as
-first line in the top file, as flag to ``gf``
+This can be (in order of increasing priority), as
+first line in the file, as flag to ``gf``
when invoked, or as flag to the ``i`` command.
The prefix ``--#`` is used only in files.
-If the environment variabls ``GF_LIB_PATH`` is defined, its
-value is automatically prefixed to each directory to
-extend the original search path.
+GF attempts to satisfy an ``import`` command by searching for the
+import filename in the above search paths, initially qualified
+relative to the current working directory. If the file is not found in
+that initial expansion, the search paths are re-qualified relative to
+the directories given in the ``GF_LIB_PATH`` environment variable. If
+``GF_LIB_PATH`` is not defined, its default value is
+``/usr/local/share/gf-3.9/lib`` (assuming you have GF version 3.9).
+
+If your GF resource grammar libraries are installed somewhere else,
+you will want to set ``GF_LIB_PATH`` to point there instead. In a
+pinch, you can point to the ``GF/lib/src/`` folder in your clone of
+the GF source code repository.
+
+Developers of resource grammars may find it useful to define multiple
+directories, colon-separated, in ``GF_LIB_PATH``.
===Alternative grammar formats===
diff --git a/doc/gf-refman.html b/doc/gf-refman.html
index 19e943c49..e7db8829a 100644
--- a/doc/gf-refman.html
+++ b/doc/gf-refman.html
@@ -3204,7 +3204,10 @@ in the top of <CODE>FILE.gf</CODE> causes the GF compiler, when invoked on <CODE
to search through the current directory (<CODE>.</CODE>) and the directories
<CODE>present</CODE>, <CODE>prelude</CODE>, and <CODE>/home/aarne/GF/tmp</CODE>, in this order.
If a directory <CODE>DIR</CODE> is not found relative to the working directory,
-also <CODE>$(GF_LIB_PATH)/DIR</CODE> is searched.
+<CODE>$(GF_LIB_PATH)/DIR</CODE> is searched. <CODE>$GF_LIB_PATH</CODE>
+can be a colon-separated list of directories, in which case each directory
+in the list contributes to the search path expansion.
+
</P>
<A NAME="toc53"></A>
<H2>Alternative grammar input formats</H2>