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 July 17, 2005
  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 500MB 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 40960 /"
 338 A 20MB root file system (all sizes are in 512 byte blocks).
 339 .It Li "da0s2-2=swap 131072 /"
 340 A 64MB swap partition.
 341 .It Li "da0s2-3=ufs 204800 /var"
 342 A 100MB /var file system.
 343 .It Li "da0s2-4=ufs 0 /usr 1"
 344 With the balance of free space (around 316MB) 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 doc
 409 Miscellaneous documentation
 410 .It Li games
 411 Games
 412 .It Li manpages
 413 Manual pages (unformatted)
 414 .It Li catpages
 415 Pre-formatted manual pages
 416 .It Li proflibs
 417 Profiled libraries for developers.
 418 .It Li dict
 419 Dictionary information (for tools like spell).
 420 .It Li info
 421 GNU info files and other extra docs.
 422 .It Li lib32
 423 (amd64 only)
 424 32-bit runtime compatibility libraries.
 425 .It Li ports
 426 The ports collection.
 427 .It Li ssecure
 428 /usr/src/secure
 429 .It Li sbase
 430 /usr/src/[top level files]
 431 .It Li scontrib
 432 /usr/src/contrib
 433 .It Li sgnu
 434 /usr/src/gnu
 435 .It Li setc
 436 /usr/src/etc
 437 .It Li sgames
 438 /usr/src/games
 439 .It Li sinclude
 440 /usr/src/include
 441 .It Li skrb5
 442 /usr/src/kerberos5
 443 .It Li slib
 444 /usr/src/lib
 445 .It Li slibexec
 446 /usr/src/libexec
 447 .It Li srelease
 448 /usr/src/release
 449 .It Li srescue
 450 /usr/src/rescue
 451 .It Li sbin
 452 /usr/src/bin
 453 .It Li ssbin
 454 /usr/src/sbin
 455 .It Li sshare
 456 /usr/src/share
 457 .It Li ssys
 458 /usr/src/sys
 459 .It Li subin
 460 /usr/src/usr.bin
 461 .It Li susbin
 462 /usr/src/usr.sbin
 463 .It Li ssmailcf
 464 /usr/src/usr.sbin/sendmail/cf
 465 .It Li Xbin
 466 X.Org client applications.
 467 .It Li Xlib
 468 X.Org libraries.
 469 .It Li Xman
 470 X.Org manual pages.
 471 .It Li Xdoc
 472 X.Org protocol and library documentation.
 473 .It Li Xprog
 474 X.Org imake distribution.
 475 .It Li Xsrv
 476 X.Org X server.
 477 .It Li Xnest
 478 X.Org nested X server.
 479 .It Li Xprt
 480 X.Org print server.
 481 .It Li Xvfb
 482 X.Org virtual frame-buffer X server.
 483 .It Li Xfmsc
 484 X.Org miscellaneous font set.
 485 .It Li Xf75
 486 X.Org 75DPI font set.
 487 .It Li Xf100
 488 X.Org 100DPI font set.
 489 .It Li Xfcyr
 490 X.Org Cyrillic font set.
 491 .It Li Xft1
 492 X.Org Type 1 font set.
 493 .It Li Xftt
 494 X.Org TrueType font set.
 495 .It Li Xfs
 496 X.Org font server.
 497 .El
 498 .El
 499 .It distSetDeveloper
 500 Selects the standard Developer's distribution set.
 501 .Pp
 502 .Sy Variables :
 503 None
 504 .It distSetXDeveloper
 505 Selects the standard X Developer's distribution set.
 506 .Pp
 507 .Sy Variables :
 508 None
 509 .It distSetKernDeveloper
 510 Selects the standard kernel Developer's distribution set.
 511 .Pp
 512 .Sy Variables :
 513 None
 514 .It distSetUser
 515 Selects the standard user distribution set.
 516 .Pp
 517 .Sy Variables :
 518 None
 519 .It distSetXUser
 520 Selects the standard X user's distribution set.
 521 .Pp
 522 .Sy Variables :
 523 None
 524 .It distSetMinimum
 525 Selects the very minimum distribution set.
 526 .Pp
 527 .Sy Variables :
 528 None
 529 .It distSetEverything
 530 Selects the full whack - all available distributions.
 531 .Pp
 532 .Sy Variables :
 533 None
 534 .It distSetSrc
 535 Interactively select source subcomponents.
 536 .Pp
 537 .Sy Variables :
 538 None
 539 .It distSetXOrg
 540 Interactively select X.Org subcomponents.
 541 .Pp
 542 .Sy Variables :
 543 None
 544 .It distExtractAll
 545 Install all currently selected distributions (requires that
 546 media device also be selected).
 547 .Pp
 548 .Sy Variables :
 549 None
 550 .It docBrowser
 551 Install (if necessary) an HTML documentation browser and go to the
 552 HTML documentation submenu.
 553 .Pp
 554 .Sy Variables :
 555 .Bl -tag -width indent
 556 .It browserPackage
 557 The name of the browser package to try and install as necessary.
 558 Defaults to latest links package.
 559 .It browserBinary
 560 The name of the browser binary itself (if overriding the
 561 .Ar browserPackage
 562 variable).
 563 Defaults to links.
 564 .El
 565 .It installCommit
 566 Commit any and all pending changes to disk.
 567 This function
 568 is essentially shorthand for a number of more granular "commit"
 569 functions.
 570 .Pp
 571 .Sy Variables :
 572 None
 573 .It installExpress
 574 Start an "express" installation, asking few questions of
 575 the user.
 576 .Pp
 577 .Sy Variables :
 578 None
 579 .It installStandard
 580 Start a "standard" installation, the most user-friendly
 581 installation type available.
 582 .Pp
 583 .Sy Variables :
 584 None
 585 .It installUpgrade
 586 Start an upgrade installation.
 587 .Pp
 588 .Sy Variables :
 589 None
 590 .It installFixitHoloShell
 591 Start up the "emergency holographic shell" over on VTY4
 592 if running as init.
 593 This will also happen automatically
 594 as part of the installation process unless
 595 .Ar noHoloShell
 596 is set.
 597 .Pp
 598 .Sy Variables :
 599 None
 600 .It installFixitCDROM
 601 Go into "fixit" mode, assuming a live file system CDROM
 602 currently in the drive.
 603 .Pp
 604 .Sy Variables :
 605 None
 606 .It installFixitFloppy
 607 Go into "fixit" mode, assuming an available fixit floppy
 608 disk (user will be prompted for it).
 609 .Pp
 610 .Sy Variables :
 611 None
 612 .It installFilesystems
 613 Do just the file system initialization part of an install.
 614 .Pp
 615 .Sy Variables :
 616 None
 617 .It installVarDefaults
 618 Initialize all variables to their defaults, overriding any
 619 previous settings.
 620 .Pp
 621 .Sy Variables :
 622 None
 623 .It loadConfig
 624 Sort of like an #include statement, it allows you to load one
 625 configuration file from another.
 626 .Pp
 627 .Sy Variables :
 628 .Bl -tag -width indent
 629 .It configFile
 630 The fully qualified pathname of the file to load.
 631 .El
 632 .It mediaOpen
 633 If a media device is set, mount it.
 634 .Pp
 635 .Sy Variables :
 636 None
 637 .It mediaClose
 638 If a media device is open, close it.
 639 .Pp
 640 .Sy Variables :
 641 None
 642 .It mediaSetCDROM
 643 Select a
 644 .Fx
 645 CDROM as the installation media.
 646 .Pp
 647 .Sy Variables :
 648 None
 649 .It mediaSetFloppy
 650 Select a pre-made floppy installation set as the installation media.
 651 .Pp
 652 .Sy Variables :
 653 None
 654 .It mediaSetDOS
 655 Select an existing DOS primary partition as the installation media.
 656 The first primary partition found is used (e.g.\& C:).
 657 .Pp
 658 .Sy Variables :
 659 None
 660 .It mediaSetTape
 661 Select a tape device as the installation media.
 662 .Pp
 663 .Sy Variables :
 664 None
 665 .It mediaSetFTP
 666 Select an FTP site as the installation media.
 667 .Pp
 668 .Sy Variables :
 669 .Bl -tag -width indent
 670 .It hostname
 671 The name of the host being installed (non-optional).
 672 .It domainname
 673 The domain name of the host being installed (optional).
 674 .It defaultrouter
 675 The default router for this host (non-optional).
 676 .It netDev
 677 Which host interface to use
 678 .Ar ( ed0
 679 or
 680 .Ar ep0 ,
 681 for example.
 682 Non-optional).
 683 .It netInteractive
 684 If set, bring up the interactive network setup form even
 685 if all relevant configuration variables are already set (optional).
 686 .It ipaddr
 687 The IP address for the selected host interface (non-optional).
 688 .It netmask
 689 The netmask for the selected host interface (non-optional).
 690 .It _ftpPath
 691 The fully qualified URL of the FTP site containing the
 692 .Fx
 693 distribution you are interested in, e.g.\&
 694 .Ar ftp://ftp.FreeBSD.org/pub/FreeBSD/ .
 695 .El
 696 .It mediaSetFTPActive
 697 Alias for
 698 .Ar mediaSetFTP
 699 using "active" FTP transfer mode.
 700 .Pp
 701 .Sy Variables :
 702 Same as for
 703 .Ar mediaSetFTP .
 704 .It mediaSetFTPPassive
 705 Alias for
 706 .Ar mediaSetFTP
 707 using "passive" FTP transfer mode.
 708 .Pp
 709 .Sy Variables :
 710 Same as for
 711 .Ar mediaSetFTP .
 712 .It mediaSetHTTP
 713 Alias for
 714 .Ar mediaSetFTP
 715 using an HTTP proxy.
 716 .Pp
 717 .Sy Variables :
 718 See
 719 .Ar mediaSetFTP ,
 720 plus
 721 .Bl -tag -width indent
 722 .It _httpPath
 723 The proxy to use (host:port) (non-optional).
 724 .El
 725 .It mediaSetUFS
 726 Select an existing UFS partition (mounted with the label editor) as
 727 the installation media.
 728 .Pp
 729 .Sy Variables :
 730 .Bl -tag -width indent
 731 .It ufs
 732 full /path to directory containing the
 733 .Fx
 734 distribution you are
 735 interested in.
 736 .El
 737 .It mediaSetNFS
 738 .Pp
 739 .Sy Variables :
 740 .Bl -tag -width indent
 741 .It hostname
 742 The name of the host being installed (non-optional).
 743 .It domainname
 744 The domain name of the host being installed (optional).
 745 .It defaultrouter
 746 The default router for this host (non-optional).
 747 .It netDev
 748 Which host interface to use
 749 .Ar ( ed0
 750 or
 751 .Ar ep0 ,
 752 for example.
 753 Non-optional).
 754 .It netInteractive
 755 If set, bring up the interactive network setup form even
 756 if all relevant configuration variables are already set (optional).
 757 .It ipaddr
 758 The IP address for the selected host interface (non-optional).
 759 .It netmask
 760 The netmask for the selected host interface (non-optional).
 761 .It nfs
 762 full hostname:/path specification for directory containing
 763 the
 764 .Fx
 765 distribution you are interested in.
 766 .El
 767 .It mediaSetFTPUserPass
 768 .Pp
 769 .Sy Variables :
 770 .Bl -tag -width indent
 771 .It ftpUser
 772 The username to log in as on the ftp server site.
 773 Default: ftp
 774 .It ftpPass
 775 The password to use for this username on the ftp
 776 server site.
 777 Default: user@host
 778 .El
 779 .It mediaSetCPIOVerbosity
 780 .Pp
 781 .Sy Variables :
 782 .Bl -tag -width indent
 783 .It cpioVerbose
 784 Can be used to set the verbosity of cpio extractions to low, medium or
 785 high.
 786 .El
 787 .It mediaGetType
 788 Interactively get the user to specify some type of media.
 789 .Pp
 790 .Sy Variables :
 791 None
 792 .It optionsEditor
 793 Invoke the interactive options editor.
 794 .Pp
 795 .Sy Variables :
 796 None
 797 .It packageAdd
 798 Try to fetch and add a package to the system (requires
 799 that a media type be set),
 800 .Pp
 801 .Sy Variables :
 802 .Bl -tag -width indent
 803 .It package
 804 The name of the package to add, e.g.\& bash-1.14.7 or ncftp-2.4.2.
 805 .El
 806 .It addGroup
 807 Invoke the interactive group editor.
 808 .Pp
 809 .Sy Variables :
 810 None
 811 .It addUser
 812 Invoke the interactive user editor.
 813 .Pp
 814 .Sy Variables :
 815 None
 816 .It shutdown
 817 Stop the script and terminate sysinstall.
 818 .Pp
 819 .Sy Variables :
 820 None
 821 .It system
 822 Execute an arbitrary command with
 823 .Xr system 3
 824 .Pp
 825 .Sy Variables :
 826 .Bl -tag -width indent
 827 .It command
 828 The name of the command to execute.
 829 When running
 830 from a boot floppy, very minimal expectations should
 831 be made as to what is available until/unless a relatively
 832 full system installation has just been done.
 833 .El
 834 .It tcpMenuSelect
 835 Configure a network device.
 836 .Pp
 837 .Sy Variables :
 838 Same as for
 839 .Ar mediaSetFTP
 840 except that
 841 .Ar _ftpPath
 842 is not used.
 843 .El
 844 .Sh DISTRIBUTION MEDIA
 845 The following files can be used to affect the operation of
 846 .Nm
 847 when used during initial system installation.
 848 .Bl -tag -width ".Pa packages/INDEX"
 849 .It Pa cdrom.inf
 850 A text file of properties, listed one per line, that describe the
 851 contents of the media in use.
 852 The syntax for each line is simply
 853 .Dq Ar property No = Ar value .
 854 Currently, only the following properties are recognized.
 855 .Bl -tag -width ".Va CD_MACHINE_ARCH"
 856 .It Va CD_VERSION
 857 This property should be set to the
 858 .Fx
 859 version on the current
 860 media volume.
 861 For example,
 862 .Dq Li "CD_VERSION = 5.3" .
 863 .It Va CD_MACHINE_ARCH
 864 This property should be set to the architecture of the contents on
 865 this volume.
 866 This property is normally only used with
 867 .Fx
 868 products that contain
 869 CDs for different architectures, to provide better error messages if
 870 users try to install Alpha packages on an i386 machine.
 871 For example,
 872 .Dq Li "CD_MACHINE_ARCH = alpha" .
 873 .It Va CD_VOLUME
 874 In a multi-volume collection (such as the
 875 .Fx
 876 4-CD set), the
 877 .Pa ports/INDEX
 878 file on each disc should contain the full package index for the set.
 879 The last field of the
 880 .Pa INDEX
 881 file denotes which volume the package
 882 appears on, and the
 883 .Va CD_VOLUME
 884 property here defines the volume ID of the current disc.
 885 .El
 886 .It Pa packages/INDEX
 887 The package index file.
 888 Each package is listed on a separate line with additional meta-data
 889 such as the required dependencies.
 890 This index is generated by
 891 .Dq Li "make index"
 892 from the
 893 .Xr ports 7
 894 collection.
 895 When multi-volume support is enabled, an additional field should be
 896 added to each line indicating which media volume contains the given
 897 package.
 898 .El
 899 .Pp
 900 For information about building a full release of
 901 .Fx ,
 902 please see
 903 .Xr release 7 .
 904 .Sh FILES
 905 This utility may edit the contents of
 906 .Pa /etc/rc.conf ,
 907 .Pa /etc/hosts ,
 908 and
 909 .Pa /etc/resolv.conf
 910 as necessary to reflect changes in the network configuration.
 911 .Sh SEE ALSO
 912 If you have a reasonably complete source tree online, take
 913 a look at
 914 .Pa /usr/src/usr.sbin/sysinstall/install.cfg
 915 for a sample installation script.
 916 .Sh HISTORY
 917 This version of
 918 .Nm
 919 first appeared in
 920 .Fx 2.0 .
 921 .Sh AUTHORS
 922 .An Jordan K. Hubbard Aq jkh@FreeBSD.org
 923 .Sh BUGS
 924 Editing slice and partition tables on disks which are currently mounted by
 925 the system is not allowed.
 926 This is generally only a problem when
 927 .Nm
 928 is run on a system that is already installed.
 929 Use
 930 .Xr fdisk 8
 931 and
 932 .Xr bsdlabel 8
 933 for these tasks.
 934 .Pp
 935 This utility is a prototype which lasted several years past
 936 its expiration date and is greatly in need of death.