dany/libwebp
1
0
Fork 0
mirror of https://github.com/webmproject/libwebp.git synced 2025-02-13 15:32:53 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

manpages: italicize option parameters

Browse Source 
Change-Id: Id7e4edde2a1c91fe4fbf96ddc280a06132e9986a
This commit is contained in:
James Zern 2013-02-01 20:33:00 -08:00
parent 12d6cecfbd
commit 14c3820038
4 changed files with 41 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
man/cwebp.1
View File

@ -1,5 +1,5 @@
.\" Hey, EMACS: -*- nroff -*- .\" Hey, EMACS: -*- nroff -*-
.TH CWEBP 1 "January 11, 2013" .TH CWEBP 1 "February 01, 2013"
.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
@ -16,7 +16,7 @@ Input format can be either PNG, JPEG, TIFF or raw Y'CbCr samples.
.SH OPTIONS .SH OPTIONS
The basic options are: The basic options are:
.TP .TP
.B \-o string .BI \-o " string
Specify the name of the output WebP file. If omitted, \fBcwebp\fP will Specify the name of the output WebP file. If omitted, \fBcwebp\fP will
perform compression but only report statistics. perform compression but only report statistics.
.TP .TP
@ -29,7 +29,7 @@ A summary of all the possible options.
.B \-version .B \-version
Print the version number (as major.minor.revision) and exit. Print the version number (as major.minor.revision) and exit.
.TP .TP
.B \-q float .BI \-q " float
Specify the compression factor for RGB channels between 0 and 100. The default Specify the compression factor for RGB channels between 0 and 100. The default
is 75. is 75.
.br .br
@ -40,19 +40,19 @@ In case of lossless compression (specified by the \-lossless option), a small
factor enables faster compression speed, but produces a larger file. Maximum factor enables faster compression speed, but produces a larger file. Maximum
compression is achieved by using a value of 100. compression is achieved by using a value of 100.
.TP .TP
.B \-alpha_q int .BI \-alpha_q " int
Specify the compression factor for alpha compression between 0 and 100. Specify the compression factor for alpha compression between 0 and 100.
Lossless compression of alpha is achieved using a value of 100, while the lower Lossless compression of alpha is achieved using a value of 100, while the lower
values result in a lossy compression. The default is 100. values result in a lossy compression. The default is 100.
.TP .TP
.B \-f int .BI \-f " int
Specify the strength of the deblocking filter, between 0 (no filtering) Specify the strength of the deblocking filter, between 0 (no filtering)
and 100 (maximum filtering). A value of 0 will turn off any filtering. and 100 (maximum filtering). A value of 0 will turn off any filtering.
Higher value will increase the strength of the filtering process applied Higher value will increase the strength of the filtering process applied
after decoding the picture. The higher the value the smoother the picture will after decoding the picture. The higher the value the smoother the picture will
appear. Typical values are usually in the range of 20 to 50. appear. Typical values are usually in the range of 20 to 50.
.TP .TP
.B \-preset string .BI \-preset " string
Specify a set of pre-defined parameters to suit a particular type of Specify a set of pre-defined parameters to suit a particular type of
source material. Possible values are: \fBdefault\fP, \fBphoto\fP, source material. Possible values are: \fBdefault\fP, \fBphoto\fP,
\fBpicture\fP, \fBdrawing\fP, \fBicon\fP, \fBtext\fP. Since \fBpicture\fP, \fBdrawing\fP, \fBicon\fP, \fBtext\fP. Since
@ -60,14 +60,14 @@ source material. Possible values are: \fBdefault\fP, \fBphoto\fP,
\fB\-q\fP one), this option should preferably appear first in the \fB\-q\fP one), this option should preferably appear first in the
order of the arguments. order of the arguments.
.TP .TP
.B \-sns int .BI \-sns " int
Specify the amplitude of the spatial noise shaping. Spatial noise shaping Specify the amplitude of the spatial noise shaping. Spatial noise shaping
(or \fBsns\fP for short) refers to a general collection of built-in algorithms (or \fBsns\fP for short) refers to a general collection of built-in algorithms
used to decide which area of the picture should use relatively less bits, used to decide which area of the picture should use relatively less bits,
and where else to better transfer these bits. The possible range goes from and where else to better transfer these bits. The possible range goes from
0 (algorithm is off) to 100 (the maximal effect). The default value is 80. 0 (algorithm is off) to 100 (the maximal effect). The default value is 80.
.TP .TP
.B \-m int .BI \-m " int
Specify the compression method to use. This parameter controls the Specify the compression method to use. This parameter controls the
trade off between encoding speed and the compressed file size and quality. trade off between encoding speed and the compressed file size and quality.
Possible values range from 0 to 6. Default value is 4. Possible values range from 0 to 6. Default value is 4.
@ -83,7 +83,7 @@ the filtering strength to reach a well-balanced quality.
.SH ADDITIONAL OPTIONS .SH ADDITIONAL OPTIONS
More advanced options are: More advanced options are:
.TP .TP
.B \-sharpness int .BI \-sharpness " int
Specify the sharpness of the filtering (if used). Specify the sharpness of the filtering (if used).
Range is 0 (sharpest) to 7 (least sharp). Default is 0. Range is 0 (sharpest) to 7 (least sharp). Default is 0.
.TP .TP
@ -91,11 +91,11 @@ Range is 0 (sharpest) to 7 (least sharp). Default is 0.
Use a stronger filtering than the default one (if filtering is being Use a stronger filtering than the default one (if filtering is being
used thanks to the \fB\-f\fP option). Strong filtering is off by default. used thanks to the \fB\-f\fP option). Strong filtering is off by default.
.TP .TP
.B \-segments int .BI \-segments " int
Change the number of partitions to use during the segmentation of the Change the number of partitions to use during the segmentation of the
sns algorithm. Segments should be in range 1 to 4. Default value is 4. sns algorithm. Segments should be in range 1 to 4. Default value is 4.
.TP .TP
.B \-partition_limit int .BI \-partition_limit " int
Degrade quality by limiting the number of bits used by some macroblocks. Degrade quality by limiting the number of bits used by some macroblocks.
Range is 0 (no degradation, the default) to 100 (full degradation). Range is 0 (no degradation, the default) to 100 (full degradation).
Useful values are usually around 30-70 for moderately large images. Useful values are usually around 30-70 for moderately large images.
@ -114,39 +114,39 @@ If using \fB-partition_limit\fP is not enough to meet the 512k constraint, one
should use less segments in order to save more header bits per macroblock. should use less segments in order to save more header bits per macroblock.
See the \fB-segments\fP option. See the \fB-segments\fP option.
.TP .TP
.B \-size int .BI \-size " int
Specify a target size (in bytes) to try and reach for the compressed output. Specify a target size (in bytes) to try and reach for the compressed output.
Compressor will make several pass of partial encoding in order to get as Compressor will make several pass of partial encoding in order to get as
close as possible to this target. close as possible to this target.
.TP .TP
.B \-psnr float .BI \-psnr " float
Specify a target PSNR (in dB) to try and reach for the compressed output. Specify a target PSNR (in dB) to try and reach for the compressed output.
Compressor will make several pass of partial encoding in order to get as Compressor will make several pass of partial encoding in order to get as
close as possible to this target. close as possible to this target.
.TP .TP
.B \-pass int .BI \-pass " int
Set a maximum number of passes to use during the dichotomy used by Set a maximum number of passes to use during the dichotomy used by
options \fB\-size\fP or \fB\-psnr\fP. Maximum value is 10. options \fB\-size\fP or \fB\-psnr\fP. Maximum value is 10.
.TP .TP
.B \-crop x_position y_position width height .BI \-crop " x_position y_position width height
Crop the source to a rectangle with top-left corner at coordinates Crop the source to a rectangle with top-left corner at coordinates
(\fBx_position\fP, \fBy_position\fP) and size \fBwidth\fP x \fBheight\fP. (\fBx_position\fP, \fBy_position\fP) and size \fBwidth\fP x \fBheight\fP.
This cropping area must be fully contained within the source rectangle. This cropping area must be fully contained within the source rectangle.
.TP .TP
.B \-s width height .BI \-s " width height
Specify that the input file actually consists of raw Y'CbCr samples following Specify that the input file actually consists of raw Y'CbCr samples following
the ITU-R BT.601 recommendation, in 4:2:0 linear format. the ITU-R BT.601 recommendation, in 4:2:0 linear format.
The luma plane has size \fBwidth\fP x \fBheight\fP. The luma plane has size \fBwidth\fP x \fBheight\fP.
.TP .TP
.B \-map int .BI \-map " int
Output additional ASCII-map of encoding information. Possible map values Output additional ASCII-map of encoding information. Possible map values
range from 1 to 6. This is only meant to help debugging. range from 1 to 6. This is only meant to help debugging.
.TP .TP
.B \-pre int .BI \-pre " int
Specify a pre-processing filter. This option is a placeholder Specify a pre-processing filter. This option is a placeholder
and has currently no effect. and has currently no effect.
.TP .TP
.B \-alpha_filter string .BI \-alpha_filter " string
Specify the predictive filtering method for the alpha plane. One of 'none', Specify the predictive filtering method for the alpha plane. One of 'none',
\&'fast' or 'best', in increasing complexity and slowness order. Default is \&'fast' or 'best', in increasing complexity and slowness order. Default is
\&'fast'. Internally, alpha filtering is performed using four possible \&'fast'. Internally, alpha filtering is performed using four possible
@ -154,7 +154,7 @@ predictions (none, horizontal, vertical, gradient). The 'best' mode will try
each mode in turn and pick the one which gives the smaller size. The 'fast' each mode in turn and pick the one which gives the smaller size. The 'fast'
mode will just try to form an a-priori guess without testing all modes. mode will just try to form an a-priori guess without testing all modes.
.TP .TP
.B \-alpha_method int .BI \-alpha_method " int
Specify the algorithm used for alpha compression: 0 or 1. Algorithm 0 denotes Specify the algorithm used for alpha compression: 0 or 1. Algorithm 0 denotes
no compression, 1 uses WebP lossless format for compression. The default is 1. no compression, 1 uses WebP lossless format for compression. The default is 1.
.TP .TP
@ -168,11 +168,11 @@ Using this option will discard the alpha channel.
.B \-lossless .B \-lossless
Encode the image without any loss. Encode the image without any loss.
.TP .TP
.B \-hint string .BI \-hint " string
Specify the hint about input image type. Possible values are: Specify the hint about input image type. Possible values are:
\fBphoto\fP, \fBpicture\fP or \fBgraph\fP. \fBphoto\fP, \fBpicture\fP or \fBgraph\fP.
.TP .TP
.B \-metadata string .BI \-metadata " string
A comma separated list of metadata to copy from the input to the output if A comma separated list of metadata to copy from the input to the output if
present. present.
Valid values: \fBall\fP, \fBnone\fP, \fBexif\fP, \fBiccp\fP, \fBxmp\fP. Valid values: \fBall\fP, \fBnone\fP, \fBexif\fP, \fBiccp\fP, \fBxmp\fP.

8
man/dwebp.1
View File

@ -1,5 +1,5 @@
.\" Hey, EMACS: -*- nroff -*- .\" Hey, EMACS: -*- nroff -*-
.TH DWEBP 1 "January 28, 2013" .TH DWEBP 1 "February 01, 2013"
.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
@ -21,7 +21,7 @@ Print usage summary.
.B \-version .B \-version
Print the version number (as major.minor.revision) and exit. Print the version number (as major.minor.revision) and exit.
.TP .TP
.B \-o string .BI \-o " string
Specify the name of the output file (as PNG format by default). Specify the name of the output file (as PNG format by default).
.TP .TP
.B \-pam .B \-pam
@ -53,7 +53,7 @@ but will make the decoding faster.
.B \-mt .B \-mt
Use multi-threading for decoding, if possible. Use multi-threading for decoding, if possible.
.TP .TP
.B \-crop x_position y_position width height .BI \-crop " x_position y_position width height
Crop the decoded picture to a rectangle with top-left corner at coordinates Crop the decoded picture to a rectangle with top-left corner at coordinates
(\fBx_position\fP, \fBy_position\fP) and size \fBwidth\fP x \fBheight\fP. (\fBx_position\fP, \fBy_position\fP) and size \fBwidth\fP x \fBheight\fP.
This cropping area must be fully contained within the source rectangle. This cropping area must be fully contained within the source rectangle.
@ -61,7 +61,7 @@ The top-left corner will be snapped to even coordinates if needed.
This option is meant to reduce the memory needed for cropping large images. This option is meant to reduce the memory needed for cropping large images.
Note: the cropping is applied \fIbefore\fP any scaling. Note: the cropping is applied \fIbefore\fP any scaling.
.TP .TP
.B \-scale width height .BI \-scale " width height
Rescale the decoded picture to dimension \fBwidth\fP x \fBheight\fP. This Rescale the decoded picture to dimension \fBwidth\fP x \fBheight\fP. This
option is mostly intended to reducing the memory needed to decode large images, option is mostly intended to reducing the memory needed to decode large images,
when only a small version is needed (thumbnail, preview, etc.). Note: scaling when only a small version is needed (thumbnail, preview, etc.). Note: scaling

10
man/gif2webp.1
View File

@ -1,5 +1,5 @@
.\" Hey, EMACS: -*- nroff -*- .\" Hey, EMACS: -*- nroff -*-
.TH GIF2WEBP 1 "November 15, 2012" .TH GIF2WEBP 1 "February 01, 2013"
.SH NAME .SH NAME
gif2webp \- Convert a GIF image to WebP gif2webp \- Convert a GIF image to WebP
.SH SYNOPSIS .SH SYNOPSIS
@ -15,7 +15,7 @@ command.
.SH OPTIONS .SH OPTIONS
The basic options are: The basic options are:
.TP .TP
.B \-o string .BI \-o " string
Specify the name of the output WebP file. If omitted, \fBgif2webp\fP will Specify the name of the output WebP file. If omitted, \fBgif2webp\fP will
perform conversion but only report statistics. perform conversion but only report statistics.
.TP .TP
@ -28,7 +28,7 @@ Print the version number (as major.minor.revision) and exit.
.B \-lossy .B \-lossy
Encode the image using lossy compression. Encode the image using lossy compression.
.TP .TP
.B \-q float .BI \-q " float
Specify the compression factor for RGB channels between 0 and 100. The default Specify the compression factor for RGB channels between 0 and 100. The default
is 75. is 75.
.br .br
@ -40,7 +40,7 @@ In case of lossy compression (specified by the \-lossy option), a small factor
produces a smaller file with lower quality. Best quality is achieved by using a produces a smaller file with lower quality. Best quality is achieved by using a
value of 100. value of 100.
.TP .TP
.B \-m int .BI \-m " int
Specify the compression method to use. This parameter controls the Specify the compression method to use. This parameter controls the
trade off between encoding speed and the compressed file size and quality. trade off between encoding speed and the compressed file size and quality.
Possible values range from 0 to 6. Default value is 4. Possible values range from 0 to 6. Default value is 4.
@ -49,7 +49,7 @@ additional encoding possibilities and decide on the quality gain.
Lower value can result is faster processing time at the expense of Lower value can result is faster processing time at the expense of
larger file size and lower compression quality. larger file size and lower compression quality.
.TP .TP
.B \-f int .BI \-f " int
For lossy encoding only (specified by the \-lossy option). Specify the strength For lossy encoding only (specified by the \-lossy option). Specify the strength
of the deblocking filter, between 0 (no filtering) and 100 (maximum filtering). of the deblocking filter, between 0 (no filtering) and 100 (maximum filtering).
A value of 0 will turn off any filtering. Higher value will increase the A value of 0 will turn off any filtering. Higher value will increase the

20
man/webpmux.1
View File

@ -1,5 +1,5 @@
.\" Hey, EMACS: -*- nroff -*- .\" Hey, EMACS: -*- nroff -*-
.TH WEBPMUX 1 "October 23, 2012" .TH WEBPMUX 1 "February 01, 2013"
.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
@ -62,25 +62,25 @@ Get EXIF metadata.
.B xmp .B xmp
Get XMP metadata. Get XMP metadata.
.TP .TP
.B frgm n .BI frgm " n
Get nth fragment. Get nth fragment.
.TP .TP
.B frame n .BI frame " n
Get nth frame. Get nth frame.
.SS SET_OPTIONS (\-set) .SS SET_OPTIONS (\-set)
.TP .TP
.B icc file.icc .BI icc " file.icc
Set ICC profile. Set ICC profile.
.P .P
Where: 'file.icc' contains the ICC profile to be set. Where: 'file.icc' contains the ICC profile to be set.
.TP .TP
.B exif file.exif .BI exif " file.exif
Set EXIF metadata. Set EXIF metadata.
.P .P
Where: 'file.exif' contains the EXIF metadata to be set. Where: 'file.exif' contains the EXIF metadata to be set.
.TP .TP
.B xmp file.xmp .BI xmp " file.xmp
Set XMP metadata. Set XMP metadata.
.P .P
Where: 'file.xmp' contains the XMP metadata to be set. Where: 'file.xmp' contains the XMP metadata to be set.
@ -98,13 +98,13 @@ Strip XMP metadata.
.SS FRAGMENT_OPTIONS (\-frgm) .SS FRAGMENT_OPTIONS (\-frgm)
.TP .TP
.B file_i +xi+yi .I file_i +xi+yi
Where: 'file_i' is the i'th fragment (WebP format) and 'xi','yi' specify the Where: 'file_i' is the i'th fragment (WebP format) and 'xi','yi' specify the
image offset for this fragment. image offset for this fragment.
.SS FRAME_OPTIONS (\-frame) .SS FRAME_OPTIONS (\-frame)
.TP .TP
.B file_i +di[+xi+yi[+mi]] .I file_i +di[+xi+yi[+mi]]
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 and 'mi' is offset for this frame, 'di' is the pause duration before next frame and 'mi' is
the dispose method for this frame (0 for NONE or 1 for BACKGROUND). the dispose method for this frame (0 for NONE or 1 for BACKGROUND).
@ -112,11 +112,11 @@ the dispose method for this frame (0 for NONE or 1 for BACKGROUND).
Additionally, if 'mi' is ommitted then'xi' and 'yi' can be omitted and will Additionally, if 'mi' is ommitted then'xi' and 'yi' can be omitted and will
default to +0+0. default to +0+0.
.TP .TP
.B \-loop n .BI \-loop " n
Loop the frames n number of times. 0 indicates the frames should loop forever. Loop the frames n number of times. 0 indicates the frames should loop forever.
Valid range is 0 to 65535 [Default: 0 (infinite)]. Valid range is 0 to 65535 [Default: 0 (infinite)].
.TP .TP
.B \-bgcolor A,R,G,B .BI \-bgcolor " A,R,G,B
Background color of the canvas. Background color of the canvas.
.br .br
where: 'A', 'R', 'G' and 'B' are integers in the range 0 to 255 specifying the where: 'A', 'R', 'G' and 'B' are integers in the range 0 to 255 specifying the