Merge tag 'upstream/6.33.1_b2+dfsg.1'
[debian_inform6.git] / docs / README.paths
blobeb76f0fa5f199f8fadb5b8845794d26af2e484d0
1 Search paths
2 ============
4 To attempt to emulate the search path facility of the C preprocessor,
5 Inform is compiled with some built-in search paths.  For include files,
6 this is (in order of searching):
8     .                           current directory
9     PKGDATA/include             local include directory
10     PKGDATA/lib                 local library directory
11     PKGDATA/VERSION/include     system include directory
12     PKGDATA/VERSION/lib         system library directory
14 where PKGDATA is the package data prefix (default: /usr/local/share/inform)
15 and VERSION is the Inform version.  For modules, the search path is:
17     .                           current directory
18     PKGDATA/lib                 local library directory
19     PKGDATA/VERSION/lib         system library directory
21 This is as if Inform has been given the +include_file and +module_file
22 arguments with the comma-separated lists of directories shown above.
23 However, note that explicitly giving one of these arguments to Inform will
24 override the default setting, not prepend to it, as with the C
25 preprocessor.