1.\" $NetBSD: sysinst.8,v 1.5 2022/01/28 19:36:00 wiz 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 January 28, 2022 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 Dp 36.Op Fl C Ar bg:fg 37.Op Fl f Ar definition_file 38.Op Fl m Ar message_catalog_dir 39.Sh DESCRIPTION 40.Nm 41is a menu-based program that may be used to install or upgrade a 42.Nx 43system. 44It 45is usually invoked automatically when the system is booted 46from appropriate installation media. 47.Pp 48The following options are available: 49.Bl -tag -width 24n 50.It Fl C Ar bg:fg 51Use the ansi colors (see 52.In curses.h ) 53bg as background (default: 4 for blue) 54and fg as foreground/text color (default: 7 for white). 55.It Fl D 56Switch on debugging. 57.It Fl f Ar definition_file 58Use 59.Ar definition_file 60as a file for definitions other than the defaults. 61See the 62.Sx DEFINITION FILE 63section for its format. 64.It Fl m Ar message_catalog_dir 65Search for available language files in 66.Ar message_catalog_dir . 67If this argument is missing and there are 68.Pa sysinstmsgs.* 69files in the current directory, those are used. 70If no such files are found, a compiled in default catalog directory 71is used. 72.It Fl p 73Start the extended partition editor instead of the installer. 74This option is not available on some versions compiled for space limited 75install media. 76.El 77.Sh DEFINITION FILE 78A definition file can be used with 79.Nm 80to control several aspects of the installation or upgrade process. 81Options can be stored within the file as 82.Dl option = value 83pairs. 84Options include the following, shown with their defaults 85as well as a description 86.Dq ( REL 87and 88.Dq MACH 89are the release and architecture 90respectively, as determined by the image 91.Nm 92is used on): 93.Bl -column "targetroot mount" "pub/NetBSD/NetBSD-REL" 94.It Sy "option name" Ta Sy "default value" Ta Sy "description" 95.It machine Ta MACH Ta Machine architecture 96.It xfer dir Ta /usr/INSTALL Ta Transfer dir 97.It ext dir Ta "" Ta Extract dir (will usually be set later on) 98.It ftp host Ta "ftp.NetBSD.org" Ta FTP host for fetching files 99.It ftp dir Ta "pub/NetBSD/NetBSD-REL" Ta FTP directory for fetching files 100.It ftp prefix Ta "/MACH/binary/sets" Ta Directory to look for sets, 101used for all methods of fetching (i.e., not just FTP) 102.It ftp user Ta "ftp" Ta FTP user for connecting 103.It ftp pass Ta "-" Ta FTP password 104.It ftp proxy Ta "-" Ta FTP proxy 105.It nfs host Ta "-" Ta NFS host for fetching via NFS 106.It nfs dir Ta "/bsd/release" Ta NFS directory for fetching files 107.It cd dev Ta "cd0a" Ta Name of CD device for fetching files 108.It fd dev Ta "/dev/fd0a" Ta Name of floppy device for fetching files 109.It local dev Ta "-" Ta Other device to be mounted for fetching files 110.It local fs Ta "ffs" Ta File system type for local device 111.It local dir Ta "release" Ta Directory to look for in the mounted local file system 112.It targetroot mount Ta "/targetroot" Ta Directory to mount target root dir to 113.It dist postfix Ta ".tgz" Ta Suffix of set files to be extracted 114.It diskname Ta "mydisk" Ta Xr disktab 5 diskname to use for target disk 115.El 116.Sh SEE ALSO 117.Xr release 7 , 118.Xr afterboot 8 , 119.Xr boot 8 , 120.Xr diskless 8 121.Pp 122.Em <machine> Ns Pa /INSTALL.* 123files on CD-ROM installation media 124.Pa .../NetBSD- Ns Em <rel> Ns Pa / Ns Em <machine> Ns Pa /INSTALL.* 125files in 126.Nx 127releases or snapshots. 128.Pp 129The default message catalog files are installed in 130.Pa /usr/share/sysinst/catalog . 131.Sh HISTORY 132A 133.Nm 134command appeared in 135.Nx 1.3 . 136