Sun Sep 16 21:33:30 2012 UTC ()
New sentence, new line.
Sort option descriptions.
Comment out partial sentence.
Sort SEE ALSO and remove trailing comma.
Use more markup.


(wiz)
diff -r1.1 -r1.2 src/external/bsd/liblzf/usr.bin/lzf/lzf.1

cvs diff -r1.1 -r1.2 src/external/bsd/liblzf/usr.bin/lzf/lzf.1 (expand / switch to unified diff)

--- src/external/bsd/liblzf/usr.bin/lzf/lzf.1 2012/09/16 18:59:29 1.1
+++ src/external/bsd/liblzf/usr.bin/lzf/lzf.1 2012/09/16 21:33:30 1.2
@@ -1,14 +1,14 @@ @@ -1,14 +1,14 @@
1.\" $NetBSD: lzf.1,v 1.1 2012/09/16 18:59:29 tls Exp $ 1.\" $NetBSD: lzf.1,v 1.2 2012/09/16 21:33:30 wiz Exp $
2.\" 2.\"
3.\" Copyright (c) 2012 The NetBSD Foundation, inc. 3.\" Copyright (c) 2012 The NetBSD Foundation, inc.
4.\" All rights reserved. 4.\" All rights reserved.
5.\" 5.\"
6.\" This code is derived from software contributed to the NetBSD Foundation 6.\" This code is derived from software contributed to the NetBSD Foundation
7.\" by Thor Lancelot Simon. 7.\" by Thor Lancelot Simon.
8.\" 8.\"
9.\" Redistribution and use in source and binary forms, with or without 9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions 10.\" modification, are permitted provided that the following conditions
11.\" are met: 11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright 12.\" 1. Redistributions of source code must retain the above copyright
13.\" notice, this list of conditions and the following disclaimer. 13.\" notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright 14.\" 2. Redistributions in binary form must reproduce the above copyright
@@ -53,91 +53,99 @@ @@ -53,91 +53,99 @@
53.Oo 53.Oo
54.Ar file Oo ... 54.Ar file Oo ...
55.Oc 55.Oc
56.Oc 56.Oc
57.Nm lzfcat 57.Nm lzfcat
58.Ar file 58.Ar file
59.Oo 59.Oo
60.Ar file Oo ... 60.Ar file Oo ...
61.Oc 61.Oc
62.Oc 62.Oc
63.Sh DESCRIPTION 63.Sh DESCRIPTION
64.Nm 64.Nm
65is a simple program to compress or uncompress files using LZF 65is a simple program to compress or uncompress files using LZF
66(sometimes known as "Lempel-Ziv Fast") coding. LZF is extremely 66(sometimes known as "Lempel-Ziv Fast") coding.
67fast, about 75% of the performance of 67LZF is extremely fast, about 75% of the performance of
68.Xr memcpy 3 68.Xr memcpy 3
69for many inputs, while offering a moderate compression ratio, 69for many inputs, while offering a moderate compression ratio,
70usually between 1.5:1 and 2:1. 70usually between 1.5:1 and 2:1.
71.Pp 71.Pp
72When compressing, it removes each input file and replaces it with an 72When compressing, it removes each input file and replaces it with an
73output file with the suffix ".lzf" appended. When uncompressing, it 73output file with the suffix
74removes each input file and replaces it with an output file with the 74.Dq Pa .lzf
75suffix ".lzf" removed. If no files are specified as arguments, standard 75appended.
76input and standard output are used as input and output respectively. 76When uncompressing, it removes each input file and replaces it with
 77an output file with the suffix
 78.Dq Pa .lzf
 79removed.
 80If no files are specified as arguments, standard input and standard
 81output are used as input and output respectively.
77.Pp 82.Pp
78If invoked as 83If invoked as
79.Nm lzf , 84.Nm lzf ,
80the default mode of operation is to compress. 85the default mode of operation is to compress.
81If invoked as 86If invoked as
82.Nm unlzf , 87.Nm unlzf ,
83the default mode of operation is to uncompress. 88the default mode of operation is to uncompress.
84If invoked as 89If invoked as
85.Nm lzfcat , 90.Nm lzfcat ,
86the default mode of operation is to uncompress to standard output. 91the default mode of operation is to uncompress to standard output.
87.Sh OPTIONS 92.Sh OPTIONS
88The following options are available: 93The following options are available:
89.Bl -tag -width width 94.Bl -tag -width width
 95.It Fl b
 96This option selects a compression blocksize.
 97Small compression block sizes give poor compression and slow
 98operation; the default of 64KiB is strongly recommended.
 99Block sizes larger than 64KiB are silently reduced to 64KiB in
 100order to not produce output incompatible with other versions of
 101.Nm .
90.It Fl c 102.It Fl c
91This option selects compression. 103This option selects compression.
92.It Fl d 104.It Fl d
93This option selects decompression. 105This option selects decompression.
94.It Fl f 106.It Fl f
95This option forces overwrite of preexisting output files, if any. 107This option forces overwrite of preexisting output files, if any.
96option, allowing non-compressed data to pass through unchanged. 108.\" option, allowing non-compressed data to pass through unchanged.
97.It Fl h 109.It Fl h
98This option prints command usage. 110This option prints command usage.
99.It Fl b 
100This option selects a compression blocksize. Small compression block 
101sizes give poor compression and slow operation; the default of 64KiB is 
102strongly recommended. Block sizes larger than 64KiB are silently reduced 
103to 64KiB in order to not produce output incompatible with other versions 
104of 
105.Nm . 
106.It Fl v 111.It Fl v
107This option prints compression statistics for each file processed. 112This option prints compression statistics for each file processed.
108.El 113.El
109.Sh SEE ALSO 114.Sh SEE ALSO
110.Xr gzip 1 , 
111.Xr bzip2 1 , 115.Xr bzip2 1 ,
112.Xr compress 1 , 116.Xr compress 1 ,
113.Xr xz 1 , 117.Xr gzip 1 ,
 118.Xr xz 1
114.Sh HISTORY 119.Sh HISTORY
115The 120The
116.Nm 121.Nm
117program was first included with version 0.1 of Marc Lehmann's LZF library. 122program was first included with version 0.1 of Marc Lehmann's LZF library.
118It was rewritten for version 2.0 of the library to offer the current 123It was rewritten for version 2.0 of the library to offer the current
119syntax, which is mostly compatible with other compression utilities such 124syntax, which is mostly compatible with other compression utilities such
120as 125as
121.Xr gzip 1 . 126.Xr gzip 1 .
122The 127The
123.Nm 128.Nm
124program first appeared in 129program first appeared in
125.Nx 7.0 . 130.Nx 7.0 .
126.Sh AUTHORS 131.Sh AUTHORS
127The 132The
128.Nm 133.Nm
129program was written by 134program was written by
130.An Stefan Traby Aq stefan@hello-penguin.com . 135.An Stefan Traby Aq stefan@hello-penguin.com .
131.Sh BUGS 136.Sh BUGS
132Some versions of 137Some versions of
133.Nm 138.Nm
134install a program named "lzcat" 139install a program named
 140.Dq Pa lzcat
135instead of 141instead of
136.Nm lzfcat . 142.Nm lzfcat .
137Because the "lzcat" name is also used by 143Because the
 144.Pq lzcat
 145name is also used by
138.Xr xz 1 , 146.Xr xz 1 ,
139in 147in
140.Nx 148.Nx
141the name 149the name
142.Nm lzfcat 150.Nm lzfcat
143is used instead. 151is used instead.