Initial commit

1 files changed, 44 insertions, 0 deletions

diff --git a/vo/votools/doc/dispname.hlp b/vo/votools/doc/dispname.hlp
new file mode 100644
index 00000000..9c6cb6f3
--- /dev/null
+++ b/vo/votools/doc/dispname.hlp
@@ -0,0 +1,44 @@
+.help dispname Mar12 votools
+.ih
+NAME
+dispname -- Get the currently displayed image name
+.ih
+USAGE
+dispname frame
+
+.ih
+PARAMETERS
+.ls frame
+Frame number to query.
+.le
+
+.ih
+DESCRIPTION
+
+The \fIDISPNAME\fR task is used to get the name of the image displayed
+in the frame number specified by the \fIframe\fR parameter.
+
+.ih
+EXAMPLES
+
+1. Print the displayed image name to the STDOUT
+
+.nf
+  votools> display dev$pix 1
+  votools> dispname 1 verbose+
+  dev$pix
+.fi
+
+2. Get the name, but use it within as script as a parameter:
+
+.nf
+    int  frame_num = 1
+    dispname (frame_num)
+    printf ("The displayed image is '%s'\n", dispname.name)
+.fi
+
+
+.ih
+SEE ALSO
+
+.endhelp