diff options
author | Joe Hunkeler <jhunkeler@gmail.com> | 2015-08-11 16:51:37 -0400 |
---|---|---|
committer | Joe Hunkeler <jhunkeler@gmail.com> | 2015-08-11 16:51:37 -0400 |
commit | 40e5a5811c6ffce9b0974e93cdd927cbcf60c157 (patch) | |
tree | 4464880c571602d54f6ae114729bf62a89518057 /pkg/softools/mkmanpage.hlp | |
download | iraf-osx-40e5a5811c6ffce9b0974e93cdd927cbcf60c157.tar.gz |
Repatch (from linux) of OSX IRAF
Diffstat (limited to 'pkg/softools/mkmanpage.hlp')
-rw-r--r-- | pkg/softools/mkmanpage.hlp | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/pkg/softools/mkmanpage.hlp b/pkg/softools/mkmanpage.hlp new file mode 100644 index 00000000..75721696 --- /dev/null +++ b/pkg/softools/mkmanpage.hlp @@ -0,0 +1,43 @@ +.help mkmanpage Feb86 softools +.ih +NAME +mkmanpage -- create and edit a new manual page +.ih +USAGE +mkmanage module +.ih +PARAMETERS +.ls module +The name of the program to be documented, i.e., the name that will appear at +the top of the manual page, and the root name of the ".hlp" file to be +created. +.le +.ls clformat = yes +Make a CL format manual page template? +.le +.ls cltemplate = "doc$mancl.hlp" +Filename of the template file for a CL manual page. +.le +.ls xtemplate = "doc$manx.hlp" +Filename of the template file for a library procedure manual page. +.le +.ih +DESCRIPTION +The \fImkmanpage\fR task is used to create a fill-in-the-blanks type +template, to be edited to create the manual page for the named help module +or task. Depending upon the type of manual page to be created, \fImkmanpage\fR +copies the template file to the current directory, creating a new file with +the name "module.hlp", where \fImodule\fR is the name entered on the +command line. The editor is called up to edit the file and the task exits. +.ih +EXAMPLES +1. Make a new manual page for task "page". + + cl> mkmanpage page + +The task creates a file "page.hlp" in the current directory, and calls +up the editor to edit the new file. +.ih +SEE ALSO +mkhelpdb, help, lroff +.endhelp |