diff options
Diffstat (limited to 'mcon/man')
| -rwxr-xr-x | mcon/man/mconfig.SH | 189 | ||||
| -rwxr-xr-x | mcon/man/mlint.SH | 107 | ||||
| -rwxr-xr-x | mcon/man/mxref.SH | 58 |
3 files changed, 191 insertions, 163 deletions
diff --git a/mcon/man/mconfig.SH b/mcon/man/mconfig.SH index bf49fe9..1dd8a97 100755 --- a/mcon/man/mconfig.SH +++ b/mcon/man/mconfig.SH @@ -18,88 +18,88 @@ echo "Extracting mcon/man/metaconfig.$manext (with variable substitutions)" $rm -f metaconfig.$manext $spitshell >metaconfig.$manext <<!GROK!THIS! .TH METACONFIG $manext "Version $VERSION PL$PATCHLEVEL" -''' @(#) Manual page for metaconfig -''' -''' $Id$ -''' -''' Copyright (c) 1991-1997, 2004-2006, Raphael Manfredi -''' -''' You may redistribute only under the terms of the Artistic Licence, -''' as specified in the README file that comes with the distribution. -''' You may reuse parts of this distribution only within the terms of -''' that same Artistic Licence; a copy of which may be found at the root -''' of the source tree for dist 4.0. -''' -''' $Log: mconfig.SH,v $ -''' Revision 3.0.1.17 1997/02/28 16:29:31 ram -''' patch61: documents the runnning environment and the src.U unit -''' patch61: added warnings for $_a and $_o, as well as "startsh" -''' -''' Revision 3.0.1.16 1995/09/25 09:17:48 ram -''' patch59: documented new ?Y: directive -''' patch59: fixed my e-mail address -''' -''' Revision 3.0.1.15 1995/07/25 14:18:24 ram -''' patch56: added extra nroff escapes at line heads to keep leading dots -''' patch56: documented new -G option -''' patch56: extended description of the Csym.U unit -''' patch56: now mentions what a compile-link test line should look like -''' -''' Revision 3.0.1.14 1995/05/12 12:25:02 ram -''' patch54: documented new -K switch for knowledgeable users -''' -''' Revision 3.0.1.13 1995/01/30 14:46:39 ram -''' patch49: documented new special units Prefixit.U and Prefixup.U -''' -''' Revision 3.0.1.12 1995/01/11 15:39:16 ram -''' patch45: documents new -O option and new Getfile escape supports -''' patch45: documents the & escape in Myread and the new cc symbol lookup -''' -''' Revision 3.0.1.11 1994/10/29 16:32:38 ram -''' patch36: added nroff protection for lines beginning with '.' -''' patch36: documents new ?F: line for file declarations -''' patch36: added example showing how ./loc can be used -''' -''' Revision 3.0.1.10 1994/08/29 16:33:40 ram -''' patch32: documented new Typedef.U unit for typedef lookup -''' -''' Revision 3.0.1.9 1994/06/20 07:10:14 ram -''' patch30: added -L option for easier unit testing -''' patch30: new -D and -U options supported by Configure -''' -''' Revision 3.0.1.8 1994/05/13 15:29:16 ram -''' patch27: now understands macro definitions in ?H: lines -''' -''' Revision 3.0.1.7 1994/05/06 15:19:25 ram -''' patch23: documented the new 'p' option in Getfile.U -''' -''' Revision 3.0.1.6 1994/01/24 14:19:47 ram -''' patch16: symbols defined in a unit can be tagged "internal use only" -''' patch16: documents new MailList.U special unit -''' patch16: new general <\$variable> macro substitution -''' -''' Revision 3.0.1.5 1993/10/16 13:51:50 ram -''' patch12: new option -M to activate ?M: lines -''' patch12: documents new ?M: lines format -''' patch12: new internal Makefile command cm_h_weed for ?M: support -''' patch12: documents usage for new confmagic.h file -''' -''' Revision 3.0.1.4 1993/09/09 11:50:35 ram -''' patch9: lots of typo fixes and abusive variable substitution problems -''' -''' Revision 3.0.1.3 1993/08/30 08:53:51 ram -''' patch8: wrongly stated that patchlevel.h should not be part of MANIFEST.new -''' -''' Revision 3.0.1.2 1993/08/24 12:13:32 ram -''' patch3: typo fixes -''' -''' Revision 3.0.1.1 1993/08/19 06:42:23 ram -''' patch1: leading config.sh searching was not aborting properly -''' -''' Revision 3.0 1993/08/18 12:10:14 ram -''' Baseline for dist 3.0 netwide release. -''' -''' +.\" @(#) Manual page for metaconfig +.\" +.\" $Id$ +.\" +.\" Copyright (c) 1991-1997, 2004-2006, Raphael Manfredi +.\" +.\" You may redistribute only under the terms of the Artistic Licence, +.\" as specified in the README file that comes with the distribution. +.\" You may reuse parts of this distribution only within the terms of +.\" that same Artistic Licence; a copy of which may be found at the root +.\" of the source tree for dist 4.0. +.\" +.\" $Log: mconfig.SH,v $ +.\" Revision 3.0.1.17 1997/02/28 16:29:31 ram +.\" patch61: documents the runnning environment and the src.U unit +.\" patch61: added warnings for $_a and $_o, as well as "startsh" +.\" +.\" Revision 3.0.1.16 1995/09/25 09:17:48 ram +.\" patch59: documented new ?Y: directive +.\" patch59: fixed my e-mail address +.\" +.\" Revision 3.0.1.15 1995/07/25 14:18:24 ram +.\" patch56: added extra nroff escapes at line heads to keep leading dots +.\" patch56: documented new -G option +.\" patch56: extended description of the Csym.U unit +.\" patch56: now mentions what a compile-link test line should look like +.\" +.\" Revision 3.0.1.14 1995/05/12 12:25:02 ram +.\" patch54: documented new -K switch for knowledgeable users +.\" +.\" Revision 3.0.1.13 1995/01/30 14:46:39 ram +.\" patch49: documented new special units Prefixit.U and Prefixup.U +.\" +.\" Revision 3.0.1.12 1995/01/11 15:39:16 ram +.\" patch45: documents new -O option and new Getfile escape supports +.\" patch45: documents the & escape in Myread and the new cc symbol lookup +.\" +.\" Revision 3.0.1.11 1994/10/29 16:32:38 ram +.\" patch36: added nroff protection for lines beginning with '.' +.\" patch36: documents new ?F: line for file declarations +.\" patch36: added example showing how ./loc can be used +.\" +.\" Revision 3.0.1.10 1994/08/29 16:33:40 ram +.\" patch32: documented new Typedef.U unit for typedef lookup +.\" +.\" Revision 3.0.1.9 1994/06/20 07:10:14 ram +.\" patch30: added -L option for easier unit testing +.\" patch30: new -D and -U options supported by Configure +.\" +.\" Revision 3.0.1.8 1994/05/13 15:29:16 ram +.\" patch27: now understands macro definitions in ?H: lines +.\" +.\" Revision 3.0.1.7 1994/05/06 15:19:25 ram +.\" patch23: documented the new 'p' option in Getfile.U +.\" +.\" Revision 3.0.1.6 1994/01/24 14:19:47 ram +.\" patch16: symbols defined in a unit can be tagged "internal use only" +.\" patch16: documents new MailList.U special unit +.\" patch16: new general <\$variable> macro substitution +.\" +.\" Revision 3.0.1.5 1993/10/16 13:51:50 ram +.\" patch12: new option -M to activate ?M: lines +.\" patch12: documents new ?M: lines format +.\" patch12: new internal Makefile command cm_h_weed for ?M: support +.\" patch12: documents usage for new confmagic.h file +.\" +.\" Revision 3.0.1.4 1993/09/09 11:50:35 ram +.\" patch9: lots of typo fixes and abusive variable substitution problems +.\" +.\" Revision 3.0.1.3 1993/08/30 08:53:51 ram +.\" patch8: wrongly stated that patchlevel.h should not be part of MANIFEST.new +.\" +.\" Revision 3.0.1.2 1993/08/24 12:13:32 ram +.\" patch3: typo fixes +.\" +.\" Revision 3.0.1.1 1993/08/19 06:42:23 ram +.\" patch1: leading config.sh searching was not aborting properly +.\" +.\" Revision 3.0 1993/08/18 12:10:14 ram +.\" Baseline for dist 3.0 netwide release. +.\" +.\" .de Ex \" Start of Example .sp .in +5 @@ -541,9 +541,9 @@ The \fIfile\fR can contain blank lines, comment lines introduced with '#', and lines containing a single symbol. If this option is not supplied, any \fI$exclusions_file\fR variable in \fI.package\fR is honored instead. -''' -''' T u t o r i a l -''' +.\" +.\" T u t o r i a l +.\" .SH TUTORIAL This (long) section is an introduction to \fImetaconfig\fR, in which we will learn all the basics. If you already know how to use \fImetaconfig\fR, you @@ -1742,6 +1742,25 @@ before prompting via \fIgetfile\fR for instance. If the prefix does not make use of ~name expanstion, then the above will be a no-op on the \fI$dflt\fR variable, naturally. .TP +Specific.U +This unit is empty by default. It is meant as a project-specific hook +to have shell code executed by \fIConfigure\fR after \fIconfig.sh\fR was +generated but before the extraction of .SH files. +.sp +Copy the unit to your project's \fIU/\fR directory and customize it. +.sp +Here is what the \fIdist\fR project uses it for (showing only the unit's code, +not the full unit here): +.Ex +: project-specific code +file=revision.h +echo " " +echo "Generating \$file..." >&4 +bin/svn-revision . \$file +.Ef +That shell code is executed when \fIConfigure\fR is back to the top directory +of the source tree. +.TP Typedef.U This unit produces the \fI\$typedef\fR shell variable, used internally by \fIConfigure\fR to check whether a typedef exists or not. A typical diff --git a/mcon/man/mlint.SH b/mcon/man/mlint.SH index 4f4177a..bdf80c8 100755 --- a/mcon/man/mlint.SH +++ b/mcon/man/mlint.SH @@ -18,54 +18,54 @@ echo "Extracting mcon/man/metalint.$manext (with variable substitutions)" $rm -f metalint.$manext $spitshell >metalint.$manext <<!GROK!THIS! .TH METALINT $manext "Version $VERSION PL$PATCHLEVEL" -''' @(#) Manual page for metalint -''' -''' $Id$ -''' -''' Copyright (c) 1991-1997, 2004-2006, Raphael Manfredi -''' -''' You may redistribute only under the terms of the Artistic Licence, -''' as specified in the README file that comes with the distribution. -''' You may reuse parts of this distribution only within the terms of -''' that same Artistic Licence; a copy of which may be found at the root -''' of the source tree for dist 4.0. -''' -''' $Log: mlint.SH,v $ -''' Revision 3.0.1.9 1997/02/28 16:30:25 ram -''' patch61: new "create" and "empty" lint directives -''' patch61: documented new messages -''' -''' Revision 3.0.1.8 1995/09/25 09:18:07 ram -''' patch59: documented new ?Y: directive -''' patch59: fixed my e-mail address -''' -''' Revision 3.0.1.7 1995/07/25 14:18:51 ram -''' patch56: added two new warnings for : comments lines in Configure -''' -''' Revision 3.0.1.6 1994/10/29 16:33:56 ram -''' patch36: documents new ?F: lines and the related metalint warnings -''' patch36: removed statement in BUGS since all warnings may now be shut -''' -''' Revision 3.0.1.5 1994/05/06 15:20:30 ram -''' patch23: added -L switch to override public unit repository path -''' patch23: two new warnings concerning last unit lines -''' -''' Revision 3.0.1.4 1994/01/24 14:20:39 ram -''' patch16: can now easily suppress warning about made "special units" -''' -''' Revision 3.0.1.3 1993/11/10 17:37:39 ram -''' patch14: documents stale ?M: dependency check -''' -''' Revision 3.0.1.2 1993/10/16 13:52:23 ram -''' patch12: added support for ?M: lines and fixed some typos -''' -''' Revision 3.0.1.1 1993/08/19 06:42:24 ram -''' patch1: leading config.sh searching was not aborting properly -''' -''' Revision 3.0 1993/08/18 12:10:15 ram -''' Baseline for dist 3.0 netwide release. -''' -''' +.\" @(#) Manual page for metalint +.\" +.\" $Id$ +.\" +.\" Copyright (c) 1991-1997, 2004-2006, Raphael Manfredi +.\" +.\" You may redistribute only under the terms of the Artistic Licence, +.\" as specified in the README file that comes with the distribution. +.\" You may reuse parts of this distribution only within the terms of +.\" that same Artistic Licence; a copy of which may be found at the root +.\" of the source tree for dist 4.0. +.\" +.\" $Log: mlint.SH,v $ +.\" Revision 3.0.1.9 1997/02/28 16:30:25 ram +.\" patch61: new "create" and "empty" lint directives +.\" patch61: documented new messages +.\" +.\" Revision 3.0.1.8 1995/09/25 09:18:07 ram +.\" patch59: documented new ?Y: directive +.\" patch59: fixed my e-mail address +.\" +.\" Revision 3.0.1.7 1995/07/25 14:18:51 ram +.\" patch56: added two new warnings for : comments lines in Configure +.\" +.\" Revision 3.0.1.6 1994/10/29 16:33:56 ram +.\" patch36: documents new ?F: lines and the related metalint warnings +.\" patch36: removed statement in BUGS since all warnings may now be shut +.\" +.\" Revision 3.0.1.5 1994/05/06 15:20:30 ram +.\" patch23: added -L switch to override public unit repository path +.\" patch23: two new warnings concerning last unit lines +.\" +.\" Revision 3.0.1.4 1994/01/24 14:20:39 ram +.\" patch16: can now easily suppress warning about made "special units" +.\" +.\" Revision 3.0.1.3 1993/11/10 17:37:39 ram +.\" patch14: documents stale ?M: dependency check +.\" +.\" Revision 3.0.1.2 1993/10/16 13:52:23 ram +.\" patch12: added support for ?M: lines and fixed some typos +.\" +.\" Revision 3.0.1.1 1993/08/19 06:42:24 ram +.\" patch1: leading config.sh searching was not aborting properly +.\" +.\" Revision 3.0 1993/08/18 12:10:15 ram +.\" Baseline for dist 3.0 netwide release. +.\" +.\" .SH NAME metalint \- a metaconfig unit consistency checker .SH SYNOPSIS @@ -260,11 +260,20 @@ The file is listed more than once on the ?F: line, under the same name. This does not appear when declaring both a private UU file and a public file with the same name, for instance. .TP -"(?F) UU file $uufile in non-special unit ignored." +"(?F) UU file 'xxx' in non-special unit ignored." Private UU files (i.e. files like the \fImyread\fR script created for later perusal by \fIConfigure\fR) may only be created in special units. Exceptions allowed if the ?F: line is preceded by a proper ?LINT: hint. .TP +"(?F) file 'xxx' already exported by yyy.U." +The listed file 'xxx' is already reported exported (listed likewise) in +the other unit yyy.U and is conflicting. An exported file is a generated +file above the UU directory. +.TP +"(?F) UU file 'xxx' already created by yyy.U." +The listed file 'xxx' is already created in the UU directory by the other +unit yyy.U. A created file is listed as ./xxx on the ?F: line. +.TP "(?T) temporary symbol '\$xxx' multiply declared." Self explanatory. .TP diff --git a/mcon/man/mxref.SH b/mcon/man/mxref.SH index 359f959..229341e 100755 --- a/mcon/man/mxref.SH +++ b/mcon/man/mxref.SH @@ -18,35 +18,35 @@ echo "Extracting mcon/man/metaxref.$manext (with variable substitutions)" $rm -f metaxref.$manext $spitshell >metaxref.$manext <<!GROK!THIS! .TH METAXREF $manext "Version $VERSION PL$PATCHLEVEL" -''' @(#) Manual page for metaxref -''' -''' $Id$ -''' -''' Copyright (c) 1991-1997, 2004-2006, Raphael Manfredi -''' -''' You may redistribute only under the terms of the Artistic Licence, -''' as specified in the README file that comes with the distribution. -''' You may reuse parts of this distribution only within the terms of -''' that same Artistic Licence; a copy of which may be found at the root -''' of the source tree for dist 4.0. -''' -''' $Log: mxref.SH,v $ -''' Revision 3.0.1.4 1997/02/28 16:30:39 ram -''' patch61: new -L option to match metaconfig and metalint -''' -''' Revision 3.0.1.3 1994/10/29 16:34:26 ram -''' patch36: the leading .TH was referring to metaconfig -''' -''' Revision 3.0.1.2 1993/10/16 13:52:46 ram -''' patch12: added BUGS section -''' -''' Revision 3.0.1.1 1993/08/19 06:42:25 ram -''' patch1: leading config.sh searching was not aborting properly -''' -''' Revision 3.0 1993/08/18 12:10:15 ram -''' Baseline for dist 3.0 netwide release. -''' -''' +.\" @(#) Manual page for metaxref +.\" +.\" $Id$ +.\" +.\" Copyright (c) 1991-1997, 2004-2006, Raphael Manfredi +.\" +.\" You may redistribute only under the terms of the Artistic Licence, +.\" as specified in the README file that comes with the distribution. +.\" You may reuse parts of this distribution only within the terms of +.\" that same Artistic Licence; a copy of which may be found at the root +.\" of the source tree for dist 4.0. +.\" +.\" $Log: mxref.SH,v $ +.\" Revision 3.0.1.4 1997/02/28 16:30:39 ram +.\" patch61: new -L option to match metaconfig and metalint +.\" +.\" Revision 3.0.1.3 1994/10/29 16:34:26 ram +.\" patch36: the leading .TH was referring to metaconfig +.\" +.\" Revision 3.0.1.2 1993/10/16 13:52:46 ram +.\" patch12: added BUGS section +.\" +.\" Revision 3.0.1.1 1993/08/19 06:42:25 ram +.\" patch1: leading config.sh searching was not aborting properly +.\" +.\" Revision 3.0 1993/08/18 12:10:15 ram +.\" Baseline for dist 3.0 netwide release. +.\" +.\" .SH NAME metaxref \- builds cross-reference file/unit/item information .SH SYNOPSIS |