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