[src/trunk]: src/share/man/man9 Document the defflag and defparam statements.

[gmcgarry <gmcgarry%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/db2988dadf0b
branches:  trunk
changeset: 519233:db2988dadf0b
user:      gmcgarry <gmcgarry%NetBSD.org@localhost>
date:      Thu Dec 13 19:26:50 2001 +0000

description:
Document the defflag and defparam statements.

diffstat:

 share/man/man9/config.9 |  45 +++++++++++++++++++++++++++++++++++++++++----
 1 files changed, 41 insertions(+), 4 deletions(-)

diffs (71 lines):

diff -r 24975a443ab8 -r db2988dadf0b share/man/man9/config.9
--- a/share/man/man9/config.9   Thu Dec 13 17:25:37 2001 +0000
+++ b/share/man/man9/config.9   Thu Dec 13 19:26:50 2001 +0000
@@ -1,4 +1,4 @@
-.\"     $NetBSD: config.9,v 1.2 2001/09/04 02:51:15 wiz Exp $
+.\"     $NetBSD: config.9,v 1.3 2001/12/13 19:26:50 gmcgarry Exp $
 .\"
 .\" Copyright (c) 2001 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -134,13 +134,50 @@
 character, and any line that begins with white space continues the
 previous line.  Valid statements are:
 .Bl -tag -width xxxxxx
+.It defflag [filename] {options}
+The space-separated list of pre-processor macros
+.Em options
+are defined in file
+.Em filename .
+This statement permits ``options FOO'' for FOO (i.e, without a value)
+in the machine description file.
+.Xr config 8
+will generate an error if a value is given.  If the filename field is
+not specified, the options are defined on the commandline invocation
+of
+.Xr make 1 .
+The
+.Em option
+is case-sensitive.
+.It defparam [filename] {options}
+The space-separated list of pre-processor macros
+.Em options
+are defined in file
+.Em filename .
+This statement permits ``options FOO=bar'' or ``option FOO="\\"com\\""''
+in the machine description file.
+.Xr config 8
+will generate an error if a value is not given.  If the filename field
+is not specified, the options are defined on the commandline
+invocation of
+.Xr make 1 .
+The
+.Em option
+is case-sensitive.
 .It defopt [filename] {options}
 The space-separated list of pre-processor macros
 .Em options
 are defined in file
 .Em filename .
-If the filename field is not specified, the options are defined on the
-commandline invocation of make.
+This statement permits the syntax of either the defflag and defparam
+statements and
+.Xr config 8
+does not perform any checking of whether ``options FOO'' takes a
+value.  Therefore, the use of the defopt statement is deprecated in
+favour of the defflag and defparam statements.  If the filename field
+is not specified, the options are defined on the commandline
+invocation of
+.Xr make 1 .
 The
 .Em option
 is case-sensitive.
@@ -260,7 +297,7 @@
 .sp
 .Xr config 8 ,
 .Xr autoconf 9 ,
-.Xr driver 9 .
+.Xr driver 9
 .Sh HISTORY
 Autoconfiguration first appeared in
 .Bx 4.1 .