dany/libwebp
1
0
Fork 0
mirror of https://github.com/webmproject/libwebp.git synced 2024-11-19 20:08:28 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

manpages: minor formatting updates

Browse Source 
escape '-'s
use consistent section names
webpmux.1:
 document -loop
 create subsections for each OPTION group

Change-Id: If41dc24d80e4a662024e82697d8d2cc4e194a35d
This commit is contained in:
James Zern 2011-11-03 16:10:27 -07:00
parent abd030b573
commit 1daf39bbbc
3 changed files with 45 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
man/cwebp.1
View File

@ -1,10 +1,10 @@
.\" Hey, EMACS: -*- nroff -*-
.TH CWEBP 1 "September 19, 2011"
.TH CWEBP 1 "November 3, 2011"
.SH NAME
cwebp \- compress an image file to a WebP file
.SH SYNOPSIS
.B cwebp
.RI [ options ] " input_file -o output_file.webp
.RI [ options ] " input_file \-o output_file.webp
.br
.SH DESCRIPTION
This manual page documents the
@ -149,18 +149,17 @@ Do not print anything.
.B \-short
Only print brief information (output file size and PSNR) for testing purpose.
.SH Examples:
cwebp -q 70 picture.png -o picture.webp
.SH EXAMPLES
cwebp \-q 70 picture.png \-o picture.webp
.br
cwebp -sns 70 -f 50 -strong -af -size 60000 picture.png -o picture.webp
cwebp \-sns 70 \-f 50 \-strong \-af \-size 60000 picture.png \-o picture.webp
.SH
.SH SEE ALSO
.BR dwebp (1).
.br
Please refer to http://code.google.com/speed/webp/ for additional
information.
.SH AUTHOR
.SH AUTHORS
\fBcwebp\fP was written by the WebP team.
.br
The latest source tree is available at http://www.webmproject.org/code

11
man/dwebp.1
View File

@ -1,5 +1,5 @@
.\" Hey, EMACS: -*- nroff -*-
.TH DWEBP 1 "September 19, 2011"
.TH DWEBP 1 "November 3, 2011"
.SH NAME
dwebp \- decompress a WebP file to an image file
.SH SYNOPSIS
@ -64,18 +64,17 @@ Print extra information (decoding time in particular).
.B \-noasm
Disable all assembly optimizations.
.SH Examples:
dwebp picture.webp -o output.png
.SH EXAMPLES
dwebp picture.webp \-o output.png
.br
dwebp picture.webp -ppm -o output.ppm
dwebp picture.webp \-ppm \-o output.ppm
.SH
.SH SEE ALSO
.BR cwebp (1).
.br
Please refer to http://code.google.com/speed/webp/ for additional
information.
.SH AUTHOR
.SH AUTHORS
\fBdwebp\fP was written by the WebP team.
.br
The latest source tree is available at http://www.webmproject.org/code

74
man/webpmux.1
View File

@ -1,53 +1,51 @@
.\" Hey, EMACS: -*- nroff -*-
.TH WEBPMUX 1 "September 30, 2011"
.TH WEBPMUX 1 "November 3, 2011"
.SH NAME
webpmux \- command line tool to create WebP Mux/container file.
.SH SYNOPSIS
.B webpmux -get
.B webpmux \-get
.I GET_OPTIONS
.I INPUT
.B -o
.B \-o
.I OUTPUT
.br
.B webpmux -set
.B webpmux \-set
.I SET_OPTIONS
.I INPUT
.B -o
.B \-o
.I OUTPUT
.br
.B webpmux -strip
.B webpmux \-strip
.I STRIP_OPTIONS
.I INPUT
.B -o
.B \-o
.I OUTPUT
.br
.B webpmux [-tile
.B webpmux [ \-tile
.I TILE_OPTIONS
.B ]... -o
.B ]... \-o
.I OUTPUT
.br
.B webpmux [-frame
.B webpmux [ \-frame
.I FRAME_OPTIONS
.B ]... -loop
.B ]... \-loop
.I LOOP_COUNT
.B -o
.B \-o
.I OUTPUT
.br
.B webpmux -info
.B webpmux \-info
.I INPUT
.br
.B webpmux -help
.B webpmux \-help
.SH DESCRIPTION
This manual page documents the
.B webpmux
command.
.PP
\fBwebpmux\fP command line tool can be used to create a WebP container file
\fBwebpmux\fP can be used to create a WebP container file
and extract/strip relevant data from the container file.
.SH OPTIONS
The basic options are:
.TP
.SH GET_OPTIONS:
.SS GET_OPTIONS (\-get):
.TP
.B icc
Get ICC Color profile.
@ -60,68 +58,64 @@ Get nth tile.
.TP
.B frame n
Get nth frame.
.TP
.SH SET_OPTIONS:
.SS SET_OPTIONS (\-set)
.TP
.B icc
Set ICC Color profile.
.TP
.B xmp
Set XMP metadata.
.TP
.SH STRIP_OPTIONS:
.SS STRIP_OPTIONS (\-strip)
.TP
.B icc
Strip ICC Color profile.
.TP
.B xmp
Strip XMP metadata.
.TP
.SH TILE_OPTIONS:
.SS TILE_OPTIONS (\-tile)
.TP
.B file_i +xi+yi
Where: 'file_i' is the i'th tile (webp format) and 'xi','yi' specify the image offset for this tile.
.TP
.SH FRAME_OPTIONS:
.SS FRAME_OPTIONS (\-frame)
.TP
.B file_i +xi+yi+di
Where: 'file_i' is the i'th frame (webp format), 'xi','yi' specify the image offset for this frame and 'di' is the pause duration before next frame.
.TP
.B \-loop n
Loop the frames n number of times. 0 indicates the frames should loop forever.
.SH INPUT
.SS INPUT
.TP
Input file in WebP format.
.TP
.SH OUTPUT
.SS OUTPUT (\-o)
.TP
Output file in WebP format.
.TP
.SH Examples:
webpmux -set icc image_profile.icc in.webp -o icc_container.webp
.SH EXAMPLES
webpmux \-set icc image_profile.icc in.webp \-o icc_container.webp
.br
webpmux -get icc icc_container.webp -o image_profile.icc
webpmux \-get icc icc_container.webp \-o image_profile.icc
.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
.br
webpmux -get xmp xmp_container.webp -o image_metadata.xmp
webpmux \-get xmp xmp_container.webp \-o image_metadata.xmp
.br
webpmux -frame anim_1.webp +0+0+0 -frame anim_2.webp +50+50+0 -loop 10 -o anim_container.webp
webpmux \-frame anim_1.webp +0+0+0 \-frame anim_2.webp +50+50+0 \-loop 10 \-o anim_container.webp
.br
webpmux -get frame 2 anim_container.webp -o frame_2.webp
webpmux \-get frame 2 anim_container.webp \-o frame_2.webp
.SH
.SH SEE ALSO
.BR dwebp (1), cwebp (1).
.BR dwebp (1),
.BR cwebp (1).
.br
Please refer to http://code.google.com/speed/webp/ for additional
information.
.SH AUTHOR
.SH AUTHORS
\fBwebpmux\fP is written by the WebP team.
.br
The latest source tree is available at http://www.webmproject.org/code