| sysinstall.8 (125540) | sysinstall.8 (131500) |
|---|---|
| 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. --- 8 unchanged lines hidden (view full) --- 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.\" | 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. --- 8 unchanged lines hidden (view full) --- 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: head/usr.sbin/sysinstall/sysinstall.8 125540 2004-02-07 00:34:11Z olgeni $ | 25.\" $FreeBSD: head/usr.sbin/sysinstall/sysinstall.8 131500 2004-07-02 23:13:00Z ru $ |
| 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 --- 33 unchanged lines hidden (view full) --- 67.Nm 68utility is essentially nothing more than a monolithic C program with 69the ability to write MBRs and disk labels (through the services 70of the 71.Xr libdisk 3 72library) and install distributions or packages onto new and 73existing 74.Fx | 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 --- 33 unchanged lines hidden (view full) --- 67.Nm 68utility is essentially nothing more than a monolithic C program with 69the ability to write MBRs and disk labels (through the services 70of the 71.Xr libdisk 3 72library) and install distributions or packages onto new and 73existing 74.Fx |
| 75systems. It also contains some extra intelligence | 75systems. 76It also contains some extra intelligence |
| 76for running as a replacement for 77.Xr init 8 78when it's invoked by the 79.Fx | 77for running as a replacement for 78.Xr init 8 79when it's invoked by the 80.Fx |
| 80installation boot procedure. It | 81installation boot procedure. 82It |
| 81assumes very little in the way of additional utility support and 82performs most file system operations by calling the relevant syscalls 83(such as 84.Xr mount 2 ) 85directly. 86.Pp 87The 88.Nm --- 7 unchanged lines hidden (view full) --- 96termcap entry). 97.Pp 98This product is currently at the end of its life cycle and will 99eventually be replaced. 100.Sh RUNNING SCRIPTS 101The 102.Nm 103utility may be either driven interactively through its various internal menus | 83assumes very little in the way of additional utility support and 84performs most file system operations by calling the relevant syscalls 85(such as 86.Xr mount 2 ) 87directly. 88.Pp 89The 90.Nm --- 7 unchanged lines hidden (view full) --- 98termcap entry). 99.Pp 100This product is currently at the end of its life cycle and will 101eventually be replaced. 102.Sh RUNNING SCRIPTS 103The 104.Nm 105utility may be either driven interactively through its various internal menus |
| 104or run in batch mode, driven by an external script. Such a script may | 106or run in batch mode, driven by an external script. 107Such a script may |
| 105be loaded and executed in one of 3 ways: 106.Bl -tag -width Ds 107.It Sy "LOAD_CONFIG_FILE" 108If 109.Nm 110is compiled with LOAD_CONFIG_FILE set in the environment 111(or in the Makefile) to some value, then that value will 112be used as the filename to automatically look for and load --- 9 unchanged lines hidden (view full) --- 122is run interactively, that is to say in the default manner, it will 123bring up a main menu which contains a "load config file" option. 124Selecting this option will prompt for the name of a script file which 125it then will attempt to load from a DOS or UFS formatted floppy. 126.It Sy "COMMAND LINE" 127Each command line argument is treated as a script directive 128when 129.Nm | 108be loaded and executed in one of 3 ways: 109.Bl -tag -width Ds 110.It Sy "LOAD_CONFIG_FILE" 111If 112.Nm 113is compiled with LOAD_CONFIG_FILE set in the environment 114(or in the Makefile) to some value, then that value will 115be used as the filename to automatically look for and load --- 9 unchanged lines hidden (view full) --- 125is run interactively, that is to say in the default manner, it will 126bring up a main menu which contains a "load config file" option. 127Selecting this option will prompt for the name of a script file which 128it then will attempt to load from a DOS or UFS formatted floppy. 129.It Sy "COMMAND LINE" 130Each command line argument is treated as a script directive 131when 132.Nm |
| 130is run in multi-user mode. Execution ends either by explicit request 131(e.g. calling the | 133is run in multi-user mode. 134Execution ends either by explicit request 135(e.g.\& calling the |
| 132.Ar shutdown 133directive), upon reaching the end of the argument list or on error. 134.Pp 135For example: 136.Bd -literal 137/usr/sbin/sysinstall _ftpPath=ftp://ziggy/pub/ mediaSetFTP configPackages 138.Ed 139.Pp --- 12 unchanged lines hidden (view full) --- 152.Pp 153or 154.Ar #somecomment 155.Pp 156Where 157.Ar var=value 158is the assignment of some internal 159.Nm | 136.Ar shutdown 137directive), upon reaching the end of the argument list or on error. 138.Pp 139For example: 140.Bd -literal 141/usr/sbin/sysinstall _ftpPath=ftp://ziggy/pub/ mediaSetFTP configPackages 142.Ed 143.Pp --- 12 unchanged lines hidden (view full) --- 156.Pp 157or 158.Ar #somecomment 159.Pp 160Where 161.Ar var=value 162is the assignment of some internal 163.Nm |
| 160variable, e.g. "ftpPass=FuNkYChiKn", and | 164variable, e.g.\& "ftpPass=FuNkYChiKn", and |
| 161.Ar function 162is the name of an internal 163.Nm | 165.Ar function 166is the name of an internal 167.Nm |
| 164function, e.g. "mediaSetFTP", and | 168function, e.g.\& "mediaSetFTP", and |
| 165.Ar #comment 166is a single-line comment for documentation purposes (ignored by | 169.Ar #comment 170is a single-line comment for documentation purposes (ignored by |
| 167sysinstall). Each directive must be by itself on a single line, | 171sysinstall). 172Each directive must be by itself on a single line, |
| 168functions taking their arguments by examining known variable names. 169This requires that you be sure to assign the relevant variables before 170calling a function which requires them. 171.Pp 172The 173.Ar noError 174variable can be assigned before each directive: this will cause any error 175detected while processing the directive itself to be ignored. --- 72 unchanged lines hidden (view full) --- 248.Sy Variables : 249None 250.It diskPartitionEditor 251Invokes the disk partition (MBR) editor. 252.Pp 253.Sy Variables : 254.Bl -tag -width findx 255.It geometry | 173functions taking their arguments by examining known variable names. 174This requires that you be sure to assign the relevant variables before 175calling a function which requires them. 176.Pp 177The 178.Ar noError 179variable can be assigned before each directive: this will cause any error 180detected while processing the directive itself to be ignored. --- 72 unchanged lines hidden (view full) --- 253.Sy Variables : 254None 255.It diskPartitionEditor 256Invokes the disk partition (MBR) editor. 257.Pp 258.Sy Variables : 259.Bl -tag -width findx 260.It geometry |
| 256The disk geometry, as a cyls/heads/sectors formatted string. Default: no | 261The disk geometry, as a cyls/heads/sectors formatted string. 262Default: no |
| 257change to geometry. 258.It partition 259Set to disk partitioning type or size, its value being 260.Ar free 261in order to use only remaining free space for 262.Fx , 263.Ar all 264to use the entire disk for --- 35 unchanged lines hidden (view full) --- 300.It diskPartitionWrite 301Causes any pending MBR changes (typically from the 302.Ar diskPartitionEditor 303function) to be written out. 304.Pp 305.Sy Variables : 306None 307.It diskLabelEditor | 263change to geometry. 264.It partition 265Set to disk partitioning type or size, its value being 266.Ar free 267in order to use only remaining free space for 268.Fx , 269.Ar all 270to use the entire disk for --- 35 unchanged lines hidden (view full) --- 306.It diskPartitionWrite 307Causes any pending MBR changes (typically from the 308.Ar diskPartitionEditor 309function) to be written out. 310.Pp 311.Sy Variables : 312None 313.It diskLabelEditor |
| 308Invokes the disk label editor. This is a bit trickier from a script | 314Invokes the disk label editor. 315This is a bit trickier from a script |
| 309since you need to essentially label everything inside each 310.Fx 311(type 0xA5) partition created by the 312.Ar diskPartitionEditor 313function, and that requires knowing a few rules about how things are | 316since you need to essentially label everything inside each 317.Fx 318(type 0xA5) partition created by the 319.Ar diskPartitionEditor 320function, and that requires knowing a few rules about how things are |
| 314laid out. When creating a script to automatically allocate disk space | 321laid out. 322When creating a script to automatically allocate disk space |
| 315and partition it up, it is suggested that you first perform the 316installation interactively at least once and take careful notes as to 317what the slice names will be, then and only then hardwiring them into 318the script. 319.Pp 320For example, let's say you have a SCSI disk on which you've created a new 321.Fx 322partition in slice 2 (your DOS partition residing in slice 1). 323The slice name would be 324.Ar da0s2 325for the whole 326.Fx 327partition 328.Ar ( da0s1 329being your DOS primary | 323and partition it up, it is suggested that you first perform the 324installation interactively at least once and take careful notes as to 325what the slice names will be, then and only then hardwiring them into 326the script. 327.Pp 328For example, let's say you have a SCSI disk on which you've created a new 329.Fx 330partition in slice 2 (your DOS partition residing in slice 1). 331The slice name would be 332.Ar da0s2 333for the whole 334.Fx 335partition 336.Ar ( da0s1 337being your DOS primary |
| 330partition). Now let's further assume that you have 500MB in this | 338partition). 339Now let's further assume that you have 500MB in this |
| 331partition and you want to sub-partition that space into root, swap, 332var and usr file systems for 333.Fx . 334Your invocation of the 335.Ar diskLabelEditor 336function might involve setting the following variables: 337.Bl -tag -width findx 338.It Li "da0s2-1=ufs 40960 /" --- 6 unchanged lines hidden (view full) --- 345With the balance of free space (around 316MB) going to the /usr 346file system and with soft-updates enabled (the argument following 347the mount point, if non-zero, means to set the soft updates flag). 348.El 349.Pp 350One can also use the 351.Ar diskLabelEditor 352for mounting or erasing existing partitions as well as creating new | 340partition and you want to sub-partition that space into root, swap, 341var and usr file systems for 342.Fx . 343Your invocation of the 344.Ar diskLabelEditor 345function might involve setting the following variables: 346.Bl -tag -width findx 347.It Li "da0s2-1=ufs 40960 /" --- 6 unchanged lines hidden (view full) --- 354With the balance of free space (around 316MB) going to the /usr 355file system and with soft-updates enabled (the argument following 356the mount point, if non-zero, means to set the soft updates flag). 357.El 358.Pp 359One can also use the 360.Ar diskLabelEditor 361for mounting or erasing existing partitions as well as creating new |
| 353ones. Using the previous example again, let's say that we also wanted | 362ones. 363Using the previous example again, let's say that we also wanted |
| 354to mount our DOS partition and make sure that an 355.Pa /etc/fstab | 364to mount our DOS partition and make sure that an 365.Pa /etc/fstab |
| 356entry is created for it in the new installation. Before calling the | 366entry is created for it in the new installation. 367Before calling the |
| 357.Ar diskLabelEditor 358function, we simply add an additional line: 359.Pp 360.Dl "da0s1=/dos_c N" 361.Pp | 368.Ar diskLabelEditor 369function, we simply add an additional line: 370.Pp 371.Dl "da0s1=/dos_c N" 372.Pp |
| 362before the call. This tells the label editor that you want to mount | 373before the call. 374This tells the label editor that you want to mount |
| 363the first slice on 364.Pa /dos_c 365and not to attempt to newfs it (not that 366.Nm 367would attempt this for a DOS partition in any case, but it could just 368as easily be an existing UFS partition being named here and the 2nd 369field is non-optional). 370.Pp --- 16 unchanged lines hidden (view full) --- 387.Sy Variables : 388None 389.It distReset 390Resets all selected distributions to the empty set (no distributions selected). 391.Pp 392.Sy Variables : 393None 394.It distSetCustom | 375the first slice on 376.Pa /dos_c 377and not to attempt to newfs it (not that 378.Nm 379would attempt this for a DOS partition in any case, but it could just 380as easily be an existing UFS partition being named here and the 2nd 381field is non-optional). 382.Pp --- 16 unchanged lines hidden (view full) --- 399.Sy Variables : 400None 401.It distReset 402Resets all selected distributions to the empty set (no distributions selected). 403.Pp 404.Sy Variables : 405None 406.It distSetCustom |
| 395Allows the selection of a custom distribution set (e.g. not just one of the | 407Allows the selection of a custom distribution set (e.g.\& not just one of the |
| 396existing "canned" sets) with no user interaction. 397.Pp 398.Sy Variables : 399.Bl -tag -width indent 400.It dists | 408existing "canned" sets) with no user interaction. 409.Pp 410.Sy Variables : 411.Bl -tag -width indent 412.It dists |
| 401List of distributions to load. Possible distribution values are: | 413List of distributions to load. 414Possible distribution values are: |
| 402.Bl -tag -width indentxx 403.It Li base 404The base binary distribution. 405.It Li doc 406Miscellaneous documentation 407.It Li games 408Games 409.It Li manpages --- 240 unchanged lines hidden (view full) --- 650.Sy Variables : 651.Bl -tag -width indent 652.It browserPackage 653The name of the browser package to try and install as necessary. 654Defaults to latest links package. 655.It browserBinary 656The name of the browser binary itself (if overriding the 657.Ar browserPackage | 415.Bl -tag -width indentxx 416.It Li base 417The base binary distribution. 418.It Li doc 419Miscellaneous documentation 420.It Li games 421Games 422.It Li manpages --- 240 unchanged lines hidden (view full) --- 663.Sy Variables : 664.Bl -tag -width indent 665.It browserPackage 666The name of the browser package to try and install as necessary. 667Defaults to latest links package. 668.It browserBinary 669The name of the browser binary itself (if overriding the 670.Ar browserPackage |
| 658variable). Defaults to links. | 671variable). 672Defaults to links. |
| 659.El 660.It installCommit | 673.El 674.It installCommit |
| 661Commit any and all pending changes to disk. This function | 675Commit any and all pending changes to disk. 676This function |
| 662is essentially shorthand for a number of more granular "commit" 663functions. 664.Pp 665.Sy Variables : 666None 667.It installExpress 668Start an "express" installation, asking few questions of 669the user. --- 8 unchanged lines hidden (view full) --- 678None 679.It installUpgrade 680Start an upgrade installation. 681.Pp 682.Sy Variables : 683None 684.It installFixitHoloShell 685Start up the "emergency holographic shell" over on VTY4 | 677is essentially shorthand for a number of more granular "commit" 678functions. 679.Pp 680.Sy Variables : 681None 682.It installExpress 683Start an "express" installation, asking few questions of 684the user. --- 8 unchanged lines hidden (view full) --- 693None 694.It installUpgrade 695Start an upgrade installation. 696.Pp 697.Sy Variables : 698None 699.It installFixitHoloShell 700Start up the "emergency holographic shell" over on VTY4 |
| 686if running as init. This will also happen automatically | 701if running as init. 702This will also happen automatically |
| 687as part of the installation process unless 688.Ar noHoloShell 689is set. 690.Pp 691.Sy Variables : 692None 693.It installFixitCDROM 694Go into "fixit" mode, assuming a live file system CDROM --- 41 unchanged lines hidden (view full) --- 736None 737.It mediaSetFloppy 738Select a pre-made floppy installation set as the installation media. 739.Pp 740.Sy Variables : 741None 742.It mediaSetDOS 743Select an existing DOS primary partition as the installation media. | 703as part of the installation process unless 704.Ar noHoloShell 705is set. 706.Pp 707.Sy Variables : 708None 709.It installFixitCDROM 710Go into "fixit" mode, assuming a live file system CDROM --- 41 unchanged lines hidden (view full) --- 752None 753.It mediaSetFloppy 754Select a pre-made floppy installation set as the installation media. 755.Pp 756.Sy Variables : 757None 758.It mediaSetDOS 759Select an existing DOS primary partition as the installation media. |
| 744The first primary partition found is used (e.g. C:). | 760The first primary partition found is used (e.g.\& C:). |
| 745.Pp 746.Sy Variables : 747None 748.It mediaSetTape 749Select a tape device as the installation media. 750.Pp 751.Sy Variables : 752None --- 8 unchanged lines hidden (view full) --- 761The domain name of the host being installed (optional). 762.It defaultrouter 763The default router for this host (non-optional). 764.It netDev 765Which host interface to use 766.Ar ( ed0 767or 768.Ar ep0 , | 761.Pp 762.Sy Variables : 763None 764.It mediaSetTape 765Select a tape device as the installation media. 766.Pp 767.Sy Variables : 768None --- 8 unchanged lines hidden (view full) --- 777The domain name of the host being installed (optional). 778.It defaultrouter 779The default router for this host (non-optional). 780.It netDev 781Which host interface to use 782.Ar ( ed0 783or 784.Ar ep0 , |
| 769for example. Non-optional). | 785for example. 786Non-optional). |
| 770.It netInteractive 771If set, bring up the interactive network setup form even 772if all relevant configuration variables are already set (optional). 773.It ipaddr 774The IP address for the selected host interface (non-optional). 775.It netmask 776The netmask for the selected host interface (non-optional). 777.It _ftpPath --- 53 unchanged lines hidden (view full) --- 831The domain name of the host being installed (optional). 832.It defaultrouter 833The default router for this host (non-optional). 834.It netDev 835Which host interface to use 836.Ar ( ed0 837or 838.Ar ep0 , | 787.It netInteractive 788If set, bring up the interactive network setup form even 789if all relevant configuration variables are already set (optional). 790.It ipaddr 791The IP address for the selected host interface (non-optional). 792.It netmask 793The netmask for the selected host interface (non-optional). 794.It _ftpPath --- 53 unchanged lines hidden (view full) --- 848The domain name of the host being installed (optional). 849.It defaultrouter 850The default router for this host (non-optional). 851.It netDev 852Which host interface to use 853.Ar ( ed0 854or 855.Ar ep0 , |
| 839for example. Non-optional). | 856for example. 857Non-optional). |
| 840.It netInteractive 841If set, bring up the interactive network setup form even 842if all relevant configuration variables are already set (optional). 843.It ipaddr 844The IP address for the selected host interface (non-optional). 845.It netmask 846The netmask for the selected host interface (non-optional). 847.It nfs --- 34 unchanged lines hidden (view full) --- 882None 883.It packageAdd 884Try to fetch and add a package to the system (requires 885that a media type be set), 886.Pp 887.Sy Variables : 888.Bl -tag -width indent 889.It package | 858.It netInteractive 859If set, bring up the interactive network setup form even 860if all relevant configuration variables are already set (optional). 861.It ipaddr 862The IP address for the selected host interface (non-optional). 863.It netmask 864The netmask for the selected host interface (non-optional). 865.It nfs --- 34 unchanged lines hidden (view full) --- 900None 901.It packageAdd 902Try to fetch and add a package to the system (requires 903that a media type be set), 904.Pp 905.Sy Variables : 906.Bl -tag -width indent 907.It package |
| 890The name of the package to add, e.g. bash-1.14.7 or ncftp-2.4.2. | 908The name of the package to add, e.g.\& bash-1.14.7 or ncftp-2.4.2. |
| 891.El 892.It addGroup 893Invoke the interactive group editor. 894.Pp 895.Sy Variables : 896None 897.It addUser 898Invoke the interactive user editor. --- 7 unchanged lines hidden (view full) --- 906None 907.It system 908Execute an arbitrary command with 909.Xr system 3 910.Pp 911.Sy Variables : 912.Bl -tag -width indent 913.It command | 909.El 910.It addGroup 911Invoke the interactive group editor. 912.Pp 913.Sy Variables : 914None 915.It addUser 916Invoke the interactive user editor. --- 7 unchanged lines hidden (view full) --- 924None 925.It system 926Execute an arbitrary command with 927.Xr system 3 928.Pp 929.Sy Variables : 930.Bl -tag -width indent 931.It command |
| 914The name of the command to execute. When running | 932The name of the command to execute. 933When running |
| 915from a boot floppy, very minimal expectations should 916be made as to what's available until/unless a relatively 917full system installation has just been done. 918.El 919.It tcpMenuSelect 920Configure a network device. 921.Pp 922.Sy Variables : --- 88 unchanged lines hidden --- | 934from a boot floppy, very minimal expectations should 935be made as to what's available until/unless a relatively 936full system installation has just been done. 937.El 938.It tcpMenuSelect 939Configure a network device. 940.Pp 941.Sy Variables : --- 88 unchanged lines hidden --- |