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 .Bl -tag -width indent
 191 .It configAnonFTP
 192 Invoke the Anonymous FTP configuration menu.
 193 .Pp
 194 .Sy Variables :
 195 None
 196 .It configRouter
 197 Select which routing daemon you wish to use, potentially
 198 loading any required 3rd-party routing daemons as necessary.
 199 .Pp
 200 .Sy Variables :
 201 .Bl -tag -width indent
 202 .It router
 203 can be set to the name of the desired routing daemon,
 204 e.g.\&
 205 .Dq routed
 206 or
 207 .Dq gated ,
 208 otherwise it is prompted for.
 209 .El
 210 .It configNFSServer
 211 Configure host as an NFS server.
 212 .Pp
 213 .Sy Variables :
 214 None
 215 .It configNTP
 216 Configure host as a user of the Network Time Protocol.
 217 .Pp
 218 .Sy Variables :
 219 .Bl -tag -width indent
 220 .It ntpdate_hosts
 221 Whitespace-separated list of
 222 .Xr ntpdate 8
 223 servers to sync from.
 224 .El
 225 .It configPCNFSD
 226 Configure host to support PC NFS.
 227 .Pp
 228 .Sy Variables :
 229 .Bl -tag -width indent
 230 .It pcnfsd_pkg
 231 The name of the PCNFSD package to load if necessary (defaults to hard coded
 232 version).
 233 .El
 234 .It configPackages
 235 Bring up the interactive package management menu.
 236 .Pp
 237 .Sy Variables :
 238 None
 239 .It configUsers
 240 Add users and/or groups to the system.
 241 .Pp
 242 .Sy Variables :
 243 None
 244 .It diskPartitionEditor
 245 Invokes the disk partition (MBR) editor.
 246 .Pp
 247 .Sy Variables :
 248 .Bl -tag -width findx
 249 .It geometry
 250 The disk geometry, as a cyls/heads/sectors formatted string.
 251 The word "sane" instructs
 252 .Nm
 253 to calculate a safe (not necessarily optimal) geometry if the
 254 current one has more than 65535 cylinders, more than 256 heads or
 255 more than 63 sectors per track (255 sectors on the PC98
 256 architecture).
 257 Default: no
 258 change to geometry.
 259 .It partition
 260 Set to disk partitioning type or size, its value being
 261 .Ar free
 262 in order to use only remaining free space for
 263 .Fx ,
 264 .Ar all
 265 to use the entire disk for
 266 .Fx
 267 but maintain a proper partition
 268 table,
 269 .Ar existing
 270 to use an existing
 271 .Fx
 272 partition (first found),
 273 .Ar exclusive
 274 to use the disk in
 275 .Dq dangerously dedicated
 276 mode or, finally,
 277 .Ar somenumber
 278 to allocate
 279 .Ar somenumber
 280 blocks of available free space to a new
 281 .Fx
 282 partition.
 283 Default: Interactive mode.
 284 .It bootManager
 285 is set to one of
 286 .Ar boot
 287 to signify the installation of a boot manager,
 288 .Ar standard
 289 to signify installation of a "standard" non-boot MGR DOS
 290 MBR or
 291 .Ar none
 292 to indicate that no change to the boot manager is desired.
 293 Default: none.
 294 .It diskInteractive
 295 If set, bring up the interactive disk partition editor.
 296 .El
 297 .Pp
 298 Note: Nothing is actually written to disk by this function, an explicit call to
 299 .Ar diskPartitionWrite
 300 being required for that to happen.
 301 .It diskPartitionWrite
 302 Causes any pending MBR changes (typically from the
 303 .Ar diskPartitionEditor
 304 function) to be written out.
 305 .Pp
 306 .Sy Variables :
 307 None
 308 .It diskLabelEditor
 309 Invokes the disk label editor.
 310 This is a bit trickier from a script
 311 since you need to essentially label everything inside each
 312 .Fx
 313 (type 0xA5) partition created by the
 314 .Ar diskPartitionEditor
 315 function, and that requires knowing a few rules about how things are
 316 laid out.
 317 When creating a script to automatically allocate disk space
 318 and partition it up, it is suggested that you first perform the
 319 installation interactively at least once and take careful notes as to
 320 what the slice names will be, then and only then hardwiring them into
 321 the script.
 322 .Pp
 323 For example, let's say you have a SCSI disk on which you have created a new
 324 .Fx
 325 partition in slice 2 (your DOS partition residing in slice 1).
 326 The slice name would be
 327 .Ar da0s2
 328 for the whole
 329 .Fx
 330 partition
 331 .Ar ( da0s1
 332 being your DOS primary
 333 partition).
 334 Now let's further assume that you have 4GB in this
 335 partition and you want to sub-partition that space into root, swap,
 336 var and usr file systems for
 337 .Fx .
 338 Your invocation of the
 339 .Ar diskLabelEditor
 340 function might involve setting the following variables:
 341 .Bl -tag -width findx
 342 .It Li "da0s2-1=ufs 2097152 /"
 343 A 1GB root file system (all sizes are in 512 byte blocks).
 344 .It Li "da0s2-2=swap 1048576 /"
 345 A 512MB swap partition.
 346 .It Li "da0s2-3=ufs 524288 /var"
 347 A 256MB /var file system.
 348 .It Li "da0s2-4=ufs 0 /usr 1"
 349 With the balance of free space (around 2.25GB) going to the /usr
 350 file system and with soft-updates enabled (the argument following
 351 the mount point, if non-zero, means to set the soft updates flag).
 352 .El
 353 .Pp
 354 One can also use the
 355 .Ar diskLabelEditor
 356 for mounting or erasing existing partitions as well as creating new
 357 ones.
 358 Using the previous example again, let's say that we also wanted
 359 to mount our DOS partition and make sure that an
 360 .Pa /etc/fstab
 361 entry is created for it in the new installation.
 362 Before calling the
 363 .Ar diskLabelEditor
 364 function, we simply add an additional line:
 365 .Pp
 366 .Dl "da0s1=/dos_c N"
 367 .Pp
 368 before the call.
 369 This tells the label editor that you want to mount
 370 the first slice on
 371 .Pa /dos_c
 372 and not to attempt to newfs it (not that
 373 .Nm
 374 would attempt this for a DOS partition in any case, but it could just
 375 as easily be an existing UFS partition being named here and the 2nd
 376 field is non-optional).
 377 .Pp
 378 You can also set the
 379 .Ar diskInteractive
 380 variable to request that the disk label editor use an interactive dialog
 381 to partition the disk instead of using variables to explicitly layout the
 382 disk as described above.
 383 .Pp
 384 Note: No file system data is actually written to disk until an
 385 explicit call to
 386 .Ar diskLabelCommit
 387 is made.
 388 .It diskLabelCommit
 389 Writes out all pending disklabel information and creates and/or mounts any
 390 file systems which have requests pending from the
 391 .Ar diskLabelEditor
 392 function.
 393 .Pp
 394 .Sy Variables :
 395 None
 396 .It distReset
 397 Resets all selected distributions to the empty set (no distributions selected).
 398 .Pp
 399 .Sy Variables :
 400 None
 401 .It distSetCustom
 402 Allows the selection of a custom distribution set (e.g.\& not just one of the
 403 existing "canned" sets) with no user interaction.
 404 .Pp
 405 .Sy Variables :
 406 .Bl -tag -width indent
 407 .It dists
 408 List of distributions to load.
 409 Possible distribution values are:
 410 .Bl -tag -width indentxx
 411 .It Li base
 412 The base binary distribution.
 413 .It Li GENERIC
 414 The GENERIC kernel.
 415 .It Li doc
 416 Miscellaneous documentation
 417 .It Li games
 418 Games
 419 .It Li manpages
 420 Manual pages (unformatted)
 421 .It Li catpages
 422 Pre-formatted manual pages
 423 .It Li proflibs
 424 Profiled libraries for developers.
 425 .It Li dict
 426 Dictionary information (for tools like spell).
 427 .It Li info
 428 GNU info files and other extra docs.
 429 .It Li lib32
 430 (amd64 and powerpc64 only)
 431 32-bit runtime compatibility libraries.
 432 .It Li ports
 433 The ports collection.
 434 .It Li ssecure
 435 /usr/src/secure
 436 .It Li sbase
 437 /usr/src/[top level files]
 438 .It Li scontrib
 439 /usr/src/contrib
 440 .It Li scrypto
 441 /usr/src/crypto
 442 .It Li sgnu
 443 /usr/src/gnu
 444 .It Li setc
 445 /usr/src/etc
 446 .It Li sgames
 447 /usr/src/games
 448 .It Li sinclude
 449 /usr/src/include
 450 .It Li skrb5
 451 /usr/src/kerberos5
 452 .It Li slib
 453 /usr/src/lib
 454 .It Li slibexec
 455 /usr/src/libexec
 456 .It Li srelease
 457 /usr/src/release
 458 .It Li srescue
 459 /usr/src/rescue
 460 .It Li stools
 461 /usr/src/tools
 462 .It Li sbin
 463 /usr/src/bin
 464 .It Li ssbin
 465 /usr/src/sbin
 466 .It Li sshare
 467 /usr/src/share
 468 .It Li ssys
 469 /usr/src/sys
 470 .It Li stools
 471 /usr/src/tools
 472 .It Li subin
 473 /usr/src/usr.bin
 474 .It Li susbin
 475 /usr/src/usr.sbin
 476 .It Li local
 477 Local additions collection.
 478 .El
 479 .El
 480 .It distSetDeveloper
 481 Selects the standard Developer's distribution set.
 482 .Pp
 483 .Sy Variables :
 484 None
 485 .It distSetUser
 486 Selects the standard user distribution set.
 487 .Pp
 488 .Sy Variables :
 489 None
 490 .It distSetMinimum
 491 Selects the very minimum distribution set.
 492 .Pp
 493 .Sy Variables :
 494 None
 495 .It distSetEverything
 496 Selects the full whack - all available distributions.
 497 .Pp
 498 .Sy Variables :
 499 None
 500 .It distSetSrc
 501 Interactively select source subcomponents.
 502 .Pp
 503 .Sy Variables :
 504 None
 505 .It distExtractAll
 506 Install all currently selected distributions (requires that
 507 media device also be selected).
 508 .Pp
 509 .Sy Variables :
 510 None
 511 .It docBrowser
 512 Install (if necessary) an HTML documentation browser and go to the
 513 HTML documentation submenu.
 514 .Pp
 515 .Sy Variables :
 516 .Bl -tag -width indent
 517 .It browserPackage
 518 The name of the browser package to try and install as necessary.
 519 Defaults to latest links package.
 520 .It browserBinary
 521 The name of the browser binary itself (if overriding the
 522 .Ar browserPackage
 523 variable).
 524 Defaults to links.
 525 .El
 526 .It installCommit
 527 Commit any and all pending changes to disk.
 528 This function
 529 is essentially shorthand for a number of more granular "commit"
 530 functions.
 531 .Pp
 532 .Sy Variables :
 533 None
 534 .It installConfigure
 535 Commit any rc.conf changes to disk.
 536 .Pp
 537 .Sy Variables :
 538 .Bl -tag -width indent
 539 .It keeprcconf
 540 Preserve existing rc.conf parameters.
 541 This is useful if you have a post-install script which modifies rc.conf.
 542 .El
 543 .It installExpress
 544 Start an "express" installation, asking few questions of
 545 the user.
 546 .Pp
 547 .Sy Variables :
 548 None
 549 .It installStandard
 550 Start a "standard" installation, the most user-friendly
 551 installation type available.
 552 .Pp
 553 .Sy Variables :
 554 None
 555 .It installUpgrade
 556 Start an upgrade installation.
 557 .Pp
 558 .Sy Variables :
 559 None
 560 .It installFixitHoloShell
 561 Start up the "emergency holographic shell" over on VTY4
 562 if running as init.
 563 This will also happen automatically
 564 as part of the installation process unless
 565 .Ar noHoloShell
 566 is set.
 567 .Pp
 568 .Sy Variables :
 569 None
 570 .It installFixitCDROM
 571 Go into "fixit" mode, assuming a live file system CDROM
 572 currently in the drive.
 573 .Pp
 574 .Sy Variables :
 575 None
 576 .It installFixitFloppy
 577 Go into "fixit" mode, assuming an available fixit floppy
 578 disk (user will be prompted for it).
 579 .Pp
 580 .Sy Variables :
 581 None
 582 .It installFilesystems
 583 Do just the file system initialization part of an install.
 584 .Pp
 585 .Sy Variables :
 586 None
 587 .It installVarDefaults
 588 Initialize all variables to their defaults, overriding any
 589 previous settings.
 590 .Pp
 591 .Sy Variables :
 592 None
 593 .It loadConfig
 594 Sort of like an #include statement, it allows you to load one
 595 configuration file from another.
 596 .Pp
 597 .Sy Variables :
 598 .Bl -tag -width indent
 599 .It configFile
 600 The fully qualified pathname of the file to load.
 601 .El
 602 .It mediaOpen
 603 If a media device is set, mount it.
 604 .Pp
 605 .Sy Variables :
 606 None
 607 .It mediaClose
 608 If a media device is open, close it.
 609 .Pp
 610 .Sy Variables :
 611 None
 612 .It mediaSetCDROM
 613 Select a
 614 .Fx
 615 CDROM as the installation media.
 616 .Pp
 617 .Sy Variables :
 618 None
 619 .It mediaSetFloppy
 620 Select a pre-made floppy installation set as the installation media.
 621 .Pp
 622 .Sy Variables :
 623 None
 624 .It mediaSetDOS
 625 Select an existing DOS primary partition as the installation media.
 626 The first primary partition found is used (e.g.\& C:).
 627 .Pp
 628 .Sy Variables :
 629 None
 630 .It mediaSetFTP
 631 Select an FTP site as the installation media.
 632 .Pp
 633 .Sy Variables :
 634 .Bl -tag -width indent
 635 .It hostname
 636 The name of the host being installed (non-optional).
 637 .It domainname
 638 The domain name of the host being installed (optional).
 639 .It defaultrouter
 640 The default router for this host (non-optional).
 641 .It netDev
 642 Which network interface to use.
 643 Multiple network interfaces may be specified using a comma delimited list.
 644 If netDev is set to ANY, all available network interfaces will be probed and the
 645 first interface found to have a link will be used. (non-optional).
 646 .It netInteractive
 647 If set, bring up the interactive network setup form even
 648 if all relevant configuration variables are already set (optional).
 649 .It ipaddr
 650 The IP address for the selected host interface (non-optional).
 651 .It netmask
 652 The netmask for the selected host interface (non-optional).
 653 .It _ftpPath
 654 The fully qualified URL of the FTP site containing the
 655 .Fx
 656 distribution you are interested in, e.g.\&
 657 .Ar ftp://ftp.FreeBSD.org/pub/FreeBSD/ .
 658 .El
 659 .It mediaSetFTPActive
 660 Alias for
 661 .Ar mediaSetFTP
 662 using "active" FTP transfer mode.
 663 .Pp
 664 .Sy Variables :
 665 Same as for
 666 .Ar mediaSetFTP .
 667 .It mediaSetFTPPassive
 668 Alias for
 669 .Ar mediaSetFTP
 670 using "passive" FTP transfer mode.
 671 .Pp
 672 .Sy Variables :
 673 Same as for
 674 .Ar mediaSetFTP .
 675 .It mediaSetHTTP
 676 Alias for
 677 .Ar mediaSetFTP
 678 using an HTTP proxy.
 679 .Pp
 680 .Sy Variables :
 681 See
 682 .Ar mediaSetFTP ,
 683 plus
 684 .Bl -tag -width indent
 685 .It _httpPath
 686 The proxy to use (host:port) (non-optional).
 687 .It httpDirectory
 688 The path from http root.
 689 .El
 690 .It mediaSetUFS
 691 Select an existing UFS partition (mounted with the label editor) as
 692 the installation media.
 693 .Pp
 694 .Sy Variables :
 695 .Bl -tag -width indent
 696 .It ufs
 697 full /path to directory containing the
 698 .Fx
 699 distribution you are
 700 interested in.
 701 .El
 702 .It mediaSetNFS
 703 .Pp
 704 .Sy Variables :
 705 .Bl -tag -width indent
 706 .It hostname
 707 The name of the host being installed (non-optional).
 708 .It domainname
 709 The domain name of the host being installed (optional).
 710 .It defaultrouter
 711 The default router for this host (non-optional).
 712 .It netDev
 713 Which host interface to use
 714 .Ar ( ed0
 715 or
 716 .Ar ep0 ,
 717 for example.
 718 Non-optional).
 719 .It netInteractive
 720 If set, bring up the interactive network setup form even
 721 if all relevant configuration variables are already set (optional).
 722 .It ipaddr
 723 The IP address for the selected host interface (non-optional).
 724 .It netmask
 725 The netmask for the selected host interface (non-optional).
 726 .It nfs
 727 full hostname:/path specification for directory containing
 728 the
 729 .Fx
 730 distribution you are interested in.
 731 .El
 732 .It mediaSetFTPUserPass
 733 .Pp
 734 .Sy Variables :
 735 .Bl -tag -width indent
 736 .It ftpUser
 737 The username to log in as on the ftp server site.
 738 Default: ftp
 739 .It ftpPass
 740 The password to use for this username on the ftp
 741 server site.
 742 Default: user@host
 743 .El
 744 .It mediaSetCPIOVerbosity
 745 .Pp
 746 .Sy Variables :
 747 .Bl -tag -width indent
 748 .It cpioVerbose
 749 Can be used to set the verbosity of cpio extractions to low or high.
 750 .El
 751 .It mediaGetType
 752 Interactively get the user to specify some type of media.
 753 .Pp
 754 .Sy Variables :
 755 None
 756 .It optionsEditor
 757 Invoke the interactive options editor.
 758 .Pp
 759 .Sy Variables :
 760 None
 761 .It packageAdd
 762 Try to fetch and add a package to the system (requires
 763 that a media type be set),
 764 .Pp
 765 .Sy Variables :
 766 .Bl -tag -width indent
 767 .It package
 768 The name of the package to add, e.g.\& bash-1.14.7 or ncftp-2.4.2.
 769 .El
 770 .It addGroup
 771 Invoke the interactive group editor.
 772 .Pp
 773 .Sy Variables :
 774 None
 775 .It addUser
 776 Invoke the interactive user editor.
 777 .Pp
 778 .Sy Variables :
 779 None
 780 .It shutdown
 781 Stop the script, terminate sysinstall and reboot the system.
 782 On the sparc64 platform, the system is halted rather than rebooted.
 783 .Pp
 784 .Sy Variables :
 785 None
 786 .It system
 787 Execute an arbitrary command with
 788 .Xr system 3
 789 .Pp
 790 .Sy Variables :
 791 .Bl -tag -width indent
 792 .It command
 793 The name of the command to execute.
 794 When running
 795 from a boot floppy, very minimal expectations should
 796 be made as to what is available until/unless a relatively
 797 full system installation has just been done.
 798 .El
 799 .It tcpMenuSelect
 800 Configure a network device.
 801 .Pp
 802 .Sy Variables :
 803 Same as for
 804 .Ar mediaSetFTP
 805 except that
 806 .Ar _ftpPath
 807 is not used.
 808 .El
 809 .Sh DISTRIBUTION MEDIA
 810 The following files can be used to affect the operation of
 811 .Nm
 812 when used during initial system installation.
 813 .Bl -tag -width ".Pa packages/INDEX"
 814 .It Pa cdrom.inf
 815 A text file of properties, listed one per line, that describe the
 816 contents of the media in use.
 817 The syntax for each line is simply
 818 .Dq Ar property No = Ar value .
 819 Currently, only the following properties are recognized.
 820 .Bl -tag -width ".Va CD_MACHINE_ARCH"
 821 .It Va CD_VERSION
 822 This property should be set to the
 823 .Fx
 824 version on the current
 825 media volume.
 826 For example,
 827 .Dq Li "CD_VERSION = 5.3" .
 828 .It Va CD_MACHINE_ARCH
 829 This property should be set to the architecture of the contents on
 830 this volume.
 831 This property is normally only used with
 832 .Fx
 833 products that contain
 834 CDs for different architectures, to provide better error messages if
 835 users try to install packages built for the wrong architecture.
 836 For example,
 837 .Dq Li "CD_MACHINE_ARCH = amd64" .
 838 .It Va CD_VOLUME
 839 In a multi-volume collection (such as the
 840 .Fx
 841 4-CD set), the
 842 .Pa ports/INDEX
 843 file on each disc should contain the full package index for the set.
 844 The last field of the
 845 .Pa INDEX
 846 file denotes which volume the package
 847 appears on, and the
 848 .Va CD_VOLUME
 849 property here defines the volume ID of the current disc.
 850 .El
 851 .It Pa packages/INDEX
 852 The package index file.
 853 Each package is listed on a separate line with additional meta-data
 854 such as the required dependencies.
 855 This index is generated by
 856 .Dq Li "make index"
 857 from the
 858 .Xr ports 7
 859 collection.
 860 When multi-volume support is enabled, an additional field should be
 861 added to each line indicating which media volume contains the given
 862 package.
 863 .El
 864 .Pp
 865 For information about building a full release of
 866 .Fx ,
 867 please see
 868 .Xr release 7 .
 869 .Sh FILES
 870 This utility may edit the contents of
 871 .Pa /etc/rc.conf ,
 872 .Pa /etc/hosts ,
 873 and
 874 .Pa /etc/resolv.conf
 875 as necessary to reflect changes in the network configuration.
 876 .Sh SEE ALSO
 877 If you have a reasonably complete source tree online, take
 878 a look at
 879 .Pa /usr/src/usr.sbin/sysinstall/install.cfg
 880 for a sample installation script.
 881 .Sh HISTORY
 882 This version of
 883 .Nm
 884 first appeared in
 885 .Fx 2.0 .
 886 .Sh AUTHORS
 887 .An Jordan K. Hubbard Aq jkh@FreeBSD.org
 888 .Sh BUGS
 889 Editing slice and partition tables on disks which are currently mounted by
 890 the system is not allowed.
 891 This is generally only a problem when
 892 .Nm
 893 is run on a system that is already installed.
 894 Use
 895 .Xr fdisk 8
 896 and
 897 .Xr bsdlabel 8
 898 for these tasks.
 899 .Pp
 900 There are a (great) number of undocumented variables.
 901 UTSL.