<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
                   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<!-- lifted from troff+man by doclifter -->
<refentry id='dpyimage1'>
<!--  @(#)dpyimage.1 2001/04/02 NIST -->
<!--  I Image Group -->
<!--  Stan Janet -->

<refmeta>
<refentrytitle>DPYIMAGE</refentrytitle>
<manvolnum>1D</manvolnum>
<refmiscinfo class='date'>02 April 2001</refmiscinfo>
<refmiscinfo class='source'>NIST</refmiscinfo>
<refmiscinfo class='manual'>NFIS Reference Manual</refmiscinfo>
</refmeta>
<refnamediv id='name'>
<refname>dpyimage</refname>
<refpurpose>displays the image contents of Baseline JPEG, Lossless JPEG, WSQ, IHead, and raw pixmap files.</refpurpose>
</refnamediv>
<!-- body begins here -->
<refsynopsisdiv id='synopsis'>
<cmdsynopsis>
  <command>dpyimage</command>    
    <arg choice='opt'><replaceable>options</replaceable></arg>
    <arg choice='plain' rep='repeat'><replaceable>image-file</replaceable></arg>
    <sbr/>
    <arg choice='plain'>-r <replaceable>w,h,d,wp</replaceable></arg>
    <sbr/>
    <arg choice='plain'>-A </arg>
    <sbr/>
    <arg choice='plain'>-s <replaceable>n</replaceable></arg>
    <sbr/>
    <arg choice='plain'>-a <replaceable>n</replaceable></arg>
    <sbr/>
    <arg choice='plain'>-v </arg>
    <sbr/>
    <arg choice='plain'>-x </arg>
    <sbr/>
    <arg choice='plain'>-b <replaceable>n</replaceable></arg>
    <sbr/>
    <arg choice='plain'>-N <replaceable>n</replaceable></arg>
    <sbr/>
    <arg choice='plain'>-O </arg>
    <sbr/>
    <arg choice='plain'>-k </arg>
    <sbr/>
    <arg choice='plain'>-W <replaceable>n</replaceable></arg>
    <sbr/>
    <arg choice='plain'>-H <replaceable>n</replaceable></arg>
    <sbr/>
    <arg choice='plain'>-X <replaceable>n</replaceable></arg>
    <sbr/>
    <arg choice='plain'>-Y <replaceable>n</replaceable></arg>
    <sbr/>
    <arg choice='plain'>-n </arg>
    <sbr/>
    <arg choice='plain'>-T <replaceable>title</replaceable></arg>
    <sbr/>
    <arg choice='plain'>-t </arg>
    <sbr/>
    <arg choice='plain'>-D <replaceable>dir</replaceable></arg>
    <sbr/>
    <arg choice='plain'>-d <replaceable>display</replaceable></arg>
    <sbr/>
</cmdsynopsis>
</refsynopsisdiv>


<refsect1 id='description'><title>DESCRIPTION</title>
<para><emphasis remap='B'>Dpyimage</emphasis>
reads various image file formats, decompresses and reconstructs pixmaps
as needed, and displays image contents in an X11 window.  Supported
file formats include Baseline JPEG (lossy), Lossless JPEG,
WSQ (lossy), NIST IHead, and raw pixmap files.  Raw pixmaps containing
either grayscale or interleaved RGB color pixels are supported.
This utility automatically differentiates between these different formats.</para>

<para>If only one file (or the <option>-n</option> option)
is specified on the command line, the image or images are
simply read from disk and then displayed.
If multiple files are specified,
<command>dpyimage</command> attempts to minimize the display waiting time
by forking a background process to pre-read images from disk.
By default, the child
transfers images to the parent via a pipe.
This always allows at least one image to be read in from disk
while the user is viewing the current image.
Since a process writing on a pipe
is blocked (until a read on the other end of the pipe)
after transferring four kilobytes, the child
will only be one image ahead of the parent except when handling
smaller images.</para>

<para>If the <option>-t</option> option appears on the command line,
the processes use temporary files as the means of exchanging
image data. Therefore, the child is not constrained on
the number of images it may pre-read for the parent.
However, the filesystem on which the directory for temporary files resides
must have enough space for copies of all images in uncompressed
state or an error may occur.
This is the suggested mode
for viewing compressed images for which
decompression takes considerably longer than disk I/O.</para>

<para>If the image is too large to be displayed on the screen,
the upper lefthand corner will be displayed and the rest of the
image can be moved into view by holding down a mouse button,
moving in the direction desired, and then releasing the button.
Button presses when another button(s) is already down
and button releases when another button(s) is still down
are ignored.</para>

<para>Users may exit from the program by striking keys 'x' or 'X'.
Advancing to the next image is accomplished by any other
keystroke.</para>

</refsect1>

<refsect1 id='options'><title>OPTIONS</title>
<variablelist remap='TP'>
  <varlistentry>
  <term><option>-r </option><emphasis remap='I'>w</emphasis>,<emphasis remap='I'>h</emphasis>,<emphasis remap='I'>d</emphasis>,<emphasis remap='I'>wp</emphasis></term>
  <listitem>
<para>raw pixmap attributes:</para>
  <!-- .RS -->
<para><emphasis remap='I'>w</emphasis>  - pixel width,
<!-- .br -->
<emphasis remap='I'>h</emphasis>  - pixel height,
<!-- .br -->
<emphasis remap='I'>d</emphasis>  - pixel depth,
<!-- .br -->
<emphasis remap='I'>wp</emphasis> - white pixel value</para>
    <!-- .RS -->
<para>bi-level  wp=0|1
<!-- .br -->
grayscale wp=0|255
<!-- .br -->
RGB       wp=0 (value ignored)</para>
    <!-- .RE -->
  <!-- .RE -->
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-A</option></term>
  <listitem>
<para>automatically advances through images.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-s </option><emphasis remap='I'>n</emphasis></term>
  <listitem>
<para>in automatic mode, sleeps <emphasis remap='I'>n</emphasis> seconds before advancing to
the next image [2].</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-a </option><emphasis remap='I'>n</emphasis></term>
  <listitem>
<para>sets drag accelerator to <emphasis remap='I'>n</emphasis> &mdash; changes in pointer position
will result in <emphasis remap='I'>n</emphasis> shifts in the displayed image [1].</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-v</option></term>
  <listitem>
<para>turns on verbose output.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-x</option></term>
  <listitem>
<para>turns on debug mode, causing a core dump when an X11 error occurs.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-b </option><emphasis remap='I'>n</emphasis></term>
  <listitem>
<para>sets border width to <emphasis remap='I'>n</emphasis> pixels [4].</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-N </option><emphasis remap='I'>n</emphasis></term>
  <listitem>
<para>the child I/O process is niced to level <emphasis remap='I'>n</emphasis>.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-O</option></term>
  <listitem>
<para>overrides the redirect on windows (no window manager).</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-k</option></term>
  <listitem>
<para>informs utility that there is no keyboard input.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-W </option><emphasis remap='I'>n</emphasis></term>
  <listitem>
<para>displays image in a window of width <emphasis remap='I'>n</emphasis> pixels.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-H </option><emphasis remap='I'>n</emphasis></term>
  <listitem>
<para>displays image in a window of height <emphasis remap='I'>n</emphasis> pixels.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-X </option><emphasis remap='I'>n</emphasis></term>
  <listitem>
<para>positions image window with top-left corner <emphasis remap='I'>n</emphasis>
pixels to the right of the display's top-left corner [0].</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-Y </option><emphasis remap='I'>n</emphasis></term>
  <listitem>
<para>positions image window with top-left corner <emphasis remap='I'>n</emphasis>
pixels below the display's top-left corner [0].</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-n</option></term>
  <listitem>
<para>does not fork to display multiple images.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-T </option><emphasis remap='I'>title</emphasis></term>
  <listitem>
<para>sets window name to <emphasis remap='I'>title</emphasis> [<emphasis remap='I'>file</emphasis>].
<option>-t
uses temporary files to transfer multiple images to parent [via pipe].</option></para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-D </option><emphasis remap='I'>directory</emphasis></term>
  <listitem>
<para>creates temporary files in <emphasis remap='I'>directory</emphasis> [/tmp].</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><option>-d </option><emphasis remap='I'>display</emphasis></term>
  <listitem>
<para>connects to alternate display.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>image-file ...</emphasis></term>
  <listitem>
<para>one or more image files whose pixmaps are to be displayed.</para>

  </listitem>
  </varlistentry>
</variablelist>
</refsect1>

<refsect1 id='environment'><title>ENVIRONMENT</title>
<para>If the environment variable <envar>TMPDIR</envar> is set
and the <option>-D</option> option is not set on the command line,
<command>dpyimage</command> uses this directory as the location for temporary files.</para>

</refsect1>

<refsect1 id='examples'><title>EXAMPLES</title>
<para>From <emphasis remap='I'>test/imgtools/execs/dpyimage/dpyimage.src</emphasis>:</para>

<para><emphasis remap='B'>% dpyimage -r 500,500,8,255 ../../data/finger/gray/raw/finger.raw</emphasis>
<!-- .br -->
displays a fingerprint image from a raw pixmap file.</para>

<para><emphasis remap='B'>% dpyimage ../../data/finger/gray/jpegl/finger.jpl</emphasis>
<!-- .br -->
displays a reconstructed fingerprint image from a Lossless JPEG file.</para>

<para><emphasis remap='B'>% dpyimage ../../data/finger/gray/wsq/finger.wsq</emphasis>
<!-- .br -->
displays a reconstructed fingerprint image from a WSQ file.</para>

<para><emphasis remap='B'>% dpyimage ../../data/face/gray/jpegb/face.jpb</emphasis>
<!-- .br -->
displays a reconstructed grayscale face image from a Baseline JPEG file.</para>

<para><emphasis remap='B'>% dpyimage -r 768,1024,24,0 ../../data/face/rgb/raw/intrlv/face.raw</emphasis>
<!-- .br -->
displays a color face image from a raw pixmap file.</para>

<para><emphasis remap='B'>% dpyimage ../../data/face/rgb/jpegb/face.jpb</emphasis>
<!-- .br -->
displays a reconstructed color face image from a Baseline JPEG file.</para>

<para><emphasis remap='B'>% dpyimage ../../data/face/rgb/jpegl/face.jpl</emphasis>
<!-- .br -->
displays a reconstructed color face image from a Lossless JPEG file.</para>

</refsect1>

<refsect1 id='see_also'><title>SEE ALSO</title>
<para><emphasis remap='B'>an2ktool</emphasis>(1C),
<emphasis remap='B'>cjpegb</emphasis>(1D),
<emphasis remap='B'>cjpegl</emphasis>(1D),
<emphasis remap='B'>cwsq</emphasis>(1D),
<emphasis remap='B'>djpegb</emphasis>(1D),
<emphasis remap='B'>djpegl</emphasis>(1D),
<emphasis remap='B'>dpyan2k</emphasis>(1C),
<emphasis remap='B'>dwsq</emphasis>(1D)</para>

</refsect1>

<refsect1 id='author'><title>AUTHOR</title>
<para>NIST/ITL/DIV894/Image Group</para>
</refsect1>
</refentry>

