FM / man

/usr/share/doc/libtiff-devel/html/man

Name	Size	Mode	Actions
CMakeLists.txt	3435	0644	edit dl rm
fax2ps.1.html	6463	0644	edit dl rm
fax2tiff.1.html	15703	0644	edit dl rm
HtmlDoc.cmake	2147	0644	edit dl rm
index.html	3826	0644	edit dl rm
libtiff.3tiff.html	55646	0644	edit dl rm
pal2rgb.1.html	4522	0644	edit dl rm
ppm2tiff.1.html	3836	0644	edit dl rm
raw2tiff.1.html	11353	0644	edit dl rm
tiff2bw.1.html	3835	0644	edit dl rm
tiff2pdf.1.html	11566	0644	edit dl rm
tiff2ps.1.html	13490	0644	edit dl rm
tiff2rgba.1.html	4620	0644	edit dl rm
TIFFbuffer.3tiff.html	3668	0644	edit dl rm
TIFFClose.3tiff.html	2200	0644	edit dl rm
tiffcmp.1.html	3763	0644	edit dl rm
TIFFcodec.3tiff.html	3470	0644	edit dl rm
TIFFcolor.3tiff.html	18970	0644	edit dl rm
tiffcp.1.html	14246	0644	edit dl rm
tiffcrop.1.html	30269	0644	edit dl rm
TIFFDataWidth.3tiff.html	2268	0644	edit dl rm
TIFFDeferStrileArrayWriting.3tiff.html	4022	0644	edit dl rm
tiffdither.1.html	5324	0644	edit dl rm
tiffdump.1.html	3554	0644	edit dl rm
TIFFError.3tiff.html	3176	0644	edit dl rm
TIFFFieldDataType.3tiff.html	2184	0644	edit dl rm
TIFFFieldName.3tiff.html	2129	0644	edit dl rm
TIFFFieldPassCount.3tiff.html	2618	0644	edit dl rm
TIFFFieldReadCount.3tiff.html	2826	0644	edit dl rm
TIFFFieldTag.3tiff.html	2253	0644	edit dl rm
TIFFFieldWriteCount.3tiff.html	3150	0644	edit dl rm
TIFFFlush.3tiff.html	2901	0644	edit dl rm
TIFFGetField.3tiff.html	33650	0644	edit dl rm
tiffinfo.1.html	4186	0644	edit dl rm
tiffmedian.1.html	4669	0644	edit dl rm
TIFFmemory.3tiff.html	3306	0644	edit dl rm
TIFFOpen.3tiff.html	14772	0644	edit dl rm
TIFFOpenOptions.3tiff.html	7052	0644	edit dl rm
TIFFPrintDirectory.3tiff.html	4258	0644	edit dl rm
TIFFquery.3tiff.html	5098	0644	edit dl rm
TIFFReadDirectory.3tiff.html	7557	0644	edit dl rm
TIFFReadEncodedStrip.3tiff.html	3576	0644	edit dl rm
TIFFReadEncodedTile.3tiff.html	3516	0644	edit dl rm
TIFFReadRawStrip.3tiff.html	2862	0644	edit dl rm
TIFFReadRawTile.3tiff.html	2951	0644	edit dl rm
TIFFReadRGBAImage.3tiff.html	8618	0644	edit dl rm
TIFFReadRGBAStrip.3tiff.html	7258	0644	edit dl rm
TIFFReadRGBATile.3tiff.html	8048	0644	edit dl rm
TIFFReadScanline.3tiff.html	4500	0644	edit dl rm
TIFFReadTile.3tiff.html	3646	0644	edit dl rm
TIFFRGBAImage.3tiff.html	11629	0644	edit dl rm
tiffset.1.html	3630	0644	edit dl rm
TIFFSetDirectory.3tiff.html	3429	0644	edit dl rm
TIFFSetField.3tiff.html	31189	0644	edit dl rm
TIFFsize.3tiff.html	2469	0644	edit dl rm
tiffsplit.1.html	3125	0644	edit dl rm
TIFFStrileQuery.3tiff.html	4958	0644	edit dl rm
TIFFstrip.3tiff.html	4180	0644	edit dl rm
TIFFswab.3tiff.html	3239	0644	edit dl rm
TIFFtile.3tiff.html	4867	0644	edit dl rm
TIFFWarning.3tiff.html	3136	0644	edit dl rm
TIFFWriteDirectory.3tiff.html	6273	0644	edit dl rm
TIFFWriteEncodedStrip.3tiff.html	4424	0644	edit dl rm
TIFFWriteEncodedTile.3tiff.html	4215	0644	edit dl rm
TIFFWriteRawStrip.3tiff.html	3999	0644	edit dl rm
TIFFWriteRawTile.3tiff.html	3630	0644	edit dl rm
TIFFWriteScanline.3tiff.html	6819	0644	edit dl rm
TIFFWriteTile.3tiff.html	3170	0644	edit dl rm

Edit: /usr/share/doc/libtiff-devel/html/man/TIFFOpen.3tiff.html (14772B)

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta name="generator" content="groff -Thtml, see www.gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<meta name="Content-Style" content="text/css">
<style type="text/css">
 p { margin-top: 0; margin-bottom: 0; vertical-align: top }
 pre { margin-top: 0; margin-bottom: 0; vertical-align: top }
 table { margin-top: 0; margin-bottom: 0; vertical-align: top }
 h1 { text-align: center }
</style>
<title>TIFFOpen</title>

</head>
<body>

<h1 align="center">TIFFOpen</h1>

<a href="#NAME">NAME</a> 
<a href="#SYNOPSIS">SYNOPSIS</a> 
<a href="#DESCRIPTION">DESCRIPTION</a> 
<a href="#OPTIONS">OPTIONS</a> 
<a href="#BYTE ORDER">BYTE ORDER</a> 
<a href="#RETURN VALUES">RETURN VALUES</a> 
<a href="#DIAGNOSTICS">DIAGNOSTICS</a> 
<a href="#SEE ALSO">SEE ALSO</a>

<hr>

TIFFOpen,
TIFFFdOpen, TIFFClientOpen &minus; open a
TIFF file for reading or writing

<h2>SYNOPSIS
<a name="SYNOPSIS"></a>
</h2>

#include
&lt;tiffio.h&gt;

TIFF*
TIFFOpen(const char *filename, const char
*mode) 
TIFF* TIFFFdOpen(const int fd, const char
*filename, const char
*mode)

typedef
tsize_t (*TIFFReadWriteProc)(thandle_t, tdata_t, tsize_t);
 
typedef toff_t (*TIFFSeekProc)(thandle_t, toff_t, int); 
typedef int (*TIFFCloseProc)(thandle_t); 
typedef toff_t (*TIFFSizeProc)(thandle_t); 
typedef int (*TIFFMapFileProc)(thandle_t, tdata_t*,
toff_t*); 
typedef void (*TIFFUnmapFileProc)(thandle_t, tdata_t,
toff_t);

TIFF*
TIFFClientOpen(const char *filename, const
char *mode, thandle_t
clientdata, TIFFReadWriteProc
readproc, TIFFReadWriteProc
writeproc, TIFFSeekProc seekproc,
TIFFCloseProc closeproc, TIFFSizeProc
sizeproc, TIFFMapFileProc mapproc,
TIFFUnmapFileProc unmapproc)

<h2>DESCRIPTION
<a name="DESCRIPTION"></a>
</h2>

TIFFOpen
opens a TIFF file whose name is
filename and returns a handle to be used in
subsequent calls to routines in libtiff. If the open
operation fails, then zero is returned. The mode
parameter specifies if the file is to be opened for reading
(&lsquo;&lsquo;r&rsquo;&rsquo;), writing
(&lsquo;&lsquo;w&rsquo;&rsquo;), or appending
(&lsquo;&lsquo;a&rsquo;&rsquo;) and, optionally, whether to
override certain default aspects of library operation (see
below). When a file is opened for appending, existing data
will not be touched; instead new data will be written as
additional subfiles. If an existing file is opened for
writing, all previous data is overwritten.

If a file is
opened for reading, the first TIFF directory
in the file is automatically read (also see
TIFFSetDirectory(3TIFF) for reading directories other
than the first). If a file is opened for writing or
appending, a default directory is automatically created for
writing subsequent data. This directory has all the default
values specified in TIFF Revision 6.0:
BitsPerSample=1, ThreshHolding=bilevel art
scan, FillOrder=1 (most significant bit of each data
byte is filled first), Orientation=1 (the 0th row
represents the visual top of the image, and the 0th column
represents the visual left hand side),
SamplesPerPixel=1, RowsPerStrip=infinity,
ResolutionUnit=2 (inches), and Compression=1
(no compression). To alter these values, or to define values
for additional fields, TIFFSetField(3TIFF) must be
used.

TIFFOpenExt
(added in libtiff 4.5) is like TIFFOpen , but
options, such as re-entrant error and warning handlers and a
limit in byte that libtiff internal memory allocation
functions are allowed to request per call may be passed with
the opts argument. The opts argument may be NULL. Refer to
TIFFOpenOptions for allocating and filling the opts
argument parameters. The allocated memory for
TIFFOpenOptions can be released straight after
successful execution of the related &quot;TIFFOpenExt&quot;
functions.

TIFFFdOpenExt
(added in libtiff 4.5) is like TIFFFdOpen , but
options argument opts like for TIFFOpenExt can be
passed.

TIFFFdOpen
is like TIFFOpen except that it opens a
TIFF file given an open file descriptor
fd. The file&rsquo;s name and mode must reflect that
of the open descriptor. The object associated with the file
descriptor must support random access.

TIFFClientOpen
is like TIFFOpen except that the caller supplies a
collection of functions that the library will use to do
UNIX -like I/O operations. The
readproc and writeproc are called to read and
write data at the current file position. seekproc is
called to change the current file position a la
lseek(2). closeproc is invoked to release any
resources associated with an open file. sizeproc is
invoked to obtain the size in bytes of a file.
mapproc and unmapproc are called to map and
unmap a file&rsquo;s contents in memory; c.f. mmap(2)
and munmap(2). The clientdata parameter is an
opaque &lsquo;&lsquo;handle&rsquo;&rsquo; passed to the
client-specified routines passed as parameters to
TIFFClientOpen.

<h2>OPTIONS
<a name="OPTIONS"></a>
</h2>

The open mode
parameter can include the following flags in addition to the
&lsquo;&lsquo;r&rsquo;&rsquo;,
&lsquo;&lsquo;w&rsquo;&rsquo;, and
&lsquo;&lsquo;a&rsquo;&rsquo; flags. Note however that
option flags must follow the read-write-append
specification.

l</td>
<td width="10%"></td>
<td width="78%">

When creating a new file force information be written
with Little-Endian byte order (but see below). By default
the library will create new files using the native
CPU byte order.</td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">

b</td>
<td width="10%"></td>
<td width="78%">

When creating a new file force information be written
with Big-Endian byte order (but see below). By default the
library will create new files using the native
CPU byte order.</td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">

L</td>
<td width="10%"></td>
<td width="78%">

Force image data that is read or written to be treated
with bits filled from Least Significant Bit (
LSB ) to Most Significant Bit (
MSB ). Note that this is the opposite to the
way the library has worked from its inception.</td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">

B</td>
<td width="10%"></td>
<td width="78%">

Force image data that is read or written to be treated
with bits filled from Most Significant Bit (
MSB ) to Least Significant Bit (
LSB ); this is the default.</td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">

H</td>
<td width="10%"></td>
<td width="78%">

Force image data that is read or written to be treated
with bits filled in the same order as the native
CPU. </td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">

M</td>
<td width="10%"></td>
<td width="78%">

Enable the use of memory-mapped files for images opened
read-only. If the underlying system does not support
memory-mapped files or if the specific image being opened
cannot be memory-mapped then the library will fallback to
using the normal system interface for reading information.
By default the library will attempt to use memory-mapped
files. </td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">

m</td>
<td width="10%"></td>
<td width="78%">

Disable the use of memory-mapped files.</td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">

C</td>
<td width="10%"></td>
<td width="78%">

Enable the use of &lsquo;&lsquo;strip
chopping&rsquo;&rsquo; when reading images that are
comprised of a single strip or tile of uncompressed data.
Strip chopping is a mechanism by which the library will
automatically convert the single-strip image to multiple
strips, each of which has about 8 Kilobytes of data. This
facility can be useful in reducing the amount of memory used
to read an image because the library normally reads each
strip in its entirety. Strip chopping does however alter the
apparent contents of the image because when an image is
divided into multiple strips it looks as though the
underlying file contains multiple separate strips. Finally,
note that default handling of strip chopping is a
compile-time configuration parameter. The default behaviour,
for backwards compatibility, is to enable strip
chopping. </td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">

c</td>
<td width="10%"></td>
<td width="78%">

Disable the use of strip chopping when reading
images. </td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">

h</td>
<td width="10%"></td>
<td width="78%">

Read TIFF header only, do not load the first image
directory. That could be useful in case of the broken first
directory. We can open the file and proceed to the other
directories. </td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">

4</td>
<td width="10%"></td>
<td width="78%">

ClassicTIFF for creating a file (default)</td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">

8</td>
<td width="10%"></td>
<td width="78%">

BigTIFF for creating a file.</td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">

D</td>
<td width="10%"></td>
<td width="78%">

Enable use of deferred strip/tile offset/bytecount array
loading. They will be loaded the first time they are
accessed to. This loading will be done in its entirety
unless the O flag is also specified.</td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">

O</td>
<td width="10%"></td>
<td width="78%">

On-demand loading of values of the strip/tile
offset/bytecount arrays, limited to the requested
strip/tile, instead of whole array loading (implies D)</td></tr>
</table>

<h2>BYTE ORDER
<a name="BYTE ORDER"></a>
</h2>

The
TIFF specification (all versions)
states that compliant readers must be capable of reading
images written in either byte order. Nonetheless some
software that claims to support the reading of
TIFF images is incapable of reading images in
anything but the native CPU byte order on
which the software was written. (Especially notorious are
applications written to run on Intel-based machines.) By
default the library will create new files with the native
byte-order of the CPU on which the
application is run. This ensures optimal performance and is
portable to any application that conforms to the TIFF
specification. To force the library to use a specific
byte-order when creating a new file the
&lsquo;&lsquo;b&rsquo;&rsquo; and
&lsquo;&lsquo;l&rsquo;&rsquo; option flags may be included
in the call to open a file; for example,
&lsquo;&lsquo;wb&rsquo;&rsquo; or
&lsquo;&lsquo;wl&rsquo;&rsquo;.

<h2>RETURN VALUES
<a name="RETURN VALUES"></a>
</h2>

Upon successful
completion TIFFOpen, TIFFFdOpen, and
TIFFClientOpen return a TIFF pointer.
Otherwise, NULL is returned.

<h2>DIAGNOSTICS
<a name="DIAGNOSTICS"></a>
</h2>

All error
messages are directed to the TIFFError(3TIFF)
routine. Likewise, warning messages are directed to the
TIFFWarning(3TIFF) routine.

&quot;%s&quot;:
Bad mode. The specified mode parameter was not
one of &lsquo;&lsquo;r&rsquo;&rsquo; (read),
&lsquo;&lsquo;w&rsquo;&rsquo; (write), or
&lsquo;&lsquo;a&rsquo;&rsquo; (append).

%s: Cannot
open. TIFFOpen() was unable to open the specified
filename for read/writing.

Cannot read
TIFF header. An error occurred while attempting to read
the header information.

Error
writing TIFF header. An error occurred while writing the
default header information for a new file.

Not a TIFF
file, bad magic number %d (0x%x). The magic number in
the header was not (hex) 0x4d4d or (hex) 0x4949.

Not a TIFF
file, bad version number %d (0x%x). The version field in
the header was not 42 (decimal).

Cannot
append to file that has opposite byte ordering. A file
with a byte ordering opposite to the native byte ordering of
the current machine was opened for appending
(&lsquo;&lsquo;a&rsquo;&rsquo;). This is a limitation of the
library.

libtiff(3TIFF),
TIFFClose(3TIFF)
<hr>
</body>
</html>

cmd: