Differential D54538 Diff 169144 usr.sbin/makefs/makefs.8

Changeset View

Standalone View

usr.sbin/makefs/makefs.8

	Show All 27 Lines
	.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR			.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
	.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF			.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
	.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS			.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
	.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN			.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
	.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)			.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
	.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE			.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
	.\" POSSIBILITY OF SUCH DAMAGE.			.\" POSSIBILITY OF SUCH DAMAGE.
	.\"			.\"
	.Dd July 19, 2025			.Dd January 5, 2026
	.Dt MAKEFS 8			.Dt MAKEFS 8
	.Os			.Os
	.Sh NAME			.Sh NAME
	.Nm makefs			.Nm makefs
	.Nd create a file system image from a directory tree or a mtree manifest			.Nd create a file system image from a directory tree or a mtree manifest
	.Sh SYNOPSIS			.Sh SYNOPSIS
	.Nm			.Nm
	.Op Fl DxZ			.Op Fl DxZ
	▲ Show 20 Lines • Show All 74 Lines • ▼ Show 20 Lines
	.Ar debug-mask			.Ar debug-mask
	is a bit map defined in the header file			is a bit map defined in the header file
	.Ar makefs.h .			.Ar makefs.h .
	See the source for usage, and look for defines starting with			See the source for usage, and look for defines starting with
	.Ar DEBUG_ .			.Ar DEBUG_ .
	.It Fl F Ar mtree-specfile			.It Fl F Ar mtree-specfile
	.Em This is almost certainly not the option you are looking for.			.Em This is almost certainly not the option you are looking for.
	To create an image from a list of files in an mtree format manifest,			To create an image from a list of files in an mtree format manifest,
	specify it as the last argument on the command line, not as a the			specify it as the last argument on the command line, not as the
	argument to			argument to
	.Fl F .			.Fl F .
	.Pp			.Pp
	Use			Use
	.Ar mtree-specfile			.Ar mtree-specfile
	as an			as an
	.Xr mtree 8			.Xr mtree 8
	.Sq specfile			.Sq specfile
	▲ Show 20 Lines • Show All 184 Lines • ▼ Show 20 Lines
	.Bl -tag -width optimization -offset indent -compact			.Bl -tag -width optimization -offset indent -compact
	.It Sy avgfilesize			.It Sy avgfilesize
	Expected average file size.			Expected average file size.
	.It Sy avgfpdir			.It Sy avgfpdir
	Expected number of files per directory.			Expected number of files per directory.
	.It Sy bsize			.It Sy bsize
	Block size.			Block size.
	.It Sy density			.It Sy density
	Bytes per inode. If unset, will allocate the minimum number of inodes to			Bytes per inode.
				If unset, will allocate the minimum number of inodes to
	represent the filesystem if no free space has been requested (free blocks			represent the filesystem if no free space has been requested (free blocks
	or minimum size set); otherwise the larger of the newfs defaults or what			or minimum size set); otherwise the larger of the newfs defaults or what
	is required by the free inode parameters if set.			is required by the free inode parameters if set.
	.It Sy fsize			.It Sy fsize
	Fragment size.			Fragment size.
	.It Sy label			.It Sy label
	Label name of the image.			Label name of the image.
	.It Sy maxbpg			.It Sy maxbpg
	▲ Show 20 Lines • Show All 256 Lines • ▼ Show 20 Lines
	The root of the staged directory tree is mapped to			The root of the staged directory tree is mapped to
	.Va rootpath .			.Va rootpath .
	.Pp			.Pp
	Dataset properties, as described in			Dataset properties, as described in
	.Xr zfsprops 7 ,			.Xr zfsprops 7 ,
	may be specified following the dataset name.			may be specified following the dataset name.
	The following properties may be set for a dataset:			The following properties may be set for a dataset:
	.Pp			.Pp
	.Bl -tag -compact -offset indent			.Bl -hang -compact -offset indent
	.It atime			.It atime
	.It canmount			.It canmount
	.It compression			.It compression
	.It exec			.It exec
	.It mountpoint			.It mountpoint
	.It setuid			.It setuid
	.El			.El
	Note that			Note that
	Show All 38 Lines