webpmux man page: Clarify some title, descriptions and examples

Based on the feedback here:
https://groups.google.com/a/webmproject.org/d/msg/webp-discuss/qY6rWJLqRTY/pF8oSj8DOGYJ

(cherry picked from commit 30f3b75b33)

Change-Id: I9119ea8e211ffb269026010e3c590385bc6a9f17
This commit is contained in:
Urvang Joshi 2014-08-29 13:13:49 -07:00 committed by James Zern
parent 23d4fb3362
commit 4c82ff76c1

View File

@ -1,7 +1,8 @@
.\" Hey, EMACS: -*- nroff -*- .\" Hey, EMACS: -*- nroff -*-
.TH WEBPMUX 1 "December 17, 2013" .TH WEBPMUX 1 "August 28, 2014"
.SH NAME .SH NAME
webpmux \- command line tool to create WebP Mux/container file. webpmux \- create animated WebP files from non\-animated WebP images, extract
frames from animated WebP images, and manage XMP/EXIF metadata and ICC profile.
.SH SYNOPSIS .SH SYNOPSIS
.B webpmux \-get .B webpmux \-get
.I GET_OPTIONS .I GET_OPTIONS
@ -45,8 +46,8 @@ This manual page documents the
.B webpmux .B webpmux
command. command.
.PP .PP
\fBwebpmux\fP can be used to create a WebP container file \fBwebpmux\fP can be used to create/extract from animated WebP files, as well as
and extract/strip relevant data from the container file. to add/extract/strip XMP/EXIF metadata and ICC profile.
.SH OPTIONS .SH OPTIONS
.SS GET_OPTIONS (\-get): .SS GET_OPTIONS (\-get):
.TP .TP
@ -60,7 +61,7 @@ Get EXIF metadata.
Get XMP metadata. Get XMP metadata.
.TP .TP
.BI frame " n .BI frame " n
Get nth frame. Get nth frame from an animated image. (n = 0 has a special meaning: last frame).
.SS SET_OPTIONS (\-set) .SS SET_OPTIONS (\-set)
.TP .TP
@ -91,12 +92,13 @@ Strip EXIF metadata.
Strip XMP metadata. Strip XMP metadata.
.SS FRAME_OPTIONS (\-frame) .SS FRAME_OPTIONS (\-frame)
Create an animated WebP file from multiple (non\-animated) WebP images.
.TP .TP
.I file_i +di[+xi+yi[+mi[bi]]] .I file_i +di[+xi+yi[+mi[bi]]]
Where: 'file_i' is the i'th frame (WebP format), 'xi','yi' specify the image Where: 'file_i' is the i'th frame (WebP format), 'xi','yi' specify the image
offset for this frame, 'di' is the pause duration before next frame, 'mi' is offset for this frame, 'di' is the pause duration before next frame, 'mi' is
the dispose method for this frame (0 for NONE or 1 for BACKGROUND) and 'bi' is the dispose method for this frame (0 for NONE or 1 for BACKGROUND) and 'bi' is
the blending method for this frame (+b for BLEND or -b for NO_BLEND). the blending method for this frame (+b for BLEND or \-b for NO_BLEND).
Argument 'bi' can be omitted and will default to +b (BLEND). Argument 'bi' can be omitted and will default to +b (BLEND).
Also, 'mi' can be omitted if 'bi' is omitted and will default to 0 (NONE). Also, 'mi' can be omitted if 'bi' is omitted and will default to 0 (NONE).
Finally, if 'mi' and 'bi' are omitted then 'xi' and 'yi' can be omitted and will Finally, if 'mi' and 'bi' are omitted then 'xi' and 'yi' can be omitted and will
@ -130,37 +132,61 @@ Please report all bugs to our issue tracker:
http://code.google.com/p/webp/issues http://code.google.com/p/webp/issues
.br .br
Patches welcome! See this page to get started: Patches welcome! See this page to get started:
http://www.webmproject.org/code/contribute/submitting-patches/ http://www.webmproject.org/code/contribute/submitting\-patches/
.SH EXAMPLES .SH EXAMPLES
.P
Add ICC profile:
.br
webpmux \-set icc image_profile.icc in.webp \-o icc_container.webp webpmux \-set icc image_profile.icc in.webp \-o icc_container.webp
.P
Extract ICC profile:
.br .br
webpmux \-get icc icc_container.webp \-o image_profile.icc webpmux \-get icc icc_container.webp \-o image_profile.icc
.P
Strip ICC profile:
.br .br
webpmux \-strip icc icc_container.webp \-o without_icc.webp webpmux \-strip icc icc_container.webp \-o without_icc.webp
.P
Add XMP metadata:
.br .br
webpmux \-set xmp image_metadata.xmp in.webp \-o xmp_container.webp webpmux \-set xmp image_metadata.xmp in.webp \-o xmp_container.webp
.P
Extract XMP metadata:
.br .br
webpmux \-get xmp xmp_container.webp \-o image_metadata.xmp webpmux \-get xmp xmp_container.webp \-o image_metadata.xmp
.P
Strip XMP metadata:
.br .br
webpmux \-strip xmp xmp_container.webp \-o without_xmp.webp webpmux \-strip xmp xmp_container.webp \-o without_xmp.webp
.P
Add EXIF metadata:
.br .br
webpmux \-set exif image_metadata.exif in.webp \-o exif_container.webp webpmux \-set exif image_metadata.exif in.webp \-o exif_container.webp
.P
Extract EXIF metadata:
.br .br
webpmux \-get exif exif_container.webp \-o image_metadata.exif webpmux \-get exif exif_container.webp \-o image_metadata.exif
.P
Strip EXIF metadata:
.br .br
webpmux \-strip exif exif_container.webp \-o without_exif.webp webpmux \-strip exif exif_container.webp \-o without_exif.webp
.P
Create an animated WebP file from 3 (non\-animated) WebP images:
.br .br
webpmux \-frame anim_1.webp +100 \-frame anim_2.webp +100+50+50 webpmux \-frame 1.webp +100 \-frame 2.webp +100+50+50
.br .br
.RS 8 .RS 8
\-frame anim_2.webp +100+50+50+1+b \-loop 10 \-bgcolor 255,255,255,255 \-frame 3.webp +100+50+50+1+b \-loop 10 \-bgcolor 255,255,255,255
.br .br
.RS 8
\-o anim_container.webp \-o anim_container.webp
.RE .RE
.P
Get the 2nd frame from an animated WebP file:
.br .br
webpmux \-get frame 2 anim_container.webp \-o frame_2.webp webpmux \-get frame 2 anim_container.webp \-o frame_2.webp
.P
Using \-get/\-set/\-strip with input file name starting with '\-':
.br .br
webpmux \-set icc image_profile.icc \-o icc_container.webp \-\- \-\-\-in.webp webpmux \-set icc image_profile.icc \-o icc_container.webp \-\- \-\-\-in.webp
.br .br