diff options
| author | Joseph Hunkeler <jhunkeler@gmail.com> | 2015-07-08 20:46:52 -0400 |
|---|---|---|
| committer | Joseph Hunkeler <jhunkeler@gmail.com> | 2015-07-08 20:46:52 -0400 |
| commit | fa080de7afc95aa1c19a6e6fc0e0708ced2eadc4 (patch) | |
| tree | bdda434976bc09c864f2e4fa6f16ba1952b1e555 /pkg/system/help/hdbexamine.hlp | |
| download | iraf-linux-fa080de7afc95aa1c19a6e6fc0e0708ced2eadc4.tar.gz | |
Initial commit
Diffstat (limited to 'pkg/system/help/hdbexamine.hlp')
| -rw-r--r-- | pkg/system/help/hdbexamine.hlp | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/pkg/system/help/hdbexamine.hlp b/pkg/system/help/hdbexamine.hlp new file mode 100644 index 00000000..a7498c23 --- /dev/null +++ b/pkg/system/help/hdbexamine.hlp @@ -0,0 +1,55 @@ +.help hdbexamine Feb86 softools +.ih +NAME +hdbexamine -- examine a help database +.ih +USAGE +hdbexamine +.ih +PARAMETERS +.ls helpdb = "helpdb" +The filename of the help database to be examined. The reserved name "helpdb" +causes the actual filename to be taken from the environment variable of +the same name. +.le +.ls verbose = no +If this switch is enabled, \fIhdbexamine\fR will print a detailed description +of the help database listing the modules in each package, the date the entry +for the package was last modified, and other information. A more concise +summary listing only the packages and the number of help modules in each +package is printed by default. +.le +.ih +DESCRIPTION +The \fIhdbexamine\fR task is used to examine the contents of a help +database. By default the standard IRAF help database is examined. +Examining the help database with \fIhdbexamine\fR verifies that it can +be read by \fIhelp\fR, and may be useful as a diagnostic in the event +that an invalid help directory file (".hd") somewhere in the help +directory tree, causes the database to be compiled incorrectly. +.ih +EXAMPLES +1. Print a concise summary of the contents and structure of the standard +help database. + +.nf +cl> hdbexamine +Help database dev$help.db created Feb 14 21:34 by tody +Database contains 794 modules in 43 packages, file size 105460 bytes + +_clpackage Nov 4 1984 tody clpackage$_clpackage.hd +clpackage May 29 17:44 rooke clpackage$clpackage.hd +os Feb 13 11:06 tody host$os/doc/os.hd +root Nov 4 1984 tody lib$root.hd +_math Apr 1 13:38 tody math$_math.hd +curfit Jan 6 16:23 tody math$curfit/doc/curfit.hd +gsurfit Jan 2 14:46 davis math$gsurfit/doc/gsurfit.hd +iminterp Aug 6 16:31 davis math$iminterp/doc/iminterp.hd +bias Dec 17 8:53 valdes pkg$imred/bias/bias.hd +coude Dec 31 14:38 valdes pkg$imred/coude/coude.hd +vtel Jan 22 8:36 lytle pkg$imred/vtel/vtel.hd +plot Jan 28 14:04 hammond pkg$plot/plot.hd +.fi +.ih +SEE ALSO +mkhelpdb, help |