d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Minor cleanup for mkuzip(8) man page.

Browse Source 
List all single-letter options in summary.
Order options alphabetically.

Sponsored by:	Mellanox Technologies
MFC after:	3 days
This commit is contained in:
Konstantin Belousov 2019-02-19 20:26:03 +00:00
parent 7bcd1fab5a
commit 90ce241081
1 changed files with 33 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
usr.bin/mkuzip/mkuzip.8
View File

@ -25,7 +25,7 @@
.\" .\"
.\" $FreeBSD$ .\" $FreeBSD$
.\" .\"
.Dd March 17, 2006 .Dd February 19, 2019
.Dt MKUZIP 8 .Dt MKUZIP 8
.Os .Os
.Sh NAME .Sh NAME
@ -35,10 +35,10 @@
class class
.Sh SYNOPSIS .Sh SYNOPSIS
.Nm .Nm
.Op Fl v .Op Fl dLSsvZ
.Op Fl j Ar compression_jobs
.Op Fl o Ar outfile .Op Fl o Ar outfile
.Op Fl s Ar cluster_size .Op Fl s Ar cluster_size
.Op Fl j Ar compression_jobs
.Ar infile .Ar infile
.Sh DESCRIPTION .Sh DESCRIPTION
The The
@ -68,6 +68,33 @@ locating each individual cluster is written to the output file.
.Pp .Pp
The options are: The options are:
.Bl -tag -width indent .Bl -tag -width indent
.It Fl j Ar compression_jobs
Specify the number of compression jobs that
.Nm
runs in parallel to speed up compression.
When option is not specified the number of jobs set to be equal
to the value of
.Va hw.ncpu
.Xr sysctl 8
variable.
.It Fl d
Enable de-duplication.
When the option is enabled the
.Nm
detects identical blocks in the input and replaces each subsequent occurence
of such block with pointer to the very first one in the output.
Setting this option results is moderate decrease of compressed image size,
typically around 3-5% of a final size of the compressed image.
.It Fl L
Use
.Xr lzma 3
compression algorithm instead of the default
.Xr zlib 3 .
The
.Xr lzma 3
provides noticeable better compression levels on the same data set
at the expense of much slower compression speed (10-20x) and somewhat slower
decompression (2-3x).
.It Fl o Ar outfile .It Fl o Ar outfile
Name of the output file Name of the output file
.Ar outfile . .Ar outfile .
@ -79,16 +106,9 @@ compression or
.Pa .ulzma .Pa .ulzma
for the for the
.Xr lzma 3 . .Xr lzma 3 .
.It Fl L .It Fl S
Use Print summary about the compression ratio as well as output
.Xr lzma 3 file size after file has been processed.
compression algorithm instead of the default
.Xr zlib 3 .
The
.Xr lzma 3
provides noticeable better compression levels on the same data set
at the expense of much slower compression speed (10-20x) and somewhat slower
decompression (2-3x).
.It Fl s Ar cluster_size .It Fl s Ar cluster_size
Split the image into clusters of Split the image into clusters of
.Ar cluster_size .Ar cluster_size
@ -111,26 +131,6 @@ Setting
.Fl Z .Fl Z
results is slight increase of compressed image size, typically less than 0.1% results is slight increase of compressed image size, typically less than 0.1%
of a final size of the compressed image. of a final size of the compressed image.
.It Fl d
Enable de-duplication.
When the option is enabled the
.Nm
detects identical blocks in the input and replaces each subsequent occurence
of such block with pointer to the very first one in the output.
Setting this option results is moderate decrease of compressed image size,
typically around 3-5% of a final size of the compressed image.
.It Fl S
Print summary about the compression ratio as well as output
file size after file has been processed.
.It Fl j Ar compression_jobs
Specify the number of compression jobs that
.Nm
runs in parallel to speed up compression.
When option is not specified the number of jobs set to be equal
to the value of
.Va hw.ncpu
.Xr sysctl 8
variable.
.El .El
.Sh NOTES .Sh NOTES
The compression ratio largely depends on the cluster size used. The compression ratio largely depends on the cluster size used.