Skip site navigation (1)Skip section navigation (2)
Date:      Wed, 13 Jan 1999 11:31:48 +0100 (CET)
From:      Andrzej Bialecki <abial@nask.pl>
To:        Joe Abley <jabley@clear.co.nz>
Cc:        "Daniel C. Sobral" <dcs@newsguy.com>, Mike Smith <mike@smith.net.au>, freebsd-hackers@FreeBSD.ORG
Subject:   Re: FICL and setting BTX variables
Message-ID:  <Pine.BSF.4.02A.9901131127490.5148-100000@korin.warman.org.pl>
In-Reply-To: <19990113204253.D1312@clear.co.nz>

next in thread | previous in thread | raw e-mail | index | archive | help
On Wed, 13 Jan 1999, Joe Abley wrote:

> Hi again,
> 
> Has anybody had a chance to look at the boot help merge script I posted the
> other day? Just interested as to whether I had got the right end of the stick.

Yes, I tried it. There are several things which should be corrected - see
the diffs attached below. Besides obvious errors, I think we should
preserve blank lines inside the help topics in order to improve
readability.

The diffs are between loader.help generated with perl script, and
loader.help1 generated from the same sources by your awk script, with
command:
	diff -u --ignore-space-change loader.help loader.help1

Andrzej Bialecki

--------------------   ++-------++  -------------------------------------
 <abial@nask.pl>       ||PicoBSD||   FreeBSD in your pocket? Go and see:
 Research & Academic   |+-------+|       "Small & Embedded FreeBSD"
 Network in Poland     | |TT~~~| |    http://www.freebsd.org/~picobsd/
--------------------   ~-+==---+-+  -------------------------------------

--- loader.help	Wed Jan 13 11:14:28 1999
+++ loader.help1	Wed Jan 13 11:15:30 1999
@@ -24,11 +24,7 @@
 
 	Emits <message>, with no trailing newline if -n is specified.  This is
 	most useful in conjunction with scripts and the '@' line prefix.
-
 	Variables are substituted by prefixing them with $, eg.
-
-		echo Current device is $currdev
-
 	will print the current device.
 
 ################################################################################
@@ -43,14 +39,12 @@
 # Thelp DDisplay command help
 
 	help [topic [subtopic]]
-	?
 
+	?
 	The help command displays help on commands and their usage.
-
 	In command help, a term enclosed with <...> indicates a value as
 	described by the term.  A term enclosed with [...] is optional,
 	and may not be required by all forms of the command.
-
 	Some commands may not be availalble.  Use the '?' command to list
 	most available commands.
 
@@ -62,7 +56,6 @@
 	Loads the module contained in <filename> into memory.  If no other
 	modules are loaded, <filename> must be a kernel or the command will
 	fail.
-
 	If -t is specified, the module is loaded as raw data of <type>, for
 	later use by the kernel or other modules.  <type> may be any string.
 
@@ -73,7 +66,6 @@
 
 	Displays a listing of files in the directory <path>, or the root
 	directory of the current device if <path> is not specified.
-
 	The -l argument displays file sizes as well; the process of obtaining
 	file sizes on some media may be very slow.
 
@@ -100,7 +92,6 @@
 	Scan for Plug-and-Play devices.  This command is normally automatically
 	run as part of the boot process, in order to dynamically load modules
 	required for system operation.
-
 	If the -v argument is specified, details on the devices found will
 	be printed.
 
@@ -113,10 +104,8 @@
 	-t argument is specified, it will return nothing if no input has been
 	received after <value> seconds.  (Any keypress will cancel the 
 	timeout).
-
 	If -p is specified, <prompt> is printed before reading input. No 
 	newline is emitted after the prompt.
-
 	If a variable name is supplied, the variable is set to the value read,
 	less any terminating newline.
 
@@ -131,8 +120,8 @@
 # Tset DSet a variable
 
 	set <variable name>
-	set <variable name>=<value>
 
+	set <variable name>=<value>
 	The set command is used to set variables.
 
 ################################################################################
@@ -240,8 +229,6 @@
 	Variable substitution is performed on the prompt.  The default 
 	prompt can be set with:
 
-		set prompt=\$currdev>
-
 ################################################################################
 # Tset Srootdev DSet the root filesystem
 
@@ -258,7 +245,6 @@
 
 	Displays the value of <variable>, or all variables if not specified.
 	Multiple paths can be separated with a semicolon.
-
 	See the set command for a list of some variables.
 
 ################################################################################
@@ -268,15 +254,9 @@
 
 	The entire contents of <filename> are read into memory before executing
 	commands, so it is safe to source a file from removable media.
-
 	A number of modifiers may be prefixed to commands within a script file
 	to alter their behaviour:
 
-	@	Suppresses the printing of the command when executed.
-
-	-	Prevents the script from terminating if the command returns
-		an error.
-
 ################################################################################
 # Tunload DRemove all modules from memory
 
@@ -290,6 +270,4 @@
 	unset <variable name>
 
 	If allowed, the named variable's value is discarded and the variable
-	is removed.	
 
-################################################################################


To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-hackers" in the body of the message



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?Pine.BSF.4.02A.9901131127490.5148-100000>