added TIFFRewriteDirectory info

This commit is contained in:
Frank Warmerdam 2001-09-26 17:32:24 +00:00
parent 4f152a1867
commit 7f05378ed7
2 changed files with 24 additions and 5 deletions

View File

@ -1,5 +1,5 @@
#! smake
# $Header: /cvs/maptools/cvsroot/libtiff/man/Makefile.in,v 1.9 2001-07-27 13:18:50 warmerda Exp $
# $Header: /cvs/maptools/cvsroot/libtiff/man/Makefile.in,v 1.10 2001-09-26 17:32:24 warmerda Exp $
#
# @WARNING@
#
@ -178,6 +178,7 @@ MANDEVLINKS=\
lib/TIFFLastDirectory.3t \
lib/TIFFRegisterCODEC.3t \
lib/TIFFReverseBits.3t \
lib/TIFFRewriteDirectory.3t \
lib/TIFFRGBAImageOK.3t \
lib/TIFFRGBAImageBegin.3t \
lib/TIFFRGBAImageGet.3t \
@ -299,6 +300,7 @@ lib/TIFFIsUpSampled.3t:; ${ECHO} ".so ${MANDIR}TIFFquery.3t" > $@
lib/TIFFIsMSB2LSB.3t:; ${ECHO} ".so ${MANDIR}TIFFquery.3t" > $@
lib/TIFFLastDirectory.3t:; ${ECHO} ".so ${MANDIR}TIFFquery.3t" > $@
lib/TIFFReverseBits.3t:; ${ECHO} ".so ${MANDIR}TIFFswab.3t" > $@
lib/TIFFRewriteDirectory.3t:; ${ECHO} ".so ${MANDIR}TIFFWriteDirectory.3t" > $@
lib/TIFFRGBAImageOK.3t:; ${ECHO} ".so ${MANDIR}TIFFRGBAImage.3t" > $@
lib/TIFFRGBAImageBegin.3t:; ${ECHO} ".so ${MANDIR}TIFFRGBAImage.3t" > $@
lib/TIFFRGBAImageGet.3t:; ${ECHO} ".so ${MANDIR}TIFFRGBAImage.3t" > $@

View File

@ -1,4 +1,4 @@
.\" $Header: /cvs/maptools/cvsroot/libtiff/man/Attic/TIFFWriteDirectory.3t,v 1.1 1999-07-27 21:50:27 mike Exp $
.\" $Header: /cvs/maptools/cvsroot/libtiff/man/Attic/TIFFWriteDirectory.3t,v 1.2 2001-09-26 17:32:24 warmerda Exp $
.\"
.\" Copyright (c) 1988-1997 Sam Leffler
.\" Copyright (c) 1991-1997 Silicon Graphics, Inc.
@ -23,17 +23,20 @@
.\" OF THIS SOFTWARE.
.\"
.if n .po 0
.TH TIFFWriteDirectory 3T "December 16, 1991"
.TH TIFFWriteDirectory 3T "September 26, 2001"
.SH NAME
TIFFWriteDirectory \- write the current directory in an open
TIFFWriteDirectory, TIFFRewriteDirectory \- write the current directory in an open
.SM TIFF
file
.SH SYNOPSIS
.B "#include <tiffio.h>"
.br
.B "int TIFFWriteDirectory(TIFF* tif)"
.br
.B "int TIFFRewriteDirectory(TIFF* tif)"
.SH DESCRIPTION
Write the contents of the current directory to the file and setup
.IR TIFFWriteDirectory
will write the contents of the current directory to the file and setup
to create a new subfile in the same file.
Applications only need to call
.IR TIFFWriteDirectory
@ -46,6 +49,20 @@ is automatically called by
and
.IR TIFFFlush
to write a modified directory if the file is open for writing.
.PP
The
.IR TIFFRewriteDirectory
function operates similarly to
.IR TIFFWriteDirectory
but can be called with directories previously read or written that already
have an established location in the file. It will rewrite the directory,
but instead of place it at it's old location (as
.IR TIFFWriteDirectory
would) it will place them at the end of the file, correcting the pointer from
the preceeding directory or file header to point to it's new location. This
is particularly important in cases where the size of the directory and
pointed to data has grown, so it won't fit in the space available at the
old location.
.SH "RETURN VALUES"
1 is returned when the contents are successfully
written to the file.