xref: /netbsd-src/usr.sbin/sysinst/sysinst.8 (revision 181254a7b1bdde6873432bffef2d2decc4b5c22f)
1.\"	$NetBSD: sysinst.8,v 1.3 2020/03/06 20:07:26 maya Exp $
2.\"
3.\" Copyright (c) 2007 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
16.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
17.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
19.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25.\" POSSIBILITY OF SUCH DAMAGE.
26.\"
27.Dd March 6, 2020
28.Dt SYSINST 8
29.Os
30.Sh NAME
31.Nm sysinst
32.Nd install or upgrade a NetBSD system
33.Sh SYNOPSIS
34.Nm
35.Op Fl D
36.Op Fl f Ar definition_file
37.Sh DESCRIPTION
38.Nm
39is a menu-based program that may be used to install or upgrade a
40.Nx
41system.
42It
43is usually invoked automatically when the system is booted
44from appropriate installation media.
45.Pp
46The following options are available:
47.Bl -tag -width XfXdefinition_fileXX
48.It Fl D
49Switch on debugging.
50.It Fl f Ar definition_file
51Use
52.Ar definition_file
53as a file for definitions other than the defaults.
54See the
55.Sx DEFINITION FILE
56section for its format.
57.El
58.Sh DEFINITION FILE
59A definition file can be used with
60.Nm
61to control several aspects of the installation or upgrade process.
62Options can be stored within the file as
63.Dl option = value
64pairs.
65Options include the following, shown with their defaults
66as well as a description
67.Dq ( REL
68and
69.Dq MACH
70are the release and architecture
71respectively, as determined by the image
72.Nm
73is used on):
74.Bl -column "targetroot mount" "pub/NetBSD/NetBSD-REL"
75.It Sy "option name" Ta Sy "default value" Ta Sy "description"
76.It machine Ta MACH Ta Machine architecture
77.It xfer dir Ta /usr/INSTALL Ta Transfer dir
78.It ext dir Ta "" Ta Extract dir (will usually be set later on)
79.It ftp host Ta "ftp.NetBSD.org" Ta FTP host for fetching files
80.It ftp dir Ta "pub/NetBSD/NetBSD-REL" Ta FTP directory for fetching files
81.It ftp prefix Ta "/MACH/binary/sets" Ta Directory to look for sets,
82used for all methods of fetching (i.e., not just FTP)
83.It ftp user Ta "ftp" Ta FTP user for connecting
84.It ftp pass Ta "-" Ta FTP password
85.It ftp proxy Ta "-" Ta FTP proxy
86.It nfs host Ta "-" Ta NFS host for fetching via NFS
87.It nfs dir Ta "/bsd/release" Ta NFS directory for fetching files
88.It cd dev Ta "cd0a" Ta Name of CD device for fetching files
89.It fd dev Ta "/dev/fd0a" Ta Name of floppy device for fetching files
90.It local dev Ta "-" Ta Other device to be mounted for fetching files
91.It local fs Ta "ffs" Ta File system type for local device
92.It local dir Ta "release" Ta Directory to look for in the mounted local file system
93.It targetroot mount Ta "/targetroot" Ta Directory to mount target root dir to
94.It dist postfix Ta ".tgz" Ta Suffix of set files to be extracted
95.It diskname Ta "mydisk" Ta Xr disktab 5 diskname to use for target disk
96.El
97.Sh SEE ALSO
98.Xr release 7 ,
99.Xr afterboot 8 ,
100.Xr boot 8 ,
101.Xr diskless 8
102.Pp
103.Em <machine> Ns Pa /INSTALL.*
104files on CD-ROM installation media
105.Pa .../NetBSD- Ns Em <rel> Ns Pa / Ns Em <machine> Ns Pa /INSTALL.*
106files in
107.Nx
108releases or snapshots.
109.Sh HISTORY
110A
111.Nm
112command appeared in
113.Nx 1.3 .
114