[Kst] extragear/graphics/doc/kst

[Ted Kisner]

SVN commit 477040 by tskisner:

Update commandline docbook chapter to mention matrix/image input.  Note that many other chapters need fixed to include current info about the readMatrix datasource change and the matrix dialog.

 M  +26 -10    commandline-chapter.docbook  


--- trunk/extragear/graphics/doc/kst/commandline-chapter.docbook #477039:477040
@@ -12,13 +12,9 @@
 
 <title>Command Line Usage and Examples</title>
 <para>
-A typical use of kst is from the command line to make X-Y plots of data
-files. kst can read ascii data, or readdata compatible binary files.
-
+A typical use of kst is from the command line to make X-Y plots or Z images from data files. kst can read ascii data, readdata/dirfile compatible binary files, and optionally (with external libraries) FITS images, PIOLib files, netCDF files, and HEALPix FITS files.
 </para>
 
-
-
 <refentry id="command-linesynopsis">
 
 <refmeta>
@@ -51,11 +47,7 @@
 <term><option>[file...]</option></term>
 <listitem>
 <para>
-A .kst file, or one or more data files.  Supported
-formats are ASCII columns, BOOMERANG frame files, or BLAST dirfile
-files.  A .kst files stores all
-options that can be set by other flags.  The following flags can be used to
-override the options set in the .kst file:
+A .kst file, or one or more data files.  Supported formats are ASCII columns, BOOMERANG frame files, BLAST dirfile files, and other optionally supported types.  A .kst files stores all options that can be set by other flags.  The following flags can be used to override the options set in the .kst file:
 <option>-F datafile</option>, <option>-n NS</option>, <option>-s NS</option>,
 <option>-f F0</option>, <option>-a</option>.
 The rest can not be overridden.  If an override flag is given, it is applied
@@ -106,6 +98,16 @@
 </varlistentry>
 
 <varlistentry>
+<term><option>-z Z</option></term>
+<listitem>
+<para>
+The source for the Z matrix data (which gets displayed as an image).  For ASCII files, this
+is the column containing the z data.  For other optional formats (HEALPix, FITS image, etc), this is the name of the desired matrix field, as displayed in the matrix dialog.  Some matrix-compatible datasources also allow using an alias which is the number of the desired matrix field.  To plot multiple matrices, this may be specified multiple times.
+</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
 <term><option>-p P</option></term>
 <listitem>
 <para>
@@ -273,6 +275,20 @@
 </para>
 </informalexample>
 
+<informalexample>
+<para>
+(Using optional HEALPix Data Source) To plot the first 3 maps in a HEALPix FITS file in a 2x2 grid:
+<screen><userinput><command>kst -z 1 -z 2 -z 3 -m 2 healpix_example_sm.fits</command></userinput></screen>
+</para>
+</informalexample>
+
+<informalexample>
+<para>
+(Using optional HEALPix Data Source) To plot a map with a specific field name in a HEALPix FITS file:
+<screen><userinput><command>kst -z "1 - TEMPERATURE (Kelvin)" healpix_example_sm.fits</command></userinput></screen>
+</para>
+</informalexample>
+
 </refsect1>
 
 </refentry>