[src/trunk]: src/external/zlib/pigz/dist Convert to mdoc. Sort options.

[wiz <wiz%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/c598b1601dd5
branches:  trunk
changeset: 755768:c598b1601dd5
user:      wiz <wiz%NetBSD.org@localhost>
date:      Sat Jun 19 14:45:39 2010 +0000

description:
Convert to mdoc. Sort options.

diffstat:

 external/zlib/pigz/dist/pigz.1 |  257 ++++++++++++++++++----------------------
 1 files changed, 115 insertions(+), 142 deletions(-)

diffs (truncated from 306 to 300 lines):

diff -r 42b813322e08 -r c598b1601dd5 external/zlib/pigz/dist/pigz.1
--- a/external/zlib/pigz/dist/pigz.1    Sat Jun 19 13:44:11 2010 +0000
+++ b/external/zlib/pigz/dist/pigz.1    Sat Jun 19 14:45:39 2010 +0000
@@ -1,187 +1,160 @@
-.TH PIGZ 1 local
-.SH NAME
-pigz, unpigz \- compress or expand files
-.SH SYNOPSIS
-.ll +8
-.B pigz
-.RB [ " \-cdfhikKlLnNqrRtTz0..9 " ]
-[
-.B -b
-.I blocksize
-]
-[
-.B -p
-.I threads
-]
-[
-.B -S
-.I suffix
-]
-[
-.I "name \&..."
-]
-.ll -8
-.br
-.B unpigz
-.RB [ " \-cfhikKlLnNqrRtTz " ]
-[
-.B -b
-.I blocksize
-]
-[
-.B -p
-.I threads
-]
-[
-.B -S
-.I suffix
-]
-[
-.I "name \&..."
-]
-.SH DESCRIPTION
-.I Pigz
+.Dd June 19, 2010
+.Dt PIGZ 1
+.Os
+.Sh NAME
+.Nm pigz ,
+.Nm unpigz
+.Nd compress or expand files
+.Sh SYNOPSIS
+.Nm
+.Op Fl 0..9cdfhiKkLlNnqRrTtz
+.Op Fl b Ar blocksize
+.Op Fl p Ar threads
+.Op Fl S Ar suffix
+.Op Ar
+.Nm unpigz
+.Op Fl cfhiKkLlNnqRrTtz
+.Op Fl b Ar blocksize
+.Op Fl p Ar threads
+.Op Fl S Ar suffix
+.Op Ar
+.Sh DESCRIPTION
+.Nm
 compresses using threads to make use of multiple processors and cores.
 The input is broken up into 128 KB chunks with each compressed in parallel.
 The individual check value for each chunk is also calculated in parallel.
 The compressed data is written in order to the output, and a combined check
 value is calculated from the individual check values.
-.PP
+.Pp
 The compressed data format generated is in the gzip, zlib, or single-entry
 zip format using the deflate compression method.  The compression produces
 partial raw deflate streams which are concatenated by a single write thread
 and wrapped with the appropriate header and trailer, where the trailer
 contains the combined check value.
-.PP
+.Pp
 Each partial raw deflate stream is terminated by an empty stored block
-(using the Z_SYNC_FLUSH option of zlib), in order to end that partial bit
-stream at a byte boundary.  That allows the partial streams to be
-concatenated simply as sequences of bytes.  This adds a very small four to
-five byte overhead to the output for each input chunk.
-.PP
+(using the
+.Dv Z_SYNC_FLUSH
+option of
+.Xr zlib 3 ) ,
+in order to end that partial bit stream at a byte boundary.
+That allows the partial streams to be concatenated simply as sequences
+of bytes.
+This adds a very small four to five byte overhead to the output for
+each input chunk.
+.Pp
 The default input block size is 128K, but can be changed with the
-.B -b
-option.  The number of compress threads is set by default to the number
-of online processors,
-which can be changed using the 
-.B -p
-option.  Specifying
-.B -p 1
+.Fl b
+option.
+The number of compress threads is set by default to the number
+of online processors, which can be changed using the 
+.Fl p
+option.
+Specifying
+.Fl p Ar 1
 avoids the use of threads entirely.
-.PP
+.Pp
 The input blocks, while compressed independently, have the last 32K of the
 previous block loaded as a preset dictionary to preserve the compression
-effectiveness of deflating in a single thread.  This can be turned off using
-the
-.B -i
+effectiveness of deflating in a single thread.
+This can be turned off using the
+.Fl i
 or
-.B --independent
+.Fl Fl independent
 option, so that the blocks can be decompressed
 independently for partial error recovery or for random access.
-.PP
+.Pp
 Decompression can't be parallelized, at least not without specially prepared
-deflate streams for that purpose.  As a result,
-.I pigz
-uses a single thread
-(the main thread) for decompression, but will create three other threads for
-reading, writing, and check calculation, which can speed up decompression
-under some circumstances.  Parallel decompression can be turned off by
-specifying one process 
-(
-.B -dp 1
+deflate streams for that purpose.
+As a result,
+.Nm
+uses a single thread (the main thread) for decompression, but will
+create three other threads for reading, writing, and check
+calculation, which can speed up decompression under some
+circumstances.
+Parallel decompression can be turned off by specifying one process
+.Fl ( dp Ar 1
 or
-.B -tp 1
-).
-.PP
+.Fl tp Ar 1 ) .
+.Pp
 Compressed files can be restored to their original form using
-.I pigz -d
+.Nm pigz Fl d
 or
-.I unpigz.
-
-.SH OPTIONS
-.TP
-.B -# --fast --best
+.Nm unpigz .
+.Sh OPTIONS
+.Bl -tag -width XXiXXXindependentXX
+.It Fl #, Fl Fl fast, Fl Fl best
 Regulate the speed of compression using the specified digit
-.IR # ,
+.Ar # ,
 where
-.B \-1
+.Fl 1
 or
-.B \-\-fast
+.Fl Fl fast
 indicates the fastest compression method (less compression)
 and
-.B \-9
+.Fl 9
 or
-.B \-\-best
+.Fl Fl best
 indicates the slowest compression method (best compression).
 Level 0 is no compression.
-.TP
-.B -b --blocksize mmm
-Set compression block size to mmmK (default 128KiB).
-.TP
-.B -c --stdout --to-stdout
+.It Fl b, Fl Fl blocksize Ar mmm
+Set compression block size to
+.Ar mmm
+K (default 128KiB).
+.It Fl c, Fl Fl stdout, Fl Fl to-stdout
 Write all processed output to stdout (won't delete).
-.TP
-.B -d --decompress --uncompress
+.It Fl d, Fl Fl decompress, Fl Fl uncompress
 Decompress the compressed input.
-.TP
-.B -f --force
+.It Fl f, Fl Fl force
 Force overwrite, compress .gz, links, and to terminal.
-.TP
-.B -h --help
+.It Fl h, Fl Fl help
 Display a help screen and quit.
-.TP
-.B -i --independent
+.It Fl i, Fl Fl independent
 Compress blocks independently for damage recovery.
-.TP
-.B -k --keep
-Do not delete original file after processing.
-.TP
-.B -K --zip
+.It Fl K, Fl Fl zip
 Compress to PKWare zip (.zip) single entry format.
-.TP
-.B -l --list
+.It Fl k, Fl Fl keep
+Do not delete original file after processing.
+.It Fl L, Fl Fl license
+Display the
+.Nm pigz
+license and quit.
+.It Fl l, Fl Fl list
 List the contents of the compressed input.
-.TP
-.B -L --license
-Display the
-.I pigz
-license and quit.
-.TP
-.B -n --no-name
+.It Fl N, Fl Fl name
+Store/restore file name and mod time in/from header.
+.It Fl n, Fl Fl no-name
 Do not store or restore file name in/from header.
-.TP
-.B -N --name
-Store/restore file name and mod time in/from header.
-.TP
-.B -p --processes n
+.It Fl p, Fl Fl processes Ar n
 Allow up to n processes (default is the number of online processors)
-.TP
-.B -q --quiet --silent
+.It Fl q, Fl Fl quiet, Fl Fl silent
 Print no messages, even on error.
-.TP
-.B -r --recursive
+.It Fl r, Fl Fl recursive
 Process the contents of all subdirectories.
-.TP
-.B -S --suffix .sss
-Use suffix .sss instead of .gz (for compression).
-.TP
-.B -t --test
+.It Fl S, Fl Fl suffix Ar .sss
+Use suffix
+.Ar .sss
+instead of
+.Pa .gz
+(for compression).
+.It Fl T, Fl Fl no-time
+Do not store or restore mod time in/from header.
+.It Fl t, Fl Fl test
 Test the integrity of the compressed input.
-.TP
-.B -T --no-time
-Do not store or restore mod time in/from header.
-.TP
-.B -v --verbose
-Provide more verbose output.
-.TP
-.B -V --version
+.It Fl V, Fl Fl version
 Show the version of pigz.
-.TP
-.B -z --zlib
-Compress to zlib (.zz) instead of gzip format.
-.SH "COPYRIGHT NOTICE"
+.It Fl v, Fl Fl verbose
+Provide more verbose output.
+.It Fl z, Fl Fl zlib
+Compress to zlib
+.Pq Pa .zz
+instead of gzip format.
+.El
+.Sh COPYRIGHT NOTICE
 This software is provided 'as-is', without any express or implied
-warranty.  In no event will the author be held liable for any damages
+warranty.
+In no event will the author be held liable for any damages