xref: /freebsd/tools/tools/makeroot/makeroot.8 (revision f05cddf9)
1.\"-
2.\" Copyright (c) 2013 SRI International
3.\" All rights reserved.
4.\"
5.\" This software was developed by SRI International and the University of
6.\" Cambridge Computer Laboratory under DARPA/AFRL contract (FA8750-10-C-0237)
7.\" ("CTSRD"), as part of the DARPA CRASH research programme.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28.\" SUCH DAMAGE.
29.\"
30.\" $FreeBSD$
31.Dd May 20, 2013
32.Dt MAKEROOT 8
33.Os
34.Sh NAME
35.Nm makeroot
36.Nd Tool to create root filesystem images given a tree containing a manifest
37.Sh SYNOPSIS
38.Nm
39.Op Fl d
40.Op Fl B Ar byte-order
41.Op Fl e Ar extras-manifest
42.Op Fl f Ar filelist
43.Op Fl k Ar keydir Op Fl K Ar user
44.Op Fl p Ar master.passwd Op Fl g Ar group
45.Op Fl s Ar size
46.Ar image-file
47.Ar rootdir
48.Sh DESCRIPTION
49The
50.Nm
51script creates a UFS filesystem image into
52.Ar imagefile .
53By default,
54all filesystem objects listed in the
55.Pa METALOG
56file contained in the
57.Ar rootdir
58directory will be placed in the root of the UFS image
59.Ar image-file .
60.Pp
61Images can be customized with a number of different flags:
62.Bl -tag -width indent
63.It Fl B Ar byte-order
64Set the byte order of the image to
65.Ar byte-order .
66This argument is passed directly to
67.Xr makefs 8 .
68.It Fl d
69Enable debugging output.
70.It Fl e Ar manifest
71Extra files listed in the
72.Xr nmtree 8
73format
74.Ar manifest
75file are added to the filesystem image.
76If no contents= tag is specified or a contents= tag is relative then
77files are found relative to the basename of the full path of the
78manifest.
79If a contents= tag is provided and it is an absolute path then the file
80will be from that path.
81.It Fl f Ar filelist
82Constrain set of filesystem objects included from
83.Ar rootdir
84to those listed (one per line) in the
85.Ar filelist
86plus any required directories.
87.It Fl k Ar keydir Op Fl K Ar user
88Create a .ssh/authorized_keys file from a collection of public key files
89stored in
90.Ar keydir
91and install it in the home directory of
92.Ar user .
93If no
94.Fl K
95argument is supplied then the files will be installed in the root user's
96directory.
97.It Fl p Ar master.passwd Op Fl g Ar group
98Install an alternate
99.Ar master.passwd
100file and optionally an alternative
101.Ar group
102file.
103.It Fl s Ar size
104Set the size of the image to
105.Ar size .
106The
107.Fl s
108argument is passed directly to
109.Xr makefs 8 .
110.El
111.Sh FILES
112.Bl -tag -width METALOG -compact
113.It Pa METALOG
114.Xr mtree 5
1152.0 format manifest of permissions and ownership for files in the root
116directory.
117This file is generated by installworld, distribution, and installkernel.
118.El
119.Sh EXAMPLES
120.Dl $ makeroot.sh -k keys -K ctsrd -p extras/etc/master.passwd -g extras/etc/group -e extras/mdroot.mtree -e demo/demo.mtree -e extras/ctsrd.mtree -s 26112k -f demo.files cheribsd-demo.img /path/to/dist
121.Sh SEE ALSO
122.Xr mtree 5 ,
123.Xr makefs 8 ,
124.Xr nmtree 8
125.Sh AUTHORS
126This software and this manual page were developed by SRI International
127and the University of Cambridge Computer Laboratory under DARPA/AFRL
128contract
129.Pq FA8750-10-C-0237
130.Pq Do CTSRD Dc ,
131as part of the DARPA CRASH research programme.
132