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