File: set_help_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 (24 lines) | stat: -rw-r--r-- 828 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
\DOC set_help_search_path

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

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

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

\FAILURE
Never fails.

\SEEALSO
help_search_path, install, search_path, set_search_path.

\ENDDOC