Apply CVE-2023-4863 patch
[platform/upstream/libwebp.git] / man / img2webp.1
1 .\"                                      Hey, EMACS: -*- nroff -*-
2 .TH IMG2WEBP 1 "May 1, 2020"
3 .SH NAME
4 img2webp \- create animated WebP file from a sequence of input images.
5 .SH SYNOPSIS
6 .B img2webp
7 [file_level_options] [files] [per_frame_options...]
8 .br
9 .B img2webp argument_file_name
10 .br
11 .SH DESCRIPTION
12 This manual page documents the
13 .B img2webp
14 command.
15 .PP
16 \fBimg2webp\fP compresses a sequence of images using the animated WebP format.
17 Input images can either be PNG, JPEG, TIFF or WebP.
18 If a single file name (not starting with the character '\-') is supplied as
19 the argument, the command line arguments are actually tokenized from this file.
20 This allows for easy scripting or using a large number of arguments.
21 .SH FILE-LEVEL OPTIONS
22 The file-level options are applied at the beginning of the compression process,
23 before the input frames are read.
24 .TP
25 .BI \-o " string
26 Specify the name of the output WebP file.
27 .TP
28 .BI \-min_size
29 Encode images to achieve smallest size. This disables key frame insertion and
30 picks the parameters resulting in the smallest output for each frame. It uses
31 lossless compression by default, but can be combined with \-q, \-m, \-lossy or
32 \-mixed options.
33 .TP
34 .BI \-kmin " int
35 .TP
36 .BI \-kmax " int
37 Specify the minimum and maximum distance between consecutive key frames
38 (independently decodable frames) in the output animation. The tool will insert
39 some key frames into the output animation as needed so that this criteria is
40 satisfied.
41 .br
42 .B \-mixed
43 Mixed compression mode: optimize compression of the image by picking either
44 lossy or lossless compression for each frame heuristically. This global
45 option disables the local option \fB-lossy\fP and \fB-lossless\fP .
46 .TP
47 .BI \-loop " int
48 Specifies the number of times the animation should loop. Using '0'
49 means 'loop indefinitely'.
50 .TP
51 .BI \-v
52 Be more verbose.
53 .TP
54 .B \-h, \-help
55 A short usage summary.
56 .TP
57 .B \-version
58 Print the version numbers of the relevant libraries used.
59
60 .SH PER-FRAME OPTIONS
61 The per-frame options are applied for the images following as arguments in the
62 command line. They can be modified any number of times preceding each particular
63 input image.
64 .TP
65 .BI \-d " int
66 Specify the image duration in milliseconds.
67 .TP
68 .B \-lossless, \-lossy
69 Compress the next image(s) using lossless or lossy compression mode. The
70 default mode is lossless.
71 .TP
72 .BI \-q " float
73 Specify the compression factor between 0 and 100. The default is 75.
74 .TP
75 .BI \-m " int
76 Specify the compression method to use. This parameter controls the
77 trade off between encoding speed and the compressed file size and quality.
78 Possible values range from 0 to 6. Default value is 4.
79
80 .SH EXAMPLE
81 img2webp -loop 2 in0.png -lossy in1.jpg -d 80 in2.tiff -o out.webp
82 .br
83
84 .SH BUGS
85 Please report all bugs to the issue tracker:
86 https://bugs.chromium.org/p/webp
87 .br
88 Patches welcome! See this page to get started:
89 http://www.webmproject.org/code/contribute/submitting\-patches/
90
91 .SH AUTHORS
92 \fBimg2webp\fP is a part of libwebp and was written by the WebP team.
93 .br
94 The latest source tree is available at
95 https://chromium.googlesource.com/webm/libwebp
96 .PP
97 This manual page was written by Pascal Massimino <pascal.massimino@gmail.com>,
98 for the Debian project (and may be used by others).
99
100 .SH SEE ALSO
101 .BR webpmux (1),
102 .BR gif2webp (1)
103 .br
104 Please refer to http://developers.google.com/speed/webp/ for additional
105 information.