Command Line Options

DS9 will process each command line option, one at a time, as the last step in the initialization process. Therefore, it is possible to use command line options as a little script. For example, the following command line option is used:
 

$ds9 -tile foo.fits -cmap Heat -zscale bar.fits -cmap I8

First DS9 is put in tile mode, then foo.fits is loaded. Then the colormap for foo.fits is changed to Heat. Next, a new frame is created and bar.fits is loaded. And finally, the colormap for bar.fits is changed to I8.

align

analysis

array

blink

bin

cmap

colorbar

contour

coords

dss

exit

fifo

fifo_only

geometry

grid

help

histequ

horzgraph

iconify

inet_only

info

invert

lower

linear

ln

log

magnifier

minmax

minmaxmode

minmaxsample

mode

mosaicimage

mosaicimages

mosaic

orient

panner

pixeltable

port

port_only

print

private

raise

rass

region

rotate

scale

scalemode

scalelimits

scalescope

shm

single

squared

sqrt

source

tile

tilemode

title

unix

unix_only

url

version

vertgraph

visual

wcs

wcsformat

z1

zmax

zscale

zoom

align

Aligns current frame to WCS equatorial coordinate axis, if present.
Syntax: -align
Example: $ds9 -align

analysis

Load analysis file.
Syntax: -analysis filename
Example: $ds9 -analysis my.analysis

array

Load an array.
Syntax: -array filename
Example: $ds9 -array foo.arr[dim=512,bitpix=-32]

blink

Activates Blink Mode.
Syntax: -blink
Example: $ds9 -blink

bin

Controls binning factor, binning buffer size, and  binning function for binning FITS bin tables.
Syntax: -bin [about <x> <y>]
           [buffersize <value>]
           [cols <x> <y>]
           [factor <value>]
           [filter <string>]
           [function average|sum]
           [to fit]
Example:
-bin about 4096 4096
-bin buffersize 512
-bin cols detx dety
-bin factor 4
-bin filter "pha>5"
-bin function sum
-bin to fit

cmap

Changes Colormap for current frame.
Syntax: -cmap name
Example: $ds9 -cmap BB

colorbar
nocolorbar

Toggles Colorbar in display.
Syntax: -colorbar
      -nocolorbar
Example: $ds9 -nocolorbar

contour
nocontour

Toggles contours in display.
Syntax: -contour
      -nocontour
Example: $ds9 -nocontour

coords

Toggles specified coordinate system display in information panel.
Syntax: -coords [wcs|detector|amplifier|physical|image] [yes|no]
Example: $ds9 -coords physical yes wcs no

dss

Retreive the following named object from the Digital Sky Survey Image server. The object name is resolved using the default Name Resolution Server.
Syntax: -dss <object>
Example: $ds9 -dss m51

exit
quit

Quits DS9.
Syntax: -exit
      -quit
Example: $ds9 -exit

fifo

Set the name of the IRAF input and output fifos. The default is "none". These fifos are used by IRAF to communicate with DS9.
Syntax: -fifo name
Example: $ds9 -fifo /dev/imt

fifo_only

Only use IRAF input and output fifos. Same as -port 0 -unix none.
Syntax: -fifo_only
Example: $ds9 -fifo_only

geometry

Define the initial window geometry. see X(1).
Syntax: -geometry value
Example: $ds9 -geometry 640x480

grid
nogrid

Toggles the coordinate grid display
Syntax: -grid
      -nogrid
Example: $ds9 -grid

help

Displays list of Command Line Options. Users of CSH and TCSH may have to quote.
Syntax:    -?
       -- -help
Example:
$ds9 -- -help
$ds9 '-?'

histequ

Select histogram equalization scale for current frame.
Syntax: -histequ
Example: $ds9 -histequ

horzgraph
nohorzgraph

Toggles Horizontal Graph in display.
Syntax: -horzgraph
      -nohorzgraph
Example: $ds9 -horzgraph

iconify

DS9 is iconified at startup.
Syntax: -iconify
Example: $ds9 -iconify

info
noinfo

Toggle Information display.
Syntax: -info
      -noinfo
Example:  $ds9 -noinfo

invert

Invert colormap of current frame.
Syntax: -invert
Example: $ds9 -invert

linear

Select Linear scale for current frame.
Syntax: -linear
Example: $ds9 -linear

ln

Select Natural Log scale for current frame. This is the same algorithm as used in SAOImage.
Syntax: -ln
Example: $ds9 -ln

log

Select LOG scale for current frame. This is the same algorithm as used in IRAF.
Syntax: -log
Example: $ds9 -log

lower

Lower ds9 in the window stacking order.
Syntax: -lower
Example: $ds9 -lower

magnifier
nomagnifier

Toggle Magnifier display.
Syntax: -magnifier
      -nomagnifier
Example:  $ds9 -nomagnifier

minmax

Set Scale Limits based  on the min and max data values.
Syntax: -minmax
Example: $ds9 -minmax

minmaxmode

Select the current minmax mode. This is how ds9 determines  the min and max data values from the data. SCAN will scan all data. SAMPLE will sample the data every n samples. DATAMIN and IRAFMIN will use the values of the keywords if present. In general, it is recommended to use SCAN unless your computer is slow or your data files are very large.
Syntax: -minmax [scan|sample|datamin|irafmin]
Example: $ds9 -minmax sample

minmaxsample

Select the increment  interval for determining the min and max data values during sampling. The larger the interval, the quicker the process is.
Syntax: -minmaxsampe
Example: $ds9 -minmaxsample 20

mode

Select the current mode.
Syntax: -mode [pointer|crosshair|colorbar|pan|zoom|rotate]
Example: $ds9 -mode crosshair

mosaicimage

Load entire FITS Mosaic image composed of multiple extensions in one FITS file.  All extensions that are FITS Images and are valid FITS Mosaic Images will be loaded.
Syntax: -mosaicimage filename
Example: $ds9 -mosaicimage fourshooter.fits

mosaicimages

Load entire FITS Mosaic image composed of multiple files into the current frame.  All files that match filename in pattern will be loaded. See FITS Mosaic for supported patterns.
Syntax: -mosaicimages filename
Example: $ds9 -mosaicimages img001.fits

mosaic

Load FITS mosaic image segment.
Syntax: -mosaic filename
Example: $ds9 -mosaic amp1.fits -mosaic amp2.fits

orient

Set the orientation of the current frame.
Syntax: -orient [none|x|y|xy]
Example: $ds9 -orient xy

panner
nopanner

Toggle Panner display.
Syntax: -panner
      -nopanner
Example:  $ds9 -nopanner

pixeltable
nopixeltable

Display/Hide pixel table
Syntax: -pixeltable
       -nopixeltable
Example: $ds9 -pixeltable

port

Set the IRAF port number, used by IRAF to communicate with DS9. The default is 5137, the standard IRAF port used by ximtool.
Syntax: -port number
Example: $ds9 -port 5137

port_only
inet_only

Only use the IRAF port number. This is the same as -fifo none -unix none.
Syntax: -port_only
Example: $ds9 -port_only

print

Print the display.
Syntax: -print
Example: $ds9 -print

private

use private colormap, valid for pseudocolor 8 mode.
Syntax: -private
Example: $ds9 -private

raise

Riase ds9 in the window stacking order.
Syntax: -raise
Example: $ds9 -raise

region

Loads a Regions File into the current frame.
Syntax: -region filename
Example: $ds9 -region catalog.reg

rotate

Rotate the current frame to the value in degrees.
Syntax: -rotate value
Example: $ds9 -rotate 45

scale
ztrans

Sets the scale for the current frame. ln is a natural log algorithm, same as used in SAOImage. log is a log distribution, same as used in IRAF.
Syntax: -scale [linear|log|squared|sqrt|histequ]
      -ztrans [linear|log|squared|sqrt|histequ]
Example: $ds9 -scale log

scalemode

Set the scale limits base on the specified value. value=100 sets the limits to the min and max of the data, value<100 sets the limits based on the percentage specified, zscale sets the limits based on the IRAF algorithm, zmax sets the lower limit to ZSCALE min and the upper limit to the maxium data value.
Syntax: -scalemode [<value>|zscale|zmax]
Example: $ds9 -scalemode zscale
        $ds9 -scalemode 80

scalelimits

Set the scale limits to the specified values .
Syntax: -scalelimits value value
Example: $ds9 -scalelimits 100 200

scalescope

For FITS Mosaics, scope specifies if the limits are applied global across each FITS Mosaic segment, or on a per segment basis.
Syntax: -scalescope [local|global]
Example: $ds9 -scalescope global

shm

Load a shared memory segment into the current frame. id is the shared memory id, size is the size of the segment in bytes.
Syntax:   -shm <key> <size> [<filename>]
       -shm [key|shmid] <id> <size> [<filename>]
       -shm mosaicimage [key|shmid] <id> <size> [<filename>]
       -shm mosaic [key|shmid] <id> <size> [<filename>]
       -shm array [key|shmid] <id> <size> [[xdim=<x>,ydim=<y>|dim=<dim>],bitpix=<b>,[skip=<s>]]
Example: $ds9 -shm 102 8640
        $ds9 -shm shmid 102 8640 foo[2]
        $ds9 -shm mosaicimage key 100 10240 foo
        $ds9 -shm mosaic key 100 10240 foo
        $ds9 -shm array shmid 102 8640 [dim=32,bitpix=-32]

single

Set display mode to single.
Syntax: -single
Example: $ds9 -single

squared

Select Squared scale for current frame.
Syntax: -squared
Example: $ds9 -squared

sqrt

Select Square Root scale for current frame.
Syntax: -sqrt
Example: $ds9 -sqrt

source

Sources a valid TCL file.
Syntax: -source filename
Example: $ds9 -source extensions.tcl

tile

Toggles DS9 into tile mode.
Syntax: -tile
Example: $ds9 -tile

tilemode

Sets the type of Tile algorithm
Syntax: -tilemode [grid|row|column]
Example:  $ds9 -tilemode row

title

Changes the display window title to the specified name.
Syntax: -title name
Example: $ds9 -title Voyager

unix

Set the IRAF unix socket name, used by IRAF to communicate with DS9. The default is /tmp/.IMT%d, so that the standard IRAF unix socket is defined.
Syntax: -unix name
Example: $ds9 -unix "/tmp/.IMT%d"

unix_only

Only use the IRAF unix socket name. This is the same as -fifo none -port 0.
Syntax: -unix_only
Example: $ds9 -unix_only

url

Load FITS file from specified url.
Syntax: -url <url>
Example: $ds9 -url 'ftp://legacy.gsfc.nasa.gov/rosat/data/hri/img.fits'

version

Displays the version of ds9 and exits.

vertgraph
novertgraph

Toggles Vertical Graph in display.
Syntax: -vertgraph
      -novertgraph
Example: $ds9 -vertgraph

visual

Force DS9 to use the specified color visual. This argument MUST be the first argument listed. Requires the visual be available.
Syntax: -visual [pseudocolor|pseudocolor8|truecolor|truecolor8|truecolor16|truecolor24]
Example: $ds9 -visual truecolor24

wcs

Selects WCS display coordinate system.
Syntax: -wcs [fk4|fk5|galactic|ecliptic]
Example: $ds9 -wcs fk4

wcsformat

Toggles WCS display format.
Syntax: -wcsformat [degrees|sexagesimal]
Example: $ds9 -wcsformat sexagesimal

z1
z2

Set the scale limits to the specified values and changes the scalemode to user.
Syntax: -z1 value -z2 value
Example: $ds9 -z1 100 -z2 200

zmax

Set Scale Limits based  on the IRAF algorithm and maxium data value.
Syntax: -zmax
Example: $ds9 -zmax

zscale

Set Scale Limits based  on the IRAF algorithm.
Syntax: -zscale
Example: $ds9 -zscale

zoom

Set the zoom value for the current frame.
Syntax: -zoom value
Example: $ds9 -zoom 1.25