Blame man/webpmux.1

Packit 9c6abc
.\"                                      Hey, EMACS: -*- nroff -*-
Packit 9c6abc
.TH WEBPMUX 1 "December 1, 2017"
Packit 9c6abc
.SH NAME
Packit 9c6abc
webpmux \- create animated WebP files from non\-animated WebP images, extract
Packit 9c6abc
frames from animated WebP images, and manage XMP/EXIF metadata and ICC profile.
Packit 9c6abc
.SH SYNOPSIS
Packit 9c6abc
.B webpmux \-get
Packit 9c6abc
.I GET_OPTIONS
Packit 9c6abc
.I INPUT
Packit 9c6abc
.B \-o
Packit 9c6abc
.I OUTPUT
Packit 9c6abc
.br
Packit 9c6abc
.B webpmux \-set
Packit 9c6abc
.I SET_OPTIONS
Packit 9c6abc
.I INPUT
Packit 9c6abc
.B \-o
Packit 9c6abc
.I OUTPUT
Packit 9c6abc
.br
Packit 9c6abc
.B webpmux \-strip
Packit 9c6abc
.I STRIP_OPTIONS
Packit 9c6abc
.I INPUT
Packit 9c6abc
.B \-o
Packit 9c6abc
.I OUTPUT
Packit 9c6abc
.br
Packit 9c6abc
.B webpmux \-frame
Packit 9c6abc
.I FRAME_OPTIONS
Packit 9c6abc
.B [ \-frame ... ] [ \-loop
Packit 9c6abc
.I LOOP_COUNT
Packit 9c6abc
.B ]
Packit 9c6abc
.br
Packit 9c6abc
.RS 8
Packit 9c6abc
.B [ \-bgcolor
Packit 9c6abc
.I BACKGROUND_COLOR
Packit 9c6abc
.B ] \-o
Packit 9c6abc
.I OUTPUT
Packit 9c6abc
.RE
Packit 9c6abc
.br
Packit 9c6abc
.B webpmux \-duration
Packit 9c6abc
.I DURATION OPTIONS
Packit 9c6abc
.B [ \-duration ... ]
Packit 9c6abc
.I INPUT
Packit 9c6abc
.B \-o
Packit 9c6abc
.I OUTPUT
Packit 9c6abc
.br
Packit 9c6abc
.B webpmux \-info
Packit 9c6abc
.I INPUT
Packit 9c6abc
.br
Packit 9c6abc
.B webpmux [\-h|\-help]
Packit 9c6abc
.br
Packit 9c6abc
.B webpmux \-version
Packit 9c6abc
.br
Packit 9c6abc
.B webpmux argument_file_name
Packit 9c6abc
.SH DESCRIPTION
Packit 9c6abc
This manual page documents the
Packit 9c6abc
.B webpmux
Packit 9c6abc
command.
Packit 9c6abc
.PP
Packit 9c6abc
\fBwebpmux\fP can be used to create/extract from animated WebP files, as well as
Packit 9c6abc
to add/extract/strip XMP/EXIF metadata and ICC profile.
Packit 9c6abc
If a single file name (not starting with the character '\-') is supplied as
Packit 9c6abc
the argument, the command line argument are actually tokenized from this file.
Packit 9c6abc
This allows for easy scripting or using large number of arguments.
Packit 9c6abc
.SH OPTIONS
Packit 9c6abc
.SS GET_OPTIONS (\-get):
Packit 9c6abc
.TP
Packit 9c6abc
.B icc
Packit 9c6abc
Get ICC profile.
Packit 9c6abc
.TP
Packit 9c6abc
.B exif
Packit 9c6abc
Get EXIF metadata.
Packit 9c6abc
.TP
Packit 9c6abc
.B xmp
Packit 9c6abc
Get XMP metadata.
Packit 9c6abc
.TP
Packit 9c6abc
.BI frame " n
Packit 9c6abc
Get nth frame from an animated image. (n = 0 has a special meaning: last frame).
Packit 9c6abc
Packit 9c6abc
.SS SET_OPTIONS (\-set)
Packit 9c6abc
.TP
Packit 9c6abc
.BI icc " file.icc
Packit 9c6abc
Set ICC profile.
Packit 9c6abc
.P
Packit 9c6abc
Where: 'file.icc' contains the ICC profile to be set.
Packit 9c6abc
.TP
Packit 9c6abc
.BI exif " file.exif
Packit 9c6abc
Set EXIF metadata.
Packit 9c6abc
.P
Packit 9c6abc
Where: 'file.exif' contains the EXIF metadata to be set.
Packit 9c6abc
.TP
Packit 9c6abc
.BI xmp " file.xmp
Packit 9c6abc
Set XMP metadata.
Packit 9c6abc
.P
Packit 9c6abc
Where: 'file.xmp' contains the XMP metadata to be set.
Packit 9c6abc
Packit 9c6abc
.SS STRIP_OPTIONS (\-strip)
Packit 9c6abc
.TP
Packit 9c6abc
.B icc
Packit 9c6abc
Strip ICC profile.
Packit 9c6abc
.TP
Packit 9c6abc
.B exif
Packit 9c6abc
Strip EXIF metadata.
Packit 9c6abc
.TP
Packit 9c6abc
.B xmp
Packit 9c6abc
Strip XMP metadata.
Packit 9c6abc
Packit 9c6abc
.SS DURATION_OPTIONS (\-duration)
Packit 9c6abc
Amend the duration of a specific interval of frames. This option is only
Packit 9c6abc
effective on animated WebP and has no effect on a single-frame file.
Packit 9c6abc
.TP
Packit 9c6abc
.I duration[,start[,end]]
Packit 9c6abc
Where:
Packit 9c6abc
.br
Packit 9c6abc
.B duration
Packit 9c6abc
is the duration for the interval in milliseconds (mandatory).
Packit 9c6abc
Must be non-negative.
Packit 9c6abc
.br
Packit 9c6abc
.B start
Packit 9c6abc
is the starting frame index of the interval (optional).
Packit 9c6abc
.br
Packit 9c6abc
.B end
Packit 9c6abc
is the ending frame index (inclusive) of the interval (optional).
Packit 9c6abc
.TP
Packit 9c6abc
The three typical usages of this option are:
Packit 9c6abc
.br
Packit 9c6abc
.B -duration d
Packit 9c6abc
     set the duration to 'd' for the whole animation.
Packit 9c6abc
.br
Packit 9c6abc
.B -duration d,f
Packit 9c6abc
     set the duration of frame 'f' to 'd'.
Packit 9c6abc
.br
Packit 9c6abc
.B -duration d,start,end
Packit 9c6abc
     set the duration to 'd' for the whole [start,end] interval.
Packit 9c6abc
.TP
Packit 9c6abc
.P
Packit 9c6abc
Note that the frames outside of the [start, end] interval will remain untouched.
Packit 9c6abc
The 'end' value '0' has the special meaning 'last frame of the animation'.
Packit 9c6abc
.TP
Packit 9c6abc
.I Reminder:
Packit 9c6abc
frame indexing starts at '1'.
Packit 9c6abc
.br
Packit 9c6abc
Packit 9c6abc
.SS FRAME_OPTIONS (\-frame)
Packit 9c6abc
Create an animated WebP file from multiple (non\-animated) WebP images.
Packit 9c6abc
.TP
Packit 9c6abc
.I file_i +di[+xi+yi[+mi[bi]]]
Packit 9c6abc
Where: 'file_i' is the i'th frame (WebP format), 'xi','yi' specify the image
Packit 9c6abc
offset for this frame, 'di' is the pause duration before next frame, 'mi' is
Packit 9c6abc
the dispose method for this frame (0 for NONE or 1 for BACKGROUND) and 'bi' is
Packit 9c6abc
the blending method for this frame (+b for BLEND or \-b for NO_BLEND).
Packit 9c6abc
Argument 'bi' can be omitted and will default to +b (BLEND).
Packit 9c6abc
Also, 'mi' can be omitted if 'bi' is omitted and will default to 0 (NONE).
Packit 9c6abc
Finally, if 'mi' and 'bi' are omitted then 'xi' and 'yi' can be omitted and will
Packit 9c6abc
default to +0+0.
Packit 9c6abc
.TP
Packit 9c6abc
.BI \-loop " n
Packit 9c6abc
Loop the frames n number of times. 0 indicates the frames should loop forever.
Packit 9c6abc
Valid range is 0 to 65535 [Default: 0 (infinite)].
Packit 9c6abc
.TP
Packit 9c6abc
.BI \-bgcolor " A,R,G,B
Packit 9c6abc
Background color of the canvas.
Packit 9c6abc
.br
Packit 9c6abc
where: 'A', 'R', 'G' and 'B' are integers in the range 0 to 255 specifying the
Packit 9c6abc
Alpha, Red, Green and Blue component values respectively
Packit 9c6abc
[Default: 255,255,255,255].
Packit 9c6abc
Packit 9c6abc
.SS INPUT
Packit 9c6abc
.TP
Packit 9c6abc
Input file in WebP format.
Packit 9c6abc
Packit 9c6abc
.SS OUTPUT (\-o)
Packit 9c6abc
.TP
Packit 9c6abc
Output file in WebP format.
Packit 9c6abc
Packit 9c6abc
.SS Note:
Packit 9c6abc
.TP
Packit 9c6abc
The nature of EXIF, XMP and ICC data is not checked and is assumed to be valid.
Packit 9c6abc
Packit 9c6abc
.SH BUGS
Packit 9c6abc
Please report all bugs to the issue tracker:
Packit 9c6abc
https://bugs.chromium.org/p/webp
Packit 9c6abc
.br
Packit 9c6abc
Patches welcome! See this page to get started:
Packit 9c6abc
http://www.webmproject.org/code/contribute/submitting\-patches/
Packit 9c6abc
Packit 9c6abc
.SH EXAMPLES
Packit 9c6abc
.P
Packit 9c6abc
Add ICC profile:
Packit 9c6abc
.br
Packit 9c6abc
webpmux \-set icc image_profile.icc in.webp \-o icc_container.webp
Packit 9c6abc
.P
Packit 9c6abc
Extract ICC profile:
Packit 9c6abc
.br
Packit 9c6abc
webpmux \-get icc icc_container.webp \-o image_profile.icc
Packit 9c6abc
.P
Packit 9c6abc
Strip ICC profile:
Packit 9c6abc
.br
Packit 9c6abc
webpmux \-strip icc icc_container.webp \-o without_icc.webp
Packit 9c6abc
.P
Packit 9c6abc
Add XMP metadata:
Packit 9c6abc
.br
Packit 9c6abc
webpmux \-set xmp image_metadata.xmp in.webp \-o xmp_container.webp
Packit 9c6abc
.P
Packit 9c6abc
Extract XMP metadata:
Packit 9c6abc
.br
Packit 9c6abc
webpmux \-get xmp xmp_container.webp \-o image_metadata.xmp
Packit 9c6abc
.P
Packit 9c6abc
Strip XMP metadata:
Packit 9c6abc
.br
Packit 9c6abc
webpmux \-strip xmp xmp_container.webp \-o without_xmp.webp
Packit 9c6abc
.P
Packit 9c6abc
Add EXIF metadata:
Packit 9c6abc
.br
Packit 9c6abc
webpmux \-set exif image_metadata.exif in.webp \-o exif_container.webp
Packit 9c6abc
.P
Packit 9c6abc
Extract EXIF metadata:
Packit 9c6abc
.br
Packit 9c6abc
webpmux \-get exif exif_container.webp \-o image_metadata.exif
Packit 9c6abc
.P
Packit 9c6abc
Strip EXIF metadata:
Packit 9c6abc
.br
Packit 9c6abc
webpmux \-strip exif exif_container.webp \-o without_exif.webp
Packit 9c6abc
.P
Packit 9c6abc
Create an animated WebP file from 3 (non\-animated) WebP images:
Packit 9c6abc
.br
Packit 9c6abc
webpmux \-frame 1.webp +100 \-frame 2.webp +100+50+50
Packit 9c6abc
.br
Packit 9c6abc
.RS 8
Packit 9c6abc
\-frame 3.webp +100+50+50+1+b \-loop 10 \-bgcolor 255,255,255,255
Packit 9c6abc
.br
Packit 9c6abc
\-o anim_container.webp
Packit 9c6abc
.RE
Packit 9c6abc
.P
Packit 9c6abc
Get the 2nd frame from an animated WebP file:
Packit 9c6abc
.br
Packit 9c6abc
webpmux \-get frame 2 anim_container.webp \-o frame_2.webp
Packit 9c6abc
.P
Packit 9c6abc
Using \-get/\-set/\-strip with input file name starting with '\-':
Packit 9c6abc
.br
Packit 9c6abc
webpmux \-set icc image_profile.icc \-o icc_container.webp \-\- \-\-\-in.webp
Packit 9c6abc
.br
Packit 9c6abc
webpmux \-get icc \-o image_profile.icc \-\- \-\-\-icc_container.webp
Packit 9c6abc
.br
Packit 9c6abc
webpmux \-strip icc \-o without_icc.webp \-\- \-\-\-icc_container.webp
Packit 9c6abc
Packit 9c6abc
.SH AUTHORS
Packit 9c6abc
\fBwebpmux\fP is a part of libwebp and was written by the WebP team.
Packit 9c6abc
.br
Packit 9c6abc
The latest source tree is available at
Packit 9c6abc
https://chromium.googlesource.com/webm/libwebp
Packit 9c6abc
.PP
Packit 9c6abc
This manual page was written by Vikas Arora <vikaas.arora@gmail.com>,
Packit 9c6abc
for the Debian project (and may be used by others).
Packit 9c6abc
Packit 9c6abc
.SH SEE ALSO
Packit 9c6abc
.BR cwebp (1),
Packit 9c6abc
.BR dwebp (1),
Packit 9c6abc
.BR gif2webp (1)
Packit 9c6abc
.br
Packit 9c6abc
Please refer to http://developers.google.com/speed/webp/ for additional
Packit 9c6abc
information.