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 .\" $DragonFly: src/release/sysinstall/Attic/sysinstall.8,v 1.3 2003/08/06 20:21:37 rob Exp $
  27 .\"
  28 .Dd August 9, 1997
  29 .Dt SYSINSTALL 8
  30 .Os
  31 .Sh NAME
  32 .Nm sysinstall
  33 .Nd system installation and configuration tool
  34 .Sh SYNOPSIS
  35 .Nm
  36 .Op Ar var=value
  37 .Op Ar function
  38 .Op Ar ...
  39 .Sh DESCRIPTION
  40 .Nm
  41 is a utility 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 program 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 .Nm
  67 is essentially nothing more than a monolithic C program with
  68 the ability to write MBRs and disk labels (through the services
  69 of the
  70 .Xr libdisk 3
  71 library) and install distributions or packages onto new and
  72 existing
  73 .Fx
  74 systems.  It also contains some extra intelligence
  75 for running as a replacement for
  76 .Xr init 8
  77 when it's invoked by the
  78 .Fx
  79 installation boot procedure.  It
  80 assumes very little in the way of additional utility support and
  81 performs most file system operations by calling the relevant syscalls
  82 (such as
  83 .Xr mount 2 )
  84 directly.
  85 .Pp
  86 .Nm
  87 currently uses the
  88 .Xr dialog 3
  89 library to do user interaction with simple ANSI line graphics, color
  90 support for which is enabled by either running on a syscons VTY or some
  91 other color-capable terminal emulator (newer versions of xterm will support
  92 color when using the
  93 .Dq xterm-color
  94 termcap entry).
  95 .Pp
  96 This product is currently at the end of its life cycle and will
  97 eventually be replaced.
  98 .Sh RUNNING SCRIPTS
  99 .Nm
 100 may be either driven interactively through its various internal menus
 101 or run in batch mode, driven by an external script.  Such a script may
 102 be loaded and executed in one of 3 ways:
 103 .Bl -tag -width Ds
 104 .It Sy "LOAD_CONFIG_FILE"
 105 If
 106 .Nm
 107 is compiled with LOAD_CONFIG_FILE set in the environment
 108 (or in the Makefile) to some value, then that value will
 109 be used as the filename to automatically look for and load
 110 when
 111 .Nm
 112 starts up and with no user interaction required.
 113 This option is aimed primarily at large sites who wish to create a
 114 single prototype install for multiple machines with largely identical
 115 configurations and/or installation options.
 116 .It Sy "MAIN MENU"
 117 If
 118 .Nm
 119 is run interactively, that is to say in the default manner, it will
 120 bring up a main menu which contains a "load config file" option.
 121 Selecting this option will prompt for the name of a script file which
 122 it then will attempt to load from a DOS or UFS formatted floppy.
 123 .It Sy "COMMAND LINE"
 124 Each command line argument is treated as a script directive
 125 when
 126 .Nm
 127 is run in multi-user mode.  Execution ends either by explicit request
 128 (e.g. calling the
 129 .Ar shutdown
 130 directive), upon reaching the end of the argument list or on error.
 131 .Pp
 132 For example:
 133 .Bd -literal
 134 /stand/sysinstall _ftpPath=ftp://ziggy/pub/ mediaSetFTP configPackages
 135 .Ed
 136 .Pp
 137 Would initialize
 138 .Nm
 139 for FTP installation media (using the server `ziggy') and then
 140 bring up the package installation editor, exiting when finished.
 141 .El
 142 .Sh SCRIPT SYNTAX
 143 A script is a list of one or more directives, each directive taking
 144 the form of:
 145 .Pp
 146 .Ar var=value
 147 .Pp
 148 .Ar function
 149 .Pp
 150 or
 151 .Ar #somecomment
 152 .Pp
 153 Where
 154 .Ar var=value
 155 is the assignment of some internal
 156 .Nm
 157 variable, e.g. "ftpPass=FuNkYChiKn", and
 158 .Ar function
 159 is the name of an internal
 160 .Nm
 161 function, e.g. "mediaSetFTP", and
 162 .Ar #comment
 163 is a single-line comment for documentation purposes (ignored by
 164 sysinstall).  Each directive must be by itself on a single line,
 165 functions taking their arguments by examining known variable names.
 166 This requires that you be sure to assign the relevant variables before
 167 calling a function which requires them.
 168 .Pp
 169 The
 170 .Ar noError
 171 variable can be assigned before each directive: this will cause any error
 172 detected while processing the directive itself to be ignored.
 173 The value of
 174 .Ar noError
 175 will automatically reset to the default "unassigned" every time a directive is
 176 processed.
 177 .Pp
 178 When and where a function depends on the settings of one or more variables
 179 will be noted in the following table:
 180 .Pp
 181 .Sy "Function Glossary" :
 182 .Pp
 183 .Bl -tag -width indent
 184 .It configAnonFTP
 185 Invoke the Anonymous FTP configuration menu.
 186 .Pp
 187 .Sy Variables :
 188 None
 189 .It configRouter
 190 Select which routing daemon you wish to use, potentially
 191 loading any required 3rd-party routing daemons as necessary.
 192 .Pp
 193 .Sy Variables :
 194 .Bl -tag -width indent
 195 .It router
 196 can be set to the name of the desired routing daemon,
 197 e.g.\&
 198 .Dq routed
 199 or
 200 .Dq gated ,
 201 otherwise it is prompted for.
 202 .El
 203 .It configNFSServer
 204 Configure host as an NFS server.
 205 .Pp
 206 .Sy Variables :
 207 None
 208 .It configNTP
 209 Configure host as a user of the Network Time Protocol.
 210 .Pp
 211 .Sy Variables :
 212 .Bl -tag -width indent
 213 .It ntpdate_flags
 214 The flags to
 215 .Xr ntpdate 8 ,
 216 that is to say the name of the server to sync from.
 217 .El
 218 .It configPCNFSD
 219 Configure host to support PC NFS.
 220 .Pp
 221 .Sy Variables :
 222 .Bl -tag -width indent
 223 .It pcnfsd_pkg
 224 The name of the PCNFSD package to load if necessary (defaults to hard coded
 225 version).
 226 .El
 227 .It configPackages
 228 Bring up the interactive package management menu.
 229 .Pp
 230 .Sy Variables :
 231 None
 232 .It configUsers
 233 Add users and/or groups to the system.
 234 .Pp
 235 .Sy Variables :
 236 None
 237 .It configXEnvironment
 238 Configure the X display subsystem.
 239 .Pp
 240 .Sy Variables :
 241 None
 242 .It diskPartitionEditor
 243 Invokes the disk partition (MBR) editor.
 244 .Pp
 245 .Sy Variables :
 246 .Bl -tag -width findx
 247 .It geometry
 248 The disk geometry, as a cyls/heads/sectors formatted string.  Default: no
 249 change to geometry.
 250 .It partition
 251 Set to disk partitioning type or size, its value being
 252 .Ar free
 253 in order to use only remaining free space for
 254 .Fx ,
 255 .Ar all
 256 to use the entire disk for
 257 .Fx
 258 but maintain a proper partition
 259 table,
 260 .Ar existing
 261 to use an existing
 262 .Fx
 263 partition (first found),
 264 .Ar exclusive
 265 to use the disk in
 266 .Dq dangerously dedicated
 267 mode or, finally,
 268 .Ar somenumber
 269 to allocate
 270 .Ar somenumber
 271 blocks of available free space to a new
 272 .Fx
 273 partition.
 274 Default:  Interactive mode.
 275 .It bootManager
 276 is set to one of
 277 .Ar boot
 278 to signify the installation of a boot manager,
 279 .Ar standard
 280 to signify installation of a "standard" non-boot MGR DOS
 281 MBR or
 282 .Ar none
 283 to indicate that no change to the boot manager is desired.
 284 Default: none.
 285 .It diskInteractive
 286 If set, bring up the interactive disk partition editor.
 287 .El
 288 .Pp
 289 Note: Nothing is actually written to disk by this function, a explicit call to
 290 .Ar diskPartitionWrite
 291 being required for that to happen.
 292 .It diskPartitionWrite
 293 Causes any pending MBR changes (typically from the
 294 .Ar diskPartitionEditor
 295 function) to be written out.
 296 .Pp
 297 .Sy Variables :
 298 None
 299 .It diskLabelEditor
 300 Invokes the disk label editor.  This is a bit trickier from a script
 301 since you need to essentially label everything inside each
 302 .Fx
 303 (type 0xA5) partition created by the
 304 .Ar diskPartitionEditor
 305 function, and that requires knowing a few rules about how things are
 306 laid out.  When creating a script to automatically allocate disk space
 307 and partition it up, it is suggested that you first perform the
 308 installation interactively at least once and take careful notes as to
 309 what the slice names will be, then and only then hardwiring them into
 310 the script.
 311 .Pp
 312 For example, let's say you have a SCSI disk on which you've created a new
 313 .Fx
 314 partition in slice 2 (your DOS partition residing in slice 1).
 315 The slice name would be
 316 .Ar da0s2
 317 for the whole
 318 .Fx
 319 partition
 320 .Ar ( da0s1
 321 being your DOS primary
 322 partition).  Now let's further assume that you have 500MB in this
 323 partition and you want to sub-partition that space into root, swap,
 324 var and usr file systems for
 325 .Fx .
 326 Your invocation of the
 327 .Ar diskLabelEditor
 328 function might involve setting the following variables:
 329 .Bl -tag -width findx
 330 .It Li "da0s2-1=ufs 40960 /"
 331 A 20MB root file system (all sizes are in 512 byte blocks).
 332 .It Li "da0s2-2=swap 131072 /"
 333 A 64MB swap partition.
 334 .It Li "da0s2-3=ufs 204800 /var"
 335 A 100MB /var file system.
 336 .It Li "da0s2-4=ufs 0 /usr 1"
 337 With the balance of free space (around 316MB) going to the /usr
 338 file system and with soft-updates enabled (the argument following
 339 the mount point, if non-zero, means to set the soft updates flag).
 340 .El
 341 .Pp
 342 One can also use the
 343 .Ar diskLabelEditor
 344 for mounting or erasing existing partitions as well as creating new
 345 ones.  Using the previous example again, let's say that we also wanted
 346 to mount our DOS partition and make sure that an
 347 .Pa /etc/fstab
 348 entry is created for it in the new installation.  Before calling the
 349 .Ar diskLabelEditor
 350 function, we simply add an additional line:
 351 .Pp
 352 .Dl "da0s1=/dos_c N"
 353 .Pp
 354 before the call.  This tells the label editor that you want to mount
 355 the first slice on
 356 .Pa /dos_c
 357 and not to attempt to newfs it (not that
 358 .Nm
 359 would attempt this for a DOS partition in any case, but it could just
 360 as easily be an existing UFS partition being named here and the 2nd
 361 field is non-optional).
 362 .Pp
 363 You can also set the
 364 .Ar diskInteractive
 365 variable to request that the disk label editor use an interactive dialog
 366 to partition the disk instead of using variables to explicitly layout the
 367 disk as described above.
 368 .Pp
 369 Note:  No file system data is actually written to disk until an
 370 explicit call to
 371 .Ar diskLabelCommit
 372 is made.
 373 .It diskLabelCommit
 374 Writes out all pending disklabel information and creates and/or mounts any
 375 file systems which have requests pending from the
 376 .Ar diskLabelEditor
 377 function.
 378 .Pp
 379 .Sy Variables :
 380 None
 381 .It distReset
 382 Resets all selected distributions to the empty set (no distributions selected).
 383 .Pp
 384 .Sy Variables :
 385 None
 386 .It distSetCustom
 387 Allows the selection of a custom distribution set (e.g. not just on of the
 388 existing "canned" sets) with no user interaction.
 389 .Pp
 390 .Sy Variables :
 391 .Bl -tag -width indent
 392 .It dists
 393 List of distributions to load.  Possible distribution values are:
 394 .Bl -tag -width indentxx
 395 .It Li bin
 396 The base binary distribution.
 397 .It Li doc
 398 Miscellaneous documentation
 399 .It Li games
 400 Games
 401 .It Li manpages
 402 Manual pages (unformatted)
 403 .It Li catpages
 404 Pre-formatted manual pages
 405 .It Li proflibs
 406 Profiled libraries for developers.
 407 .It Li dict
 408 Dictionary information (for tools like spell).
 409 .It Li info
 410 GNU info files and other extra docs.
 411 .It Li crypto
 412 Encryption binaries and libraries.
 413 .It Li compat1x
 414 Compatibility with
 415 .Fx
 416 1.x
 417 .It Li compat20
 418 Compatibility with
 419 .Fx 2.0
 420 .It Li compat21
 421 Compatibility with
 422 .Fx 2.1
 423 .It Li compat22
 424 .Fx 2.2
 425 and
 426 .Fx 3.0
 427 a.out binary compatibility
 428 .It Li compat3x
 429 Compatibility with
 430 .Fx
 431 3.x
 432 (available for
 433 .Fx 4.0
 434 systems only)
 435 .It Li compat4x
 436 Compatibility with
 437 .Fx
 438 4.x
 439 (available for
 440 earlier releases of
 441 .Fx
 442 4.x)
 443 .It Li ports
 444 The ports collection.
 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 .Pp
 923 For information about building a full release of
 924 .Fx ,
 925 please see
 926 .Xr release 7 .
 927 .Sh FILES
 928 This utility may edit the contents of
 929 .Pa /etc/rc.conf ,
 930 .Pa /etc/hosts ,
 931 and
 932 .Pa /etc/resolv.conf
 933 as necessary to reflect changes in the network configuration.
 934 .Sh SEE ALSO
 935 If you have a reasonably complete source tree online, take
 936 a look at
 937 .Pa /usr/src/release/sysinstall/install.cfg
 938 for a sample installation script.
 939 .Sh BUGS
 940 This utility is a prototype which lasted several years past
 941 its expiration date and is greatly in need of death.
 942 .Sh AUTHORS
 943 .An Jordan K. Hubbard Aq jkh@FreeBSD.org
 944 .Sh HISTORY
 945 This version of
 946 .Nm
 947 first appeared in
 948 .Fx 2.0 .