manpages: minor formatting updates

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

View File

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

View File

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

View File

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