mkuzip.8 (fa9896e082a1046ff4fbc75fcba4d18d1f2efc19) mkuzip.8 (525a177c165740fc697df3de5b92e58b3b41477c)
1.\"-
2.\" Copyright (c) 2004-2016 Maxim Sobolev <sobomax@FreeBSD.org>
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright

--- 193 unchanged lines hidden (view full) ---

202.Ar Lzma
203and
204.Ar Zstd will continue to provide better compression ratios as cluster sizes
205are increased, at high enough compression levels.
206The same tradeoff continues to apply: reads in
207.Xr geom_uzip 4
208become more expensive the greater the cluster size.
209.Pp
1.\"-
2.\" Copyright (c) 2004-2016 Maxim Sobolev <sobomax@FreeBSD.org>
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright

--- 193 unchanged lines hidden (view full) ---

202.Ar Lzma
203and
204.Ar Zstd will continue to provide better compression ratios as cluster sizes
205are increased, at high enough compression levels.
206The same tradeoff continues to apply: reads in
207.Xr geom_uzip 4
208become more expensive the greater the cluster size.
209.Pp
210The
211.Nm
212utility
213inserts a short shell script at the beginning of the generated image,
214which makes it possible to
215.Dq run
216the image just like any other shell script.
217The script tries to load the
218.Xr geom_uzip 4
219class if it is not loaded, configure the image as an
220.Xr md 4
221disk device using
222.Xr mdconfig 8 ,
223and automatically mount it using
224.Xr mount_cd9660 8
225on the mount point provided as the first argument to the script.
226.Pp
227The de-duplication is a
228.Fx
229specific feature and while it does not require any changes to on-disk
230compressed image format, however it did require some matching changes to the
231.Xr geom_uzip 4
232to handle resulting images correctly.
233.Pp
234To make use of

--- 7 unchanged lines hidden (view full) ---

242.Fx .
243The status on any particular system can be verified by checking
244.Xr sysctl 8
245.Dv kern.features.geom_uzip_zstd
246for
247.Dq 1 .
248.Sh EXIT STATUS
249.Ex -std
210The de-duplication is a
211.Fx
212specific feature and while it does not require any changes to on-disk
213compressed image format, however it did require some matching changes to the
214.Xr geom_uzip 4
215to handle resulting images correctly.
216.Pp
217To make use of

--- 7 unchanged lines hidden (view full) ---

225.Fx .
226The status on any particular system can be verified by checking
227.Xr sysctl 8
228.Dv kern.features.geom_uzip_zstd
229for
230.Dq 1 .
231.Sh EXIT STATUS
232.Ex -std
233.Sh EXAMPLES
234.Pp
235The following describes how to create and mount a uzip image.
236.Pp
237Create a file system image:
238.Bd -literal -offset indent
239makefs /src.img /usr/src
240.Ed
241.Pp
242Create the uzip image, the output file will be named src.img.uzip:
243.Bd -literal -offset indent
244mkuzip /src.img
245.Ed
246.Pp
247Ensure geom_uzip is loaded:
248.Bd -literal -offset indent
249kldload geom_uzip
250.Ed
251.Pp
252Create an MD device backed by the uzip image:
253.Bd -literal -offset indent
254mdconfig -f /src.img.uzip
255.Ed
256.Pp
257Mount the uzip image:
258.Bd -literal -offset indent
259mount -o ro /dev/md0.uzip /mnt
260.Ed
250.Sh SEE ALSO
251.Xr gzip 1 ,
252.Xr xz 1 ,
253.Xr zstd 1 ,
254.Xr zlib 3 ,
255.Xr geom 4 ,
256.Xr geom_uzip 4 ,
257.Xr md 4 ,
258.Xr mdconfig 8 ,
259.Xr mount_cd9660 8
260.Sh AUTHORS
261.An Maxim Sobolev Aq Mt sobomax@FreeBSD.org
261.Sh SEE ALSO
262.Xr gzip 1 ,
263.Xr xz 1 ,
264.Xr zstd 1 ,
265.Xr zlib 3 ,
266.Xr geom 4 ,
267.Xr geom_uzip 4 ,
268.Xr md 4 ,
269.Xr mdconfig 8 ,
270.Xr mount_cd9660 8
271.Sh AUTHORS
272.An Maxim Sobolev Aq Mt sobomax@FreeBSD.org