File: set_help.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 (28 lines) | stat: -rw-r--r-- 642 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
 
\DOC set_help

\TYPE {set_help : (string -> string)}

\SYNOPSIS
Specifies a filter to pipe help output through.

\DESCRIBE
Evaluating {set_help `filter`} will make future help output (generated in
response to a {help} command) be piped through the program {filter}. The
function returns the name of the previous filter. The default is {cat}, so
output is just sent to the console. Previous versions of HOL used {more} by
default.

\FAILURE
Never fails.

\EXAMPLE
{
#set_help `lpr`;;
`cat` : string
}
\noindent This causes the help file to be printed instead of being displayed.

\SEEALSO
help, help_search_path, set_help_search_path

\ENDDOC