From 4b46e21e19aa761ecc03b6d15d13c73723593e83 Mon Sep 17 00:00:00 2001 From: William Joye Date: Mon, 4 Jun 2018 15:10:54 -0400 Subject: update doc --- ds9/doc/ref/command.html | 58 ++++++++++++++++++++++++++++-- ds9/doc/ref/samp.html | 91 +++++++++++++++++++++++++++++++++++++++++++++-- ds9/doc/ref/xpa.html | 82 +++++++++++++++++++++++++++++++++++++++++- ds9/parsers/catparser.tac | 4 +++ 4 files changed, 228 insertions(+), 7 deletions(-) diff --git a/ds9/doc/ref/command.html b/ds9/doc/ref/command.html index df9870c..4d3a450 100644 --- a/ds9/doc/ref/command.html +++ b/ds9/doc/ref/command.html @@ -401,9 +401,10 @@ -catalog [new]
        [ned|simbad|denis|skybot]
-         - [ascss|cmc|gsc1|gsc2|gsc3|ac|nomad|ppmx|sao|sdss5|sdss6|sdss7|sdss8|tycho|ua2|ub1|ucac2]
-         [2mass|iras]
+         + [aavso|ac|ascss|cmc|gaia|gsc1|gsc2|gsc3|nomad|ppmx|sao|sdss5|sdss6|sdss7|sdss8|sdss9|tycho]
+         [ua2|ub1|ucac2|ucac2sup|ucac3|ucac4|urat1]
+         [2mass|iras]
        [csc|xmm|rosat]
        [first|nvss]
        @@ -521,6 +522,7 @@ + [crosshair]
        [<ref>] [dec <col>]
@@ -635,6 +637,7 @@ + [match error <value> degrees|arcmin|arcsec]
        [<ref>] @@ -731,6 +734,7 @@ + [match function 1and2|1not2|2not1]
        [<ref>] @@ -827,6 +831,7 @@ + [match return 1and2|1only|2only]
        [<ref>] @@ -923,6 +928,7 @@ + [match unique yes|no]
        [<ref>] [maxrows <number>]
@@ -974,10 +980,13 @@         [<ref>] + [symbol shape circle + point|box point|diamond point|cross + point|x point|arrow point|boxcircle point]
         [<ref>] [symbol add| [#] remove]
@@ -1080,6 +1089,7 @@ + [update]
        [<ref>] [x <col>]
@@ -1209,6 +1219,7 @@           + [match]
          [lock [yes|no]]
@@ -1473,6 +1484,7 @@ + [match <coordsys>]
           [lock <coordsys>|none]
@@ -1631,6 +1643,7 @@ $ds9 + -envi foo.hdr foo.bsq

exit
@@ -2377,6 +2390,7 @@ + [pan]
            @@ -2516,6 +2530,7 @@ + [crosshair]
            @@ -2655,6 +2670,7 @@ + [open|close]
 
Example:
@@ -2897,6 +2913,7 @@ + [yes|open]
            [no|close]
@@ -2999,8 +3016,10 @@ + duplicate [#]]
   +    [[<plotname>] stats yes|no]
      [[<plotname>] @@ -3072,6 +3091,7 @@ + list yes|no]
      [[<plotname>] @@ -3142,6 +3162,7 @@ + loadconfig <filename>]
      [[<plotname>] saveconfig <filename>]
@@ -3244,6 +3265,7 @@ + legend yes|no]
      [[<plotname>] legend position right|left|top|bottom]
@@ -3325,6 +3347,7 @@ + barmode normal|stacked|aligned|overlap]

# configure current dataset
@@ -3398,6 +3421,7 @@ + shape circle|square|diamond|plus|splus|scross|triangle|arrow]
      [[<plotname>] @@ -3469,11 +3493,13 @@ + shape fill yes|no]
      [[<plotname>] shape color <value>]
      + [[<plotname>] @@ -3543,9 +3569,11 @@ + smooth step|linear|cubic|quadratic|catrom]
      + [[<plotname>] @@ -3615,9 +3643,11 @@ + color <value>]
      + [[<plotname>] @@ -3687,6 +3717,7 @@ + width <value>]
      @@ -3758,6 +3789,7 @@ + [[<plotname>] @@ -3827,6 +3859,7 @@ + dash yes|no]
      @@ -3898,6 +3931,7 @@ + [[<plotname>] @@ -3967,6 +4001,7 @@ + error yes|no]
      @@ -4038,6 +4073,7 @@ + [[<plotname>] @@ -4107,6 +4143,7 @@ + error color <value>]
      @@ -4179,6 +4216,7 @@ + [[<plotname>] @@ -4248,6 +4286,7 @@ + color <value>]
      @@ -4320,6 +4359,7 @@ + [[<plotname>] @@ -4389,6 +4429,7 @@ + error width <value>]
      @@ -4461,6 +4502,7 @@ + [[<plotname>] @@ -4530,6 +4572,7 @@ + name <string>]

@@ -4580,6 +4623,7 @@ $ds9 -plot font numbers slant italic

$ds9 + -plot title 'This is a Title'
$ds9 -plot title x 'X Axis'
$ds9 -plot title y 'Y Axis'
@@ -4647,6 +4691,7 @@ + <dms> <arcmin> <arcsec>

@@ -5049,6 +5094,7 @@ + <filename> [image|table|slice]
 
Example:
@@ -5292,6 +5338,7 @@ + [sigma <value>]
        @@ -5303,6 +5350,7 @@ + [sigmaminor <value>]
        @@ -5314,6 +5362,7 @@ + [angle <value>]
        @@ -5325,6 +5374,7 @@ + [match]
        [lock [yes|no]]
        @@ -5346,6 +5396,7 @@ + -smooth sigmaminor 2.0
$ds9 @@ -5357,6 +5408,7 @@ + -smooth angle 45
$ds9 -smooth match
diff --git a/ds9/doc/ref/samp.html b/ds9/doc/ref/samp.html index 61c4ea9..3941900 100644 --- a/ds9/doc/ref/samp.html +++ b/ds9/doc/ref/samp.html @@ -455,9 +455,11 @@ catalog [new]
        [ned|simbad|denis|skybot]
-         - [ascss|cmc|gsc1|gsc2|gsc3|ac|nomad|ppmx|sao|sdss5|sdss6|sdss7|sdss8|tycho|ua2|ub1|ucac2]
-         [2mass|iras]
+         + [aavso|ac|ascss|cmc|gaia|gsc1|gsc2|gsc3|nomad|ppmx|sao|sdss5|sdss6|sdss7|sdss8|sdss9|tycho]
+         [ua2|ub1|ucac2|ucac2sup|ucac3|ucac4|urat1]
+         + [2mass|iras]
        [csc|xmm|rosat]
        [first|nvss]
        @@ -573,6 +575,7 @@ + [crosshair]
        [<ref>] [dec <col>]
@@ -685,6 +688,7 @@ + [match error <value> degrees|arcmin|arcsec]
        [<ref>] @@ -779,6 +783,7 @@ + [match function 1and2|1not2|2not1]
        [<ref>] @@ -873,6 +878,7 @@ + [match return 1and2|1only|2only]
        [<ref>] @@ -967,6 +973,7 @@ + [match unique yes|no]
        [<ref>] [maxrows <number>]
@@ -1017,10 +1024,13 @@         [<ref>] + [symbol shape circle + point|box point|diamond point|cross + point|x point|arrow point|boxcircle point]
        [<ref>] [symbol add| [#] remove]
@@ -1121,6 +1131,7 @@ + [update]
        [<ref>] [x <col>]
@@ -2182,6 +2193,7 @@ + Macros for more information.

Syntax:
iexam []
@@ -2301,6 +2313,7 @@ + quality (1-100)

Syntax:
jpeg [new|slice] [<filename>] [1-100]
@@ -2744,6 +2757,7 @@      [new name <plotname>]
     + [new name <plotname> line|bar|scatter]

# load data into existing plot from @@ -2825,6 +2839,7 @@ + duplicate [#]]
     @@ -2896,6 +2911,7 @@ + [[<plotname>] stats yes|no]
     [[<plotname>] @@ -2966,6 +2982,7 @@ + list yes|no]
     [[<plotname>] @@ -3036,6 +3053,7 @@ + loadconfig <filename>]
     [[<plotname>] saveconfig <filename>]
@@ -3108,6 +3126,7 @@ + [[<plotname>] pagesetup orient portrait|landscape]
     [[<plotname>] pagesetup size letter|legal|tabloid|poster|a4]
@@ -3180,6 +3199,7 @@ + [[<plotname>] print]
     [[<plotname>] print destination printer|file]
@@ -3274,6 +3294,7 @@ + legend yes|no]
     [[<plotname>] legend position right|left|top|bottom]
@@ -3355,6 +3376,7 @@ + barmode normal|stacked|aligned|overlap]

 # configure current dataset
@@ -3428,6 +3450,7 @@ + shape circle|square|diamond|plus|splus|scross|triangle|arrow]
     [[<plotname>] @@ -3499,6 +3522,7 @@ + shape fill yes|no]
     [[<plotname>] @@ -3573,6 +3597,7 @@ + [[<plotname>] @@ -3642,6 +3667,7 @@ + smooth step|linear|cubic|quadratic|catrom]
     @@ -3714,6 +3740,7 @@ + [[<plotname>] @@ -3783,6 +3810,7 @@ + color <value>]
     @@ -3855,6 +3883,7 @@ + [[<plotname>] @@ -3924,6 +3953,7 @@ + width <value>]
     @@ -3996,6 +4026,7 @@ + [[<plotname>] @@ -4065,6 +4096,7 @@ + dash yes|no]
     @@ -4136,6 +4168,7 @@ + [[<plotname>] @@ -4205,6 +4238,7 @@ + error yes|no]
     @@ -4276,6 +4310,7 @@ + [[<plotname>] @@ -4345,6 +4380,7 @@ + error color <value>]
     @@ -4417,6 +4453,7 @@ + [[<plotname>] @@ -4486,6 +4523,7 @@ + color <value>]
     @@ -4558,6 +4596,7 @@ + [[<plotname>] @@ -4627,6 +4666,7 @@ + error width <value>]
     @@ -4699,6 +4739,7 @@ + [[<plotname>] @@ -4768,6 +4809,7 @@ + name <string>]

@@ -4857,6 +4899,7 @@ + value = ds9.get(string cmd)
plot stats
@@ -4954,6 +4997,7 @@ + axis x auto
plot @@ -5019,6 +5063,7 @@ + axis x min
plot @@ -5084,6 +5129,7 @@ + axis x max
plot @@ -5149,6 +5195,7 @@ + axis x format
plot @@ -5214,6 +5261,7 @@ + legend
plot legend position
@@ -5287,6 +5335,7 @@ + font numbers size
plot @@ -5356,6 +5405,7 @@ + font numbers weight
plot @@ -5425,6 +5475,7 @@ + font numbers slant
plot @@ -5494,6 +5545,7 @@ + title
plot @@ -5563,6 +5615,7 @@ + title x
plot barmode
 @@ -5582,21 +5635,27 @@ plot legend position
ds9.set(string + cmd)
plot legend yes
plot legend position left

string + value = ds9.get(string cmd)
plot font numbers font
plot + font numbers size
plot + font numbers weight
plot + font numbers slant
ds9.set(string + cmd)
plot font numbers font times
plot font numbers size 12
@@ -5604,15 +5663,20 @@ plot font numbers slant italic

string + value = ds9.get(string cmd)
plot + title
plot + title xaxis
plot + title yaxis
ds9.set(string + cmd)
plot title "This is a Title"
plot title x "X Axis"
@@ -5620,13 +5684,16 @@ plot title legend "This is the Legend"

string + value = ds9.get(string cmd)
plot + barmode
 ds9.set(string + cmd)
plot barmode aligned

@@ -5709,6 +5776,7 @@ + dash
plot @@ -5778,6 +5846,7 @@ + error
plot @@ -5847,6 +5916,7 @@ + error color
plot @@ -5916,6 +5986,7 @@ + error width
plot @@ -5985,6 +6056,7 @@ + name
ds9.set(string @@ -6054,6 +6126,7 @@ + cmd)
plot show yes
plot shape circle
@@ -6098,6 +6171,7 @@ + <dms> <arcmin> <arcsec>

@@ -6718,6 +6792,7 @@ + [crosshair]
        [<ref>] [export sb|tsv <filename>]
@@ -6829,6 +6904,7 @@ + [update]
 
Example:
@@ -6944,6 +7020,7 @@ + [sigma <value>]
       @@ -6954,6 +7031,7 @@ + [sigmaminor <value>]
       @@ -6965,6 +7043,7 @@ + [angle <value>]
       @@ -6976,6 +7055,7 @@ + [match]
       [lock [yes|no]]
       [open|close]
@@ -7006,6 +7086,7 @@ + sigma 2.0
smooth @@ -7017,6 +7098,7 @@ + sigmaminor 2.0
smooth @@ -7028,6 +7110,7 @@ + angle 45
smooth @@ -7039,6 +7122,7 @@ + open
smooth close
smooth match
@@ -7159,6 +7243,7 @@ + compression method.

Syntax:
tiff [new|slice] [<filename>] [none|jpeg|packbits|deflate]
diff --git a/ds9/doc/ref/xpa.html b/ds9/doc/ref/xpa.html index 8960522..7e34fb4 100644 --- a/ds9/doc/ref/xpa.html +++ b/ds9/doc/ref/xpa.html @@ -211,6 +211,7 @@ + -p ds9 3d match
$xpaset -p ds9 3d lock yes
@@ -222,6 +223,7 @@ + -p ds9 3d open
$xpaset -p ds9 3d close
 @@ -431,7 +433,8 @@         [ned|simbad|denis|skybot]
        - [ascss|cmc|gsc1|gsc2|gsc3|ac|nomad|ppmx|sao|sdss5|sdss6|sdss7|sdss8|tycho|ua2|ub1|ucac2]
+ [aavso|ac|ascss|cmc|gaia|gsc1|gsc2|gsc3|nomad|ppmx|sao|sdss5|sdss6|sdss7|sdss8|sdss9|tycho]
+         [ua2|ub1|ucac2|ucac2sup|ucac3|ucac4|urat1]
        [2mass|iras]
        [csc|xmm|rosat]
        [first|nvss]
@@ -552,6 +555,7 @@ + [crosshair]
        [<ref>] [dec <col>]
@@ -668,6 +672,7 @@ + [match error <value> degrees|arcmin|arcsec]
        [<ref>] @@ -766,6 +771,7 @@ + [match function 1and2|1not2|2not1]
        [<ref>] @@ -864,6 +870,7 @@ + [match return 1and2|1only|2only]
        [<ref>] @@ -962,6 +969,7 @@ + [match unique yes|no]
        [<ref>] [maxrows <number>]
@@ -1010,6 +1018,7 @@         [<ref>] + [symbol shape circle point|box point|diamond point|cross point|x point|arrow point|boxcircle point]
@@ -1116,6 +1125,7 @@ + [update]
        [<ref>] [x <col>]
@@ -1703,6 +1713,7 @@ + -p ds9 export envi foo.hdr foo.bsq little
$xpaset -p ds9 export tiff foo.tiff jpeg
@@ -2236,6 +2247,7 @@ + quality (1-100)

Syntax:
jpeg [new|slice] [<filename>] [1-100]
@@ -2653,10 +2665,12 @@      [new name <plotname>]
     + [new name <plotname> line|bar|scatter]

# create new plot with data from stdin
plot + [new <title> <xaxis label> <yaxis label> xy|xyex|xyey|xyexey]
@@ -2666,11 +2680,16 @@ xy|xyex|xyey|xyexey]
     + [new name + <plotname> <title> + <xaxis label> <yaxis label> xy|xyex|xyey|xyexey]
     [new name + <plotname> line|bar|scatter + <title> <xaxis label> <yaxis label> xy|xyex|xyey|xyexey]

@@ -2679,14 +2698,18 @@ title/dim headers
plot [new stdin]
     [new + [line|bar|scatter] + stdin]
     + [new name <plotname> stdin]
     [new name <plotname> line|bar|scatter + stdin]

# load data into existing plot from @@ -2768,6 +2791,7 @@ + duplicate [#]]
     @@ -2839,6 +2863,7 @@ + [[<plotname>] stats yes|no]
     [[<plotname>] @@ -2909,6 +2934,7 @@ + list yes|no]
     [[<plotname>] @@ -2979,6 +3005,7 @@ + loadconfig <filename>]
     [[<plotname>] saveconfig <filename>]
@@ -3051,6 +3078,7 @@ + [[<plotname>] pagesetup orient portrait|landscape]
     [[<plotname>] pagesetup size letter|legal|tabloid|poster|a4]
@@ -3123,6 +3151,7 @@ + [[<plotname>] print]
     [[<plotname>] print destination printer|file]
@@ -3217,6 +3246,7 @@ + legend yes|no]
     [[<plotname>] legend position right|left|top|bottom]
@@ -3298,6 +3328,7 @@ + barmode normal|stacked|aligned|overlap]

 # configure current dataset
@@ -3371,6 +3402,7 @@ + shape circle|square|diamond|plus|splus|scross|triangle|arrow]
     [[<plotname>] @@ -3442,6 +3474,7 @@ + shape fill yes|no]
     [[<plotname>] @@ -3516,6 +3549,7 @@ + [[<plotname>] @@ -3585,6 +3619,7 @@ + smooth step|linear|cubic|quadratic|catrom]
     @@ -3657,6 +3692,7 @@ + [[<plotname>] @@ -3726,6 +3762,7 @@ + color <value>]
     @@ -3798,6 +3835,7 @@ + [[<plotname>] @@ -3867,6 +3905,7 @@ + width <value>]
     @@ -3939,6 +3978,7 @@ + [[<plotname>] @@ -4008,6 +4048,7 @@ + dash yes|no]
     @@ -4079,6 +4120,7 @@ + [[<plotname>] @@ -4148,6 +4190,7 @@ + error yes|no]
     @@ -4219,6 +4262,7 @@ + [[<plotname>] @@ -4288,6 +4332,7 @@ + error color <value>]
     @@ -4360,6 +4405,7 @@ + [[<plotname>] @@ -4429,6 +4475,7 @@ + color <value>]
     @@ -4501,6 +4548,7 @@ + [[<plotname>] @@ -4570,6 +4618,7 @@ + error width <value>]
     @@ -4642,6 +4691,7 @@ + [[<plotname>] @@ -4711,6 +4761,7 @@ + name <string>]

@@ -4750,6 +4801,7 @@ stdin

# load + data into existing plot from stdin
$cat xy.dat | xpaset ds9 plot data xy
$cat xy.dat | xpaset ds9 plot foo data xy
@@ -4853,6 +4905,7 @@ + ds9 plot axis x min
$xpaget @@ -4923,9 +4976,11 @@ + ds9 plot axis x max
$xpaget ds9 plot axis x format
$xpaset + -p ds9 plot axis x grid yes
$xpaset -p ds9 plot axis x log yes
$xpaset -p ds9 plot axis x flip yes
@@ -5011,6 +5066,7 @@ + ds9 plot font numbers size
$xpaget @@ -5081,6 +5137,7 @@ + ds9 plot font numbers weight
$xpaget @@ -5151,8 +5208,10 @@ + ds9 plot font numbers slant
$xpaset + -p ds9 plot font numbers font times
$xpaset -p ds9 plot font numbers size 12
$xpaset -p ds9 plot font numbers weight bold
@@ -5228,6 +5287,7 @@ + ds9 plot title xaxis
$xpaget @@ -5298,8 +5358,10 @@ + ds9 plot title yaxis
$xpaset + -p ds9 plot title {This is a Title}
$xpaset -p ds9 plot title x {X Axis}
$xpaset -p ds9 plot title y {Y Axis}
@@ -5389,6 +5451,7 @@ + ds9 plot dash
$xpaget @@ -5459,6 +5522,7 @@ + ds9 plot error
$xpaget @@ -5529,6 +5593,7 @@ + ds9 plot error color
$xpaget @@ -5600,6 +5665,7 @@ + ds9 plot error width
$xpaget @@ -5671,6 +5737,7 @@ + ds9 plot name
$xpaset @@ -5741,6 +5808,7 @@ + -p ds9 plot show yes
$xpaset -p ds9 plot shape circle
$xpaset -p ds9 plot shape fill no
@@ -5782,6 +5850,7 @@ + <dms> <arcmin> <arcsec>

@@ -6277,6 +6346,7 @@ + method.

Syntax:
saveimage [fits|eps|gif|tiff|jpeg|png] <filename>
@@ -6503,6 +6573,7 @@ + [sigma <value>]
       @@ -6514,6 +6585,7 @@ + [sigmaminor <value>]
       @@ -6525,6 +6597,7 @@ + [angle <value>]
    @@ -6536,6 +6609,7 @@ +    [match]
       [lock [yes|no]]
       [open|close]
@@ -6555,6 +6629,7 @@ + ds9 smooth sigmaminor
$xpaget ds9 smooth lock
@@ -6574,6 +6649,7 @@ + -p ds9 smooth sigma 2.0
$xpaset @@ -6585,6 +6661,7 @@ + -p ds9 smooth sigmaminor 2.0
$xpaset @@ -6596,6 +6673,7 @@ + -p ds9 smooth angle 45
$xpaset @@ -6607,6 +6685,7 @@ + -p ds9 smooth match
$xpaset -p ds9 smooth lock yes
$xpaset -p ds9 smooth open
@@ -6726,6 +6805,7 @@ + compression method.

Syntax:
tiff [new|slice] [<filename>] [none|jpeg|packbits|deflate]
diff --git a/ds9/parsers/catparser.tac b/ds9/parsers/catparser.tac index b5f9f40..b7b2b67 100644 --- a/ds9/parsers/catparser.tac +++ b/ds9/parsers/catparser.tac @@ -118,6 +118,10 @@ catalog : NEW_ {CATTool} | {if {![CatalogCmdCheck]} {cat::YYABORT}} catCmd | STRING_ {CatalogCmdRef $1} | STRING_ {CatalogCmdRef $1} catCmd +# special case +# backward compatibility + | SAO_ {CatalogCmdRef sao} + | SAO_ {CatalogCmdRef sao} catCmd # backward compatibility | CDS_ STRING_ {CatalogCmdRef $2} # backward compatibility -- cgit v0.12