diff options
author | jkh <jkh@FreeBSD.org> | 1997-08-18 21:10:26 +0000 |
---|---|---|
committer | jkh <jkh@FreeBSD.org> | 1997-08-18 21:10:26 +0000 |
commit | ac3f0c9820af2153cd8e3815c10d8c2b0c729fc9 (patch) | |
tree | 9beed3aa1d9dd7dcca6245ade5fa83e942855661 | |
parent | 3d3878a0ed9ddeffdd28d8dcfa7932f023ae328e (diff) | |
download | FreeBSD-src-ac3f0c9820af2153cd8e3815c10d8c2b0c729fc9.zip FreeBSD-src-ac3f0c9820af2153cd8e3815c10d8c2b0c729fc9.tar.gz |
2nd round doc cleanup.
-rw-r--r-- | release/sysinstall/sysinstall.8 | 56 | ||||
-rw-r--r-- | usr.sbin/sade/sade.8 | 56 | ||||
-rw-r--r-- | usr.sbin/sysinstall/sysinstall.8 | 56 |
3 files changed, 84 insertions, 84 deletions
diff --git a/release/sysinstall/sysinstall.8 b/release/sysinstall/sysinstall.8 index 1def9d3..465c719 100644 --- a/release/sysinstall/sysinstall.8 +++ b/release/sysinstall/sysinstall.8 @@ -22,7 +22,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.\" $Id: sysinstall.8,v 1.1 1997/08/11 13:08:29 jkh Exp $ +.\" $Id: sysinstall.8,v 1.2 1997/08/11 13:20:38 jkh Exp $ .\" .Dd August 9, 1997 .Dt SYSINSTALL 8 @@ -33,28 +33,27 @@ .Sh SYNOPSIS .Nm .Op Ar var=value -.Op Ar sub-function +.Op Ar function .Op Ar ... .Sh DESCRIPTION .Nm -is a utility for installing and configuring FreeBSD systems; -it is the first utility invoked by the FreeBSD installation boot +is a utility for installing and configuring FreeBSD systems. +It is the first utility invoked by the FreeBSD installation boot floppy and is also copied into -.Pa /stand -on newly installed FreeBSD systems so that it may be run -later to further configure the system. +.Pa /stand/sysinstall +on newly installed FreeBSD systems for use in later configuring the system. .Pp The .Nm program is generally invoked without arguments for the default -behavior which brings up the main installation/configuration menu. +behavior, where the main installation/configuration menu is presented. 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. Since this action is essentially identical to running an installation -script, with each argument corresponding to a line of script, the -reader is encouraged to read the section on scripting for more +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 @@ -69,7 +68,7 @@ for running as a replacement for .Xr init 8 when it's invoked by the FreeBSD installation boot procedure. It assumes very little in the way of additional utility support and -performs most file operations by calling the relevant syscalls +performs most file system operations by calling the relevant syscalls (such as .Xr mount 2 ) directly. @@ -89,7 +88,7 @@ utility. .Sh RUNNING SCRIPTS .Nm may be either driven interactively through its various internal menus -or run in batch mode, driven by an external script. Such scripts can +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 @@ -101,7 +100,7 @@ is compiled with LOAD_CONFIG_FILE set in the environment be used as the filename to automatically look for and load when .Nm -starts up, no interaction on the part of the user being required. +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. @@ -111,13 +110,11 @@ If .Nm 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 allow the name of a script file to be -specified and loaded from a DOS or UFS formatted floppy. +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" -In the same fashion that script directives may be specified one -operation per line in a file, so may each command line argument -be a directive +Each command line argument is treated as a script directive when .Nm is run in multi-user mode. Execution ends either by explicit request @@ -134,17 +131,17 @@ For example: Would initialize .Nm for FTP installation media (using the server `ziggy') and then -bring up the package installation editor. When the package editor -exits, so will -.Nm +bring up the package installation editor, exiting when finished. .El .Pp .Sh SCRIPT SYNTAX -A script is given one or more directives, each directive taking +A script is a list of one or more directives, each directive taking the form of: .Ar var=value +.Pp .Ar function +.Pp or .Ar #somecomment @@ -159,10 +156,13 @@ is the name of an internal function, e.g. "mediaSetFTP", and .Ar #comment is a single-line comment for documentation purposes (ignored by -sysinstall). Functions take their arguments by examining known -variable names, requiring that you be sure to assign those values -first before calling the function. Where a function in the table -below takes such arguments, they will be documented there. +sysinstall). Each directive must be by itself on a single line, +functions taking their arguments by examining known variable names. +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 .Pp @@ -261,8 +261,8 @@ Note: Nothing is actually written to disk by this function, a explicit call to being required for that to happen. .It diskPartitionWrite Causes any pending MBR changes (typically from the -.Ar diskPartitionEditor ) -to be written out. +.Ar diskPartitionEditor +function) to be written out. .Pp \fBVariables:\fR None .It diskLabelEditor diff --git a/usr.sbin/sade/sade.8 b/usr.sbin/sade/sade.8 index 1def9d3..465c719 100644 --- a/usr.sbin/sade/sade.8 +++ b/usr.sbin/sade/sade.8 @@ -22,7 +22,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.\" $Id: sysinstall.8,v 1.1 1997/08/11 13:08:29 jkh Exp $ +.\" $Id: sysinstall.8,v 1.2 1997/08/11 13:20:38 jkh Exp $ .\" .Dd August 9, 1997 .Dt SYSINSTALL 8 @@ -33,28 +33,27 @@ .Sh SYNOPSIS .Nm .Op Ar var=value -.Op Ar sub-function +.Op Ar function .Op Ar ... .Sh DESCRIPTION .Nm -is a utility for installing and configuring FreeBSD systems; -it is the first utility invoked by the FreeBSD installation boot +is a utility for installing and configuring FreeBSD systems. +It is the first utility invoked by the FreeBSD installation boot floppy and is also copied into -.Pa /stand -on newly installed FreeBSD systems so that it may be run -later to further configure the system. +.Pa /stand/sysinstall +on newly installed FreeBSD systems for use in later configuring the system. .Pp The .Nm program is generally invoked without arguments for the default -behavior which brings up the main installation/configuration menu. +behavior, where the main installation/configuration menu is presented. 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. Since this action is essentially identical to running an installation -script, with each argument corresponding to a line of script, the -reader is encouraged to read the section on scripting for more +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 @@ -69,7 +68,7 @@ for running as a replacement for .Xr init 8 when it's invoked by the FreeBSD installation boot procedure. It assumes very little in the way of additional utility support and -performs most file operations by calling the relevant syscalls +performs most file system operations by calling the relevant syscalls (such as .Xr mount 2 ) directly. @@ -89,7 +88,7 @@ utility. .Sh RUNNING SCRIPTS .Nm may be either driven interactively through its various internal menus -or run in batch mode, driven by an external script. Such scripts can +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 @@ -101,7 +100,7 @@ is compiled with LOAD_CONFIG_FILE set in the environment be used as the filename to automatically look for and load when .Nm -starts up, no interaction on the part of the user being required. +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. @@ -111,13 +110,11 @@ If .Nm 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 allow the name of a script file to be -specified and loaded from a DOS or UFS formatted floppy. +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" -In the same fashion that script directives may be specified one -operation per line in a file, so may each command line argument -be a directive +Each command line argument is treated as a script directive when .Nm is run in multi-user mode. Execution ends either by explicit request @@ -134,17 +131,17 @@ For example: Would initialize .Nm for FTP installation media (using the server `ziggy') and then -bring up the package installation editor. When the package editor -exits, so will -.Nm +bring up the package installation editor, exiting when finished. .El .Pp .Sh SCRIPT SYNTAX -A script is given one or more directives, each directive taking +A script is a list of one or more directives, each directive taking the form of: .Ar var=value +.Pp .Ar function +.Pp or .Ar #somecomment @@ -159,10 +156,13 @@ is the name of an internal function, e.g. "mediaSetFTP", and .Ar #comment is a single-line comment for documentation purposes (ignored by -sysinstall). Functions take their arguments by examining known -variable names, requiring that you be sure to assign those values -first before calling the function. Where a function in the table -below takes such arguments, they will be documented there. +sysinstall). Each directive must be by itself on a single line, +functions taking their arguments by examining known variable names. +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 .Pp @@ -261,8 +261,8 @@ Note: Nothing is actually written to disk by this function, a explicit call to being required for that to happen. .It diskPartitionWrite Causes any pending MBR changes (typically from the -.Ar diskPartitionEditor ) -to be written out. +.Ar diskPartitionEditor +function) to be written out. .Pp \fBVariables:\fR None .It diskLabelEditor diff --git a/usr.sbin/sysinstall/sysinstall.8 b/usr.sbin/sysinstall/sysinstall.8 index 1def9d3..465c719 100644 --- a/usr.sbin/sysinstall/sysinstall.8 +++ b/usr.sbin/sysinstall/sysinstall.8 @@ -22,7 +22,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.\" $Id: sysinstall.8,v 1.1 1997/08/11 13:08:29 jkh Exp $ +.\" $Id: sysinstall.8,v 1.2 1997/08/11 13:20:38 jkh Exp $ .\" .Dd August 9, 1997 .Dt SYSINSTALL 8 @@ -33,28 +33,27 @@ .Sh SYNOPSIS .Nm .Op Ar var=value -.Op Ar sub-function +.Op Ar function .Op Ar ... .Sh DESCRIPTION .Nm -is a utility for installing and configuring FreeBSD systems; -it is the first utility invoked by the FreeBSD installation boot +is a utility for installing and configuring FreeBSD systems. +It is the first utility invoked by the FreeBSD installation boot floppy and is also copied into -.Pa /stand -on newly installed FreeBSD systems so that it may be run -later to further configure the system. +.Pa /stand/sysinstall +on newly installed FreeBSD systems for use in later configuring the system. .Pp The .Nm program is generally invoked without arguments for the default -behavior which brings up the main installation/configuration menu. +behavior, where the main installation/configuration menu is presented. 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. Since this action is essentially identical to running an installation -script, with each argument corresponding to a line of script, the -reader is encouraged to read the section on scripting for more +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 @@ -69,7 +68,7 @@ for running as a replacement for .Xr init 8 when it's invoked by the FreeBSD installation boot procedure. It assumes very little in the way of additional utility support and -performs most file operations by calling the relevant syscalls +performs most file system operations by calling the relevant syscalls (such as .Xr mount 2 ) directly. @@ -89,7 +88,7 @@ utility. .Sh RUNNING SCRIPTS .Nm may be either driven interactively through its various internal menus -or run in batch mode, driven by an external script. Such scripts can +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 @@ -101,7 +100,7 @@ is compiled with LOAD_CONFIG_FILE set in the environment be used as the filename to automatically look for and load when .Nm -starts up, no interaction on the part of the user being required. +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. @@ -111,13 +110,11 @@ If .Nm 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 allow the name of a script file to be -specified and loaded from a DOS or UFS formatted floppy. +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" -In the same fashion that script directives may be specified one -operation per line in a file, so may each command line argument -be a directive +Each command line argument is treated as a script directive when .Nm is run in multi-user mode. Execution ends either by explicit request @@ -134,17 +131,17 @@ For example: Would initialize .Nm for FTP installation media (using the server `ziggy') and then -bring up the package installation editor. When the package editor -exits, so will -.Nm +bring up the package installation editor, exiting when finished. .El .Pp .Sh SCRIPT SYNTAX -A script is given one or more directives, each directive taking +A script is a list of one or more directives, each directive taking the form of: .Ar var=value +.Pp .Ar function +.Pp or .Ar #somecomment @@ -159,10 +156,13 @@ is the name of an internal function, e.g. "mediaSetFTP", and .Ar #comment is a single-line comment for documentation purposes (ignored by -sysinstall). Functions take their arguments by examining known -variable names, requiring that you be sure to assign those values -first before calling the function. Where a function in the table -below takes such arguments, they will be documented there. +sysinstall). Each directive must be by itself on a single line, +functions taking their arguments by examining known variable names. +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 .Pp @@ -261,8 +261,8 @@ Note: Nothing is actually written to disk by this function, a explicit call to being required for that to happen. .It diskPartitionWrite Causes any pending MBR changes (typically from the -.Ar diskPartitionEditor ) -to be written out. +.Ar diskPartitionEditor +function) to be written out. .Pp \fBVariables:\fR None .It diskLabelEditor |