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