From acdf0532073442b2b8fdb6e93ff9608b055f2dbc Mon Sep 17 00:00:00 2001 From: ru Date: Wed, 27 Dec 2000 14:22:05 +0000 Subject: Prepare for mdoc(7)NG. --- usr.sbin/sade/sade.8 | 169 +++++++++++++++++++++++++++++++-------------------- 1 file changed, 102 insertions(+), 67 deletions(-) (limited to 'usr.sbin/sade/sade.8') diff --git a/usr.sbin/sade/sade.8 b/usr.sbin/sade/sade.8 index 509796e..1473bab 100644 --- a/usr.sbin/sade/sade.8 +++ b/usr.sbin/sade/sade.8 @@ -53,7 +53,7 @@ The .Nm program is generally invoked without arguments for the default behavior, where the main installation/configuration menu is presented. - +.Pp On those occasions where it is deemed necessary to invoke a subsystem of sysinstall directly, however, it is also possible to do so by naming the appropriate function entry points on the command line. @@ -61,7 +61,6 @@ Since this action is essentially identical to running an installation script, each command-line argument corresponding to a line of script, the reader is encouraged to read the section on scripting for more information on this feature. -.Pp .Sh NOTES .Nm is essentially nothing more than a monolithic C program with @@ -100,8 +99,7 @@ eventually be replaced. may be either driven interactively through its various internal menus or run in batch mode, driven by an external script. Such a script may be loaded and executed in one of 3 ways: - -.Bl -tag -width Ds -compact +.Bl -tag -width Ds .It Sy "LOAD_CONFIG_FILE" If .Nm @@ -114,7 +112,6 @@ starts up and with no user interaction required. This option is aimed primarily at large sites who wish to create a single prototype install for multiple machines with largely identical configurations and/or installation options. - .It Sy "MAIN MENU" If .Nm @@ -122,7 +119,6 @@ is run interactively, that is to say in the default manner, it will bring up a main menu which contains a "load config file" option. Selecting this option will prompt for the name of a script file which it then will attempt to load from a DOS or UFS formatted floppy. - .It Sy "COMMAND LINE" Each command line argument is treated as a script directive when @@ -142,18 +138,17 @@ Would initialize for FTP installation media (using the server `ziggy') and then bring up the package installation editor, exiting when finished. .El -.Pp .Sh SCRIPT SYNTAX A script is a list of one or more directives, each directive taking the form of: - +.Pp .Ar var=value .Pp .Ar function .Pp or .Ar #somecomment - +.Pp Where .Ar var=value is the assignment of some internal @@ -171,20 +166,20 @@ This requires that you be sure to assign the relevant variables before calling a function which requires them. When and where a function depends on the settings of one or more variables will be noted in the following table: - .Pp -\fBFunction Glossary:\fR +.Sy "Function Glossary" : .Pp .Bl -tag -width indent .It configAnonFTP Invoke the Anonymous FTP configuration menu. .Pp -\fBVariables:\fR None +.Sy Variables : +None .It configRouter Select which routing daemon you wish to use, potentially loading any required 3rd-party routing daemons as necessary. .Pp -\fBVariables:\fR +.Sy Variables : .Bl -tag -width indent .It router can be set to the name of the desired routing daemon, @@ -197,11 +192,12 @@ otherwise it is prompted for. .It configNFSServer Configure host as an NFS server. .Pp -\fBVariables:\fR None +.Sy Variables : +None .It configNTP Configure host as a user of the Network Time Protocol. .Pp -\fBVariables:\fR +.Sy Variables : .Bl -tag -width indent .It ntpdate_flags The flags to @@ -211,7 +207,7 @@ that is to say the name of the server to sync from. .It configPCNFSD Configure host to support PC NFS. .Pp -\fBVariables:\fR +.Sy Variables : .Bl -tag -width indent .It pcnfsd_pkg The name of the PCNFSD package to load if necessary (defaults to hard coded @@ -220,19 +216,22 @@ version). .It configPackages Bring up the interactive package management menu. .Pp -\fBVariables:\fR None +.Sy Variables : +None .It configUsers Add users and/or groups to the system. .Pp -\fBVariables:\fR None +.Sy Variables : +None .It configXEnvironment Configure the X display subsystem. .Pp -\fBVariables:\fR None +.Sy Variables : +None .It diskPartitionEditor Invokes the disk partition (MBR) editor. .Pp -\fBVariables:\fR +.Sy Variables : .Bl -tag -width findx .It geometry The disk geometry, as a cyls/heads/sectors formatted string. Default: no @@ -282,7 +281,8 @@ Causes any pending MBR changes (typically from the .Ar diskPartitionEditor function) to be written out. .Pp -\fBVariables:\fR None +.Sy Variables : +None .It diskLabelEditor Invokes the disk label editor. This is a bit trickier from a script since you need to essentially label everything inside each @@ -324,7 +324,7 @@ A 100MB /var file system. With the balance of free space (around 316MB) going to the /usr file system. .El - +.Pp One can also use the .Ar diskLabelEditor for mounting or erasing existing partitions as well as creating new @@ -356,16 +356,18 @@ file systems which have requests pending from the .Ar diskLabelEditor function. .Pp -\fBVariables:\fR None +.Sy Variables : +None .It distReset Resets all selected distributions to the empty set (no distributions selected). .Pp -\fBVariables:\fR None +.Sy Variables : +None .It distSetCustom Allows the selection of a custom distribution set (e.g. not just on of the existing "canned" sets) with no user interaction. - -\fBVariables:\fR +.Pp +.Sy Variables : .Bl -tag -width indent .It dists List of distributions to load. Possible distribution values are: @@ -545,56 +547,68 @@ XFree86 3.3.6 non-english font set. .It Li Xfsrv XFree86 3.3.6 font server. .El +.El .It distSetDeveloper Selects the standard Developer's distribution set. .Pp -\fBVariables:\fR None +.Sy Variables : +None .It distSetXDeveloper Selects the standard X Developer's distribution set. .Pp -\fBVariables:\fR None +.Sy Variables : +None .It distSetKernDeveloper Selects the standard kernel Developer's distribution set. .Pp -\fBVariables:\fR None +.Sy Variables : +None .It distSetUser Selects the standard user distribution set. .Pp -\fBVariables:\fR None +.Sy Variables : +None .It distSetXUser Selects the standard X user's distribution set. .Pp -\fBVariables:\fR None +.Sy Variables : +None .It distSetMinimum Selects the very minimum distribution set. .Pp -\fBVariables:\fR None +.Sy Variables : +None .It distSetEverything Selects the full whack - all available distributions. .Pp -\fBVariables:\fR None +.Sy Variables : +None .It distSetCRYPTO Interactively select encryption subcomponents. .Pp -\fBVariables:\fR None +.Sy Variables : +None .It distSetSrc Interactively select source subcomponents. .Pp -\fBVariables:\fR None +.Sy Variables : +None .It distSetXF86 Interactively select XFree86 3.3.6 subcomponents. .Pp -\fBVariables:\fR None +.Sy Variables : +None .It distExtractAll Install all currently selected distributions (requires that media device also be selected). .Pp -\fBVariables:\fR None +.Sy Variables : +None .It docBrowser Install (if necessary) an HTML documentation browser and go to the HTML documentation submenu. .Pp -\fBVariables:\fR +.Sy Variables : .Bl -tag -width indent .It browserPackage The name of the browser package to try and install as necessary. @@ -609,50 +623,59 @@ Commit any and all pending changes to disk. This function is essentially shorthand for a number of more granular "commit" functions. .Pp -\fBVariables:\fR None +.Sy Variables : +None .It installExpress Start an "express" installation, asking few questions of the user. .Pp -\fBVariables:\fR None +.Sy Variables : +None .It installStandard Start a "standard" installation, the most user-friendly installation type available. .Pp -\fBVariables:\fR None +.Sy Variables : +None .It installUpgrade Start an upgrade installation. .Pp -\fBVariables:\fR None +.Sy Variables : +None .It installFixitHoloShell Start up the "emergency holographic shell" over on VTY4 if running as init. .Pp -\fBVariables:\fR None +.Sy Variables : +None .It installFixitCDROM Go into "fixit" mode, assuming a live file system CDROM currently in the drive. .Pp -\fBVariables:\fR None +.Sy Variables : +None .It installFixitFloppy Go into "fixit" mode, assuming an available fixit floppy disk (user will be prompted for it). .Pp -\fBVariables:\fR None +.Sy Variables : +None .It installFilesystems Do just the file system initialization part of an install. .Pp -\fBVariables:\fR None +.Sy Variables : +None .It installVarDefaults Initialize all variables to their defaults, overriding any previous settings. .Pp -\fBVariables:\fR None +.Sy Variables : +None .It loadConfig Sort of like an #include statement, it allows you to load one configuration file from another. .Pp -\fBVariables:\fR +.Sy Variables : .Bl -tag -width indent .It file The fully pathname of the file to load. @@ -662,24 +685,28 @@ Select a .Fx CDROM as the installation media. .Pp -\fBVariables:\fR None +.Sy Variables : +None .It mediaSetFloppy Select a pre-made floppy installation set as the installation media. .Pp -\fBVariables:\fR None +.Sy Variables : +None .It mediaSetDOS Select an existing DOS primary partition as the installation media. The first primary partition found is used (e.g. C:). .Pp -\fBVariables:\fR None +.Sy Variables : +None .It mediaSetTape Select a tape device as the installation media. .Pp -\fBVariables:\fR None +.Sy Variables : +None .It mediaSetFTP Select an FTP site as the installation media. .Pp -\fBVariables:\fR +.Sy Variables : .Bl -tag -width indent .It hostname The name of the host being installed (non-optional). @@ -711,21 +738,24 @@ Alias for .Ar mediaSetFTP using "active" FTP transfer mode. .Pp -\fBVariables:\fR Same as for +.Sy Variables : +Same as for .Ar mediaSetFTP . .It mediaSetFTPPassive Alias for .Ar mediaSetFTP using "passive" FTP transfer mode. .Pp -\fBVariables:\fR Same as for +.Sy Variables : +Same as for .Ar mediaSetFTP . .It mediaSetHTTP Alias for .Ar mediaSetFTP using an HTTP proxy. .Pp -\fBVariables:\fR See +.Sy Variables : +See .Ar mediaSetFTP , plus .Bl -tag -width indent @@ -736,7 +766,7 @@ The proxy to use (host:port) (non-optional). Select an existing UFS partition (mounted with the label editor) as the installation media. .Pp -\fBVariables:\fR +.Sy Variables : .Bl -tag -width indent .It ufs full /path to directory containing the @@ -746,7 +776,7 @@ interested in. .El .It mediaSetNFS .Pp -\fBVariables:\fR +.Sy Variables : .Bl -tag -width indent .It hostname The name of the host being installed (non-optional). @@ -775,7 +805,7 @@ distribution you're interested in. .El .It mediaSetFTPUserPass .Pp -\fBVariables:\fR +.Sy Variables : .Bl -tag -width indent .It ftpUser The username to log in as on the ftp server site. @@ -787,7 +817,7 @@ Default: user@host .El .It mediaSetCPIOVerbosity .Pp -\fBVariables:\fR +.Sy Variables : .Bl -tag -width indent .It cpioVerbose Can be used to set the verbosity of cpio extractions to low, medium or @@ -796,16 +826,18 @@ high. .It mediaGetType Interactively get the user to specify some type of media. .Pp -\fBVariables:\fR None +.Sy Variables : +None .It optionsEditor Invoke the interactive options editor. .Pp -\fBVariables:\fR None +.Sy Variables : +None .It packageAdd Try to fetch and add a package to the system (requires that a media type be set), .Pp -\fBVariables:\fR +.Sy Variables : .Bl -tag -width indent .It package The name of the package to add, e.g. bash-1.14.7 or ncftp-2.4.2. @@ -813,20 +845,23 @@ The name of the package to add, e.g. bash-1.14.7 or ncftp-2.4.2. .It addGroup Invoke the interactive group editor. .Pp -\fBVariables:\fR None +.Sy Variables : +None .It addUser Invoke the interactive user editor. .Pp -\fBVariables:\fR None +.Sy Variables : +None .It shutdown Stop the script and terminate sysinstall. .Pp -\fBVariables:\fR None +.Sy Variables : +None .It system Execute an arbitrary command with .Xr system 3 .Pp -\fBVariables:\fR +.Sy Variables : .Bl -tag -width indent .It command The name of the command to execute. When running -- cgit v1.1