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