aboutsummaryrefslogtreecommitdiff
path: root/pkg/system/phelp.cl
blob: 4de3eab22b71e99316384f3884b0974cebf558a6 (plain) (blame)
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
36
37
38
39
40
41
# PHELP -- Paged help.

procedure phelp (template)

string	template		{prompt="module name template"}

bool	file_template=no	{prompt="print help file"}
bool	all=yes			{prompt="find all modules matching template"}
string	parameter="all"		{prompt="parameter for which help is desired"}
string	section="all"		{prompt="section for which help is desired"}
string	option="help"		{prompt="type of help desired"}
int	lmargin=1		{min=1, prompt="left margin"}
int	rmargin=72		{min=2, prompt="right margin"}
string	helpdb="helpdb"		{prompt="help database to be used"}

begin
	file	helptext
	string	s_template

	# Get a temp file to hold help text.
	helptext = mktemp ("tmp$htx")
	s_template = template

	# Run HELP, redirecting the output to the temp file.
	help (s_template, > helptext, page=no,
	    all = all,
	    file_template = file_template,
	    parameter = parameter,
	    section = section,
	    option = option,
	    lmargin = lmargin,
	    rmargin = rmargin,
	    device = "terminal",
	    helpdb = helpdb)

	# Page saved text output.
	page (helptext, prompt = s_template)

	# Delete temp file.
	delete (helptext, verify-)
end