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

« back to all changes in this revision

Viewing changes to prim/help/restorname.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:
 
1
% @(#)restorname.hlq    19.1 (ESO-IPG) 02/25/03 14:03:41 
 
2
%++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
3
%.COPYRIGHT  (c)  1990 European Southern Observatory
 
4
%.IDENT      restorname.hlq
 
5
%.AUTHOR     KB, IPG/ESO
 
6
%.KEYWORDS   MIDAS, help files, RESTORE/NAME
 
7
%.PURPOSE    On-line help file for the command: RESTORE/NAME
 
8
%.VERSION    1.0  24-SEP-1992 : Creation, KB
 
9
%----------------------------------------------------------------
 
10
\se
 
11
SECTION./NAME
 
12
\es\co
 
13
RESTORE/NAME                                            04-NOV-1994  KB
 
14
\oc\su
 
15
RESTORE/NAME [file_spec] [verbose] [history] [overwrite] [descr]
 
16
        change file name according to descr. FILENAME
 
17
\us\pu
 
18
Purpose: 
 
19
          Change file name to the name stored in descr. FILENAME
 
20
\up\su
 
21
Subject:  
 
22
          Images, tables, fit files, catalogs
 
23
\us\sy
 
24
Syntax:   
 
25
          RESTORE/NAME [file_spec] [verbose] [history] [overwrite] [descr]
 
26
\ys\pa
 
27
          file_spec = name of single file or catalog name (with type `.cat');
 
28
\\
 
29
               defaulted to currently active image catalog
 
30
\ap\pa
 
31
          verbose = YES or NO, to display new name for each file as well as
 
32
               error messages or comments;
 
33
\\
 
34
               defaulted to YES
 
35
\ap\pa
 
36
          history = flag for update of HISTORY descriptor;
 
37
\\
 
38
              if NO, the history descriptor of the new frame is not updated;
 
39
\\
 
40
              defaulted to NO
 
41
\ap\pa
 
42
          overwrite = flag for overwrite check;
 
43
\\
 
44
              if CONFIRM, we check, if a file with the new name already exists
 
45
              and if so, ask for confirmation before overwriting it;
 
46
\\
 
47
              defaulted to NO_CONFIRM
 
48
\ap\pa
 
49
          descr = name of character descriptor which should be used, if the
 
50
              descr. FILENAME does not exist for an input file;
 
51
\\
 
52
              defaulted to IDENT
 
53
\ap\sa
 
54
See also: 
 
55
          INTAPE/FITS, INDISK/FITS, CREATE/ICAT, READ/DESCR, RENAME/IMAGE
 
56
\as\no
 
57
Note: 
 
58
          The parameters may also be referenced via:
 
59
\\
 
60
          FILE_SPEC=  VERBOSE=  HISTORY=  OVERWRITE=  DESCR= 
 
61
\\
 
62
          Images, tables and fit files are supported as well as catalogs
 
63
          of these.
 
64
\\
 
65
          This command is especially useful after the INTAPE/FITS command
 
66
          in order to get the original filenames back.
 
67
\on\exs
 
68
Examples:
 
69
\ex
 
70
          RESTORE/NAME 
 
71
           Use the currently active image catalog. For each image frame in that
 
72
           catalog look for the char. descriptor FILENAME. If found, rename the
 
73
           frame to the content of FILENAME.
 
74
           Display new name for each image.
 
75
\xe\ex
 
76
          RESTORE/NAME dosequis.bdf
 
77
           If the image `dosequis.bdf' has a char. descriptor FILENAME
 
78
           containing e.g. the string `cartablanca.bdf' it will be renamed
 
79
           to cartablanca.bdf .
 
80
\xe\ex
 
81
          RESTORE/NAME tecate.cerveza no ? conf
 
82
           Rename file `tecate.cerveza' to the content of descriptor FILENAME,
 
83
           e.g. `paulaner.bier'.
 
84
           If a file named `paulaner.bier' already exists the user is asked
 
85
           for confirmation before actually renaming the input file.
 
86
           The file type, e.g. table, will be determined and any active table
 
87
           catalog is updated.
 
88
           The new name of `tecate.cerveza' is not displayed.
 
89
\xe\ex
 
90
          RESTORE/NAME bohemia.cat descr=fitname
 
91
           Rename all files in catalog bohemia. The actual type of the catalog,
 
92
           e.g. fit file catalog, will be determined and all fit files with
 
93
           entries in `bohemia.cat' will be renamed according to the content
 
94
           of descriptor FILENAME. If the descr. FILENAME does not exist for
 
95
           one of the input fit files, we try to use descr. FITNAME instead.
 
96
\xe\sxe