← Back to branch summary

~ubuntu-branches/debian/jessie/eso-midas/jessie

« back to all changes in this revision

Viewing changes to prim/help/show_desc.hlq

  • Committer: Package Import Robot
  • Author(s): Ole Streicher
  • Date: 2014-04-22 14:44:58 UTC
  • Revision ID: package-import@ubuntu.com-20140422144458-okiwi1assxkkiz39
Tags: upstream-13.09pl1.2+dfsg
Import upstream version 13.09pl1.2+dfsg

Show diffs side-by-side

added added

removed removed

Lines of Context:
prim/help/show_desc.hlq
 
1
% @(#)show_desc.hlq     19.1 (ESO-IPG) 02/25/03 14:03:45 
 
2
%++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
3
%.COPYRIGHT  (c)  1990 European Southern Observatory
 
4
%.IDENT      show_desc.hlq
 
5
%.AUTHOR     KB, IPG/ESO
 
6
%.KEYWORDS   MIDAS, help files, SHOW/DESCRIPTOR
 
7
%.PURPOSE    On-line help file for the command: SHOW/DESCRIPTOR
 
8
%.VERSION    1.0  13-APR-1984 : Creation, KB
 
9
%.VERSION    1.1  04-JUN-1991 : Update, KB
 
10
%.VERSION    1.2  05-DEC-1991 : Add 3rd par., KB
 
11
%----------------------------------------------------------------
 
12
\se
 
13
SECTION./DESC
 
14
\es\co
 
15
SHOW/DESCR                                      20-JUL-1998  KB
 
16
\oc\su
 
17
SHOW/DESCR frame [descr_list] [flag]
 
18
        show existing descriptors with name, type and size 
 
19
\us\pu
 
20
Purpose: 
 
21
          Display name, type and size of descriptors of given frame.
 
22
\up\sy
 
23
Syntax:  
 
24
          SHOW/DESCR frame [descr_list] [flag]
 
25
\ys\pa
 
26
          frame = name of image
 
27
\ap\pa
 
28
          descr_list = descriptor name(s) or pattern(s) separated by a comma,
 
29
\\
 
30
             or `*' to display all descriptors,
 
31
\\
 
32
             or patternA|patternB (character `|' as used for OR in C or the
 
33
             pipe symbol in Unix) to display all descriptors with names
 
34
             matching patternA but not patternB,
 
35
\\
 
36
             or 'name.ascii' if ASCII file `name.ascii' contains the
 
37
             descriptors to be read (file type .ascii is required);
 
38
\\
 
39
             defaulted to '*', i.e. all descriptors of frame
 
40
\ap\pa
 
41
          flag = H(idden) if you only want descr. info in keyword OUTPUTI (see
 
42
               Note) and no display;
 
43
\\
 
44
               defaulted to N(ohidden)
 
45
\ap\sa
 
46
See also:
 
47
          READ/DESCR, PRINT/DESCR, WRITE/DESCR, DELETE/DESCR, WRITE/DHELP
 
48
\as\no
 
49
Note:  
 
50
          For patterns there are the following possibilities:
 
51
\\
 
52
          `abc*' => all descr. beginning with `abc' match
 
53
\\
 
54
          `*abc' => all descr. ending with `abc' match
 
55
\\
 
56
          `*abc*' => all descr. containing `abc' match
 
57
\\
 
58
          `abc*def' => all descr. beginning with `abc' and ending with `def'
 
59
          match the pattern.
 
60
\\
 
61
          If help text is available for a descriptor it is also displayed,
 
62
          otherwise the string (...) is output.
 
63
\\
 
64
          If descr_list is set to a specific descr. name (not '*' or a pattern),
 
65
          also the elements 1,2,3,4 of integer keyword OUTPUTI are filled:
 
66
\\
 
67
          OUTPUTI(1) = 1 or 0, if descr. exists or not.
 
68
\\
 
69
          If OUTPUTI(1) is 1, then (2) = descr. type (1,2,3 or 4 for integer,
 
70
          real, character or double descr);
 
71
\\
 
72
          (3) and (4) hold no. of elements and bytes per element of descr.
 
73
\\
 
74
          This information can then be used in a procedure.
 
75
\on\exs
 
76
Examples:
 
77
\ex
 
78
          SHOW/DESC durazno
 
79
            Show all the descriptors of frame `durazno.bdf'.
 
80
\xe \ex
 
81
          SHOW/DESC pera.tbl
 
82
            Show all the descriptors of table file `pera.tbl'.
 
83
\\
 
84
            Note, that we have to specify the full file name if it is not an
 
85
            image file.
 
86
\xe \ex
 
87
          SHOW/DESC pina eso*rms
 
88
            Show type and size of all hierarchical ESO descriptors of frame 
 
89
            `pina.bdf'  ending with `rms', e.g. ESO.GEN.AMBI.TEMPRMS.
 
90
\xe\ex
 
91
          SHOW/DESCR pina ESO.*|*.det.*
 
92
            Show type and size of all hierarchical ESO keywords of `pina.bdf' 
 
93
            except those with names containing the string `DET', e.g. descr.
 
94
            ESO.DET.CHIP1.PSZX would not be shown.
 
95
\xe \ex
 
96
          SHOW/DESC manzana BugsBunny
 
97
            Show type and size of descriptor BugsBunny of frame `manzana.bdf' 
 
98
            if it exists. The keyword OUTPUTI will be set accordingly. Also,
 
99
            display any help text if it exists.
 
100
\xe \sxe