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