Date: Fri, 5 Jul 2002 15:53:50 -0400 (EDT) From: Chris Pepper <pepper@rockefeller.edu> To: FreeBSD-gnats-submit@FreeBSD.org Cc: Michael Smith <msmith@FreeBSD.org> Subject: docs/40234: Typos and language cleanup in /usr/share/man/man8/loader.8.gz Message-ID: <20020705195350.61DBBA944@guest.reppep.com>
next in thread | raw e-mail | index | archive | help
>Number: 40234
>Category: docs
>Synopsis: Typos and language cleanup in /usr/share/man/man8/loader.8.gz
>Confidential: no
>Severity: non-critical
>Priority: low
>Responsible: freebsd-doc
>State: open
>Quarter:
>Keywords:
>Date-Required:
>Class: doc-bug
>Submitter-Id: current-users
>Arrival-Date: Fri Jul 05 13:00:03 PDT 2002
>Closed-Date:
>Last-Modified:
>Originator: Chris Pepper
>Release: FreeBSD 4.6-STABLE i386
>Organization:
>Environment:
System: FreeBSD guest.reppep.com 4.6-STABLE FreeBSD 4.6-STABLE #2: Fri Jul 5 11:33:25 EDT 2002 root@guest.reppep.com:/usr/obj/usr/src/sys/GENERIC i386
>Description:
/usr/share/man/man8/loader.8.gz has a bunch of typos, fixed in the patch below.
>How-To-Repeat:
man loader
>Fix:
Apply the patch below.
There are a few other issues, though, for which I'm not clear on the solution:
bcachestat
Displays statistics about disk cache usage. For depuration only.
What's 'depuration'?
boot
boot kernelname [...]
boot -flag ...
Immediately proceeds to bootstrap the system, loading the kernel
if necessary. Any flags or arguments are passed to the kernel,
but they must precede the kernel name, if a kernel name is pro-
vided.
WARNING: The behavior of this builtin is changed if loader.4th(8)
is loaded.
What can follow the kernel name? Should 2 & 3 be consolidated for clarity?
init_path
Sets the list of binaries which the kernel will try to run as
initial process. The default is
``/sbin/init:/sbin/oinit:/sbin/init.bak:/stand/sysinstall''.
Is only the first match used in init_path?
What's the purpose of the (empty) "SYSTEM DOCUMENTATION" heading?
--- loader.8.diff begins here ---
--- loader.8 Fri Jul 5 14:49:48 2002
+++ loader.8.fixed Fri Jul 5 15:48:11 2002
@@ -54,7 +54,7 @@
The smaller one is a set of commands
designed for direct use by the casual user, called "builtin
commands" for historical reasons.
-The main drive behind these commands is user-friendlyness.
+The main drive behind these commands is user-friendliness.
The bigger component is an
.Tn ANS
Forth compatible Forth interpreter based on ficl, by
@@ -96,7 +96,7 @@
will be read for historical reasons.
These files are processed through the
.Ic include
-command, which read all of them into memory before processing them,
+command, which reads all of them into memory before processing them,
making disk changes possible.
.Pp
At this point, if an
@@ -112,7 +112,7 @@
.Va prompt
will be set and
.Nm
-will engage interactive mode.
+will enter interactive mode.
.Sh BUILTIN COMMANDS
.Nm Loader Ns 's
builtin commands take its parameters from the command line.
@@ -162,7 +162,7 @@
.Op Fl n
.Op Aq message
.Xc
-Displays a text on the screen.
+Displays text on the screen.
A new line will be printed unless
.Fl n
is specified.
@@ -180,10 +180,10 @@
.Pp
.It Ic include Ar file Op Ar
Process script files.
-Each file is, at a turn, completely read into memory,
-and then have each of its lines passed to the command line interpreter.
+Each file, in turn, is completely read into memory,
+and then each of its lines is passed to the command line interpreter.
If any error is returned by the interpreter, the include
-commands aborts immediately, without reading any other files, and
+command aborts immediately, without reading any other files, and
returns an error itself (see
.Sx ERRORS ) .
.Pp
@@ -191,13 +191,13 @@
.Op Fl t Ar type
.Ar file Cm ...
.Xc
-Loads a kernel, kernel loadable module (kld), or a file of opaque
+Loads a kernel, kernel loadable module (kld), or file of opaque
contents tagged as being of the type
.Ar type .
-Kernel and modules can be either in a.out or elf format.
+Kernel and modules can be either in a.out or ELF format.
Any arguments passed after the name of the file to be loaded
will be passed as arguments to that file.
-Notice, though, that, at the present, this does not work for the kernel.
+Note, though, that at the present this does not work for the kernel.
.Pp
.It Ic ls Xo
.Op Fl l
@@ -231,7 +231,7 @@
.Pp
.It Ic pnpscan Op Fl v
Scans for Plug-and-Play devices.
-This is not functional at the present.
+This is not functional at present.
.Pp
.It Ic read Xo
.Op Fl t Ar seconds
@@ -284,13 +284,13 @@
.Em environmental queries ,
and a separate space of environment variables used by builtins, which
are not directly available to Forth words.
-It is the later ones that this session covers.
+It is the latter type that this session covers.
.Pp
-Environment variables can be set and unset through the use of the
+Environment variables can be set and unset through the
.Ic set
and
.Ic unset
-builtins, and have their value interactively examined through the
+builtins, and have their values interactively examined through the
use of the
.Ic show
builtin.
@@ -303,11 +303,11 @@
A few variables are set automatically by
.Nm .
Others can affect either
-.Nm
-or kernel's behavior at boot.
+.Nm Ns 's
+or the kernel's behavior at boot.
While some of these may require a value,
others define behavior just by being set.
-These are described below.
+Both types are described below.
.Bl -tag -width bootfile
.It Va autoboot_delay
Number of seconds
@@ -323,7 +323,7 @@
.Ic autoboot
will be automatically attempted after processing
.Pa /boot/loader.rc ,
-though explict
+though explicit
.Ic autoboot Ns 's
will be processed normally, defaulting to 10 seconds delay.
.It Va boot_askname
@@ -335,8 +335,8 @@
.It Va boot_gdb
Selects gdb-remote mode for the kernel debugger by default.
.It Va boot_single
-Prevents the kernel from initiating a multi-user startup, single-user
-mode will be entered when the kernel has finished device probes.
+Prevents the kernel from initiating a multi-user startup; instead single-user
+mode will be entered when the kernel has finished device probing.
.It Va boot_userconfig
Requests that the kernel's interactive device configuration program
be run when the kernel is booted.
@@ -364,12 +364,12 @@
.It Va LINES
Define the number of lines on the screen, to be used by the pager.
.It Va module_path
-Sets the list of directories which will be searched in for modules
-named in a load command or implicitly required by a dependancy.
+Sets the list of directories which will be searched for modules
+named in a load command or implicitly required by a dependency.
The default value for this variable is
.Dq Li /;/boot;/modules .
.It Va num_ide_disks
-Sets the number of IDE disks as a work around for some problems in
+Sets the number of IDE disks as a workaround for some problems in
finding the root disk at boot.
This has been deprecated in favour of
.Va root_disk_unit .
@@ -381,8 +381,8 @@
.Dq Li "${currdev}>" .
.It Va root_disk_unit
If the code which detects the disk unit number for the root disk is
-confused, eg. by a mix of SCSI and IDE disks, or IDE disks with
-gaps in the sequence (eg. no primary slave), the unit number can
+confused, e.g. by a mix of SCSI and IDE disks, or IDE disks with
+gaps in the sequence (e.g. no primary slave), the unit number can
be forced by setting this variable.
.It Va rootdev
By default the value of
@@ -393,9 +393,9 @@
.Va rootdev
explicitly.
.It Va dumpdev
-A name of device where the kernel can save a crash dump in the case
+The name of a device where the kernel can save a crash dump in case
of a panic.
-This automatically sets
+This automatically sets the
.Va kern.dumpdev
.Xr sysctl 3
MIB variable.
@@ -502,11 +502,11 @@
character.
.It
\e" , \e' and \e$ will escape these characters, preventing them from
-receiving special semantics on the step 2 described below.
+receiving special treatment in Step 2, described below.
.It
\e\e will be replaced with a single \e .
.It
-In any other occurance, backslash will just be removed.
+In any other occurrence, backslash will just be removed.
.El
.It
Every string between non-escaped quotes or double-quotes will be treated
@@ -516,10 +516,10 @@
.Li $VARIABLE
or
.Li ${VARIABLE}
-with the value of the environemnt variable
+with the value of the environment variable
.Va VARIABLE .
.It
-Passes multiple space-delimited arguments to the builtin command called.
+Space-delimited arguments are passed to the called builtin command.
Spaces can also be escaped through the use of \e\e .
.El
.Pp
@@ -562,9 +562,9 @@
.Ic execute
is processed
.Ef
-\&! This is particular annoying for programs that want or need to
-treat exceptions.
-In this case, it is recommended the use of a proxy.
+\&! This is particularly annoying for programs that want or need to
+handle exceptions.
+In this case, the use of a proxy is recommended.
For example:
.Dl : (boot) boot ;
.Sh FICL
@@ -588,15 +588,14 @@
.Pp
The words available to
.Tn FICL
-can be classified in four groups.
-The
+can be classified into four groups:
.Tn ANS
Forth standard words, extra
.Tn FICL
words, extra
.Fx
-words, and the builtin commands.
-The later were already described.
+words, and builtin commands;
+the latter were already described.
The
.Tn ANS
Forth standard words are listed in the
@@ -647,10 +646,10 @@
.It Ic fkey Pq Ar fd -- char
Reads a single character from a file.
.It Ic fload Pq Ar fd --
-Process file
+Processes a file
.Em fd .
.It Ic fopen Pq Ar addr len -- fd
-Open a file.
+Opens a file.
Returns a file descriptor, or -1 in case of failure.
.It Xo
.Ic fread
@@ -738,7 +737,7 @@
.Pp
.Dl boot -s
.Pp
-Loads kernel's user configuration file.
+Load kernel's user configuration file.
Notice that a kernel must be loaded before any other
.Ic load
command is attempted.
@@ -747,7 +746,7 @@
load -t userconfig_script /boot/kernel.conf
.Ed
.Pp
-Loads the kernel, a splash screen, and then autoboots in five seconds.
+Load the kernel and a splash screen, and then autoboot in five seconds.
.Bd -literal -offset indent
load kernel
load splash_bmp
@@ -755,9 +754,9 @@
autoboot 5
.Ed
.Pp
-Sets the disk unit of the root device to 2, and then boots.
-This would be needed in the case of a two IDE disks system,
-with the second IDE hardwired to wd2 instead of wd1.
+Set the disk unit of the root device to 2, and then boot.
+This would be needed in a system with two IDE disks,
+with the second IDE disk hardwired to wd2 instead of wd1.
.Bd -literal -offset indent
set root_disk_unit=2
boot /kernel
@@ -816,7 +815,7 @@
parse, pick, roll, refill, to, value, \e, false, true,
.No <> ,
.No 0<> ,
-compile\&, , erase, nip, tuck
+compile\&, erase, nip, tuck
.Ef
.Em and
.Li marker
--- loader.8.diff ends here ---
>Release-Note:
>Audit-Trail:
>Unformatted:
To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20020705195350.61DBBA944>