usr.sbin/sysinstall/sysinstall.8

   1 .\" Copyright (c) 1997
   2 .\"     Jordan Hubbard <jkh@FreeBSD.org>.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   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.
  12 .\"
  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
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd February 18, 2007
  28 .Dt SYSINSTALL 8
  29 .Os
  30 .Sh NAME
  31 .Nm sysinstall
  32 .Nd system installation and configuration tool
  33 .Sh SYNOPSIS
  34 .Nm
  35 .Op Ar var=value
  36 .Op Ar function
  37 .Op Ar ...
  38 .Sh DESCRIPTION
  39 The
  40 .Nm
  41 utility is used for installing and configuring
  42 .Fx
  43 systems.
  44 It is the first utility invoked by the
  45 .Fx
  46 installation boot
  47 floppy and is also available as
  48 .Pa /usr/sbin/sysinstall
  49 on newly installed
  50 .Fx
  51 systems for use in later configuring the system.
  52 .Pp
  53 The
  54 .Nm
  55 utility is generally invoked without arguments for the default
  56 behavior, where the main installation/configuration menu is presented.
  57 .Pp
  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.
  65 .Sh NOTES
  66 The
  67 .Nm
  68 utility is essentially nothing more than a monolithic C program with
  69 the ability to write MBRs and disk labels (through the services
  70 of the
  71 .Xr libdisk 3
  72 library) and install distributions or packages onto new and
  73 existing
  74 .Fx
  75 systems.
  76 It also contains some extra intelligence
  77 for running as a replacement for
  78 .Xr init 8
  79 when it is invoked by the
  80 .Fx
  81 installation boot procedure.
  82 It
  83 assumes very little in the way of additional utility support and
  84 performs most file system operations by calling the relevant syscalls
  85 (such as
  86 .Xr mount 2 )
  87 directly.
  88 .Pp
  89 The
  90 .Nm
  91 utility currently uses the
  92 .Xr dialog 3
  93 library to do user interaction with simple ANSI line graphics, color
  94 support for which is enabled by either running on a syscons VTY or some
  95 other color-capable terminal emulator (newer versions of xterm will support
  96 color when using the
  97 .Dq xterm-color
  98 termcap entry).
  99 .Pp
 100 This product is currently at the end of its life cycle and will
 101 eventually be replaced.
 102 .Sh RUNNING SCRIPTS
 103 The
 104 .Nm
 105 utility may be either driven interactively through its various internal menus
 106 or run in batch mode, driven by an external script.
 107 Such a script may
 108 be loaded and executed in one of 3 ways:
 109 .Bl -tag -width Ds
 110 .It Sy "LOAD_CONFIG_FILE"
 111 If
 112 .Nm
 113 is compiled with LOAD_CONFIG_FILE set in the environment
 114 (or in the Makefile) to some value, then that value will
 115 be used as the filename to automatically look for and load
 116 when
 117 .Nm
 118 starts up and with no user interaction required.
 119 This option is aimed primarily at large sites who wish to create a
 120 single prototype install for multiple machines with largely identical
 121 configurations and/or installation options.
 122 .It Sy "MAIN MENU"
 123 If
 124 .Nm
 125 is run interactively, that is to say in the default manner, it will
 126 bring up a main menu which contains a "load config file" option.
 127 Selecting this option will prompt for the name of a script file which
 128 it then will attempt to load from a DOS or UFS formatted floppy.
 129 .It Sy "COMMAND LINE"
 130 Each command line argument is treated as a script directive
 131 when
 132 .Nm
 133 is run in multi-user mode.
 134 Execution ends either by explicit request
 135 (e.g.\& calling the
 136 .Ar shutdown
 137 directive), upon reaching the end of the argument list or on error.
 138 .Pp
 139 For example:
 140 .Bd -literal
 141 /usr/sbin/sysinstall _ftpPath=ftp://ziggy/pub/ mediaSetFTP configPackages
 142 .Ed
 143 .Pp
 144 Would initialize
 145 .Nm
 146 for FTP installation media (using the server `ziggy') and then
 147 bring up the package installation editor, exiting when finished.
 148 .El
 149 .Sh SCRIPT SYNTAX
 150 A script is a list of one or more directives, each directive taking
 151 the form of:
 152 .Pp
 153 .Ar var=value
 154 .Pp
 155 .Ar function
 156 .Pp
 157 or
 158 .Ar #somecomment
 159 .Pp
 160 Where
 161 .Ar var=value
 162 is the assignment of some internal
 163 .Nm
 164 variable, e.g.\& "ftpPass=FuNkYChiKn", and
 165 .Ar function
 166 is the name of an internal
 167 .Nm
 168 function, e.g.\& "mediaSetFTP", and
 169 .Ar #comment
 170 is a single-line comment for documentation purposes (ignored by
 171 sysinstall).
 172 Each directive must be by itself on a single line,
 173 functions taking their arguments by examining known variable names.
 174 This requires that you be sure to assign the relevant variables before
 175 calling a function which requires them.
 176 .Pp
 177 The
 178 .Ar noError
 179 variable can be assigned before each directive: this will cause any error
 180 detected while processing the directive itself to be ignored.
 181 The value of
 182 .Ar noError
 183 will automatically reset to the default "unassigned" every time a directive is
 184 processed.
 185 .Pp
 186 When and where a function depends on the settings of one or more variables
 187 will be noted in the following table:
 188 .Pp
 189 .Sy "Function Glossary" :
 190 .Pp
 191 .Bl -tag -width indent
 192 .It configAnonFTP
 193 Invoke the Anonymous FTP configuration menu.
 194 .Pp
 195 .Sy Variables :
 196 None
 197 .It configRouter
 198 Select which routing daemon you wish to use, potentially
 199 loading any required 3rd-party routing daemons as necessary.
 200 .Pp
 201 .Sy Variables :
 202 .Bl -tag -width indent
 203 .It router
 204 can be set to the name of the desired routing daemon,
 205 e.g.\&
 206 .Dq routed
 207 or
 208 .Dq gated ,
 209 otherwise it is prompted for.
 210 .El
 211 .It configNFSServer
 212 Configure host as an NFS server.
 213 .Pp
 214 .Sy Variables :
 215 None
 216 .It configNTP
 217 Configure host as a user of the Network Time Protocol.
 218 .Pp
 219 .Sy Variables :
 220 .Bl -tag -width indent
 221 .It ntpdate_flags
 222 The flags to
 223 .Xr ntpdate 8 ,
 224 that is to say the name of the server to sync from.
 225 .El
 226 .It configPCNFSD
 227 Configure host to support PC NFS.
 228 .Pp
 229 .Sy Variables :
 230 .Bl -tag -width indent
 231 .It pcnfsd_pkg
 232 The name of the PCNFSD package to load if necessary (defaults to hard coded
 233 version).
 234 .El
 235 .It configPackages
 236 Bring up the interactive package management menu.
 237 .Pp
 238 .Sy Variables :
 239 None
 240 .It configUsers
 241 Add users and/or groups to the system.
 242 .Pp
 243 .Sy Variables :
 244 None
 245 .It diskPartitionEditor
 246 Invokes the disk partition (MBR) editor.
 247 .Pp
 248 .Sy Variables :
 249 .Bl -tag -width findx
 250 .It geometry
 251 The disk geometry, as a cyls/heads/sectors formatted string.
 252 Default: no
 253 change to geometry.
 254 .It partition
 255 Set to disk partitioning type or size, its value being
 256 .Ar free
 257 in order to use only remaining free space for
 258 .Fx ,
 259 .Ar all
 260 to use the entire disk for
 261 .Fx
 262 but maintain a proper partition
 263 table,
 264 .Ar existing
 265 to use an existing
 266 .Fx
 267 partition (first found),
 268 .Ar exclusive
 269 to use the disk in
 270 .Dq dangerously dedicated
 271 mode or, finally,
 272 .Ar somenumber
 273 to allocate
 274 .Ar somenumber
 275 blocks of available free space to a new
 276 .Fx
 277 partition.
 278 Default: Interactive mode.
 279 .It bootManager
 280 is set to one of
 281 .Ar boot
 282 to signify the installation of a boot manager,
 283 .Ar standard
 284 to signify installation of a "standard" non-boot MGR DOS
 285 MBR or
 286 .Ar none
 287 to indicate that no change to the boot manager is desired.
 288 Default: none.
 289 .It diskInteractive
 290 If set, bring up the interactive disk partition editor.
 291 .El
 292 .Pp
 293 Note: Nothing is actually written to disk by this function, an explicit call to
 294 .Ar diskPartitionWrite
 295 being required for that to happen.
 296 .It diskPartitionWrite
 297 Causes any pending MBR changes (typically from the
 298 .Ar diskPartitionEditor
 299 function) to be written out.
 300 .Pp
 301 .Sy Variables :
 302 None
 303 .It diskLabelEditor
 304 Invokes the disk label editor.
 305 This is a bit trickier from a script
 306 since you need to essentially label everything inside each
 307 .Fx
 308 (type 0xA5) partition created by the
 309 .Ar diskPartitionEditor
 310 function, and that requires knowing a few rules about how things are
 311 laid out.
 312 When creating a script to automatically allocate disk space
 313 and partition it up, it is suggested that you first perform the
 314 installation interactively at least once and take careful notes as to
 315 what the slice names will be, then and only then hardwiring them into
 316 the script.
 317 .Pp
 318 For example, let's say you have a SCSI disk on which you have created a new
 319 .Fx
 320 partition in slice 2 (your DOS partition residing in slice 1).
 321 The slice name would be
 322 .Ar da0s2
 323 for the whole
 324 .Fx
 325 partition
 326 .Ar ( da0s1
 327 being your DOS primary
 328 partition).
 329 Now let's further assume that you have 4GB in this
 330 partition and you want to sub-partition that space into root, swap,
 331 var and usr file systems for
 332 .Fx .
 333 Your invocation of the
 334 .Ar diskLabelEditor
 335 function might involve setting the following variables:
 336 .Bl -tag -width findx
 337 .It Li "da0s2-1=ufs 2097152 /"
 338 A 1GB root file system (all sizes are in 512 byte blocks).
 339 .It Li "da0s2-2=swap 1048576 /"
 340 A 512MB swap partition.
 341 .It Li "da0s2-3=ufs 524288 /var"
 342 A 256MB /var file system.
 343 .It Li "da0s2-4=ufs 0 /usr 1"
 344 With the balance of free space (around 2.25GB) going to the /usr
 345 file system and with soft-updates enabled (the argument following
 346 the mount point, if non-zero, means to set the soft updates flag).
 347 .El
 348 .Pp
 349 One can also use the
 350 .Ar diskLabelEditor
 351 for mounting or erasing existing partitions as well as creating new
 352 ones.
 353 Using the previous example again, let's say that we also wanted
 354 to mount our DOS partition and make sure that an
 355 .Pa /etc/fstab
 356 entry is created for it in the new installation.
 357 Before calling the
 358 .Ar diskLabelEditor
 359 function, we simply add an additional line:
 360 .Pp
 361 .Dl "da0s1=/dos_c N"
 362 .Pp
 363 before the call.
 364 This tells the label editor that you want to mount
 365 the first slice on
 366 .Pa /dos_c
 367 and not to attempt to newfs it (not that
 368 .Nm
 369 would attempt this for a DOS partition in any case, but it could just
 370 as easily be an existing UFS partition being named here and the 2nd
 371 field is non-optional).
 372 .Pp
 373 You can also set the
 374 .Ar diskInteractive
 375 variable to request that the disk label editor use an interactive dialog
 376 to partition the disk instead of using variables to explicitly layout the
 377 disk as described above.
 378 .Pp
 379 Note: No file system data is actually written to disk until an
 380 explicit call to
 381 .Ar diskLabelCommit
 382 is made.
 383 .It diskLabelCommit
 384 Writes out all pending disklabel information and creates and/or mounts any
 385 file systems which have requests pending from the
 386 .Ar diskLabelEditor
 387 function.
 388 .Pp
 389 .Sy Variables :
 390 None
 391 .It distReset
 392 Resets all selected distributions to the empty set (no distributions selected).
 393 .Pp
 394 .Sy Variables :
 395 None
 396 .It distSetCustom
 397 Allows the selection of a custom distribution set (e.g.\& not just one of the
 398 existing "canned" sets) with no user interaction.
 399 .Pp
 400 .Sy Variables :
 401 .Bl -tag -width indent
 402 .It dists
 403 List of distributions to load.
 404 Possible distribution values are:
 405 .Bl -tag -width indentxx
 406 .It Li base
 407 The base binary distribution.
 408 .It Li generic
 409 The GENERIC kernel.
 410 .It Li smp
 411 A kernel suitable for multiple processor systems.
 412 .It Li doc
 413 Miscellaneous documentation
 414 .It Li games
 415 Games
 416 .It Li manpages
 417 Manual pages (unformatted)
 418 .It Li catpages
 419 Pre-formatted manual pages
 420 .It Li proflibs
 421 Profiled libraries for developers.
 422 .It Li dict
 423 Dictionary information (for tools like spell).
 424 .It Li info
 425 GNU info files and other extra docs.
 426 .It Li lib32
 427 (amd64 only)
 428 32-bit runtime compatibility libraries.
 429 .It Li ports
 430 The ports collection.
 431 .It Li ssecure
 432 /usr/src/secure
 433 .It Li sbase
 434 /usr/src/[top level files]
 435 .It Li scontrib
 436 /usr/src/contrib
 437 .It Li sgnu
 438 /usr/src/gnu
 439 .It Li setc
 440 /usr/src/etc
 441 .It Li sgames
 442 /usr/src/games
 443 .It Li sinclude
 444 /usr/src/include
 445 .It Li skrb5
 446 /usr/src/kerberos5
 447 .It Li slib
 448 /usr/src/lib
 449 .It Li slibexec
 450 /usr/src/libexec
 451 .It Li srelease
 452 /usr/src/release
 453 .It Li srescue
 454 /usr/src/rescue
 455 .It Li stools
 456 /usr/src/tools
 457 .It Li sbin
 458 /usr/src/bin
 459 .It Li ssbin
 460 /usr/src/sbin
 461 .It Li sshare
 462 /usr/src/share
 463 .It Li ssys
 464 /usr/src/sys
 465 .It Li subin
 466 /usr/src/usr.bin
 467 .It Li susbin
 468 /usr/src/usr.sbin
 469 .It Li Xbin
 470 X.Org client applications.
 471 .It Li Xlib
 472 X.Org libraries.
 473 .It Li Xman
 474 X.Org manual pages.
 475 .It Li Xdoc
 476 X.Org protocol and library documentation.
 477 .It Li Xprog
 478 X.Org imake distribution.
 479 .It Li Xsrv
 480 X.Org X server.
 481 .It Li Xnest
 482 X.Org nested X server.
 483 .It Li Xprt
 484 X.Org print server.
 485 .It Li Xvfb
 486 X.Org virtual frame-buffer X server.
 487 .It Li Xfmsc
 488 X.Org miscellaneous font set.
 489 .It Li Xf75
 490 X.Org 75DPI font set.
 491 .It Li Xf100
 492 X.Org 100DPI font set.
 493 .It Li Xfcyr
 494 X.Org Cyrillic font set.
 495 .It Li Xft1
 496 X.Org Type 1 font set.
 497 .It Li Xftt
 498 X.Org TrueType font set.
 499 .It Li Xfs
 500 X.Org font server.
 501 .El
 502 .El
 503 .It distSetDeveloper
 504 Selects the standard Developer's distribution set.
 505 .Pp
 506 .Sy Variables :
 507 None
 508 .It distSetXDeveloper
 509 Selects the standard X Developer's distribution set.
 510 .Pp
 511 .Sy Variables :
 512 None
 513 .It distSetKernDeveloper
 514 Selects the standard kernel Developer's distribution set.
 515 .Pp
 516 .Sy Variables :
 517 None
 518 .It distSetUser
 519 Selects the standard user distribution set.
 520 .Pp
 521 .Sy Variables :
 522 None
 523 .It distSetXUser
 524 Selects the standard X user's distribution set.
 525 .Pp
 526 .Sy Variables :
 527 None
 528 .It distSetMinimum
 529 Selects the very minimum distribution set.
 530 .Pp
 531 .Sy Variables :
 532 None
 533 .It distSetEverything
 534 Selects the full whack - all available distributions.
 535 .Pp
 536 .Sy Variables :
 537 None
 538 .It distSetSrc
 539 Interactively select source subcomponents.
 540 .Pp
 541 .Sy Variables :
 542 None
 543 .It distSetXOrg
 544 Interactively select X.Org subcomponents.
 545 .Pp
 546 .Sy Variables :
 547 None
 548 .It distExtractAll
 549 Install all currently selected distributions (requires that
 550 media device also be selected).
 551 .Pp
 552 .Sy Variables :
 553 None
 554 .It docBrowser
 555 Install (if necessary) an HTML documentation browser and go to the
 556 HTML documentation submenu.
 557 .Pp
 558 .Sy Variables :
 559 .Bl -tag -width indent
 560 .It browserPackage
 561 The name of the browser package to try and install as necessary.
 562 Defaults to latest links package.
 563 .It browserBinary
 564 The name of the browser binary itself (if overriding the
 565 .Ar browserPackage
 566 variable).
 567 Defaults to links.
 568 .El
 569 .It installCommit
 570 Commit any and all pending changes to disk.
 571 This function
 572 is essentially shorthand for a number of more granular "commit"
 573 functions.
 574 .Pp
 575 .Sy Variables :
 576 None
 577 .It installExpress
 578 Start an "express" installation, asking few questions of
 579 the user.
 580 .Pp
 581 .Sy Variables :
 582 None
 583 .It installStandard
 584 Start a "standard" installation, the most user-friendly
 585 installation type available.
 586 .Pp
 587 .Sy Variables :
 588 None
 589 .It installUpgrade
 590 Start an upgrade installation.
 591 .Pp
 592 .Sy Variables :
 593 None
 594 .It installFixitHoloShell
 595 Start up the "emergency holographic shell" over on VTY4
 596 if running as init.
 597 This will also happen automatically
 598 as part of the installation process unless
 599 .Ar noHoloShell
 600 is set.
 601 .Pp
 602 .Sy Variables :
 603 None
 604 .It installFixitCDROM
 605 Go into "fixit" mode, assuming a live file system CDROM
 606 currently in the drive.
 607 .Pp
 608 .Sy Variables :
 609 None
 610 .It installFixitFloppy
 611 Go into "fixit" mode, assuming an available fixit floppy
 612 disk (user will be prompted for it).
 613 .Pp
 614 .Sy Variables :
 615 None
 616 .It installFilesystems
 617 Do just the file system initialization part of an install.
 618 .Pp
 619 .Sy Variables :
 620 None
 621 .It installVarDefaults
 622 Initialize all variables to their defaults, overriding any
 623 previous settings.
 624 .Pp
 625 .Sy Variables :
 626 None
 627 .It loadConfig
 628 Sort of like an #include statement, it allows you to load one
 629 configuration file from another.
 630 .Pp
 631 .Sy Variables :
 632 .Bl -tag -width indent
 633 .It configFile
 634 The fully qualified pathname of the file to load.
 635 .El
 636 .It mediaOpen
 637 If a media device is set, mount it.
 638 .Pp
 639 .Sy Variables :
 640 None
 641 .It mediaClose
 642 If a media device is open, close it.
 643 .Pp
 644 .Sy Variables :
 645 None
 646 .It mediaSetCDROM
 647 Select a
 648 .Fx
 649 CDROM as the installation media.
 650 .Pp
 651 .Sy Variables :
 652 None
 653 .It mediaSetFloppy
 654 Select a pre-made floppy installation set as the installation media.
 655 .Pp
 656 .Sy Variables :
 657 None
 658 .It mediaSetDOS
 659 Select an existing DOS primary partition as the installation media.
 660 The first primary partition found is used (e.g.\& C:).
 661 .Pp
 662 .Sy Variables :
 663 None
 664 .It mediaSetTape
 665 Select a tape device as the installation media.
 666 .Pp
 667 .Sy Variables :
 668 None
 669 .It mediaSetFTP
 670 Select an FTP site as the installation media.
 671 .Pp
 672 .Sy Variables :
 673 .Bl -tag -width indent
 674 .It hostname
 675 The name of the host being installed (non-optional).
 676 .It domainname
 677 The domain name of the host being installed (optional).
 678 .It defaultrouter
 679 The default router for this host (non-optional).
 680 .It netDev
 681 Which host interface to use
 682 .Ar ( ed0
 683 or
 684 .Ar ep0 ,
 685 for example.
 686 Non-optional).
 687 .It netInteractive
 688 If set, bring up the interactive network setup form even
 689 if all relevant configuration variables are already set (optional).
 690 .It ipaddr
 691 The IP address for the selected host interface (non-optional).
 692 .It netmask
 693 The netmask for the selected host interface (non-optional).
 694 .It _ftpPath
 695 The fully qualified URL of the FTP site containing the
 696 .Fx
 697 distribution you are interested in, e.g.\&
 698 .Ar ftp://ftp.FreeBSD.org/pub/FreeBSD/ .
 699 .El
 700 .It mediaSetFTPActive
 701 Alias for
 702 .Ar mediaSetFTP
 703 using "active" FTP transfer mode.
 704 .Pp
 705 .Sy Variables :
 706 Same as for
 707 .Ar mediaSetFTP .
 708 .It mediaSetFTPPassive
 709 Alias for
 710 .Ar mediaSetFTP
 711 using "passive" FTP transfer mode.
 712 .Pp
 713 .Sy Variables :
 714 Same as for
 715 .Ar mediaSetFTP .
 716 .It mediaSetHTTP
 717 Alias for
 718 .Ar mediaSetFTP
 719 using an HTTP proxy.
 720 .Pp
 721 .Sy Variables :
 722 See
 723 .Ar mediaSetFTP ,
 724 plus
 725 .Bl -tag -width indent
 726 .It _httpPath
 727 The proxy to use (host:port) (non-optional).
 728 .El
 729 .It mediaSetUFS
 730 Select an existing UFS partition (mounted with the label editor) as
 731 the installation media.
 732 .Pp
 733 .Sy Variables :
 734 .Bl -tag -width indent
 735 .It ufs
 736 full /path to directory containing the
 737 .Fx
 738 distribution you are
 739 interested in.
 740 .El
 741 .It mediaSetNFS
 742 .Pp
 743 .Sy Variables :
 744 .Bl -tag -width indent
 745 .It hostname
 746 The name of the host being installed (non-optional).
 747 .It domainname
 748 The domain name of the host being installed (optional).
 749 .It defaultrouter
 750 The default router for this host (non-optional).
 751 .It netDev
 752 Which host interface to use
 753 .Ar ( ed0
 754 or
 755 .Ar ep0 ,
 756 for example.
 757 Non-optional).
 758 .It netInteractive
 759 If set, bring up the interactive network setup form even
 760 if all relevant configuration variables are already set (optional).
 761 .It ipaddr
 762 The IP address for the selected host interface (non-optional).
 763 .It netmask
 764 The netmask for the selected host interface (non-optional).
 765 .It nfs
 766 full hostname:/path specification for directory containing
 767 the
 768 .Fx
 769 distribution you are interested in.
 770 .El
 771 .It mediaSetFTPUserPass
 772 .Pp
 773 .Sy Variables :
 774 .Bl -tag -width indent
 775 .It ftpUser
 776 The username to log in as on the ftp server site.
 777 Default: ftp
 778 .It ftpPass
 779 The password to use for this username on the ftp
 780 server site.
 781 Default: user@host
 782 .El
 783 .It mediaSetCPIOVerbosity
 784 .Pp
 785 .Sy Variables :
 786 .Bl -tag -width indent
 787 .It cpioVerbose
 788 Can be used to set the verbosity of cpio extractions to low, medium or
 789 high.
 790 .El
 791 .It mediaGetType
 792 Interactively get the user to specify some type of media.
 793 .Pp
 794 .Sy Variables :
 795 None
 796 .It optionsEditor
 797 Invoke the interactive options editor.
 798 .Pp
 799 .Sy Variables :
 800 None
 801 .It packageAdd
 802 Try to fetch and add a package to the system (requires
 803 that a media type be set),
 804 .Pp
 805 .Sy Variables :
 806 .Bl -tag -width indent
 807 .It package
 808 The name of the package to add, e.g.\& bash-1.14.7 or ncftp-2.4.2.
 809 .El
 810 .It addGroup
 811 Invoke the interactive group editor.
 812 .Pp
 813 .Sy Variables :
 814 None
 815 .It addUser
 816 Invoke the interactive user editor.
 817 .Pp
 818 .Sy Variables :
 819 None
 820 .It shutdown
 821 Stop the script, terminate sysinstall and reboot the system.
 822 On the sparc64 platform, the system is halted rather than rebooted.
 823 .Pp
 824 .Sy Variables :
 825 None
 826 .It system
 827 Execute an arbitrary command with
 828 .Xr system 3
 829 .Pp
 830 .Sy Variables :
 831 .Bl -tag -width indent
 832 .It command
 833 The name of the command to execute.
 834 When running
 835 from a boot floppy, very minimal expectations should
 836 be made as to what is available until/unless a relatively
 837 full system installation has just been done.
 838 .El
 839 .It tcpMenuSelect
 840 Configure a network device.
 841 .Pp
 842 .Sy Variables :
 843 Same as for
 844 .Ar mediaSetFTP
 845 except that
 846 .Ar _ftpPath
 847 is not used.
 848 .El
 849 .Sh DISTRIBUTION MEDIA
 850 The following files can be used to affect the operation of
 851 .Nm
 852 when used during initial system installation.
 853 .Bl -tag -width ".Pa packages/INDEX"
 854 .It Pa cdrom.inf
 855 A text file of properties, listed one per line, that describe the
 856 contents of the media in use.
 857 The syntax for each line is simply
 858 .Dq Ar property No = Ar value .
 859 Currently, only the following properties are recognized.
 860 .Bl -tag -width ".Va CD_MACHINE_ARCH"
 861 .It Va CD_VERSION
 862 This property should be set to the
 863 .Fx
 864 version on the current
 865 media volume.
 866 For example,
 867 .Dq Li "CD_VERSION = 5.3" .
 868 .It Va CD_MACHINE_ARCH
 869 This property should be set to the architecture of the contents on
 870 this volume.
 871 This property is normally only used with
 872 .Fx
 873 products that contain
 874 CDs for different architectures, to provide better error messages if
 875 users try to install Alpha packages on an i386 machine.
 876 For example,
 877 .Dq Li "CD_MACHINE_ARCH = alpha" .
 878 .It Va CD_VOLUME
 879 In a multi-volume collection (such as the
 880 .Fx
 881 4-CD set), the
 882 .Pa ports/INDEX
 883 file on each disc should contain the full package index for the set.
 884 The last field of the
 885 .Pa INDEX
 886 file denotes which volume the package
 887 appears on, and the
 888 .Va CD_VOLUME
 889 property here defines the volume ID of the current disc.
 890 .El
 891 .It Pa packages/INDEX
 892 The package index file.
 893 Each package is listed on a separate line with additional meta-data
 894 such as the required dependencies.
 895 This index is generated by
 896 .Dq Li "make index"
 897 from the
 898 .Xr ports 7
 899 collection.
 900 When multi-volume support is enabled, an additional field should be
 901 added to each line indicating which media volume contains the given
 902 package.
 903 .El
 904 .Pp
 905 For information about building a full release of
 906 .Fx ,
 907 please see
 908 .Xr release 7 .
 909 .Sh FILES
 910 This utility may edit the contents of
 911 .Pa /etc/rc.conf ,
 912 .Pa /etc/hosts ,
 913 and
 914 .Pa /etc/resolv.conf
 915 as necessary to reflect changes in the network configuration.
 916 .Sh SEE ALSO
 917 If you have a reasonably complete source tree online, take
 918 a look at
 919 .Pa /usr/src/usr.sbin/sysinstall/install.cfg
 920 for a sample installation script.
 921 .Sh HISTORY
 922 This version of
 923 .Nm
 924 first appeared in
 925 .Fx 2.0 .
 926 .Sh AUTHORS
 927 .An Jordan K. Hubbard Aq jkh@FreeBSD.org
 928 .Sh BUGS
 929 Editing slice and partition tables on disks which are currently mounted by
 930 the system is not allowed.
 931 This is generally only a problem when
 932 .Nm
 933 is run on a system that is already installed.
 934 Use
 935 .Xr fdisk 8
 936 and
 937 .Xr bsdlabel 8
 938 for these tasks.
 939 .Pp
 940 This utility is a prototype which lasted several years past
 941 its expiration date and is greatly in need of death.