release/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: src/release/sysinstall/sysinstall.8,v 1.31.2.15 2002/07/03 21:19:29 jhb Exp $
  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 earlier releases of
 440 .Fx
 441 4.x)
 442 .It Li ports
 443 The ports collection.
 444 .It Li krb4
 445 KerberosIV binaries.
 446 .It Li krb5
 447 Kerberos5 binaries.
 448 .It Li ssecure
 449 /usr/src/secure
 450 .It Li sbase
 451 /usr/src/[top level files]
 452 .It Li scontrib
 453 /usr/src/contrib
 454 .It Li sgnu
 455 /usr/src/gnu
 456 .It Li setc
 457 /usr/src/etc
 458 .It Li sgames
 459 /usr/src/games
 460 .It Li sinclude
 461 /usr/src/include
 462 .It Li slib
 463 /usr/src/lib
 464 .It Li slibexec
 465 /usr/src/libexec
 466 .It Li srelease
 467 /usr/src/release
 468 .It Li sbin
 469 /usr/src/bin
 470 .It Li ssbin
 471 /usr/src/sbin
 472 .It Li sshare
 473 /usr/src/share
 474 .It Li ssys
 475 /usr/src/sys
 476 .It Li subin
 477 /usr/src/usr.bin
 478 .It Li susbin
 479 /usr/src/usr.sbin
 480 .It Li ssmailcf
 481 /usr/src/usr.sbin/sendmail/cf
 482 .It Li XF86-xc
 483 XFree86 official sources.
 484 .It Li XF86-co
 485 XFree86 contributed sources.
 486 .It Li Xbin
 487 XFree86 binaries.
 488 .It Li Xcfg
 489 XFree86 configuration files.
 490 .It Li Xdoc
 491 XFree86 documentation.
 492 .It Li Xhtml
 493 XFree86 HTML documentation.
 494 .It Li Xlib
 495 XFree86 libraries.
 496 .It Li Xlk98
 497 XFree86 server link-kit for PC98 machines.
 498 .It Li Xlkit
 499 XFree86 server link-kit for standard machines.
 500 .It Li Xman
 501 XFree86 manual pages.
 502 .It Li Xprog
 503 XFree86 programmer's distribution.
 504 .It Li Xps
 505 XFree86 postscript documentation.
 506 .It Li Xset
 507 XFree86 graphical setup tool.
 508 .It Li PC98-Servers/X9480
 509 XFree86 PC98 8-bit (256 color) PEGC-480 server.
 510 .It Li PC98-Servers/X9EGC
 511 XFree86 PC98 4-bit (16 color) EGC server.
 512 .It Li PC98-Servers/X9GA9
 513 XFree86 PC98 GA-968V4/PCI (S3 968) server.
 514 .It Li PC98-Servers/X9GAN
 515 XFree86 PC98 GANB-WAP (cirrus) server.
 516 .It Li PC98-Servers/X9LPW
 517 XFree86 PC98 PowerWindowLB (S3) server.
 518 .It Li PC98-Servers/X9MGA
 519 [DESCRIPTION MISSING]
 520 .It Li PC98-Servers/X9NKV
 521 XFree86 PC98 NKV-NEC (cirrus) server.
 522 .It Li PC98-Servers/X9NS3
 523 XFree86 PC98 NEC (S3) server.
 524 .It Li PC98-Servers/X9SPW
 525 XFree86 PC98 SKB-PowerWindow (S3) server.
 526 .It Li PC98-Servers/X9SVG
 527 [DESCRIPTION MISSING]
 528 .It Li PC98-Servers/X9TGU
 529 XFree86 PC98 Cyber9320 and TGUI9680 server.
 530 .It Li PC98-Servers/X9WEP
 531 XFree86 PC98 WAB-EP (cirrus) server.
 532 .It Li PC98-Servers/X9WS
 533 XFree86 PC98 WABS (cirrus) server.
 534 .It Li PC98-Servers/X9WSN
 535 XFree86 PC98 WSN-A2F (cirrus) server.
 536 .It Li Servers/X3DL
 537 XFree86 3D Labs server.
 538 .It Li Servers/X8514
 539 XFree86 8514 server.
 540 .It Li Servers/XAGX
 541 XFree86 8 bit AGX server.
 542 .It Li Servers/XI128
 543 XFree86 #9 Imagine I128 server.
 544 .It Li Servers/XMa8
 545 XFree86 ATI Mach8 server.
 546 .It Li Servers/XMa32
 547 XFree86 ATI Mach32 server.
 548 .It Li Servers/XMa64
 549 XFree86 ATI Mach64 server.
 550 .It Li Servers/XMono
 551 XFree86 monochrome server.
 552 .It Li Servers/XP9K
 553 XFree86 P9000 server.
 554 .It Li Servers/XS3
 555 XFree86 S3 server.
 556 .It Li Servers/XS3V
 557 XFree86 S3 Virge server.
 558 .It Li Servers/XSVGA
 559 XFree86 SVGA server.
 560 .It Li Servers/XVG16
 561 XFree86 VGA16 server.
 562 .It Li Servers/XW32
 563 XFree86 ET4000/W32, /W32i and /W32p server.
 564 .It Li Servers/XTGA
 565 Server for TGA cards (alpha architecture only).
 566 .It Li Servers/Xnest
 567 XFree86 nested X server.
 568 .It Li Servers/Xvfb
 569 XFree86 virtual frame-buffer X server.
 570 .It Li Xfnts
 571 XFree86 base font set.
 572 .It Li Xf100
 573 XFree86 100DPI font set.
 574 .It Li Xfcyr
 575 XFree86 Cyrillic font set.
 576 .It Li Xfscl
 577 XFree86 scalable font set.
 578 .It Li Xfnon
 579 XFree86 non-english font set.
 580 .It Li Xfsrv
 581 XFree86 font server.
 582 .El
 583 .El
 584 .It distSetDeveloper
 585 Selects the standard Developer's distribution set.
 586 .Pp
 587 .Sy Variables :
 588 None
 589 .It distSetXDeveloper
 590 Selects the standard X Developer's distribution set.
 591 .Pp
 592 .Sy Variables :
 593 None
 594 .It distSetKernDeveloper
 595 Selects the standard kernel Developer's distribution set.
 596 .Pp
 597 .Sy Variables :
 598 None
 599 .It distSetUser
 600 Selects the standard user distribution set.
 601 .Pp
 602 .Sy Variables :
 603 None
 604 .It distSetXUser
 605 Selects the standard X user's distribution set.
 606 .Pp
 607 .Sy Variables :
 608 None
 609 .It distSetMinimum
 610 Selects the very minimum distribution set.
 611 .Pp
 612 .Sy Variables :
 613 None
 614 .It distSetEverything
 615 Selects the full whack - all available distributions.
 616 .Pp
 617 .Sy Variables :
 618 None
 619 .It distSetCRYPTO
 620 Interactively select encryption subcomponents.
 621 .Pp
 622 .Sy Variables :
 623 None
 624 .It distSetSrc
 625 Interactively select source subcomponents.
 626 .Pp
 627 .Sy Variables :
 628 None
 629 .It distSetXF86
 630 Interactively select XFree86 subcomponents.
 631 .Pp
 632 .Sy Variables :
 633 None
 634 .It distExtractAll
 635 Install all currently selected distributions (requires that
 636 media device also be selected).
 637 .Pp
 638 .Sy Variables :
 639 None
 640 .It docBrowser
 641 Install (if necessary) an HTML documentation browser and go to the
 642 HTML documentation submenu.
 643 .Pp
 644 .Sy Variables :
 645 .Bl -tag -width indent
 646 .It browserPackage
 647 The name of the browser package to try and install as necessary.
 648 Defaults to latest links package.
 649 .It browserBinary
 650 The name of the browser binary itself (if overriding the
 651 .Ar browserPackage
 652 variable).  Defaults to links.
 653 .El
 654 .It installCommit
 655 Commit any and all pending changes to disk.  This function
 656 is essentially shorthand for a number of more granular "commit"
 657 functions.
 658 .Pp
 659 .Sy Variables :
 660 None
 661 .It installExpress
 662 Start an "express" installation, asking few questions of
 663 the user.
 664 .Pp
 665 .Sy Variables :
 666 None
 667 .It installStandard
 668 Start a "standard" installation, the most user-friendly
 669 installation type available.
 670 .Pp
 671 .Sy Variables :
 672 None
 673 .It installUpgrade
 674 Start an upgrade installation.
 675 .Pp
 676 .Sy Variables :
 677 None
 678 .It installFixitHoloShell
 679 Start up the "emergency holographic shell" over on VTY4
 680 if running as init.  This will also happen automatically
 681 as part of the installation process unless
 682 .Ar noHoloShell
 683 is set.
 684 .Pp
 685 .Sy Variables :
 686 None
 687 .It installFixitCDROM
 688 Go into "fixit" mode, assuming a live file system CDROM
 689 currently in the drive.
 690 .Pp
 691 .Sy Variables :
 692 None
 693 .It installFixitFloppy
 694 Go into "fixit" mode, assuming an available fixit floppy
 695 disk (user will be prompted for it).
 696 .Pp
 697 .Sy Variables :
 698 None
 699 .It installFilesystems
 700 Do just the file system initialization part of an install.
 701 .Pp
 702 .Sy Variables :
 703 None
 704 .It installVarDefaults
 705 Initialize all variables to their defaults, overriding any
 706 previous settings.
 707 .Pp
 708 .Sy Variables :
 709 None
 710 .It loadConfig
 711 Sort of like an #include statement, it allows you to load one
 712 configuration file from another.
 713 .Pp
 714 .Sy Variables :
 715 .Bl -tag -width indent
 716 .It configFile
 717 The fully qualified pathname of the file to load.
 718 .El
 719 .It mediaClose
 720 If a media device is open, close it.
 721 .Pp
 722 .Sy Variables :
 723 None
 724 .It mediaSetCDROM
 725 Select a
 726 .Fx
 727 CDROM as the installation media.
 728 .Pp
 729 .Sy Variables :
 730 None
 731 .It mediaSetFloppy
 732 Select a pre-made floppy installation set as the installation media.
 733 .Pp
 734 .Sy Variables :
 735 None
 736 .It mediaSetDOS
 737 Select an existing DOS primary partition as the installation media.
 738 The first primary partition found is used (e.g. C:).
 739 .Pp
 740 .Sy Variables :
 741 None
 742 .It mediaSetTape
 743 Select a tape device as the installation media.
 744 .Pp
 745 .Sy Variables :
 746 None
 747 .It mediaSetFTP
 748 Select an FTP site as the installation media.
 749 .Pp
 750 .Sy Variables :
 751 .Bl -tag -width indent
 752 .It hostname
 753 The name of the host being installed (non-optional).
 754 .It domainname
 755 The domain name of the host being installed (optional).
 756 .It defaultrouter
 757 The default router for this host (non-optional).
 758 .It netDev
 759 Which host interface to use
 760 .Ar ( ed0
 761 or
 762 .Ar ep0 ,
 763 for example.  Non-optional).
 764 .It netInteractive
 765 If set, bring up the interactive network setup form even
 766 if all relevant configuration variables are already set (optional).
 767 .It ipaddr
 768 The IP address for the selected host interface (non-optional).
 769 .It netmask
 770 The netmask for the selected host interface (non-optional).
 771 .It _ftpPath
 772 The fully qualified URL of the FTP site containing the
 773 .Fx
 774 distribution you're interested in, e.g.\&
 775 .Ar ftp://ftp.FreeBSD.org/pub/FreeBSD/ .
 776 .El
 777 .It mediaSetFTPActive
 778 Alias for
 779 .Ar mediaSetFTP
 780 using "active" FTP transfer mode.
 781 .Pp
 782 .Sy Variables :
 783 Same as for
 784 .Ar mediaSetFTP .
 785 .It mediaSetFTPPassive
 786 Alias for
 787 .Ar mediaSetFTP
 788 using "passive" FTP transfer mode.
 789 .Pp
 790 .Sy Variables :
 791 Same as for
 792 .Ar mediaSetFTP .
 793 .It mediaSetHTTP
 794 Alias for
 795 .Ar mediaSetFTP
 796 using an HTTP proxy.
 797 .Pp
 798 .Sy Variables :
 799 See
 800 .Ar mediaSetFTP ,
 801 plus
 802 .Bl -tag -width indent
 803 .It _httpPath
 804 The proxy to use (host:port) (non-optional).
 805 .El
 806 .It mediaSetUFS
 807 Select an existing UFS partition (mounted with the label editor) as
 808 the installation media.
 809 .Pp
 810 .Sy Variables :
 811 .Bl -tag -width indent
 812 .It ufs
 813 full /path to directory containing the
 814 .Fx
 815 distribution you're
 816 interested in.
 817 .El
 818 .It mediaSetNFS
 819 .Pp
 820 .Sy Variables :
 821 .Bl -tag -width indent
 822 .It hostname
 823 The name of the host being installed (non-optional).
 824 .It domainname
 825 The domain name of the host being installed (optional).
 826 .It defaultrouter
 827 The default router for this host (non-optional).
 828 .It netDev
 829 Which host interface to use
 830 .Ar ( ed0
 831 or
 832 .Ar ep0 ,
 833 for example.  Non-optional).
 834 .It netInteractive
 835 If set, bring up the interactive network setup form even
 836 if all relevant configuration variables are already set (optional).
 837 .It ipaddr
 838 The IP address for the selected host interface (non-optional).
 839 .It netmask
 840 The netmask for the selected host interface (non-optional).
 841 .It nfs
 842 full hostname:/path specification for directory containing
 843 the
 844 .Fx
 845 distribution you're interested in.
 846 .El
 847 .It mediaSetFTPUserPass
 848 .Pp
 849 .Sy Variables :
 850 .Bl -tag -width indent
 851 .It ftpUser
 852 The username to log in as on the ftp server site.
 853 Default: ftp
 854 .It ftpPass
 855 The password to use for this username on the ftp
 856 server site.
 857 Default: user@host
 858 .El
 859 .It mediaSetCPIOVerbosity
 860 .Pp
 861 .Sy Variables :
 862 .Bl -tag -width indent
 863 .It cpioVerbose
 864 Can be used to set the verbosity of cpio extractions to low, medium or
 865 high.
 866 .El
 867 .It mediaGetType
 868 Interactively get the user to specify some type of media.
 869 .Pp
 870 .Sy Variables :
 871 None
 872 .It optionsEditor
 873 Invoke the interactive options editor.
 874 .Pp
 875 .Sy Variables :
 876 None
 877 .It packageAdd
 878 Try to fetch and add a package to the system (requires
 879 that a media type be set),
 880 .Pp
 881 .Sy Variables :
 882 .Bl -tag -width indent
 883 .It package
 884 The name of the package to add, e.g. bash-1.14.7 or ncftp-2.4.2.
 885 .El
 886 .It addGroup
 887 Invoke the interactive group editor.
 888 .Pp
 889 .Sy Variables :
 890 None
 891 .It addUser
 892 Invoke the interactive user editor.
 893 .Pp
 894 .Sy Variables :
 895 None
 896 .It shutdown
 897 Stop the script and terminate sysinstall.
 898 .Pp
 899 .Sy Variables :
 900 None
 901 .It system
 902 Execute an arbitrary command with
 903 .Xr system 3
 904 .Pp
 905 .Sy Variables :
 906 .Bl -tag -width indent
 907 .It command
 908 The name of the command to execute.  When running
 909 from a boot floppy, very minimal expectations should
 910 be made as to what's available until/unless a relatively
 911 full system installation has just been done.
 912 .El
 913 .It tcpMenuSelect
 914 Configure a network device.
 915 .Pp
 916 .Sy Variables :
 917 Same as for
 918 .Ar mediaSetFTP
 919 except that
 920 .Ar _ftpPath
 921 is not used.
 922 .El
 923 .Pp
 924 For information about building a full release of
 925 .Fx ,
 926 please see
 927 .Xr release 7 .
 928 .Sh FILES
 929 This utility may edit the contents of
 930 .Pa /etc/rc.conf ,
 931 .Pa /etc/hosts ,
 932 and
 933 .Pa /etc/resolv.conf
 934 as necessary to reflect changes in the network configuration.
 935 .Sh SEE ALSO
 936 If you have a reasonably complete source tree online, take
 937 a look at
 938 .Pa /usr/src/release/sysinstall/install.cfg
 939 for a sample installation script.
 940 .Sh BUGS
 941 This utility is a prototype which lasted several years past
 942 its expiration date and is greatly in need of death.
 943 .Sh AUTHORS
 944 .An Jordan K. Hubbard Aq jkh@FreeBSD.org
 945 .Sh HISTORY
 946 This version of
 947 .Nm
 948 first appeared in
 949 .Fx 2.0 .