STILTS-TLOOP(1)

NAME
stilts-tloop - Generates a single-column table from a loop variable

SYNOPSIS

stilts tloop [ocmd=<cmds>] [omode=out|meta|stats|count|checksum|cgi|discard|topcat|samp|tosql|gui] [out=<out-table>] [ofmt=<out-format>] [colname=<value>] [start=<float-value>] [end=<float-value>] [step=<float-value>] [forcefloat=true|false]

DESCRIPTION

tloop generates a one-column table where the values in the column are effectively populated from a for loop (start, end, step). This may be useful as it is, or it can be postprocessed with ocmd parameters to add more columns etc.

OPTIONS

ocmd=<cmds>
    Specifies processing to be performed on the output table, after all other processing has taken place. The value of this parameter is one or more of the filter commands described in SUN/256. If more than one is given, they must be separated by semicolon characters (";"). This parameter can be repeated multiple times on the same command line to build up a list of processing steps. The sequence of commands given in this way defines the processing pipeline which is performed on the table.

    Commands may alternatively be supplied in an external file, by using the indirection character '@'. Thus a value of "@filename" causes the file filename to be read for a list of filter commands to execute. The commands in the file may be separated by newline characters and/or semicolons, and lines which are blank or which start with a '#' character are ignored. A backslash character '\fR' at the end of a line joins it with the following line.

omode=out|meta|stats|count|checksum|cgi|discard|topcat|samp|tosql|gui
    The mode in which the result table will be output. The default mode is out, which means that the result will be written as a new table to disk or elsewhere, as determined by the out and ofmt parameters. However, there are other possibilities, which correspond to uses to which a table can be put other than outputting it, such as displaying metadata, calculating statistics, or populating a table in an SQL database. For some values of this parameter, additional parameters (<mode-args>) are required to determine the exact behaviour.

    Possible values are

        *   out

        *   meta

        *   stats

        *   count

        *   checksum

        *   cgi

        *   discard

        *   topcat

        *   samp

        *   tosql

        *   gui
     Use the help=omode flag or see SUN/256 for more information.

out=<out-table>
    The location of the output table. This is usually a filename to write to. If it is equal to the special value "-" (the default) the output table will be written to standard output.

    This parameter must only be given if omode has its default value of "out".

ofmt=<out-format>
    Specifies the format in which the output table will be written (one of the ones in SUN/256 - matching is case-insensitive and you can use just the first few letters). If it has the special value "(auto)" (the default), then the output filename will be examined to try to guess what sort of file is required usually by looking at the extension. If it's not obvious from the filename what output format is intended, an error will result.

    This parameter must only be given if omode has its default value of "out".

colname=<value>
    Gives the name of the single column produced by this command.

start=<float-value>
    Gives the starting value of the loop variable. This will the the value in the first row of the table.

end=<float-value>
    Gives the value which the loop variable will not exceed. Exceeding is in the positive or negative sense according to the sense of the step parameter, as usual for a for-type loop.

step=<float-value>
    Amount by which the loop variable will be incremented at each iteration, i.e. each table row.

forcefloat=true|false
    Affects the data type of the loop variable column. If true, the column is always floating point. If false, and if the other parameters are all of integer type, the column will be an integer column.

SEE ALSO
stilts(1)

If the package stilts-doc is installed, the full documentation SUN/256 is available in HTML format:
file:///usr/share/doc/stilts/sun256/index.html

VERSION
STILTS version 3.5.4-debian

This is the Debian version of Stilts, which lack the support of some file formats and network protocols. For differences see
file:///usr/share/doc/stilts/README.Debian

AUTHOR
Mark Taylor (Bristol University)