File: help_search_path.doc

package info (click to toggle)
hol88 2.02.19940316-28
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 65,924 kB
  • ctags: 21,595
  • sloc: ml: 199,939; ansic: 9,666; sh: 7,118; makefile: 6,075; lisp: 2,747; yacc: 894; sed: 201; cpp: 87; awk: 5
file content (24 lines) | stat: -rw-r--r-- 816 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 help_search_path

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

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

\DESCRIBE
Evaluating {help_search_path()} returns a list of strings representing the
pathnames of the directories that are searched when the {help} function
searches for online help files. 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 the {help}
function looks for an online help file, the directories in the help search path
are searched in the order in which they occur in the list returned by
{help_search_path}.

\FAILURE
Never fails.

\SEEALSO
install, search_path, set_help_search_path, set_search_path.

\ENDDOC