374 lines
9.5 KiB
Groff
374 lines
9.5 KiB
Groff
.\" $NetBSD: makefs.8,v 1.32 2009/01/20 20:47:25 bjh21 Exp $
|
|
.\"
|
|
.\" Copyright (c) 2001-2003 Wasabi Systems, Inc.
|
|
.\" All rights reserved.
|
|
.\"
|
|
.\" Written by Luke Mewburn for Wasabi Systems, Inc.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\" 3. All advertising materials mentioning features or use of this software
|
|
.\" must display the following acknowledgement:
|
|
.\" This product includes software developed for the NetBSD Project by
|
|
.\" Wasabi Systems, Inc.
|
|
.\" 4. The name of Wasabi Systems, Inc. may not be used to endorse
|
|
.\" or promote products derived from this software without specific prior
|
|
.\" written permission.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
|
|
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL WASABI SYSTEMS, INC
|
|
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
.\" 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
|
|
.\" POSSIBILITY OF SUCH DAMAGE.
|
|
.\"
|
|
.\" $FreeBSD$
|
|
.\"
|
|
.Dd August 16, 2013
|
|
.Dt MAKEFS 8
|
|
.Os
|
|
.Sh NAME
|
|
.Nm makefs
|
|
.Nd create a file system image from a directory tree or a mtree manifest
|
|
.Sh SYNOPSIS
|
|
.Nm
|
|
.Op Fl DxZ
|
|
.Op Fl B Ar byte-order
|
|
.Op Fl b Ar free-blocks
|
|
.Op Fl d Ar debug-mask
|
|
.Op Fl F Ar specfile
|
|
.Op Fl f Ar free-files
|
|
.Op Fl M Ar minimum-size
|
|
.Op Fl m Ar maximum-size
|
|
.Op Fl N Ar userdb-dir
|
|
.Op Fl o Ar fs-options
|
|
.Op Fl S Ar sector-size
|
|
.Op Fl s Ar image-size
|
|
.Op Fl t Ar fs-type
|
|
.Ar image-file
|
|
.Ar directory | manifest
|
|
.Op Ar extra-directory ...
|
|
.Sh DESCRIPTION
|
|
The utility
|
|
.Nm
|
|
creates a file system image into
|
|
.Ar image-file
|
|
from the directory tree
|
|
.Ar directory
|
|
or from the mtree manifest
|
|
.Ar manifest .
|
|
If optional directory tree
|
|
.Ar extra-directory
|
|
is passed, then the directory tree of each argument will be merged
|
|
into the
|
|
.Ar directory
|
|
or
|
|
.Ar manifest
|
|
first before creating
|
|
.Ar image-file .
|
|
No special devices or privileges are required to perform this task.
|
|
.Pp
|
|
The options are as follows:
|
|
.Bl -tag -width flag
|
|
.It Fl B Ar byte-order
|
|
Set the byte order of the image to
|
|
.Ar byte-order .
|
|
Valid byte orders are
|
|
.Ql 4321 ,
|
|
.Ql big ,
|
|
or
|
|
.Ql be
|
|
for big endian, and
|
|
.Ql 1234 ,
|
|
.Ql little ,
|
|
or
|
|
.Ql le
|
|
for little endian.
|
|
Some file systems may have a fixed byte order; in those cases this
|
|
argument will be ignored.
|
|
.It Fl b Ar free-blocks
|
|
Ensure that a minimum of
|
|
.Ar free-blocks
|
|
free blocks exist in the image.
|
|
An optional
|
|
.Ql %
|
|
suffix may be provided to indicate that
|
|
.Ar free-blocks
|
|
indicates a percentage of the calculated image size.
|
|
.It Fl D
|
|
Treat duplicate paths in an mtree manifest as warnings not error.
|
|
.It Fl d Ar debug-mask
|
|
Enable various levels of debugging, depending upon which bits are
|
|
set in
|
|
.Ar debug-mask .
|
|
XXX: document these
|
|
.It Fl F Ar specfile
|
|
Use
|
|
.Ar specfile
|
|
as an
|
|
.Xr mtree 8
|
|
.Sq specfile
|
|
specification.
|
|
This option has no effect when the image is created from a mtree manifest
|
|
rather than a directory.
|
|
.Pp
|
|
If a specfile entry exists in the underlying file system, its
|
|
permissions and modification time will be used unless specifically
|
|
overridden by the specfile.
|
|
An error will be raised if the type of entry in the specfile
|
|
conflicts with that of an existing entry.
|
|
.Pp
|
|
In the opposite case (where a specfile entry does not have an entry
|
|
in the underlying file system) the following occurs:
|
|
If the specfile entry is marked
|
|
.Sy optional ,
|
|
the specfile entry is ignored.
|
|
Otherwise, the entry will be created in the image, and it is
|
|
necessary to specify at least the following parameters in the
|
|
specfile:
|
|
.Sy type ,
|
|
.Sy mode ,
|
|
.Sy gname ,
|
|
or
|
|
.Sy gid ,
|
|
and
|
|
.Sy uname
|
|
or
|
|
.Sy uid ,
|
|
and
|
|
.Sy link
|
|
(in the case of symbolic links).
|
|
If
|
|
.Sy time
|
|
isn't provided, the current time will be used.
|
|
If
|
|
.Sy flags
|
|
isn't provided, the current file flags will be used.
|
|
Missing regular file entries will be created as zero-length files.
|
|
.It Fl f Ar free-files
|
|
Ensure that a minimum of
|
|
.Ar free-files
|
|
free files (inodes) exist in the image.
|
|
An optional
|
|
.Ql %
|
|
suffix may be provided to indicate that
|
|
.Ar free-files
|
|
indicates a percentage of the calculated image size.
|
|
.It Fl M Ar minimum-size
|
|
Set the minimum size of the file system image to
|
|
.Ar minimum-size .
|
|
.It Fl m Ar maximum-size
|
|
Set the maximum size of the file system image to
|
|
.Ar maximum-size .
|
|
An error will be raised if the target file system needs to be larger
|
|
than this to accommodate the provided directory tree.
|
|
.It Fl N Ar dbdir
|
|
Use the user database text file
|
|
.Pa master.passwd
|
|
and group database text file
|
|
.Pa group
|
|
from
|
|
.Ar dbdir ,
|
|
rather than using the results from the system's
|
|
.Xr getpwnam 3
|
|
and
|
|
.Xr getgrnam 3
|
|
(and related) library calls.
|
|
.It Fl o Ar fs-options
|
|
Set file system specific options.
|
|
.Ar fs-options
|
|
is a comma separated list of options.
|
|
Valid file system specific options are detailed below.
|
|
.It Fl p
|
|
Deprecated.
|
|
See the
|
|
.Fl Z
|
|
flag.
|
|
.It Fl S Ar sector-size
|
|
Set the file system sector size to
|
|
.Ar sector-size .
|
|
.\" XXX: next line also true for cd9660?
|
|
Defaults to 512.
|
|
.It Fl s Ar image-size
|
|
Set the size of the file system image to
|
|
.Ar image-size .
|
|
.It Fl t Ar fs-type
|
|
Create an
|
|
.Ar fs-type
|
|
file system image.
|
|
The following file system types are supported:
|
|
.Bl -tag -width cd9660 -offset indent
|
|
.It Sy ffs
|
|
BSD fast file system (default).
|
|
.It Sy cd9660
|
|
ISO 9660 file system.
|
|
.El
|
|
.It Fl x
|
|
Exclude file system nodes not explicitly listed in the specfile.
|
|
.It Fl Z
|
|
Create the image as a sparse file.
|
|
.El
|
|
.Pp
|
|
Where sizes are specified, a decimal number of bytes is expected.
|
|
Two or more numbers may be separated by an
|
|
.Dq x
|
|
to indicate a product.
|
|
Each number may have one of the following optional suffixes:
|
|
.Bl -tag -width 3n -offset indent -compact
|
|
.It b
|
|
Block; multiply by 512
|
|
.It k
|
|
Kibi; multiply by 1024 (1 KiB)
|
|
.It m
|
|
Mebi; multiply by 1048576 (1 MiB)
|
|
.It g
|
|
Gibi; multiply by 1073741824 (1 GiB)
|
|
.It t
|
|
Tebi; multiply by 1099511627776 (1 TiB)
|
|
.It w
|
|
Word; multiply by the number of bytes in an integer
|
|
.El
|
|
.\"
|
|
.\"
|
|
.Ss FFS-specific options
|
|
.Sy ffs
|
|
images have ffs-specific optional parameters that may be provided.
|
|
Each of the options consists of a keyword, an equal sign
|
|
.Pq Ql = ,
|
|
and a value.
|
|
The following keywords are supported:
|
|
.Pp
|
|
.Bl -tag -width optimization -offset indent -compact
|
|
.It Sy avgfilesize
|
|
Expected average file size.
|
|
.It Sy avgfpdir
|
|
Expected number of files per directory.
|
|
.It Sy bsize
|
|
Block size.
|
|
.It Sy density
|
|
Bytes per inode.
|
|
.It Sy fsize
|
|
Fragment size.
|
|
.It Sy label
|
|
Label name of the image.
|
|
.It Sy maxbpg
|
|
Maximum blocks per file in a cylinder group.
|
|
.It Sy minfree
|
|
Minimum % free.
|
|
.It Sy optimization
|
|
Optimization preference; one of
|
|
.Ql space
|
|
or
|
|
.Ql time .
|
|
.It Sy extent
|
|
Maximum extent size.
|
|
.It Sy maxbpcg
|
|
Maximum total number of blocks in a cylinder group.
|
|
.It Sy version
|
|
UFS version.
|
|
1 for FFS (default), 2 for UFS2.
|
|
.El
|
|
.Ss CD9660-specific options
|
|
.Sy cd9660
|
|
images have ISO9660-specific optional parameters that may be
|
|
provided.
|
|
The arguments consist of a keyword and, optionally, an equal sign
|
|
.Pq Ql = ,
|
|
and a value.
|
|
The following keywords are supported:
|
|
.Pp
|
|
.Bl -tag -width omit-trailing-period -offset indent -compact
|
|
.It Sy allow-deep-trees
|
|
Allow the directory structure to exceed the maximum specified in
|
|
the spec.
|
|
.\" .It Sy allow-illegal-chars
|
|
.\" Unknown
|
|
.\" .It Sy allow-lowercase
|
|
.\" Unknown
|
|
.It Sy allow-max-name
|
|
Allow 37 instead of 33 characters for filenames by omitting the
|
|
version id.
|
|
.It Sy allow-multidot
|
|
Allow multiple dots in a filename.
|
|
.It Sy applicationid
|
|
Application ID of the image.
|
|
.It Sy archimedes
|
|
Use the
|
|
.Ql ARCHIMEDES
|
|
extension to encode
|
|
.Tn RISC OS
|
|
metadata.
|
|
.It Sy chrp-boot
|
|
Write an MBR partition table to the image to allow older CHRP hardware to
|
|
boot.
|
|
.It Sy boot-load-segment
|
|
Set load segment for the boot image.
|
|
.It Sy bootimage
|
|
Filename of a boot image in the format
|
|
.Dq sysid;filename ,
|
|
where
|
|
.Dq sysid
|
|
is one of
|
|
.Ql i386 ,
|
|
.Ql mac68k ,
|
|
.Ql macppc ,
|
|
or
|
|
.Ql powerpc .
|
|
.It Sy generic-bootimage
|
|
Load a generic boot image into the first 32K of the cd9660 image.
|
|
.It Sy hard-disk-boot
|
|
Boot image is a hard disk image.
|
|
.It Sy keep-bad-images
|
|
Do not throw away images whose write was aborted due to an error.
|
|
For debugging purposes.
|
|
.It Sy label
|
|
Label name of the image.
|
|
.It Sy no-boot
|
|
Boot image is not bootable.
|
|
.It Sy no-emul-boot
|
|
Boot image is a
|
|
.Dq no emulation
|
|
ElTorito image.
|
|
.It Sy no-trailing-padding
|
|
Do not pad the image (apparently Linux needs the padding).
|
|
.\" .It Sy omit-trailing-period
|
|
.\" Unknown
|
|
.It Sy preparer
|
|
Preparer ID of the image.
|
|
.It Sy publisher
|
|
Publisher ID of the image.
|
|
.It Sy rockridge
|
|
Use RockRidge extensions (for longer filenames, etc.).
|
|
.It Sy volumeid
|
|
Volume set identifier of the image.
|
|
.El
|
|
.Sh SEE ALSO
|
|
.Xr mtree 5 ,
|
|
.Xr mtree 8 ,
|
|
.Xr newfs 8
|
|
.Sh HISTORY
|
|
The
|
|
.Nm
|
|
utility appeared in
|
|
.Nx 1.6 .
|
|
.Sh AUTHORS
|
|
.An Luke Mewburn Aq Mt lukem@NetBSD.org
|
|
(original program)
|
|
.An Daniel Watt
|
|
.An Walter Deignan
|
|
.An Ryan Gabrys
|
|
.An Alan Perez-Rathke
|
|
.An Ram Vedam
|
|
(cd9660 support)
|