libvips/man/vips.1

76 lines
2.0 KiB
Groff
Raw Normal View History

.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 function database, and to
maintain parts of the VIPS library.
To run a VIPS function, the first argument should be the name of the function
and following arguments should be the function parameters. For example:
$ vips im_invert lena.v lena2.v
.SH OPTIONS
.TP
.B -p PLUGIN, --plugin=PLUGIN
Load PLUGIN. Note that plugins in $VIPSHOME/lib are loaded automatically.
.TP
.B -v, --version
Show VIPS version.
.SH COMMANDS
.TP
.B list PACKAGE
List operations defined in PACKAGE. PACKAGE can also be "classes", "packages"
or "all".
.TP
.B cpph PACKAGE
Print C++ header for PACKAGE. PACKAGE can also be a function name, or "all".
.TP
.B cppc PACKAGE
Print C++ binding for PACKAGE. PACKAGE can also be a function name, or "all".
.TP
.B operation-name operation-arguments
Execute a named operation, for example im_invert, or add. Names prefixed with
"im_" are called via the vips7 interface, names without the prefix use the new
vips8 interface.
.SH EXAMPLES
Run a vips7 operation. The vips7 interface does not suport optional arguments.
$ vips im_invert lena.v lena2.v
Run a vips8 operation. Operation options must follow the operation name.
$ vips add --imtest=option.jpg lena.v lena2.v out.v
Get a "usage" message for an operation
$ vips add
2013-10-22 18:12:50 +02:00
usage:
add left right out
add two images
where:
2013-10-22 18:12:50 +02:00
left - Left-hand image argument, input VipsImage
right - Right-hand image argument, input VipsImage
out - Output image, output VipsImage
operation flags: sequential-unbuffered
add: too few arguments
.SH RETURN VALUE
returns 0 on success and non-zero on error.
.SH SEE ALSO
header(1)
.SH COPYRIGHT
The National Gallery and Birkbeck College, 1989-1996.