src/SDL2/external/libwebp-0.3.0/man/webpmux.1

   1 .\"                                      Hey, EMACS: -*- nroff -*-
   2 .TH WEBPMUX 1 "March 16, 2013"
   3 .SH NAME
   4 webpmux \- command line tool to create WebP Mux/container file.
   5 .SH SYNOPSIS
   6 .B webpmux \-get
   7 .I GET_OPTIONS
   8 .I INPUT
   9 .B \-o
  10 .I OUTPUT
  11 .br
  12 .B webpmux \-set
  13 .I SET_OPTIONS
  14 .I INPUT
  15 .B \-o
  16 .I OUTPUT
  17 .br
  18 .B webpmux \-strip
  19 .I STRIP_OPTIONS
  20 .I INPUT
  21 .B \-o
  22 .I OUTPUT
  23 .br
  24 .B webpmux \-frame
  25 .I FRAME_OPTIONS
  26 .B [ \-frame ... ] [ \-loop
  27 .I LOOP_COUNT
  28 .B ]
  29 .br
  30 .RS 8
  31 .B [ \-bgcolor
  32 .I BACKGROUND_COLOR
  33 .B ] \-o
  34 .I OUTPUT
  35 .RE
  36 .br
  37 .B webpmux \-info
  38 .I INPUT
  39 .br
  40 .B webpmux [\-h|\-help]
  41 .br
  42 .B webpmux \-version
  43 .SH DESCRIPTION
  44 This manual page documents the
  45 .B webpmux
  46 command.
  47 .PP
  48 \fBwebpmux\fP can be used to create a WebP container file
  49 and extract/strip relevant data from the container file.
  50 .SH OPTIONS
  51 .SS GET_OPTIONS (\-get):
  52 .TP
  53 .B icc
  54 Get ICC profile.
  55 .TP
  56 .B exif
  57 Get EXIF metadata.
  58 .TP
  59 .B xmp
  60 Get XMP metadata.
  61 .TP
  62 .BI frame " n
  63 Get nth frame.
  64
  65 .SS SET_OPTIONS (\-set)
  66 .TP
  67 .BI icc " file.icc
  68 Set ICC profile.
  69 .P
  70 Where: 'file.icc' contains the ICC profile to be set.
  71 .TP
  72 .BI exif " file.exif
  73 Set EXIF metadata.
  74 .P
  75 Where: 'file.exif' contains the EXIF metadata to be set.
  76 .TP
  77 .BI xmp " file.xmp
  78 Set XMP metadata.
  79 .P
  80 Where: 'file.xmp' contains the XMP metadata to be set.
  81
  82 .SS STRIP_OPTIONS (\-strip)
  83 .TP
  84 .B icc
  85 Strip ICC profile.
  86 .TP
  87 .B exif
  88 Strip EXIF metadata.
  89 .TP
  90 .B xmp
  91 Strip XMP metadata.
  92
  93 .SS FRAME_OPTIONS (\-frame)
  94 .TP
  95 .I file_i +di[+xi+yi[+mi]]
  96 Where: 'file_i' is the i'th frame (WebP format), 'xi','yi' specify the image
  97 offset for this frame, 'di' is the pause duration before next frame and 'mi' is
  98 the dispose method for this frame (0 for NONE or 1 for BACKGROUND).
  99 'mi' can be omitted and will default to 0 (NONE).
 100 Additionally, if 'mi' is ommitted then'xi' and 'yi' can be omitted and will
 101 default to +0+0.
 102 .TP
 103 .BI \-loop " n
 104 Loop the frames n number of times. 0 indicates the frames should loop forever.
 105 Valid range is 0 to 65535 [Default: 0 (infinite)].
 106 .TP
 107 .BI \-bgcolor " A,R,G,B
 108 Background color of the canvas.
 109 .br
 110 where: 'A', 'R', 'G' and 'B' are integers in the range 0 to 255 specifying the
 111 Alpha, Red, Green and Blue component values respectively
 112 [Default: 255,255,255,255].
 113
 114 .SS INPUT
 115 .TP
 116 Input file in WebP format.
 117
 118 .SS OUTPUT (\-o)
 119 .TP
 120 Output file in WebP format.
 121
 122 .SS Note:
 123 .TP
 124 The nature of EXIF, XMP and ICC data is not checked and is assumed to be valid.
 125
 126 .SH BUGS
 127 Please report all bugs to our issue tracker:
 128 http://code.google.com/p/webp/issues
 129 .br
 130 Patches welcome! See this page to get started:
 131 http://www.webmproject.org/code/contribute/submitting-patches/
 132
 133 .SH EXAMPLES
 134 webpmux \-set icc image_profile.icc in.webp \-o icc_container.webp
 135 .br
 136 webpmux \-get icc icc_container.webp \-o image_profile.icc
 137 .br
 138 webpmux \-strip icc icc_container.webp \-o without_icc.webp
 139 .br
 140 webpmux \-set xmp image_metadata.xmp in.webp \-o xmp_container.webp
 141 .br
 142 webpmux \-get xmp xmp_container.webp \-o image_metadata.xmp
 143 .br
 144 webpmux \-strip xmp xmp_container.webp \-o without_xmp.webp
 145 .br
 146 webpmux \-set exif image_metadata.exif in.webp \-o exif_container.webp
 147 .br
 148 webpmux \-get exif exif_container.webp \-o image_metadata.exif
 149 .br
 150 webpmux \-strip exif exif_container.webp \-o without_exif.webp
 151 .br
 152 webpmux \-frame anim_1.webp +100 \-frame anim_2.webp +100+50+50 \-loop 10
 153 .br
 154 .RS 8
 155 \-bgcolor 255,255,255,255 \-o anim_container.webp
 156 .RE
 157 .br
 158 webpmux \-get frame 2 anim_container.webp \-o frame_2.webp
 159
 160 .SH AUTHORS
 161 \fBwebpmux\fP is written by the WebP team.
 162 .br
 163 The latest source tree is available at http://www.webmproject.org/code
 164 .PP
 165 This manual page was written by Vikas Arora <vikaas.arora@gmail.com>,
 166 for the Debian project (and may be used by others).
 167
 168 .SH SEE ALSO
 169 .BR dwebp (1),
 170 .BR cwebp (1),
 171 .BR gif2webp (1).
 172 .br
 173 Please refer to http://developers.google.com/speed/webp/ for additional
 174 information.