sergiotarxz
/
libvips
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

update man pages for removed funcs

This commit is contained in:
John Cupitt 2008-08-16 17:19:59 +00:00
parent 72ff1d89c7
commit 7e2c9b9510
9 changed files with 30 additions and 118 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
man/im_analyze2vips.3
View File

@ -6,8 +6,6 @@ im_analyze2vips \- convert Analyze 7.5 images to VIPS format
int im_analyze2vips( const char *filename, IMAGE *out )
int im_analyze2vips_header( const char *filename, IMAGE *out )
.SH DESCRIPTION
.B im_analyze2vips(3)
reads the Analyze image in
@ -29,10 +27,6 @@ be retrieved with
im_header_string "dsr-data_history.patient_id" fred.v
.B im_analyze2vips_header()
reads the just the header of the image into the VIPS image. You can't read any
pixels!
.SH SEE ALSO
im_grid(3)
.SH COPYRIGHT

8
man/im_csv2vips.3
View File

@ -6,8 +6,6 @@ im_csv2vips, im_vips2csv \- read and write CSV (comma separated values) files
int im_csv2vips( const char *filename, IMAGE *out )
int im_csv2vips_header( const char *filename, IMAGE *out );
int im_vips2csv( IMAGE *in, const char *filename )
.SH DESCRIPTION
@ -41,12 +39,6 @@ never run together.
The number of lines to read from the file. Default -1, meaning read to end of
file.
.B im_csv2vips_header(3)
works exactly as
.B im_csv2vips(3)
but only sets the header of the output image. It is rather slow, since it has
to read the whole input file.
.B im_vips2csv(3)
writes the VIPS image to the file as ascii text, one line of text per
scanline. Complex numbers are written as "(real,imaginary)" and will need

10
man/im_exr2vips.3
View File

@ -1,23 +1,17 @@
.TH IM_EXR 3 "3 Jan 2003"
.SH NAME
im_exr2vips, im_exr2vips_header \- convert OpenEXR images to VIPS format
im_exr2vips \- convert OpenEXR images to VIPS format
.SH SYNOPSIS
#include <vips/vips.h>
int im_exr2vips( const char *filename, IMAGE *out )
int im_exr2vips_header( const char *filename, IMAGE *out )
.SH DESCRIPTION
.B im_exr2vips()
reads the OpenEXR image in filename, and writes the image out
in VIPS format.
.B im_png2vips_header()
reads just the header information from the OpenEXR file. You can't read any
pixels!
.SH SEE ALSO
im_isexr(3), im_vips2tiff(3)
im_open(3), im_vips2tiff(3)
.SH COPYRIGHT
Hey, you want this? You have it!

34
man/im_iscomplex.3
View File

@ -1,7 +1,7 @@
.TH IM_ISINT 3 "11 April 1990"
.SH NAME
im_isint, im_ispng, im_isuint, im_isfloat, im_isscalar, im_iscomplex, im_istiff,
istifftiled, im_isjpeg, im_isfile, im_ispartial, im_isvips, im_isMSBfirst,
im_isint, im_isuint, im_isfloat, im_isscalar, im_iscomplex,
im_isfile, im_ispartial, im_isvips, im_isMSBfirst,
im_fexists, im_amiMSBfirst \- classify image types
.SH SYNOPSIS
.B #include <vips/vips.h>
@ -14,26 +14,6 @@ int im_amiMSBfirst( void )
int im_fexists( const char *filename, ... )
int im_istiff( filename )
.br
char *filename;
int im_istifftiled( filename )
.br
char *filename;
int im_isjpeg( filename )
.br
char *filename;
int im_ispng( filename )
.br
char *filename;
int im_isppm( filename )
.br
char *filename;
int im_isvips( filename )
.br
char *filename;
@ -70,16 +50,6 @@ IMAGE *im;
im_fexists(3) returns non-zero if the named file exists and is readable. Args
as printf(3).
im_istiff(3) tests a file for tiff-ness.
im_istifftiled(3) tests a file for tiff-tiled-ness.
im_isjpeg(3) tests a file for jpeg-ness.
im_ispng(3) tests a file for png-ness.
im_isppm(3) tests a file for PPM/PGM/PBM-ness.
im_isvips(3) tests a file for vips-ness.
im_isMSBfirst(3) returns true (1) if the file is in most-significant-byte first

18
man/im_jpeg2vips.3
View File

@ -6,8 +6,6 @@ im_jpeg2vips, im_vips2jpeg, im_vips2bufjpeg, im_vips2mimejpeg \- convert JPEG im
int im_jpeg2vips( char *filename, IMAGE *out )
int im_jpeg2vips_header( char *filename, IMAGE *out )
int im_vips2jpeg( IMAGE *in, char *filename )
int im_vips2bufjpeg( IMAGE *in, IMAGE *base, char **obuf, int *olen )
@ -15,7 +13,7 @@ int im_vips2bufjpeg( IMAGE *in, IMAGE *base, char **obuf, int *olen )
int im_vips2mimejpeg( IMAGE *in )
.SH DESCRIPTION
.B im_jpeg2vips()
.B im_jpeg2vips(3)
reads the named jpeg file and writes it to the specified
IMAGE. The entire image is read before returning. It can read most 8-bit JPEG
images, including CMYK.
@ -37,13 +35,7 @@ Any embedded ICC profiles are ignored: you always just get the RGB from the
file. Instead, the embedded profile will be attached to the image as metadata.
Any EXIF data is also attached as VIPS metadata.
.B im_jpeg2vips_header()
reads just the header of the JPEG file (including any EXIF data), and sets
the fields in the VIPS image.
You can't read any pixels! This is only useful for printing header
information.
.B im_vips2jpeg()
.B im_vips2jpeg(3)
writes the IMAGE to filename in JPEG format. It uses the
default settings of the IJG library.
@ -63,7 +55,7 @@ profile from the header will be attached.
The image is automatically converted to RGB or Monochrome before saving. Any
metadata attached to the image is saved as EXIF, if possible.
.B im_vips2bufjpeg()
.B im_vips2bufjpeg(3)
returns the compressed image in a memory buffer. The buffer
is allocated for you, local to IMAGE descriptor
.B base.
@ -74,10 +66,10 @@ parameter. You are responsible for
freeing the buffer. The buffer is only allocated if the function returns
successfully.
.B im_vips2mimejpeg()
.B im_vips2mimejpeg(3)
writes the image to stdout as a MIME image/jpeg type. It
outputs Content-Length and Content-Type fields making the result suitable for
sending to a web browser.
.SH SEE ALSO
im_isjpeg(3).
im_open(3).

12
man/im_magick2vips.3
View File

@ -1,25 +1,19 @@
.TH IM_MAGICK 3 "January 2003"
.SH NAME
im_magick2vips, im_magick2vips_header \- read images with the libMagick
im_magick2vips \- read images with the libMagick
library
.SH SYNOPSIS
#include <vips/vips.h>
int im_magick2vips( const char *filename, IMAGE *out )
int im_magick2vips_header( const char *filename, IMAGE *out )
.SH DESCRIPTION
.B im_magick2vips()
.B im_magick2vips(3)
reads the image in filename using libMagick, and writes the image out
in VIPS format. It should be able to read any ImageMagick image, including
the float and double formats.
.B im_magick2vips_header()
reads the just the header into the VIPS image. You can't read any
pixels!
.SH SEE ALSO
im_ismagick(3)
im_open(3)
.SH COPYRIGHT
Hey, you want this? You have it!

18
man/im_png2vips.3
View File

@ -1,25 +1,19 @@
.TH IM_PNG 3 "3 Jan 2003"
.SH NAME
im_png2vips, im_png2vips_header, im_png2vips \- convert PNG images to and from VIPS format
im_png2vips, im_png2vips \- convert PNG images to and from VIPS format
.SH SYNOPSIS
#include <vips/vips.h>
int im_png2vips( const char *filename, IMAGE *out )
int im_png2vips_header( const char *filename, IMAGE *out )
int im_vips2png( IMAGE *in, const char *filename )
.SH DESCRIPTION
.B im_png2vips()
.B im_png2vips(3)
reads the png image in filename, and writes the image out
in VIPS format.
.B im_png2vips_header()
reads just the header information from the PNG file. You can't read any
pixels!
.B im_vips2png()
.B im_vips2png(3)
reads the image in and writes a PNG file to the specified
filename. The filename may include an optional mode string, following a ':'
character, which you can use to specify compression and interlace.
@ -42,15 +36,15 @@ alpha channel) before saving.
The call:
im_vips2png fred.v fred.png
im_vips2png fred.v fred.png
Writes a compression 6, uninterlaced PNG image.
im_vips2png fred.v fred.tif:,1
im_vips2png fred.v fred.tif:,1
Writes an interlaced image.
.SH SEE ALSO
im_ispng(3), im_vips2tiff(3)
im_open(3), im_vips2tiff(3)
.SH COPYRIGHT
Hey, you want this? You have it!

14
man/im_ppm2vips.3
View File

@ -1,27 +1,21 @@
.TH IM_PPM 3 "November 2000"
.SH NAME
im_ppm2vips, im_ppm2vips_header, im_vips2ppm \- convert PPM/PGM/PBM images to and from VIPS format
im_ppm2vips, im_vips2ppm \- convert PPM/PGM/PBM images to and from VIPS format
.SH SYNOPSIS
#include <vips/vips.h>
int im_ppm2vips( const char *filename, IMAGE *out )
int im_ppm2vips_header( const char *filename, IMAGE *out )
int im_vips2ppm( IMAGE *in, const char *filename )
.SH DESCRIPTION
.B im_ppm2vips()
.B im_ppm2vips(3)
reads the PPM/PGM/PBM image in filename, and writes the image out
in VIPS format. It can read 1, 8, 16 and 32 bit images, colour or monochrome,
stored in binary or in ASCII. One bit images become 8 bit VIPS images, with 0
and 255 for 0 and 1.
.B im_ppm2vips_header()
reads the just the header of the image into the VIPS image. You can't read any
pixels!
.B im_vips2ppm()
.B im_vips2ppm(3)
writes the VIPS image to the named file in PPM format. It can write 8, 16 or
32 bit integer images, colour or monochrome, stored as binary or ASCII. Images
of more than 8 bits can only be stored in ASCII.
@ -33,6 +27,6 @@ The storage format is indicated by a filename extension.
will write to "fred.ppm" in ascii format. The default is binary.
.SH SEE ALSO
im_isppm(3)
im_open(3)
.SH COPYRIGHT
Hey, you want this? You have it!

28
man/im_tiff2vips.3
View File

@ -1,13 +1,11 @@
.TH IM_TIFF 3 "6 June 1994"
.SH NAME
im_tiff2vips, im_tiff2vips_header, im_tiff2vips \- convert TIFF images to and from VIPS format
im_tiff2vips, im_tiff2vips \- convert TIFF images to and from VIPS format
.SH SYNOPSIS
#include <vips/vips.h>
int im_tiff2vips( const char *filename, IMAGE *out )
int im_tiff2vips_header( const char *filename, IMAGE *out )
int im_vips2tiff( IMAGE *in, const char *filename )
.SH DESCRIPTION
@ -29,16 +27,6 @@ example:
will read page 12 (numbering from page zero) from the TIFF image.
Use
.B im_istifftiled(3)
and
.B im_istiffpyramid(3)
to find the TIFF image type before calling.
.B im_tiff2vips_header(3)
reads just the header information from the TIFF file. You can't read any
pixels!
.B im_vips2tiff(3)
reads the image in and writes a TIFF file to the specified
filename. The filename may include an optional mode string, following a ':'
@ -121,36 +109,36 @@ JPEG coder.
The call:
im_vips2tiff fred.v fred.tif
im_vips2tiff fred.v fred.tif
Writes a striped, uncompressed TIFF image. Almost anything should be able to
read this.
im_vips2tiff fred.v fred.tif:jpeg,tile,pyramid
im_vips2tiff fred.v fred.tif:jpeg,tile,pyramid
Writes a tiled JPEG pyramid image. Although VIPS tries to follow the TIFF
specification carefully, you may have trouble reading this on any system other
than VIPS.
im_vips2tiff fred.v fred.tif:jpeg:25,tile:64x64
im_vips2tiff fred.v fred.tif:jpeg:25,tile:64x64
Writes a highly compressed JPEG image, with a tile size of 64 by 64 pixels.
im_vips2tiff fred.v fred.tif:,tile
im_vips2tiff fred.v fred.tif:,tile
Writes an uncompressed tiled image.
im_vips2tiff fred.v fred.tif:packbits,tile,,onebit
im_vips2tiff fred.v fred.tif:packbits,tile,,onebit
Writes a tiled one bit TIFF image (provided fred.v is a one band 8 bit image)
compressed with packbits.
im_vips2tiff fred.v fred.tif:,,,,res_inch:300
im_vips2tiff fred.v fred.tif:,,,,res_inch:300
Writes fred.v as a tiff file, with the resolution in the tiff header set to
300 dpi.
.SH SEE ALSO
im_istiff(3), im_istifftiled(3), im_istiffpyramid(3)
im_open(3)
.SH COPYRIGHT
Hey, you want this? You have it!