File: set_library_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 (34 lines) | stat: -rw-r--r-- 1,256 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
\DOC set_library_search_path

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

\SYNOPSIS
Sets the internal search path use by HOL to find libraries.

\DESCRIBE
When applied to a list of strings {l}, each of which represents the pathname to
a directory, {set_library_search_path} sets the internal search path used when
the {load_library} function searches for library load files to the list {l}.
Although the library search path can be set to an arbitrary list of strings,
each string is normally expected to be a pathname with `{/}' as its final
character.  When {load_library} looks for a library load file, the directories
in the search path are searched in the order in which they occur in the list
supplied to {set_library_search_path}.

\FAILURE
Never fails.

\EXAMPLE 
The following call adds a user's local library directory {~/hol/lib/} to the
library search path:
{
   set_library_search_path (union [`~/hol/lib/`] (library_search_path()));;
}
\noindent Users with local libraries would typically have a line of this form
in their {hol-init} file. Note that the function {union} is used to avoid
multiple occurrences of the same pathname in the library search path.

\SEEALSO
library_pathname, library_search_path, load_library.

\ENDDOC