From fa080de7afc95aa1c19a6e6fc0e0708ced2eadc4 Mon Sep 17 00:00:00 2001 From: Joseph Hunkeler Date: Wed, 8 Jul 2015 20:46:52 -0400 Subject: Initial commit --- vo/votools/doc/dispname.hlp | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 vo/votools/doc/dispname.hlp (limited to 'vo/votools/doc/dispname.hlp') 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 -- cgit