This commit is contained in:
seb
2026-07-14 23:30:16 +02:00
parent 245fb047d7
commit 262fa63f1b
109 changed files with 21566 additions and 367 deletions

View File

@@ -0,0 +1,93 @@
.TH VIPS 1 "30 June 1993"
.SH NAME
vips \- run vips operations from the command line
.SH SYNOPSIS
.B vips [options] [command] [command-options] [command-args]
.SH DESCRIPTION
.B vips(1)
is the VIPS universal main program. You can use it to run any VIPS operation
from the command line, to query the VIPS class hierarchy, and to
maintain parts of the VIPS library.
To run a VIPS operation, the first argument should be the name of the
operation
and following arguments should be the operation arguments. For example:
$ vips invert lena.v lena2.v
.SH OPTIONS
.TP
.B -l BASE-NAME, --list=BASE-NAME
List operations below BASE-NAME. This prints a one-line summary of every
operation in vips below the class BASE-NAME, where BASE-NAME may be a full
vips class name, or a nickname.
If BASE-NAME is not supplied, this will list all classes below VipsOperation.
.TP
.B -p PLUGIN, --plugin=PLUGIN
Load PLUGIN. Note that plugins in $VIPSHOME/lib/vips-plugins-MAJOR.MINOR are
loaded automatically.
.TP
.B -v, --version
Show VIPS version.
.TP
.B -c NAME, --completion NAME
Print completions for
.B NAME
.SH COMMANDS
.TP
.B operation-name operation-arguments
Execute a named operation, for example add.
.SH EXAMPLES
Run a vips operation. Operation options must follow the operation name.
$ vips insert lena.v lena2.v out.v 0 0 --background "128 0 0"
Get a "usage" message for an operation.
$ vips insert
insert image @sub into @main at @x, @y
usage:
insert main sub out x y
where:
main - Main input image, input VipsImage
sub - Sub-image to insert into main image, input VipsImage
out - Output image, output VipsImage
x - Left edge of sub in main, input gint
default: 0
min: -100000000, max: 100000000
y - Top edge of sub in main, input gint
default: 0
min: -100000000, max: 100000000
optional arguments:
expand - Expand output to hold all of both inputs, input gboolean
default: false
background - Colour for new pixels, input VipsArrayDouble
operation flags: sequential
List all draw operations.
$ vips -l draw
VipsDraw (draw), draw operations
VipsDrawink (drawink), draw with ink operations
VipsDrawRect (draw_rect), paint a rectangle on an image
VipsDrawMask (draw_mask), draw a mask on an image
VipsDrawLine (draw_line), draw a line on an image
VipsDrawCircle (draw_circle), draw a circle on an image
VipsDrawFlood (draw_flood), flood-fill an area
VipsDrawImage (draw_image), paint an image into another image
VipsDrawSmudge (draw_smudge), blur a rectangle on an image
.SH RETURN VALUE
returns 0 on success and non-zero on error.
.SH SEE ALSO
vipsheader(1)
.SH COPYRIGHT
The National Gallery and Birkbeck College, 1989-1996.

View File

@@ -0,0 +1,50 @@
.TH VIPSEDIT 1 "30 June 1993"
.SH NAME
vipsedit \- edit header of a vips image file
.SH SYNOPSIS
.B vipsedit [OPTION...] vipsfile
.SH DESCRIPTION
.B vipsedit
alters a VIPS image file's header. This is useful for setting the resolution,
for example.
The options are:
-x, --xsize=N set Xsize to N
-y, --ysize=N set Ysize to N
-b, --bands=N set Bands to N
-f, --format=F set BandFmt to F (eg. uchar)
-i, --interpretation=I
set Interpretation to I (eg. xyz)
-c, --coding=C set Coding to C (eg. labq)
-X, --xres=R set Xres to R pixels/mm
-Y, --yres=R set Yres to R pixels/mm
-u, --xoffset=N set Xoffset to N
-v, --yoffset=N set Yoffset to N
-e, --setext replace extension block with stdin
Be very careful when changing Xsize, Ysize, BandFmt or Bands. vipsedit does no
checking!
.SH EXAMPLES
To set the Xsize to 512 and Bands to 6:
vipsedit --xsize=512 --bands=6 fred.v
or
vipsedit -x 512 -b 6 fred.v
Extract the XML metadata from an image with
.B vipsheader(1),
edit it, and reattach with
.B vipsedit(1).
vipsheader -f getext fred.v | sed s/banana/pineapple/ | vipsedit -e fred.v
.SH RETURN VALUE
returns 0 on success and non-zero on error.
.SH SEE ALSO
vipsheader(1)
.SH COPYRIGHT
K. Martinez 1993

View File

@@ -0,0 +1,47 @@
.TH VIPSHEADER 1 "12 July 1990"
.SH NAME
vipsheader \- prints information about an image file
.SH SYNOPSIS
vipsheader [OPTIONS ...] files ...
.SH DESCRIPTION
.B vipsheader(1)
prints image header fields to stdout.
.SH OPTIONS
.TP
.B -a, --all
Show all fields. Fields are displayed to be convenient for humans to
read, so binary data, for example, is summarized rather than simply printed.
.TP
.B -f FIELD, --field=FIELD
Print the value of
.B FIELD
from the image header. Fields are printed in a way suitable for programs to
understand, so, for example, binary data is base64-encoded and printed as a
stream of characters.
The special field name
.B getext
prints the VIPS extension block: the XML defining the image metadata. You can
alter this, then reattach with
.B vipsedit(1).
You can use multiple "-f" arguments to print the values
of many fields.
.SH EXAMPLES
$ vipsheader -f width ~/pics/*.v
1024
1279
22865
1
256
.SH SEE ALSO
vipsedit(1)
.SH COPYRIGHT
N. Dessipris
.SH AUTHOR
N. Dessipris \- 12/07/1990

View File

@@ -0,0 +1,43 @@
.TH VIPSPROFILE 1 "13 December 2013"
.SH NAME
vipsprofile \- analyze vips profiles
.SH SYNOPSIS
.B vipsprofile
.SH DESCRIPTION
.B vipsprofile(1)
analyzes the file written by the --vips-profile option, calculates some
statistics, and draws a graph of evaluation.
Run any vips program with the --vips-profile option to generate a file called
"vips-profile.txt". This contains timing information about CPU use, memory use
and thread synchronisation.
Run
.B vipsprofile(1)
to load this file, calculate some
statistics, and draw a graph of evaluation saved to vips-profile.svg. This
analysis can help track down performance problems.
For example:
$ vips sharpen shark.jpg x.jpg --vips-profile
recording profile in vips-profile.txt
$ vipsprofile
reading from vips-profile.txt
loaded 3622 events
total time = 0.138322
name alive wait% work% unkn% memory peakm
worker 20 0.069 34.5 58.9 6.65 3.14 5.56
worker 21 0.07 1.36 60.2 38.4 2.65 5.07
worker 22 0.07 33 55.8 11.1 2.62 5.04
worker 23 0.072 34.2 59.7 6.15 2.72 5.14
wbuffer 24 0.075 99 1.03 0.00401 0 0
wbuffer 25 0.075 95.6 4.39 0.00667 0 0
main 26 0.14 52.8 0 47.2 -11.1 0.787
peak memory = 21.6 MB
writing to vips-profile.svg
.SH RETURN VALUE
returns 0 on success and non-zero on error.
.SH SEE ALSO
vips(1)

View File

@@ -0,0 +1,117 @@
.TH VIPSTHUMBNAIL 1 "13 May 2010"
.SH NAME
vipsthumbnail \- make thumbnails of image files
.SH SYNOPSIS
.B vipsthumbnail [flags] imagefile1 imagefile2 ...
.SH DESCRIPTION
.B vipsthumbnail(1)
processes each
.B imagefile
in turn, shrinking each image to fit within a 128 by 128 pixel square.
The shrunk image is written to a new file named
.B tn_imagefile.jpg.
This program is typically faster and uses less memory than
other image thumbnail programs.
For example:
$ vipsthumbnail fred.png jim.tif
will read image files
.B fred.png
and
.B jim.tif
and write thumbnails to the files
.B tn_fred.jpg
and
.B tn_jim.jpg.
$ vipsthumbnail --size=64 -o thumbnails/%s.png fred.jpg
will read image file
.B fred.jpg
and write a 64 x 64 pixel thumbnail to the file
.B thumbnails/fred.png.
.SH OPTIONS
.TP
.B -s N, --size=N
Set the output thumbnail size to
.B N
x
.B N
pixels.
You can use "MxN" to specify a rectangular bounding box.
The image is shrunk so that it just fits within this area, images
which are smaller than this are expanded.
Use "xN" or "Mx" to just resize on
one axis.
Append "<" to only resize if the input image is smaller than the
target, append ">" to only resize if the input image is larger than the target.
.TP
.B -o FORMAT, --output=FORMAT
Set the output format string. The input filename has any file type suffix
removed, then that value is substituted into
.B FORMAT
replacing
.B %s.
If
.B FORMAT
is a relative path, the name of the input directory is prepended. In other
words, any path in
.B FORMAT
is relative to the directory of the current input file.
The default value is
.B tn_%s.jpg
meaning JPEG output, with
.B tn_
prepended. You can add format options too, for example
.B tn_%s.jpg[Q=20]
will write JPEG images with Q set to 20.
.TP
.B -e PROFILE, --eprofile=PROFILE
Export thumbnails with this ICC profile. Images are only colour-transformed if
there is both an output and an input profile available. The input profile can
either be embedded in the input image or supplied with the
.B --iprofile
option.
.TP
.B -i PROFILE, --iprofile=PROFILE
Import images with this ICC profile, if no profile is embedded in the image.
Images are only colour-transformed if
there is both an output and an input profile available. The output profile
should be supplied with the
.B --oprofile
option.
.TP
.B -c, --crop
Crop the output image down. The image is shrunk so as to completely fill the
bounding box in both axes, then any excess is cropped off.
.TP
.B -d, --delete
Delete the output profile from the image. This can save a small amount of
space.
.TP
.B -t, --rotate
Auto-rotate images using EXIF orientation tags.
.TP
.B -a, --linear
Shrink images in linear light colour space. This can be much slower.
.SH RETURN VALUE
returns 0 on success and non-zero on error. Error can mean one or more
conversions failed.
.SH SEE ALSO
vipsheader(1)