stilts-doc 3.1.2-2 / usr / share / doc / stilts / sun256 / task-args.html

This file is indexed.

/usr/share/doc/stilts/sun256/task-args.html is in stilts-doc 3.1.2-2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
<html>
   
   <head>
      <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
      <link rel="stylesheet" type="text/css" href="sun-style.css">
      <title>Task Arguments</title>
   </head>
   
   <body>
      <hr>
      <a href="sec2.4.html">Next</a> <a href="task-name.html">Previous</a> <a href="stilts-cmd.html">Up</a> <a href="index.html">Contents</a> <br> <b>Next: </b><a href="sec2.4.html">Getting Help</a><br>
       <b>Up: </b><a href="stilts-cmd.html">The stilts command</a><br>
       <b>Previous: </b><a href="task-name.html">Task Names</a><br>
      
      <hr>
      <h3><a name="task-args">2.3 Task Arguments</a></h3>
      <p>The <code>&lt;task-args&gt;</code> part of the command line is a
         list of parameter assignments, 
         each giving the value of one of the named parameters belonging to 
         the task which is specified in the <code>&lt;task-name&gt;</code> part.
         
      </p>
      <p>The general form of each parameter assignment is
         <pre>
   &lt;param-name&gt;=&lt;param-value&gt;
</pre>
         If you want to set the parameter to the null value, which is legal for
         some but not all parameters, use the special string "<code>null</code>",
         or just leave the value blank ("<code>&lt;param-name&gt;=</code>").
         In some cases you can optionally leave out the <code>&lt;param-name&gt;</code>
         part of the assignment (i.e. the parameter is positionally determined); 
         this is indicated in the task's usage description if the parameter
         is described like <code>[&lt;param-name&gt;=]&lt;param-value&gt;</code>
         rather than <code>&lt;param-name&gt;=&lt;param-value&gt;</code>.
         If the <code>&lt;param-value&gt;</code> contains spaces or other special
         characters, then in most cases, such as from the Unix shell, you will
         have to quote it somehow.  How this is done depends on your platform,
         but usually surrounding the whole value in single quotes will do the trick.
         
      </p>
      <p>Tasks may have many parameters, and you don't have to set all of
         them explicitly on the comand line.  For a parameter which you don't
         set, two things can happen.  In many cases, it will default to some
         sensible value.  Sometimes however, you may be prompted for the value
         to use.
         In the latter case, a line like this will be written to the terminal:
         <pre>
   matcher - Name of matching algorithm [sky]:
</pre>
         This is prompting you for the value of the parameter named 
         <code>matcher</code>.  "Name of matching algorithm" is a short 
         description of what that parameter does.  "<code>sky</code>" is
         the default value (if there is no default, no value will appear
         in square brackets).
         At this point you can do one of four things:
         
         <ul>
            <li>Hit return - this will select the default value if there is one.
               If there is no default, this is equivalent to entering 
               "<code>null</code>".
            </li>
            <li>Enter a value for the parameter explicitly.
               The special value "<code>null</code>" means the null value,
               which is legal for some, but not all parameters.
               If the value you enter is not legal, you will see an error 
               message and you will be invited to try again. 
            </li>
            <li>Enter "<code>help</code>" or a question mark "<code>?</code>".
               This will output a message
               giving a detailed description of the parameter
               and prompt you again.
            </li>
            <li>Bail out by hitting ctrl-C or whatever is usual on your platform.</li>
         </ul>
         Under normal circumstances, most parameters which have a legal default
         value will default to it if they are not set on the command line,
         and you will only be prompted for those where there is no default or
         the program thinks there's a good chance you might not want to use it.
         You can influence this however using flags to the <code>stilts</code>
         command itself (see <a href="stilts-flags.html">Section 2.1</a>). 
         If you supply the <code>-prompt</code> flag, then you will be prompted
         for every parameter you have not explicitly set.  If you supply
         <code>-batch</code> on the other hand, you won't be prompted for 
         any parameters (and if you fail to set any without legal default
         values, the task will fail).
         
      </p>
      <p>If you want to see the actual values of the parameters for a task
         as it runs,
         including prompted values and defaulted ones 
         which you haven't specified explicitly,
         you can use the <code>-verbose</code> flag after the <code>stilts</code>
         command:
         <pre>
   % stilts -verbose tcopy cat.fits cat.vot ifmt=fits
   INFO: tcopy in=cat.fits out=cat.vot ifmt=fits ofmt=(auto)
</pre>
         </p>
      <p>If you make a parameter assignment on the command line for a
         parameter which is not used by the task in question, STILTS
         will issue an error message and the task will fail.
         Note some parameters are only used dependent on the presence or
         values of other parameters, so even supplying a parameter which is
         documented in the task's usage can have this effect.
         This is done on the assumption that if you have supplied a spurious
         parameter it's probably a mistake and you should be given the
         opportunity to correct it.
         But if you want to be free to make these mistakes without the
         task failing, you can supply the <code>-allowunused</code> flag
         as described in <a href="stilts-flags.html">Section 2.1</a>, in which case they will
         just result in a warning.
         
      </p>
      <p>Extensive help is available from <code>stilts</code> 
         itself about task and its parameters, as described in the next section.
         
      </p>
      <hr><a href="sec2.4.html">Next</a> <a href="task-name.html">Previous</a> <a href="stilts-cmd.html">Up</a> <a href="index.html">Contents</a> <br> <b>Next: </b><a href="sec2.4.html">Getting Help</a><br>
       <b>Up: </b><a href="stilts-cmd.html">The stilts command</a><br>
       <b>Previous: </b><a href="task-name.html">Task Names</a><br>
      
      <hr><i>STILTS - Starlink Tables Infrastructure Library Tool Set<br>Starlink User Note256<br>STILTS web page:
         <a href="http://www.starlink.ac.uk/stilts/">http://www.starlink.ac.uk/stilts/</a><br>Author email:
         <a href="mailto:m.b.taylor@bristol.ac.uk">m.b.taylor@bristol.ac.uk</a><br>Mailing list:
         <a href="mailto:topcat-user@jiscmail.ac.uk">topcat-user@jiscmail.ac.uk</a><br></i></body>
</html>

APT Browse - Built by Thomas Orozco.