File: search_path.doc

package info (click to toggle)
hol88 2.02.19940316dfsg-5
  • links: PTS
  • area: main
  • in suites: bookworm
  • size: 65,816 kB
  • sloc: ml: 199,939; ansic: 9,666; sh: 6,913; makefile: 6,032; lisp: 2,747; yacc: 894; sed: 201; cpp: 87; awk: 5
file content (35 lines) | stat: -rw-r--r-- 1,206 bytes parent folder | download | duplicates (11)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
\DOC search_path

\TYPE {search_path : (void -> string list)}

\SYNOPSIS
Returns the internal search path use by HOL to find files.

\DESCRIBE
Evaluating {search_path()} returns a list of strings representing the pathnames
of the directories that are searched when HOL makes access to files on disk
(using {load}, {compile}, {load_theory}, etc.). Although the search path can be
set to an arbitrary list of strings, each string in the search path is normally
expected to be either empty ({``}) or a pathname with `{/}' as its final
character.  When HOL looks for a file, the directories in the search path are
searched in the order in which they occur in the list returned by
{search_path}.

\FAILURE
Never fails.

\EXAMPLE
A typical search path is the following:
{
   #search_path();;
   [``; `~/`; `/usr/lib/hol/theories/`] : string list
}
\noindent With this search path, HOL first looks for a file in the current
working directory (the pathname represented by {``}), then in the user`s home
directory {`~/`}, and finally in the directory {`/usr/lib/hol/theories/`} (the
directory containing HOL`s built-in theories).

\SEEALSO
help_search_path, install, set_help_search_path, set_search_path.

\ENDDOC