[Kst] extragear/graphics/doc/kst

[Ted Kisner]

SVN commit 477053 by tskisner:

Update the man page

 M  +23 -3     kst.1  


--- trunk/extragear/graphics/doc/kst/kst.1 #477052:477053
@@ -35,7 +35,7 @@
 
 .TP
 \fB[file\&.\&.\&.]\fR
-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: \fB\-F datafile\fR, \fB\-n NS\fR, \fB\-s NS\fR, \fB\-f F0\fR, \fB\-a\fR\&. The rest can not be overridden\&. If an override flag is given, it is applied to all vectors in the plot\&.
+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: \fB\-F datafile\fR, \fB\-n NS\fR, \fB\-s NS\fR, \fB\-f F0\fR, \fB\-a\fR\&. The rest can not be overridden\&. If an override flag is given, it is applied to all vectors in the plot\&.
 
 ASCII data from stdin can be plotted by including "stdin" in the list \fB[file\&.\&.\&.]\fR\&.
 
@@ -52,6 +52,10 @@
 The source for the X axis data\&. For ASCII files, this is the column\&. For readata files, this is the field name\&. If this option is not specified, the row number in the file is used\&. This option can only be given once\&.
 
 .TP
+\fB\-z Z\fR
+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\&.
+
+.TP
 \fB\-p P\fR
 The source for power spectra\&. For ASCII files, this is the column\&. For binary files, this is the field name\&. To plot power spectra of multiple curves, this may be specified multiple times\&. The same source file, sample ranges and fft lengths are used for all Power Spectra requested from the command line\&.
 
@@ -141,5 +145,21 @@
 .IP
 \fB\fBkst \-y 2 \-f 0 \-n 100000 \-s 100 \-a tmp\&.dat\fR\fR 
 
-.SH AUTHOR
-Rick Chern <kst at kde\&.org>.
+.IP
+
+.PP
+(Using optional HEALPix Data Source) To plot the first 3 maps in a HEALPix FITS file in a 2x2 grid: 
+
+.IP
+\fB\fBkst \-z 1 \-z 2 \-z 3 \-m 2 healpix_example_sm\&.fits\fR\fR 
+
+.IP
+
+.PP
+(Using optional HEALPix Data Source) To plot a map with a specific field name in a HEALPix FITS file: 
+
+.IP
+\fB\fBkst \-z "1 \- TEMPERATURE (Kelvin)" healpix_example_sm\&.fits\fR\fR 
+
+.SH AUTHORS
+Rick Chern <kst at kde\&.org>, Philip Rodrigues <phil at kde\&.org>.