Package: autogen
Version: 1:5.18.16-5+b1
Severity: minor
Tags: patch
[Copy is sent to [email protected]]
Dear Maintainer,
* What led up to the situation?
Checking for defects with
[test-]groff -mandoc -t -K utf8 -ww -b -z <man page>
[test-groff is a script in the repository for "groff"]
* What was the outcome of this action?
troff: backtrace: file '<stdin>':30
troff:<stdin>:30: warning: register 'Pp' not defined
troff: backtrace: file '<stdin>':319
troff:<stdin>:319: warning: macro 'Ss' not defined
* What outcome did you expect instead?
No output (warnings).
-.-
Where are these undefined variables ment to be defined?
Where are these variables documented?
Notes and a patch are in the attachments.
-- System Information:
Debian Release: trixie/sid
APT prefers testing
APT policy: (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.7.12-amd64 (SMP w/2 CPU threads; PREEMPT)
Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=ISO-8859-1),
LANGUAGE not set
Shell: /bin/sh linked to /usr/bin/dash
Init: sysvinit (via /sbin/init)
Versions of packages autogen depends on:
ii guile-3.0-libs 3.0.9-1+b2
ii libc6 2.38-11
ii libopts25 1:5.18.16-5+b1
ii libopts25-dev 1:5.18.16-5+b1
ii libxml2 2.9.14+dfsg-1.3+b3
ii perl 5.38.2-4
Versions of packages autogen recommends:
ii autogen-doc 1:5.18.16-5
autogen suggests no packages.
-- no debconf information
Any program (person), that produces man pages, should check its content for
defects by using
groff -mandoc -t -ww -b -z [ -K utf8 | k ] <file>
The same goes for man pages that are used as an input.
For a style guide use
mandoc -T lint
-.-
So any generator should check its products with the above mentioned
'groff' and additionally with 'nroff ...'.
This is just a simple quality control measure.
The generator may have to be corrected to get a better man page,
the source file may, and any additional file may.
-.-
The difference between the formatted outputs can be seen with:
nroff -man <file1> > <out1>
nroff -man <file2> > <out2>
diff -u <out1> <out2>
and for groff, using
"printf '%s\n%s\n' '.kern 0' '.ss 12 0' | groff -man -Z - "
instead of "nroff -man"
Add the option "-t", if the file contains a table.
Read the output of "diff -u" with "less -R" or similar.
-.-.
If "man" (man-db) is used to check the manual for warnings,
the following must be set:
The option "-warnings=w"
The environmental variable:
export MAN_KEEP_STDERR=yes (or any non-empty value)
or
(produce only warnings):
export MANROFFOPT="-ww -z"
export MAN_KEEP_STDERR=yes (or any non-empty value)
-.-.
Output from "mandoc -T lint autogen.1": (possibly shortened list)
mandoc: autogen.1:209:93: STYLE: input text line longer than 80 bytes: This
option takes a ...
mandoc: autogen.1:319:2: ERROR: skipping unknown macro: .Ss "These options can
be used to control what gets processed
mandoc: autogen.1:371:2: WARNING: skipping paragraph macro: br before sp
mandoc: autogen.1:488:2: WARNING: skipping paragraph macro: PP empty
mandoc: autogen.1:567:2: WARNING: skipping paragraph macro: PP empty
mandoc: autogen.1:572:95: STYLE: input text line longer than 80 bytes: This
program is rele...
-.-.
Change '-' (\-) to '\(en' (en-dash) for a numeric range.
GNU gnulib has recently (2023-06-18) updated its
"build_aux/update-copyright" to recognize "\(en" in man pages.
autogen.1:571:Copyright (C) 1992-2018 Bruce Korb all rights reserved.
-.-.
Change two HYPHEN-MINUSES (code 0x2D) to an em-dash (\(em),
if one is intended. An en-dash is usually surrounded by a space,
while an em-dash is used without spaces.
"man" (1 byte characters in input) transforms an en-dash (\(en) to one
HYPHEN-MINUS,
and an em-dash to two HYPHEN-MINUSES without considering the space
around it.
If "--" are two single "-" (end of options) then use "\-\-".
autogen.1:84:Specify, \fB--no-definitions\fP when you wish to process
autogen.1:284:in. For example, \fB--traceout='| less'\fP will run the trace
output
autogen.1:334:specify \fB--skip-suffix=c\fP on the command line.
-.-.
Mark a full stop (.) and the exclamation mark (!) with "\&",
if it does not mean an end of a sentence.
This is a preventive action,
the paragraph could be reshaped, e.g., after changes.
When typing, one does not always notice when the line wraps after the
period.
There are too many examples of input lines in manual pages,
that end with an abbreviation point.
This marking is robust, and independent of the position on the line.
It corresponds to "\ " in TeX, and to "@:" in Texinfo.
262:(i.e. the text outside of macro quotes). Additionally, if you rebuild
-.-.
Change -- in x--y to \(em (em-dash), or, if an
option, to \-\-
84:Specify, \fB--no-definitions\fP when you wish to process
284:in. For example, \fB--traceout='| less'\fP will run the trace output
334:specify \fB--skip-suffix=c\fP on the command line.
-.-.
Use the correct macro for the font change of a single argument or
split the argument into two.
233:.IR "nothing"
237:.IR "debug-message"
241:.IR "server-shell"
247:.IR "templates"
251:.IR "block-macros"
256:.IR "expressions"
260:.IR "everything"
-.-.
Change a HYPHEN-MINUS (code 0x2D) to a minus(-dash) (\-),
if it
is in front of a name for an option,
is a symbol for standard input,
is a single character used to indicate an option,
or is in the NAME section (man-pages(7)).
N.B. - (0x2D), processed as a UTF-8 file, is changed to a hyphen
(0x2010, groff \[u2010] or \[hy]) in the output.
84:Specify, \fB--no-definitions\fP when you wish to process
269: make CFLAGS='-g \-DDEBUG_ENABLED=1'
284:in. For example, \fB--traceout='| less'\fP will run the trace output
334:specify \fB--skip-suffix=c\fP on the command line.
-.-.
Add a comma (or \&) after "e.g." and "i.e.", or use English words
(man-pages(7).
Abbreviation points should be protected against being interpreted as
an end of sentence, if they are not, and that independent of the
current place on the line.
262:(i.e. the text outside of macro quotes). Additionally, if you rebuild
-.-.
Wrong distance between sentences.
Separate the sentences and subordinate clauses; each begins on a new
line. See man-pages(7) ("Conventions for source file layout") and
"info groff" ("Input Conventions").
The best procedure is to always start a new sentence on a new line,
at least, if you are typing on a computer.
Remember coding: Only one command ("sentence") on each (logical) line.
E-mail: Easier to quote exactly the relevant lines.
Generally: Easier to edit the sentence.
Patches: Less unaffected text.
Search for two adjacent words is easier, when they belong to the same line,
and the same phrase.
The amount of space between sentences in the output can then be
controlled with the ".ss" request.
N.B
The number of lines affected can be too large to be in the patch.
464:That is sometimes inconvenient. If present on the command line or in
-.-.
Split lines longer than 80 characters into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks.
autogen.1: line 54 length 85
.SS "The following options select definitions, templates and scheme functions
to use"
autogen.1: line 56 length 97
.NOP \f\*[B-Font]\-L\f[] \f\*[I-Font]dir\f[],
\f\*[B-Font]\-\-templ\-dirs\f[]=\f\*[I-Font]dir\f[]
autogen.1: line 65 length 111
.NOP \f\*[B-Font]\-T\f[] \f\*[I-Font]tpl\-file\f[],
\f\*[B-Font]\-\-override\-tpl\f[]=\f\*[I-Font]tpl\-file\f[]
autogen.1: line 73 length 94
.NOP \f\*[B-Font]\-\-definitions\f[]=\f\*[I-Font]file\f[],
\f\*[B-Font]\-\-no\-definitions\f[]
autogen.1: line 126 length 98
.NOP \f\*[B-Font]\-b\f[] \f\*[I-Font]name\f[],
\f\*[B-Font]\-\-base\-name\f[]=\f\*[I-Font]name\f[]
autogen.1: line 187 length 101
.NOP \f\*[B-Font]\-t\f[] \f\*[I-Font]seconds\f[],
\f\*[B-Font]\-\-timeout\f[]=\f\*[I-Font]seconds\f[]
autogen.1: line 209 length 93
This option takes a keyword as its argument. The argument sets an enumeration
value that can
autogen.1: line 323 length 104
.NOP \f\*[B-Font]\-s\f[] \f\*[I-Font]suffix\f[],
\f\*[B-Font]\-\-skip\-suffix\f[]=\f\*[I-Font]suffix\f[]
autogen.1: line 336 length 106
.NOP \f\*[B-Font]\-o\f[] \f\*[I-Font]suffix\f[],
\f\*[B-Font]\-\-select\-suffix\f[]=\f\*[I-Font]suffix\f[]
autogen.1: line 346 length 96
.NOP \f\*[B-Font]\-D\f[] \f\*[I-Font]value\f[],
\f\*[B-Font]\-\-define\f[]=\f\*[I-Font]value\f[]
autogen.1: line 376 length 106
.NOP \f\*[B-Font]\-U\f[] \f\*[I-Font]name\-pat\f[],
\f\*[B-Font]\-\-undefine\f[]=\f\*[I-Font]name\-pat\f[]
autogen.1: line 387 length 99
.NOP \f\*[B-Font]\-M\f[] \f\*[I-Font]type\f[], \f\*[B-Font]\-\-make\-dep\f[]
[\f\*[I-Font]type\f[]]
autogen.1: line 473 length 108
.NOP \f\*[B-Font]\->\f[] [\f\*[I-Font]cfgfile\f[]],
\f\*[B-Font]\-\-save-opts\f[] [=\f\*[I-Font]cfgfile\f[]]
autogen.1: line 478 length 137
.NOP \f\*[B-Font]\-<\f[] \f\*[I-Font]cfgfile\f[],
\f\*[B-Font]\-\-load-opts\f[]=\f\*[I-Font]cfgfile\f[],
\f\*[B-Font]\-\-no-load-opts\f[]
autogen.1: line 484 length 104
.NOP \f\*[B-Font]\-v\f[] [{\f\*[I-Font]v|c|n\f[] \f\*[B-Font]\-\-version\f[]
[{\f\*[I-Font]v|c|n\f[]}]}]
autogen.1: line 572 length 95
This program is released under the terms of the GNU General Public License,
version 3 or later.
-.-.
Do not use margin adjustments without an explanation of its necessity.
494- \fBAUTOGEN_<option-name>\fP or \fBAUTOGEN\fP
495-.fi
496:.ad
497-The environmental presets take precedence (are processed later than)
498-the configuration files.
-.-.
Change a HYPHEN-MINUS (code 0x55, 2D) to a dash
(\-, minus) if it matches "[[:alph:]]-[[:alpha:]]" in the name of an
option).
Facilitates the copy and paste of an option in UTF-8 text.
Is not needed in ordinary words like "mother-in-law", that are not
copied and pasted to a command line (which needs ASCII code)
28:[\f\*[B-Font]\-\-option-name\f[][[=| ]\f\*[I-Font]value\f[]]]
84:Specify, \fB--no-definitions\fP when you wish to process
334:specify \fB--skip-suffix=c\fP on the command line.
478:.NOP \f\*[B-Font]\-<\f[] \f\*[I-Font]cfgfile\f[],
\f\*[B-Font]\-\-load-opts\f[]=\f\*[I-Font]cfgfile\f[],
\f\*[B-Font]\-\-no-load-opts\f[]
480:The \fIno-load-opts\fP form will disable the loading
481:of earlier config/rc/ini files. \fI\-\-no-load-opts\fP is handled early,
-.-.
Output from "test-groff -b -mandoc -dAD=l -rF0 -rHY=0 -t -w w -z -K utf8":
troff: backtrace: file '<stdin>':30
troff:<stdin>:30: warning: register 'Pp' not defined
troff: backtrace: file '<stdin>':319
troff:<stdin>:319: warning: macro 'Ss' not defined
How are these variables ment to be defined?
Where are these variables documented?
--- autogen.1 2024-05-28 21:09:23.340976362 +0000
+++ autogen.1.new 2024-05-29 02:36:04.053934231 +0000
@@ -51,9 +51,11 @@ and so on.
All of this can be done mechanically; with the proper templates
and this program.
.SH "OPTIONS"
-.SS "The following options select definitions, templates and scheme functions
to use"
+.SS "The following options select definitions, templates and scheme \
+functions to use"
.TP
-.NOP \f\*[B-Font]\-L\f[] \f\*[I-Font]dir\f[],
\f\*[B-Font]\-\-templ\-dirs\f[]=\f\*[I-Font]dir\f[]
+.NOP \f\*[B-Font]\-L\f[] \f\*[I-Font]dir\f[], \
+\f\*[B-Font]\-\-templ\-dirs\f[]=\f\*[I-Font]dir\f[]
Search for templates in \fIDIR\fP.
This option may appear an unlimited number of times.
.sp
@@ -62,7 +64,8 @@ opening a template, either as the primar
The last entry has the highest priority in the search list. That is
to say, they are searched in reverse order.
.TP
-.NOP \f\*[B-Font]\-T\f[] \f\*[I-Font]tpl\-file\f[],
\f\*[B-Font]\-\-override\-tpl\f[]=\f\*[I-Font]tpl\-file\f[]
+.NOP \f\*[B-Font]\-T\f[] \f\*[I-Font]tpl\-file\f[], \
+\f\*[B-Font]\-\-override\-tpl\f[]=\f\*[I-Font]tpl\-file\f[]
Use \fITPL-FILE\fP for the template.
This option may not be preset with environment variables
or in initialization (rc) files.
@@ -70,7 +73,8 @@ or in initialization (rc) files.
Definition files specify the standard template that is to be expanded.
This option will override that name and expand a different template.
.TP
-.NOP \f\*[B-Font]\-\-definitions\f[]=\f\*[I-Font]file\f[],
\f\*[B-Font]\-\-no\-definitions\f[]
+.NOP \f\*[B-Font]\-\-definitions\f[]=\f\*[I-Font]file\f[], \
+\f\*[B-Font]\-\-no\-definitions\f[]
Read definitions from \fIFILE\fP.
The \fIno\-definitions\fP form will disable the option.
This option is enabled by default.
@@ -81,7 +85,7 @@ Use this argument to specify the input d
command line option. If you do not specify this option, then
there must be a command line argument that specifies the file,
even if only to specify stdin with a hyphen (\fB-\fP).
-Specify, \fB--no-definitions\fP when you wish to process
+Specify, \fB\-\-no\-definitions\fP when you wish to process
a template without any active AutoGen definitions.
.TP
.NOP \f\*[B-Font]\-\-shell\f[]=\f\*[I-Font]shell\f[]
@@ -123,7 +127,8 @@ The default are the three characters, "_
on a Tandem/HP-NonStop, and I used to do a lot of work on Tandems.)
.SS "The following options modify how output is handled"
.TP
-.NOP \f\*[B-Font]\-b\f[] \f\*[I-Font]name\f[],
\f\*[B-Font]\-\-base\-name\f[]=\f\*[I-Font]name\f[]
+.NOP \f\*[B-Font]\-b\f[] \f\*[I-Font]name\f[], \
+\f\*[B-Font]\-\-base\-name\f[]=\f\*[I-Font]name\f[]
Specify \fBNAME\fP as the base name for output.
This option may not be preset with environment variables
or in initialization (rc) files.
@@ -184,7 +189,8 @@ specify, "FOR x (for-from 1) (for-to \-1
long time to finish. If you do have more than 256 entries in tables,
you will need to specify a new limit with this option.
.TP
-.NOP \f\*[B-Font]\-t\f[] \f\*[I-Font]seconds\f[],
\f\*[B-Font]\-\-timeout\f[]=\f\*[I-Font]seconds\f[]
+.NOP \f\*[B-Font]\-t\f[] \f\*[I-Font]seconds\f[], \
+\f\*[B-Font]\-\-timeout\f[]=\f\*[I-Font]seconds\f[]
Limit server shell operations to \fBSECONDS\fP.
This option takes an integer number as its argument.
The value of
@@ -206,7 +212,8 @@ Zero will disable the server time limit.
.TP
.NOP \f\*[B-Font]\-\-trace\f[]=\f\*[I-Font]level\f[]
tracing level of detail.
-This option takes a keyword as its argument. The argument sets an enumeration
value that can
+This option takes a keyword as its argument.
+The argument sets an enumeration value that can
be tested by comparing them against the option value macro.
The available keywords are:
.in +4
@@ -230,43 +237,43 @@ processing. There are six levels, each
the previous levels:
.sp
.sp
-.IR "nothing"
+.I "nothing"
Does no tracing at all (default)
.sp
.sp
-.IR "debug-message"
+.I "debug-message"
Print messages from the "DEBUG" AutoGen macro (see: DEBUG).
.sp
.sp
-.IR "server-shell"
+.I "server-shell"
Traces all input and output to the server shell. This includes a shell
"independent" initialization script about 30 lines long. Its output is
discarded and not inserted into any template.
.sp
.sp
-.IR "templates"
+.I "templates"
Traces the invocation of \fBDEFINE\fPd macros and \fBINCLUDE\fPs
.sp
.sp
-.IR "block-macros"
+.I "block-macros"
Traces all block macros. The above, plus \fBIF\fP, \fBFOR\fP,
\fBCASE\fP and \fBWHILE\fP.
.sp
.sp
-.IR "expressions"
+.I "expressions"
Displays the results of expression evaluations.
.sp
.sp
-.IR "everything"
+.I "everything"
Displays the invocation of every AutoGen macro, even \fBTEXT\fP macros
-(i.e. the text outside of macro quotes). Additionally, if you rebuild
+(i.e., the text outside of macro quotes). Additionally, if you rebuild
the ``expr.ini'' file with debugging enabled, then all calls to
AutoGen defined scheme functions will also get logged:
.br
.nf
cd ${top_builddir}/agen5
DEBUG_ENABLED=true bash bootstrap.dir expr.ini
- make CFLAGS='-g \-DDEBUG_ENABLED=1'
+ make CFLAGS='\-g \-DDEBUG_ENABLED=1'
.fi
.sp
Be aware that you cannot rebuild this source in this way without first
@@ -281,7 +288,7 @@ tracing output file or filter.
The output specified may be a file name, a file that is appended to,
or, if the option argument begins with the \fBpipe\fP operator
(\fB|\fP), a command that will receive the tracing output as standard
-in. For example, \fB--traceout='| less'\fP will run the trace output
+in. For example, \fB\-\-traceout='| less'\fP will run the trace output
through the \fBless\fP program. Appending to a file is specified by
preceding the file name with two greater-than characters (\fB>>\fP).
.TP
@@ -320,7 +327,8 @@ size limit.
in the definitions files and template files"
They specify which outputs and parts of outputs to produce.
.TP
-.NOP \f\*[B-Font]\-s\f[] \f\*[I-Font]suffix\f[],
\f\*[B-Font]\-\-skip\-suffix\f[]=\f\*[I-Font]suffix\f[]
+.NOP \f\*[B-Font]\-s\f[] \f\*[I-Font]suffix\f[], \
+\f\*[B-Font]\-\-skip\-suffix\f[]=\f\*[I-Font]suffix\f[]
Skip the file with this \fISUFFIX\fP.
This option may appear an unlimited number of times.
This option may not be preset with environment variables
@@ -331,9 +339,10 @@ select-suffix.
Occasionally, it may not be desirable to produce all of the output
files specified in the template. (For example, only the \fI.h\fP
header file, but not the \fI.c\fP program text.) To do this
-specify \fB--skip-suffix=c\fP on the command line.
+specify \fB\-\-skip\-suffix=c\fP on the command line.
.TP
-.NOP \f\*[B-Font]\-o\f[] \f\*[I-Font]suffix\f[],
\f\*[B-Font]\-\-select\-suffix\f[]=\f\*[I-Font]suffix\f[]
+.NOP \f\*[B-Font]\-o\f[] \f\*[I-Font]suffix\f[], \
+\f\*[B-Font]\-\-select\-suffix\f[]=\f\*[I-Font]suffix\f[]
specify this output suffix.
This option may appear an unlimited number of times.
This option may not be preset with environment variables
@@ -343,7 +352,8 @@ If you wish to override the suffix speci
you can use one or more copies of this option. See the suffix
specification in the @ref{pseudo macro} section of the info doc.
.TP
-.NOP \f\*[B-Font]\-D\f[] \f\*[I-Font]value\f[],
\f\*[B-Font]\-\-define\f[]=\f\*[I-Font]value\f[]
+.NOP \f\*[B-Font]\-D\f[] \f\*[I-Font]value\f[], \
+\f\*[B-Font]\-\-define\f[]=\f\*[I-Font]value\f[]
name to add to definition list.
This option may appear an unlimited number of times.
.sp
@@ -362,18 +372,18 @@ The \fB$NAME\fP part of the name string
the define-d value for \fBNAME\fP.
.sp 1
When AutoGen is finished loading the definitions, the defined values
-are exported to the environment with, \fBputenv(3)\fP.
-These values can then be used in shell scripts with \fB${NAME@\fP}
+are exported to the environment with, \fBputenv\fP(3).
+These values can then be used in shell scripts with \fB${NAME@}\fP
references and in templates with \fB(getenv "NAME")\fP.
.sp 1
While processing a template, you may specify an index to retrieve
a specific value. That index may also be a define-d value.
-.br
.sp
It is entirely equivalent to place this name in the exported environment.
Internally, that is what AutoGen actually does with this option.
.TP
-.NOP \f\*[B-Font]\-U\f[] \f\*[I-Font]name\-pat\f[],
\f\*[B-Font]\-\-undefine\f[]=\f\*[I-Font]name\-pat\f[]
+.NOP \f\*[B-Font]\-U\f[] \f\*[I-Font]name\-pat\f[], \
+\f\*[B-Font]\-\-undefine\f[]=\f\*[I-Font]name\-pat\f[]
definition list removal pattern.
This option may appear an unlimited number of times.
This option may not be preset with environment variables
@@ -384,34 +394,35 @@ directives. This option will cause the
removed from the list of defined values.
.SS "This option is used to automate dependency tracking"
.TP
-.NOP \f\*[B-Font]\-M\f[] \f\*[I-Font]type\f[], \f\*[B-Font]\-\-make\-dep\f[]
[\f\*[I-Font]type\f[]]
+.NOP \f\*[B-Font]\-M\f[] \f\*[I-Font]type\f[], \f\*[B-Font]\-\-make\-dep\f[] \
+[\f\*[I-Font]type\f[]]
emit make dependency file.
This option may appear an unlimited number of times.
This option may not be preset with environment variables
or in initialization (rc) files.
.sp
-This option behaves fairly closely to the way the \fB-M\fP series of
+This option behaves fairly closely to the way the \fB\-M\fP series of
options work with the gcc compiler, except that instead of just
emitting the predecessor dependencies, this also emits the successor
dependencies (output target files). By default, the output dependency
information will be placed in \fB<base-name>.d\fP, but may also be
-specified with \fB-MF<file>\fP. The time stamp on this file will be
+specified with \fB\-MF<file>\fP. The time stamp on this file will be
manipulated so that it will be one second older than the oldest
primary output file.
.sp
The target in this dependency file will normally be the dependency
-file name, but may also be overridden with \fB-MT<targ-name>\fP.
+file name, but may also be overridden with \fB\-MT<targ-name>\fP.
AutoGen will not alter the contents of that file, but it may create
it and it will adjust the modification time to match the start time.
.sp
\fBNB:\fP these second letters are part of the option argument, so
-\fB-MF <file>\fP must have the space character quoted or omitted, and
-\fB-M "F <file>"\fP is acceptable because the \fBF\fP is part of the
+\fB\-MF <file>\fP must have the space character quoted or omitted, and
+\fB\-M "F <file>"\fP is acceptable because the \fBF\fP is part of the
option argument.
.sp
-\fB-M\fP may be followed by any of the letters M, F, P, T, Q, D, or G.
+\fB\-M\fP may be followed by any of the letters M, F, P, T, Q, D, or G.
However, only F, Q, T and P are meaningful. All but F have somewhat
-different meanings. \fB-MT<name>\fP is interpreted as meaning
+different meanings. \fB\-MT<name>\fP is interpreted as meaning
\fB<name>\fP is a sentinel file that will depend on all inputs
(templates and definition files) and all the output files will depend
on this sentinel file. It is suitable for use as a real make target.
@@ -428,10 +439,10 @@ and then in your \fBMakefile\fP, make th
.nf
\-include whatever-you-like.dep
clean_targets += clean-your-sentinel-file
- .sp
+.sp
your-sentinel-file:
autogen \-MT$@@ \-MF$*.d .....
- .sp
+.sp
local-clean :
rm \-f $(clean_targets)
.fi
@@ -439,7 +450,7 @@ and then in your \fBMakefile\fP, make th
The modification time on the dependency file is adjusted to be one
second before the earliest time stamp of any other output file.
Consequently, it is suitable for use as the sentinel file testifying
-to the fact the program was successfully run. (\fB-include\fP is
+to the fact the program was successfully run. (\fB\-include\fP is
the GNU make way of specifying "include it if it exists". Your make
must support that feature or your bootstrap process must create the
file.)
@@ -451,7 +462,7 @@ free text that is something other than \
\fByes\fP, \fBno\fP, \fB0\fP or \fB1\fP, then the string is taken
to be an output file name. If it contains a string of white space
characters, the first token is as above and the second token is taken
-to be the target (sentinel) file as \fB-MT\fP in the paragraphs
+to be the target (sentinel) file as \fB\-MT\fP in the paragraphs
above. \fBDEPENDENCIES_OUTPUT\fP will be ignored if there are
multiple sequences of white space characters or if its contents are,
specifically, \fBfalse\fP, \fBno\fP or \fB0\fP.
@@ -461,8 +472,9 @@ specifically, \fBfalse\fP, \fBno\fP or \
Do not abort on errors.
.sp
By default, \fBAutoGen\fP will abort on an error leaving behind a core image.
-That is sometimes inconvenient. If present on the command line or in
-the environment, AutoGen will call \fBexit(1)\fP instead of \fBabort()\fP.
+That is sometimes inconvenient.
+If present on the command line or in the environment,
+AutoGen will call \fBexit\fP(1) instead of \fBabort\fP().
.TP
.NOP \f\*[B-Font]\-\&?\f[], \f\*[B-Font]\-\-help\f[]
Display usage information and exit.
@@ -470,22 +482,25 @@ Display usage information and exit.
.NOP \f\*[B-Font]\-\&!\f[], \f\*[B-Font]\-\-more-help\f[]
Pass the extended usage information through a pager.
.TP
-.NOP \f\*[B-Font]\->\f[] [\f\*[I-Font]cfgfile\f[]],
\f\*[B-Font]\-\-save-opts\f[] [=\f\*[I-Font]cfgfile\f[]]
+.NOP \f\*[B-Font]\->\f[] [\f\*[I-Font]cfgfile\f[]], \
+\f\*[B-Font]\-\-save-opts\f[] [=\f\*[I-Font]cfgfile\f[]]
Save the option state to \fIcfgfile\fP. The default is the \fIlast\fP
configuration file listed in the \fBOPTION PRESETS\fP section, below.
The command will exit after updating the config file.
.TP
-.NOP \f\*[B-Font]\-<\f[] \f\*[I-Font]cfgfile\f[],
\f\*[B-Font]\-\-load-opts\f[]=\f\*[I-Font]cfgfile\f[],
\f\*[B-Font]\-\-no-load-opts\f[]
+.NOP \f\*[B-Font]\-<\f[] \f\*[I-Font]cfgfile\f[], \
+\f\*[B-Font]\-\-load\-opts\f[]=\f\*[I-Font]cfgfile\f[], \
+\f\*[B-Font]\-\-no\-load\-opts\f[]
Load options from \fIcfgfile\fP.
-The \fIno-load-opts\fP form will disable the loading
-of earlier config/rc/ini files. \fI\-\-no-load-opts\fP is handled early,
+The \fIno\-load\-opts\fP form will disable the loading
+of earlier config/rc/ini files. \fI\-\-no\-load\-opts\fP is handled early,
out of order.
.TP
-.NOP \f\*[B-Font]\-v\f[] [{\f\*[I-Font]v|c|n\f[] \f\*[B-Font]\-\-version\f[]
[{\f\*[I-Font]v|c|n\f[]}]}]
+.NOP \f\*[B-Font]\-v\f[] [{\f\*[I-Font]v|c|n\f[] \f\*[B-Font]\-\-version\f[] \
+[{\f\*[I-Font]v|c|n\f[]}]}]
Output version of program and exit. The default mode is `v', a simple
version. The `c' mode will print copyright information and `n' will
print the full copyright notice.
-.PP
.SH "OPTION PRESETS"
Any option that is not marked as \fInot presettable\fP may be preset
by loading values from configuration ("RC" or ".INI") file(s) and values from
@@ -493,7 +508,6 @@ environment variables named:
.nf
\fBAUTOGEN_<option-name>\fP or \fBAUTOGEN\fP
.fi
-.ad
The environmental presets take precedence (are processed later than)
the configuration files.
The \fIhomerc\fP files are "\fI$HOME\fP", and "\fI.\fP".
@@ -554,8 +568,8 @@ Insufficient memory to operate.
\fBautogen\fP exited due to catching a signal. If your template includes
string formatting, a number argument to a "%s" formatting element will
trigger a segmentation fault. Autogen will catch the seg fault signal
-and exit with \fBAUTOGEN_EXIT_SIGNAL(5)\fP. Alternatively, AutoGen
-may have been interrupted with a \fBkill(2)\fP signal.
+and exit with \fBAUTOGEN_EXIT_SIGNAL\fP(5). Alternatively, AutoGen
+may have been interrupted with a \fBkill\fP(2) signal.
Subtract 128 from the actual exit code to detect the signal number.
.TP
.NOP 66 " (EX_NOINPUT)"
@@ -564,12 +578,12 @@ A specified configuration file could not
.NOP 70 " (EX_SOFTWARE)"
libopts had an internal operational error. Please report
it to [email protected]. Thank you.
-.PP
.SH "AUTHORS"
Bruce Korb
.SH "COPYRIGHT"
-Copyright (C) 1992-2018 Bruce Korb all rights reserved.
-This program is released under the terms of the GNU General Public License,
version 3 or later.
+Copyright (C) 1992\(en2018 Bruce Korb all rights reserved.
+This program is released under the terms of the GNU General Public License,
+version 3 or later.
.SH "BUGS"
Please send bug reports to: [email protected]
.SH "NOTES"