/usr/share/gtk-doc/html/libvips/using-cli.html is in libvips-doc 7.40.6-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>VIPS Reference Manual: VIPS from the command-line</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="VIPS Reference Manual">
<link rel="up" href="ch01.html" title="VIPS Overview">
<link rel="prev" href="ch01.html" title="VIPS Overview">
<link rel="next" href="using-from-c.html" title="VIPS from C">
<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
<td width="100%" align="left" class="shortcuts"></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ch01.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="using-from-c.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="using-cli"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle">VIPS from the command-line</span></h2>
<p>Using VIPS — How to use the VIPS library from the command-line</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="using-command-line"></a><h2>Using VIPS from the command-line</h2>
<p>
Use the <span class="command"><strong>vips</strong></span> command to execute VIPS operations from
the command-line. You can show all classes with:
</p>
<div class="literallayout"><p><br>
<strong class="userinput"><code>vips list classes</code></strong><br>
</p></div>
<p>
This produces output something like:
</p>
<div class="literallayout"><p><br>
<strong class="userinput"><code>VipsOperation (operation), operations</code></strong><br>
<strong class="userinput"><code> VipsSystem (system), run an external command</code></strong><br>
<strong class="userinput"><code> VipsArithmetic (arithmetic), arithmetic operations</code></strong><br>
<strong class="userinput"><code> VipsBinary (binary), binary operations</code></strong><br>
<strong class="userinput"><code> VipsAdd (add), add two images</code></strong><br>
<strong class="userinput"><code> .... and so on</code></strong><br>
</p></div>
<p>
Each line shows the canonical name of the class (for example
<code class="literal">VipsAdd</code>), the class nickname
(<code class="literal">add</code> in this case), and a short description.
Some subclasses of operation will show more, for example subclasses of
<code class="literal">VipsForeign</code> will show some of the extra flags
supported by the file load/save operations.
You can get help on a specific operation by running it with no arguments,
for example:
</p>
<div class="literallayout"><p><br>
<strong class="userinput"><code>vips gamma</code></strong><br>
</p></div>
<p>
produces the output:
</p>
<div class="literallayout"><p><br>
<strong class="userinput"><code>gamma an image</code></strong><br>
<strong class="userinput"><code>usage:</code></strong><br>
<strong class="userinput"><code> gamma in out</code></strong><br>
<strong class="userinput"><code>where:</code></strong><br>
<strong class="userinput"><code> in - Input image, input VipsImage</code></strong><br>
<strong class="userinput"><code> out - Output image, output VipsImage</code></strong><br>
<strong class="userinput"><code>optional arguments:</code></strong><br>
<strong class="userinput"><code> exponent - Gamma factor, input gdouble</code></strong><br>
<strong class="userinput"><code>operation flags: sequential-unbuffered</code></strong><br>
</p></div>
<p>
<span class="command"><strong>vips gamma</strong></span> applies a gamma factor to an image. By
default, it uses 2.4, the sRGB gamma factor, but you can specify any
gamma with the <code class="literal">exponent</code> option. You can use the
C API docs for <code class="function">vips_gamma()</code> if you need more
information.
Use it from the command-line like this:
</p>
<div class="literallayout"><p><br>
<strong class="userinput"><code>vips gamma k2.jpg x.jpg --exponent 0.42</code></strong><br>
</p></div>
<p>
This will read file <code class="literal">k2.jpg</code>, un-gamma it, and
write the result to file <code class="literal">x.jpg</code>.
Some operations take arrays of values as arguments, for example,
<span class="command"><strong>vips affine</strong></span> needs an array of four numbers for the
2x2 transform matrix. You pass arrays as space-separated lists, for
example:
</p>
<div class="literallayout"><p><br>
<strong class="userinput"><code>vips affine k2.jpg x.jpg "2 0 0 1"</code></strong><br>
</p></div>
<p>
Or <span class="command"><strong>vips bandjoin</strong></span> needs an array of input images to
join, run it like this:
</p>
<div class="literallayout"><p><br>
<strong class="userinput"><code>vips bandjoin "k2.jpg k4.jpg" x.tif</code></strong><br>
</p></div>
<p>
<span class="command"><strong>vips</strong></span> will automatically convert between image file
formats for you. Input images are detected by sniffing their first few
bytes; output formats are set from the filename suffix. You can see a
list of all the supported file formats with something like:
</p>
<div class="literallayout"><p><br>
<strong class="userinput"><code>vips list classes | grep -i foreign</code></strong><br>
</p></div>
<p>
Then get a list of the options a format supports with, for example:
</p>
<div class="literallayout"><p><br>
<strong class="userinput"><code>vips jpegsave</code></strong><br>
</p></div>
<p>
You can pass options to the implicit load and save operations enclosed
in square brackets after the filename. For example:
</p>
<div class="literallayout"><p><br>
<strong class="userinput"><code>vips affine k2.jpg x.jpg[Q=90,strip] "2 0 0 1"</code></strong><br>
</p></div>
<p>
Will write <code class="literal">x.jpg</code> at quality level 90 and will
strip all metadata from the image.
Finally, <span class="command"><strong>vips</strong></span> has a couple of useful extra options.
</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p>
Use <code class="option">--vips-progress</code> to get
<span class="command"><strong>vips</strong></span> to display a simple progress indicator.
</p></li>
<li class="listitem"><p>
Use <code class="option">--vips-leak</code> and <span class="command"><strong>vips</strong></span> will
leak-test on exit, and also display an estimate of peak memory use.
</p></li>
</ul></div>
<p>
</p>
<p>
VIPS comes with a couple of other useful programs.
<span class="command"><strong>vipsheader</strong></span> is a command which can print image header
fields. <span class="command"><strong>vipsedit</strong></span> can change fields in vips format
images. <span class="command"><strong>vipsthumbnail</strong></span> can make image thumbnails
quickly.
</p>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.20</div>
</body>
</html>
|