| @@ -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 |
65 | is a simple program to compress or uncompress files using LZF | | 65 | is 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. |
67 | fast, about 75% of the performance of | | 67 | LZF is extremely fast, about 75% of the performance of |
68 | .Xr memcpy 3 | | 68 | .Xr memcpy 3 |
69 | for many inputs, while offering a moderate compression ratio, | | 69 | for many inputs, while offering a moderate compression ratio, |
70 | usually between 1.5:1 and 2:1. | | 70 | usually between 1.5:1 and 2:1. |
71 | .Pp | | 71 | .Pp |
72 | When compressing, it removes each input file and replaces it with an | | 72 | When compressing, it removes each input file and replaces it with an |
73 | output file with the suffix ".lzf" appended. When uncompressing, it | | 73 | output file with the suffix |
74 | removes each input file and replaces it with an output file with the | | 74 | .Dq Pa .lzf |
75 | suffix ".lzf" removed. If no files are specified as arguments, standard | | 75 | appended. |
76 | input and standard output are used as input and output respectively. | | 76 | When uncompressing, it removes each input file and replaces it with |
| | | 77 | an output file with the suffix |
| | | 78 | .Dq Pa .lzf |
| | | 79 | removed. |
| | | 80 | If no files are specified as arguments, standard input and standard |
| | | 81 | output are used as input and output respectively. |
77 | .Pp | | 82 | .Pp |
78 | If invoked as | | 83 | If invoked as |
79 | .Nm lzf , | | 84 | .Nm lzf , |
80 | the default mode of operation is to compress. | | 85 | the default mode of operation is to compress. |
81 | If invoked as | | 86 | If invoked as |
82 | .Nm unlzf , | | 87 | .Nm unlzf , |
83 | the default mode of operation is to uncompress. | | 88 | the default mode of operation is to uncompress. |
84 | If invoked as | | 89 | If invoked as |
85 | .Nm lzfcat , | | 90 | .Nm lzfcat , |
86 | the default mode of operation is to uncompress to standard output. | | 91 | the default mode of operation is to uncompress to standard output. |
87 | .Sh OPTIONS | | 92 | .Sh OPTIONS |
88 | The following options are available: | | 93 | The following options are available: |
89 | .Bl -tag -width width | | 94 | .Bl -tag -width width |
| | | 95 | .It Fl b |
| | | 96 | This option selects a compression blocksize. |
| | | 97 | Small compression block sizes give poor compression and slow |
| | | 98 | operation; the default of 64KiB is strongly recommended. |
| | | 99 | Block sizes larger than 64KiB are silently reduced to 64KiB in |
| | | 100 | order to not produce output incompatible with other versions of |
| | | 101 | .Nm . |
90 | .It Fl c | | 102 | .It Fl c |
91 | This option selects compression. | | 103 | This option selects compression. |
92 | .It Fl d | | 104 | .It Fl d |
93 | This option selects decompression. | | 105 | This option selects decompression. |
94 | .It Fl f | | 106 | .It Fl f |
95 | This option forces overwrite of preexisting output files, if any. | | 107 | This option forces overwrite of preexisting output files, if any. |
96 | option, 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 |
98 | This option prints command usage. | | 110 | This option prints command usage. |
99 | .It Fl b | | | |
100 | This option selects a compression blocksize. Small compression block | | | |
101 | sizes give poor compression and slow operation; the default of 64KiB is | | | |
102 | strongly recommended. Block sizes larger than 64KiB are silently reduced | | | |
103 | to 64KiB in order to not produce output incompatible with other versions | | | |
104 | of | | | |
105 | .Nm . | | | |
106 | .It Fl v | | 111 | .It Fl v |
107 | This option prints compression statistics for each file processed. | | 112 | This 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 |
115 | The | | 120 | The |
116 | .Nm | | 121 | .Nm |
117 | program was first included with version 0.1 of Marc Lehmann's LZF library. | | 122 | program was first included with version 0.1 of Marc Lehmann's LZF library. |
118 | It was rewritten for version 2.0 of the library to offer the current | | 123 | It was rewritten for version 2.0 of the library to offer the current |
119 | syntax, which is mostly compatible with other compression utilities such | | 124 | syntax, which is mostly compatible with other compression utilities such |
120 | as | | 125 | as |
121 | .Xr gzip 1 . | | 126 | .Xr gzip 1 . |
122 | The | | 127 | The |
123 | .Nm | | 128 | .Nm |
124 | program first appeared in | | 129 | program first appeared in |
125 | .Nx 7.0 . | | 130 | .Nx 7.0 . |
126 | .Sh AUTHORS | | 131 | .Sh AUTHORS |
127 | The | | 132 | The |
128 | .Nm | | 133 | .Nm |
129 | program was written by | | 134 | program 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 |
132 | Some versions of | | 137 | Some versions of |
133 | .Nm | | 138 | .Nm |
134 | install a program named "lzcat" | | 139 | install a program named |
| | | 140 | .Dq Pa lzcat |
135 | instead of | | 141 | instead of |
136 | .Nm lzfcat . | | 142 | .Nm lzfcat . |
137 | Because the "lzcat" name is also used by | | 143 | Because the |
| | | 144 | .Pq lzcat |
| | | 145 | name is also used by |
138 | .Xr xz 1 , | | 146 | .Xr xz 1 , |
139 | in | | 147 | in |
140 | .Nx | | 148 | .Nx |
141 | the name | | 149 | the name |
142 | .Nm lzfcat | | 150 | .Nm lzfcat |
143 | is used instead. | | 151 | is used instead. |