[go: up one dir, main page]
Menu ▾ ▴

[267579]: / man / en_US / hlp.tea  Maximize  Restore  History

Download this file

94 lines (66 with data), 3.5 kB 

 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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
#

#   Dos9 Manual pages, The Dos9 project

#   Copyright (C) 2012-2014  Romain Garbi (DarkBatcher)

#

#   This program is free software: you can redistribute it and/or modify

#   it under the terms of the GNU General Public License as published by

#   the Free Software Foundation, either version 3 of the License, or

#   (at your option) any later version.

#

#   This program is distributed in the hope that it will be useful,

#   but WITHOUT ANY WARRANTY; without even the implied warranty of

#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

#   GNU General Public License for more details.

#

#   You should have received a copy of the GNU General Public License

#   along with this program.  If not, see <http://www.gnu.org/licenses/>.

#



{{HLP Command}}



	The {HLP} command print command help. It is a batch script acting as

	a front-end of the {tea|TEA} command.



{{Synopsis}}



${HLP [name | /b language [encoding] | /l | /d]}



	Print a manual page.



	- {name} : The name of the manual page to be printed.



	- {/b} : Build documentation for a given language and a given encoding.

	This switch is used to produce files from {tea|TEA} documents shipped

	with {Dos9}. The parameters that can be specified are:



		-- {language} : The language in which the documentation will be

		generated. A list of languages available can be obtained through

		the {/l} switch.



		-- {encoding} : The encoding that will be used by generated manual

		pages. This parameters requires {iconv|GNU iconv} to be installled.

		The default encoding is {utf-8}. This parameter is usefull if your

		terminal does not support {utf-8} encoding.



	- {/l} : Print a list of all languages avaliable on the current machine.

	Available languages are shown through {POSIX} locales, that is in form of

	{language_COUNTRY} where {language} and {country} are both abbreviations.

	

	- {/c} : Configures {hlp.bat} command parameter. Prompt the user for the

	selected language, format (html, text or ansi) and encoding to be used.

	This option is an user-friendly way to configure the configuration file

	{%USERPROFILE%/.dos9/hlp/hlp.conf.bat}.

	

{{Config file}}



${%USERPROFILE%/share/hlp/hlp.conf.bat}



	A batch script defining hlp setting through a set of variables. This file

	can be generated using the {/c} switch. This file is run on {hlp.bat} startup.

	Variables that must be set are the following:



		- {%mode%} : The file format to be used by {hlp.bat}. It must be one of the

		following three formats:

		

			-- {html} : Help pages will be displayed through an html medium and a web

			browser. This requires a web browser and a working {start} command.

			

			-- {ansi} : Help pages will be displayed at the command prompt, using

			ANSI escape codes for formatting. This obviously requires an ANSI-compatible

			terminal.

			-- {txt} : Help pages will be displayed at the command prompt using plain text



		- {%locale%} : The language of help pages using a {POSIX} local (e.g {language_COUNTRY}).

		The corresponding locale has to be installed in {%DOS9_PATH%/share/hlp/man}.

	

		- {%view_cmd%} : The command to be used for Help pages display. This can either be an

		internal or an external command. By default, {hlp} uses :



		${set view_cmd=!%mode%_prg!}



		@- Where variables {%txt_prg%}, {%html_prg%} et {%ansi_prg%} define the commands to be

		executed for every format.



{{Compatibility}}



	{HLP} is not compatible with {cmd.exe}



	Available since version {2014.0.9b}.



{{See also}}



	{help|HELP command}, {tea|TEA command}