2 .\" Jordan Hubbard <jkh@FreeBSD.org>. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY Jordan Hubbard AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL Jordan Hubbard OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 .\" $FreeBSD: src/release/sysinstall/sysinstall.8,v 1.31.2.15 2002/07/03 21:19:29 jhb Exp $
26 .\" $DragonFly: src/release/sysinstall/Attic/sysinstall.8,v 1.3 2003/08/06 20:21:37 rob Exp $
33 .Nd system installation and configuration tool
41 is a utility for installing and configuring
44 It is the first utility invoked by the
47 floppy and is also copied into
51 systems for use in later configuring the system.
55 program is generally invoked without arguments for the default
56 behavior, where the main installation/configuration menu is presented.
58 On those occasions where it is deemed necessary to invoke a subsystem
59 of sysinstall directly, however, it is also possible to do so by
60 naming the appropriate function entry points on the command line.
61 Since this action is essentially identical to running an installation
62 script, each command-line argument corresponding to a line of script,
63 the reader is encouraged to read the section on scripting for more
64 information on this feature.
67 is essentially nothing more than a monolithic C program with
68 the ability to write MBRs and disk labels (through the services
71 library) and install distributions or packages onto new and
74 systems. It also contains some extra intelligence
75 for running as a replacement for
77 when it's invoked by the
79 installation boot procedure. It
80 assumes very little in the way of additional utility support and
81 performs most file system operations by calling the relevant syscalls
89 library to do user interaction with simple ANSI line graphics, color
90 support for which is enabled by either running on a syscons VTY or some
91 other color-capable terminal emulator (newer versions of xterm will support
96 This product is currently at the end of its life cycle and will
97 eventually be replaced.
100 may be either driven interactively through its various internal menus
101 or run in batch mode, driven by an external script. Such a script may
102 be loaded and executed in one of 3 ways:
104 .It Sy "LOAD_CONFIG_FILE"
107 is compiled with LOAD_CONFIG_FILE set in the environment
108 (or in the Makefile) to some value, then that value will
109 be used as the filename to automatically look for and load
112 starts up and with no user interaction required.
113 This option is aimed primarily at large sites who wish to create a
114 single prototype install for multiple machines with largely identical
115 configurations and/or installation options.
119 is run interactively, that is to say in the default manner, it will
120 bring up a main menu which contains a "load config file" option.
121 Selecting this option will prompt for the name of a script file which
122 it then will attempt to load from a DOS or UFS formatted floppy.
123 .It Sy "COMMAND LINE"
124 Each command line argument is treated as a script directive
127 is run in multi-user mode. Execution ends either by explicit request
130 directive), upon reaching the end of the argument list or on error.
134 /stand/sysinstall _ftpPath=ftp://ziggy/pub/ mediaSetFTP configPackages
139 for FTP installation media (using the server `ziggy') and then
140 bring up the package installation editor, exiting when finished.
143 A script is a list of one or more directives, each directive taking
155 is the assignment of some internal
157 variable, e.g. "ftpPass=FuNkYChiKn", and
159 is the name of an internal
161 function, e.g. "mediaSetFTP", and
163 is a single-line comment for documentation purposes (ignored by
164 sysinstall). Each directive must be by itself on a single line,
165 functions taking their arguments by examining known variable names.
166 This requires that you be sure to assign the relevant variables before
167 calling a function which requires them.
171 variable can be assigned before each directive: this will cause any error
172 detected while processing the directive itself to be ignored.
175 will automatically reset to the default "unassigned" every time a directive is
178 When and where a function depends on the settings of one or more variables
179 will be noted in the following table:
181 .Sy "Function Glossary" :
183 .Bl -tag -width indent
185 Invoke the Anonymous FTP configuration menu.
190 Select which routing daemon you wish to use, potentially
191 loading any required 3rd-party routing daemons as necessary.
194 .Bl -tag -width indent
196 can be set to the name of the desired routing daemon,
201 otherwise it is prompted for.
204 Configure host as an NFS server.
209 Configure host as a user of the Network Time Protocol.
212 .Bl -tag -width indent
216 that is to say the name of the server to sync from.
219 Configure host to support PC NFS.
222 .Bl -tag -width indent
224 The name of the PCNFSD package to load if necessary (defaults to hard coded
228 Bring up the interactive package management menu.
233 Add users and/or groups to the system.
237 .It configXEnvironment
238 Configure the X display subsystem.
242 .It diskPartitionEditor
243 Invokes the disk partition (MBR) editor.
246 .Bl -tag -width findx
248 The disk geometry, as a cyls/heads/sectors formatted string. Default: no
251 Set to disk partitioning type or size, its value being
253 in order to use only remaining free space for
256 to use the entire disk for
258 but maintain a proper partition
263 partition (first found),
266 .Dq dangerously dedicated
271 blocks of available free space to a new
274 Default: Interactive mode.
278 to signify the installation of a boot manager,
280 to signify installation of a "standard" non-boot MGR DOS
283 to indicate that no change to the boot manager is desired.
286 If set, bring up the interactive disk partition editor.
289 Note: Nothing is actually written to disk by this function, a explicit call to
290 .Ar diskPartitionWrite
291 being required for that to happen.
292 .It diskPartitionWrite
293 Causes any pending MBR changes (typically from the
294 .Ar diskPartitionEditor
295 function) to be written out.
300 Invokes the disk label editor. This is a bit trickier from a script
301 since you need to essentially label everything inside each
303 (type 0xA5) partition created by the
304 .Ar diskPartitionEditor
305 function, and that requires knowing a few rules about how things are
306 laid out. When creating a script to automatically allocate disk space
307 and partition it up, it is suggested that you first perform the
308 installation interactively at least once and take careful notes as to
309 what the slice names will be, then and only then hardwiring them into
312 For example, let's say you have a SCSI disk on which you've created a new
314 partition in slice 2 (your DOS partition residing in slice 1).
315 The slice name would be
321 being your DOS primary
322 partition). Now let's further assume that you have 500MB in this
323 partition and you want to sub-partition that space into root, swap,
324 var and usr file systems for
326 Your invocation of the
328 function might involve setting the following variables:
329 .Bl -tag -width findx
330 .It Li "da0s2-1=ufs 40960 /"
331 A 20MB root file system (all sizes are in 512 byte blocks).
332 .It Li "da0s2-2=swap 131072 /"
333 A 64MB swap partition.
334 .It Li "da0s2-3=ufs 204800 /var"
335 A 100MB /var file system.
336 .It Li "da0s2-4=ufs 0 /usr 1"
337 With the balance of free space (around 316MB) going to the /usr
338 file system and with soft-updates enabled (the argument following
339 the mount point, if non-zero, means to set the soft updates flag).
344 for mounting or erasing existing partitions as well as creating new
345 ones. Using the previous example again, let's say that we also wanted
346 to mount our DOS partition and make sure that an
348 entry is created for it in the new installation. Before calling the
350 function, we simply add an additional line:
354 before the call. This tells the label editor that you want to mount
357 and not to attempt to newfs it (not that
359 would attempt this for a DOS partition in any case, but it could just
360 as easily be an existing UFS partition being named here and the 2nd
361 field is non-optional).
365 variable to request that the disk label editor use an interactive dialog
366 to partition the disk instead of using variables to explicitly layout the
367 disk as described above.
369 Note: No file system data is actually written to disk until an
374 Writes out all pending disklabel information and creates and/or mounts any
375 file systems which have requests pending from the
382 Resets all selected distributions to the empty set (no distributions selected).
387 Allows the selection of a custom distribution set (e.g. not just on of the
388 existing "canned" sets) with no user interaction.
391 .Bl -tag -width indent
393 List of distributions to load. Possible distribution values are:
394 .Bl -tag -width indentxx
396 The base binary distribution.
398 Miscellaneous documentation
402 Manual pages (unformatted)
404 Pre-formatted manual pages
406 Profiled libraries for developers.
408 Dictionary information (for tools like spell).
410 GNU info files and other extra docs.
412 Encryption binaries and libraries.
427 a.out binary compatibility
444 The ports collection.
450 /usr/src/[top level files]
480 /usr/src/usr.sbin/sendmail/cf
482 XFree86 official sources.
484 XFree86 contributed sources.
488 XFree86 configuration files.
490 XFree86 documentation.
492 XFree86 HTML documentation.
496 XFree86 server link-kit for PC98 machines.
498 XFree86 server link-kit for standard machines.
500 XFree86 manual pages.
502 XFree86 programmer's distribution.
504 XFree86 postscript documentation.
506 XFree86 graphical setup tool.
507 .It Li PC98-Servers/X9480
508 XFree86 PC98 8-bit (256 color) PEGC-480 server.
509 .It Li PC98-Servers/X9EGC
510 XFree86 PC98 4-bit (16 color) EGC server.
511 .It Li PC98-Servers/X9GA9
512 XFree86 PC98 GA-968V4/PCI (S3 968) server.
513 .It Li PC98-Servers/X9GAN
514 XFree86 PC98 GANB-WAP (cirrus) server.
515 .It Li PC98-Servers/X9LPW
516 XFree86 PC98 PowerWindowLB (S3) server.
517 .It Li PC98-Servers/X9MGA
518 [DESCRIPTION MISSING]
519 .It Li PC98-Servers/X9NKV
520 XFree86 PC98 NKV-NEC (cirrus) server.
521 .It Li PC98-Servers/X9NS3
522 XFree86 PC98 NEC (S3) server.
523 .It Li PC98-Servers/X9SPW
524 XFree86 PC98 SKB-PowerWindow (S3) server.
525 .It Li PC98-Servers/X9SVG
526 [DESCRIPTION MISSING]
527 .It Li PC98-Servers/X9TGU
528 XFree86 PC98 Cyber9320 and TGUI9680 server.
529 .It Li PC98-Servers/X9WEP
530 XFree86 PC98 WAB-EP (cirrus) server.
531 .It Li PC98-Servers/X9WS
532 XFree86 PC98 WABS (cirrus) server.
533 .It Li PC98-Servers/X9WSN
534 XFree86 PC98 WSN-A2F (cirrus) server.
536 XFree86 3D Labs server.
540 XFree86 8 bit AGX server.
542 XFree86 #9 Imagine I128 server.
544 XFree86 ATI Mach8 server.
546 XFree86 ATI Mach32 server.
548 XFree86 ATI Mach64 server.
550 XFree86 monochrome server.
552 XFree86 P9000 server.
556 XFree86 S3 Virge server.
560 XFree86 VGA16 server.
562 XFree86 ET4000/W32, /W32i and /W32p server.
564 Server for TGA cards (alpha architecture only).
566 XFree86 nested X server.
568 XFree86 virtual frame-buffer X server.
570 XFree86 base font set.
572 XFree86 100DPI font set.
574 XFree86 Cyrillic font set.
576 XFree86 scalable font set.
578 XFree86 non-english font set.
584 Selects the standard Developer's distribution set.
588 .It distSetXDeveloper
589 Selects the standard X Developer's distribution set.
593 .It distSetKernDeveloper
594 Selects the standard kernel Developer's distribution set.
599 Selects the standard user distribution set.
604 Selects the standard X user's distribution set.
609 Selects the very minimum distribution set.
613 .It distSetEverything
614 Selects the full whack - all available distributions.
619 Interactively select encryption subcomponents.
624 Interactively select source subcomponents.
629 Interactively select XFree86 subcomponents.
634 Install all currently selected distributions (requires that
635 media device also be selected).
640 Install (if necessary) an HTML documentation browser and go to the
641 HTML documentation submenu.
644 .Bl -tag -width indent
646 The name of the browser package to try and install as necessary.
647 Defaults to latest links package.
649 The name of the browser binary itself (if overriding the
651 variable). Defaults to links.
654 Commit any and all pending changes to disk. This function
655 is essentially shorthand for a number of more granular "commit"
661 Start an "express" installation, asking few questions of
667 Start a "standard" installation, the most user-friendly
668 installation type available.
673 Start an upgrade installation.
677 .It installFixitHoloShell
678 Start up the "emergency holographic shell" over on VTY4
679 if running as init. This will also happen automatically
680 as part of the installation process unless
686 .It installFixitCDROM
687 Go into "fixit" mode, assuming a live file system CDROM
688 currently in the drive.
692 .It installFixitFloppy
693 Go into "fixit" mode, assuming an available fixit floppy
694 disk (user will be prompted for it).
698 .It installFilesystems
699 Do just the file system initialization part of an install.
703 .It installVarDefaults
704 Initialize all variables to their defaults, overriding any
710 Sort of like an #include statement, it allows you to load one
711 configuration file from another.
714 .Bl -tag -width indent
716 The fully qualified pathname of the file to load.
719 If a media device is open, close it.
726 CDROM as the installation media.
731 Select a pre-made floppy installation set as the installation media.
736 Select an existing DOS primary partition as the installation media.
737 The first primary partition found is used (e.g. C:).
742 Select a tape device as the installation media.
747 Select an FTP site as the installation media.
750 .Bl -tag -width indent
752 The name of the host being installed (non-optional).
754 The domain name of the host being installed (optional).
756 The default router for this host (non-optional).
758 Which host interface to use
762 for example. Non-optional).
764 If set, bring up the interactive network setup form even
765 if all relevant configuration variables are already set (optional).
767 The IP address for the selected host interface (non-optional).
769 The netmask for the selected host interface (non-optional).
771 The fully qualified URL of the FTP site containing the
773 distribution you're interested in, e.g.\&
774 .Ar ftp://ftp.FreeBSD.org/pub/FreeBSD/ .
776 .It mediaSetFTPActive
779 using "active" FTP transfer mode.
784 .It mediaSetFTPPassive
787 using "passive" FTP transfer mode.
801 .Bl -tag -width indent
803 The proxy to use (host:port) (non-optional).
806 Select an existing UFS partition (mounted with the label editor) as
807 the installation media.
810 .Bl -tag -width indent
812 full /path to directory containing the
820 .Bl -tag -width indent
822 The name of the host being installed (non-optional).
824 The domain name of the host being installed (optional).
826 The default router for this host (non-optional).
828 Which host interface to use
832 for example. Non-optional).
834 If set, bring up the interactive network setup form even
835 if all relevant configuration variables are already set (optional).
837 The IP address for the selected host interface (non-optional).
839 The netmask for the selected host interface (non-optional).
841 full hostname:/path specification for directory containing
844 distribution you're interested in.
846 .It mediaSetFTPUserPass
849 .Bl -tag -width indent
851 The username to log in as on the ftp server site.
854 The password to use for this username on the ftp
858 .It mediaSetCPIOVerbosity
861 .Bl -tag -width indent
863 Can be used to set the verbosity of cpio extractions to low, medium or
867 Interactively get the user to specify some type of media.
872 Invoke the interactive options editor.
877 Try to fetch and add a package to the system (requires
878 that a media type be set),
881 .Bl -tag -width indent
883 The name of the package to add, e.g. bash-1.14.7 or ncftp-2.4.2.
886 Invoke the interactive group editor.
891 Invoke the interactive user editor.
896 Stop the script and terminate sysinstall.
901 Execute an arbitrary command with
905 .Bl -tag -width indent
907 The name of the command to execute. When running
908 from a boot floppy, very minimal expectations should
909 be made as to what's available until/unless a relatively
910 full system installation has just been done.
913 Configure a network device.
923 For information about building a full release of
928 This utility may edit the contents of
933 as necessary to reflect changes in the network configuration.
935 If you have a reasonably complete source tree online, take
937 .Pa /usr/src/release/sysinstall/install.cfg
938 for a sample installation script.
940 This utility is a prototype which lasted several years past
941 its expiration date and is greatly in need of death.
943 .An Jordan K. Hubbard Aq jkh@FreeBSD.org