From 7fe9f94acacb5b2a356f85a53a8750abdf7e2b33 Mon Sep 17 00:00:00 2001 From: "Jordan K. Hubbard" Date: Mon, 5 Jun 1995 15:26:38 +0000 Subject: [PATCH] My style and doc changes. --- .../help/en_US.ISO8859-1/hardware.hlp | 87 ++++++++++--------- .../help/en_US.ISO_8859-1/hardware.hlp | 87 ++++++++++--------- 2 files changed, 90 insertions(+), 84 deletions(-) diff --git a/release/sysinstall/help/en_US.ISO8859-1/hardware.hlp b/release/sysinstall/help/en_US.ISO8859-1/hardware.hlp index 4e57a60ae253..73abdd28b114 100644 --- a/release/sysinstall/help/en_US.ISO8859-1/hardware.hlp +++ b/release/sysinstall/help/en_US.ISO8859-1/hardware.hlp @@ -1,8 +1,9 @@ -Hardware Documentation Guide: $Id: hardware.hlp,v 1.4 1995/06/05 06:37:28 jkh Exp $ +Hardware Documentation Guide: $Id: hardware.hlp,v 1.5 1995/06/05 15:17:54 jkh Exp $ Table of Contents ----------------- +0. Document Conventions 1. Using UserConfig to change FreeBSD kernel settings 2. Default Configuration (GENERIC kernel) 3. LINT - other possible configurations. @@ -10,16 +11,22 @@ Table of Contents ========================================================================= +0. Document Conventions +-- -------------------- + +We have `underlined' text which represents user input with `-' +symbols throughout this document to differentiate it from +the machine output. 1. Using UserConfig to change FreeBSD kernel settings -- -------------------------------------------------- The UserConfig utility allows you to override various settings of -the FreeBSD kernel when the system is booting. This allows you to -make minor adjustments to the drivers in the system without having to -recompile the kernel. +the FreeBSD kernel before the system has booted. This allows you to +make minor adjustments to the various drivers in the system without +necessarily having to recompile the kernel. -UserConfig is activated by including the '-c' flag at the initial +UserConfig is activated by specifying the `-c' flag at the initial boot prompt. For example: >> FreeBSD BOOT @ 0x10000: 640/7168 k of memory @@ -31,9 +38,9 @@ boot prompt. For example: -- This command causes the system to boot the default kernel ("/kernel") and -the UserConfig utility will be started once the kernel is loaded into memory. +the UserConfig utility to be started once the kernel is loaded into memory. -The '-c' flag follows any other parameters that you may need to provide +The `-c' flag follows any of the other parameters you may need to provide for the system to boot properly. For example, to boot off the second of two SCSI drives installed and run UserConfig, you would type: @@ -71,64 +78,60 @@ generic kernel. This includes reassigning IRQs, disabling troublesome devices (or drivers that conflict with the hardware your system has), setting special device flags, etc. -The first thing most people do is determine the current settings for -a driver that they are having trouble with. The "ls" command displays -the current settings for all the drivers present in the kernel that -is loaded in memory. +The most common use of UserConfig is to adjust or disable a driver +which is causing trouble. The "ls" command displays the current +settings for all the drivers present in the booted kernel, and +once you have located an entry of interest you may use the displayed +device name to change its settings or even disable the driver completely. -Once you have located the entry in question, you will use the device -name to change settings or even disable the driver completely. For example, to change the address of network adapter 'ed0' to the address 0xd4000, you would type config> iomem ed0 0xd4000 ----------------- -You might also want to disable a driver you are not using. In this -example, you might want to disable device 'ie0', so you would type: +To entirely disable a device driver you are not using, use the +"disable" command. In this example, you would disable device +`ie0' by typing: config> disable ie0 ----------- -You can use the 'ls' command to verify your changes and you can correct -any mistyped commands at any time. +You can use the "ls" command to verify your changes and correct +any other problems before continuing the boot process. +Once you are happy with a given configuration you may type: "quit" -Once you are happy with a given configuration you may use the `quit' -command. This will cause the kernel to boot with the new settings you -have specified. +This will cause the kernel to boot with the new settings you +have chosen. - -Once you have a fully installed system (e.g. the filesystems have been -partitioned and the bin distribution successfully extracted), any changes -you make in UserConfig are permanently stored in the '/kernel' file on -the root filesystem. This action is performed by the utility 'dset'. -These settings will remain in effect until you replace the kernel -a different one. If you do not want your changes to be permanently -stored, remove 'dset' from the /etc/rc file before you make any -changes. +Once you have a fully installed system (e.g. the `bin' distribution +has been successfully extracted), any changes you make in UserConfig +are permanently stored in the `/kernel' file on the root filesystem. +This action is performed by the `dset' utility, which will ensure that +these settings remain in effect until you replace the kernel with +a new one. If you do not want your changes to be permanently +stored like this, remove `dset' from the /etc/rc file before you +make any changes. If you accidentally change a setting for a device that you did not mean to change, the safest thing to do is to reset the computer and start -over. Do not allow the boot to proceed (do not type 'quit') with settings -you are not happy with because the settings may be permanently stored and -may leave your system in a state where it will not run properly anymore. - +over. Do not allow the boot to proceed (e.g. do not type "quit") with +bad settings as these may be permanently stored by dset and +leave your system in a state where it will no longer run properly. We suggest as a general rule that you disable any drivers that are not used by your particular hardware configuration. There are known problems -with certain device drivers (see section 4.0) for devices that your -system may not have, yet they still conflict with some other device that -your system does have, residing at the same port/IRQ addresses. These -drivers will eventually be fixed or replaced in some future release -of the operating system, but until that time it is quite a bit simpler -to use the `disable' command to remove them from consideration entirely. +with certain device drivers (see section 4.0) that can cause conflicts +with other devices if they're also not disabled. You should move or +disable any device that resides at the same port or IRQ as a device +you actually have! You can also remove drivers that are not needed by building yourself a custom kernel that contains only the device deviers which your system really needs (see section 6.0 of the FreeBSD.FAQ). If your system has sufficient free disk space to store and compile the kernel sources, -this is the option we recommend. +this is the option we most highly recommend. @@ -158,8 +161,8 @@ table, but not all are used by each device. They are: If an entry in the table has `n/a' for the value, it means that the parameter does not apply to that device. A value of `dyn' means that the -correct value is determined automatically by the kernel when the system -boots. +correct value should be determined automatically by the kernel when the +system boots. FreeBSD GENERIC kernel: diff --git a/release/sysinstall/help/en_US.ISO_8859-1/hardware.hlp b/release/sysinstall/help/en_US.ISO_8859-1/hardware.hlp index 4e57a60ae253..73abdd28b114 100644 --- a/release/sysinstall/help/en_US.ISO_8859-1/hardware.hlp +++ b/release/sysinstall/help/en_US.ISO_8859-1/hardware.hlp @@ -1,8 +1,9 @@ -Hardware Documentation Guide: $Id: hardware.hlp,v 1.4 1995/06/05 06:37:28 jkh Exp $ +Hardware Documentation Guide: $Id: hardware.hlp,v 1.5 1995/06/05 15:17:54 jkh Exp $ Table of Contents ----------------- +0. Document Conventions 1. Using UserConfig to change FreeBSD kernel settings 2. Default Configuration (GENERIC kernel) 3. LINT - other possible configurations. @@ -10,16 +11,22 @@ Table of Contents ========================================================================= +0. Document Conventions +-- -------------------- + +We have `underlined' text which represents user input with `-' +symbols throughout this document to differentiate it from +the machine output. 1. Using UserConfig to change FreeBSD kernel settings -- -------------------------------------------------- The UserConfig utility allows you to override various settings of -the FreeBSD kernel when the system is booting. This allows you to -make minor adjustments to the drivers in the system without having to -recompile the kernel. +the FreeBSD kernel before the system has booted. This allows you to +make minor adjustments to the various drivers in the system without +necessarily having to recompile the kernel. -UserConfig is activated by including the '-c' flag at the initial +UserConfig is activated by specifying the `-c' flag at the initial boot prompt. For example: >> FreeBSD BOOT @ 0x10000: 640/7168 k of memory @@ -31,9 +38,9 @@ boot prompt. For example: -- This command causes the system to boot the default kernel ("/kernel") and -the UserConfig utility will be started once the kernel is loaded into memory. +the UserConfig utility to be started once the kernel is loaded into memory. -The '-c' flag follows any other parameters that you may need to provide +The `-c' flag follows any of the other parameters you may need to provide for the system to boot properly. For example, to boot off the second of two SCSI drives installed and run UserConfig, you would type: @@ -71,64 +78,60 @@ generic kernel. This includes reassigning IRQs, disabling troublesome devices (or drivers that conflict with the hardware your system has), setting special device flags, etc. -The first thing most people do is determine the current settings for -a driver that they are having trouble with. The "ls" command displays -the current settings for all the drivers present in the kernel that -is loaded in memory. +The most common use of UserConfig is to adjust or disable a driver +which is causing trouble. The "ls" command displays the current +settings for all the drivers present in the booted kernel, and +once you have located an entry of interest you may use the displayed +device name to change its settings or even disable the driver completely. -Once you have located the entry in question, you will use the device -name to change settings or even disable the driver completely. For example, to change the address of network adapter 'ed0' to the address 0xd4000, you would type config> iomem ed0 0xd4000 ----------------- -You might also want to disable a driver you are not using. In this -example, you might want to disable device 'ie0', so you would type: +To entirely disable a device driver you are not using, use the +"disable" command. In this example, you would disable device +`ie0' by typing: config> disable ie0 ----------- -You can use the 'ls' command to verify your changes and you can correct -any mistyped commands at any time. +You can use the "ls" command to verify your changes and correct +any other problems before continuing the boot process. +Once you are happy with a given configuration you may type: "quit" -Once you are happy with a given configuration you may use the `quit' -command. This will cause the kernel to boot with the new settings you -have specified. +This will cause the kernel to boot with the new settings you +have chosen. - -Once you have a fully installed system (e.g. the filesystems have been -partitioned and the bin distribution successfully extracted), any changes -you make in UserConfig are permanently stored in the '/kernel' file on -the root filesystem. This action is performed by the utility 'dset'. -These settings will remain in effect until you replace the kernel -a different one. If you do not want your changes to be permanently -stored, remove 'dset' from the /etc/rc file before you make any -changes. +Once you have a fully installed system (e.g. the `bin' distribution +has been successfully extracted), any changes you make in UserConfig +are permanently stored in the `/kernel' file on the root filesystem. +This action is performed by the `dset' utility, which will ensure that +these settings remain in effect until you replace the kernel with +a new one. If you do not want your changes to be permanently +stored like this, remove `dset' from the /etc/rc file before you +make any changes. If you accidentally change a setting for a device that you did not mean to change, the safest thing to do is to reset the computer and start -over. Do not allow the boot to proceed (do not type 'quit') with settings -you are not happy with because the settings may be permanently stored and -may leave your system in a state where it will not run properly anymore. - +over. Do not allow the boot to proceed (e.g. do not type "quit") with +bad settings as these may be permanently stored by dset and +leave your system in a state where it will no longer run properly. We suggest as a general rule that you disable any drivers that are not used by your particular hardware configuration. There are known problems -with certain device drivers (see section 4.0) for devices that your -system may not have, yet they still conflict with some other device that -your system does have, residing at the same port/IRQ addresses. These -drivers will eventually be fixed or replaced in some future release -of the operating system, but until that time it is quite a bit simpler -to use the `disable' command to remove them from consideration entirely. +with certain device drivers (see section 4.0) that can cause conflicts +with other devices if they're also not disabled. You should move or +disable any device that resides at the same port or IRQ as a device +you actually have! You can also remove drivers that are not needed by building yourself a custom kernel that contains only the device deviers which your system really needs (see section 6.0 of the FreeBSD.FAQ). If your system has sufficient free disk space to store and compile the kernel sources, -this is the option we recommend. +this is the option we most highly recommend. @@ -158,8 +161,8 @@ table, but not all are used by each device. They are: If an entry in the table has `n/a' for the value, it means that the parameter does not apply to that device. A value of `dyn' means that the -correct value is determined automatically by the kernel when the system -boots. +correct value should be determined automatically by the kernel when the +system boots. FreeBSD GENERIC kernel: