From: Eric Blake Date: Tue, 26 Aug 2008 15:28:15 +0000 (-0600) Subject: Update invocation documentation. X-Git-Tag: v2.63~10 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=f4df9b9b40517e5c23845a61837d6d0fcbe49081;p=thirdparty%2Fautoconf.git Update invocation documentation. * doc/autoconf.texi (autoscan Invocation): Mention --debug. (autoreconf Invocation): Mention -v. (autom4te Invocation): Tie --freeze to -F, not -f. (autoupdate Invocation): Mention --prepend-include. * doc/install.texi (configure Invocation): Mention --help=short, --help=recursive, -n/--no-create, --prefix. Avoid TABs. * bin/autoscan.in ($help): Omit space before `...'. * bin/ifnames.in ($help): Likewise. * bin/autoconf.as (Usage): Likewise. * bin/autoreconf.in ($help): Likewise. * bin/autoheader.in ($help): Likewise. * bin/autom4te.in ($help): Likewise. * bin/autoupdate.in ($help): Likewise. * lib/autoconf/status.m4 (_AC_OUTPUT_CONFIG_STATUS): Use `[OPTION]...', rather than `[OPTIONS]'. Mention --silent. Indent --file correctly. Signed-off-by: Eric Blake --- diff --git a/ChangeLog b/ChangeLog index e39b20221..da4e2a290 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,23 @@ 2008-08-26 Eric Blake + Update invocation documentation. + * doc/autoconf.texi (autoscan Invocation): Mention --debug. + (autoreconf Invocation): Mention -v. + (autom4te Invocation): Tie --freeze to -F, not -f. + (autoupdate Invocation): Mention --prepend-include. + * doc/install.texi (configure Invocation): Mention --help=short, + --help=recursive, -n/--no-create, --prefix. Avoid TABs. + * bin/autoscan.in ($help): Omit space before `...'. + * bin/ifnames.in ($help): Likewise. + * bin/autoconf.as (Usage): Likewise. + * bin/autoreconf.in ($help): Likewise. + * bin/autoheader.in ($help): Likewise. + * bin/autom4te.in ($help): Likewise. + * bin/autoupdate.in ($help): Likewise. + * lib/autoconf/status.m4 (_AC_OUTPUT_CONFIG_STATUS): Use + `[OPTION]...', rather than `[OPTIONS]'. Mention --silent. Indent + --file correctly. + Don't let frozen __m4_version__ break downgrade to m4 1.4.x. * bin/autom4te.in: Adjust comments, now that we rely on 1.4.5+. (files_to_options): Avoid inheriting __m4_version__ from frozen diff --git a/bin/autoconf.as b/bin/autoconf.as index 554000266..3a2532246 100644 --- a/bin/autoconf.as +++ b/bin/autoconf.as @@ -24,7 +24,7 @@ m4_divert_push([HEADER-COPYRIGHT])dnl m4_divert_pop([HEADER-COPYRIGHT])dnl back to BODY usage=["\ -Usage: $0 [OPTION] ... [TEMPLATE-FILE] +Usage: $0 [OPTION]... [TEMPLATE-FILE] Generate a configuration script from a TEMPLATE-FILE if given, or \`configure.ac' if present, or else \`configure.in'. Output is sent @@ -112,7 +112,7 @@ while test $# -gt 0 ; do --prepend-include=* | -B?* | \ --warnings=* | -W?* ) case $1 in - *\'*) arg=`AS_ECHO(["$1"]) | sed "s/'/'\\\\\\\\''/g"` ;; + *\'*) arg=`AS_ECHO(["$1"]) | sed "s/'/'\\\\\\\\''/g"` ;; *) arg=$1 ;; esac autom4te_options="$autom4te_options '$arg'"; shift ;; @@ -122,7 +122,7 @@ while test $# -gt 0 ; do --warnings | -W ) test $# = 1 && eval "$exit_missing_arg" case $2 in - *\'*) arg=`AS_ECHO(["$2"]) | sed "s/'/'\\\\\\\\''/g"` ;; + *\'*) arg=`AS_ECHO(["$2"]) | sed "s/'/'\\\\\\\\''/g"` ;; *) arg=$2 ;; esac autom4te_options="$autom4te_options $option '$arg'" diff --git a/bin/autoheader.in b/bin/autoheader.in index 0df6fbbbc..ab5bfcecb 100644 --- a/bin/autoheader.in +++ b/bin/autoheader.in @@ -61,7 +61,7 @@ my @include; # $HELP # ----- -$help = "Usage: $0 [OPTION] ... [TEMPLATE-FILE] +$help = "Usage: $0 [OPTION]... [TEMPLATE-FILE] Create a template file of C \`\#define\' statements for \`configure\' to use. To this end, scan TEMPLATE-FILE, or \`configure.ac\' if present, diff --git a/bin/autom4te.in b/bin/autom4te.in index 055abcede..50c410cdc 100644 --- a/bin/autom4te.in +++ b/bin/autom4te.in @@ -135,7 +135,7 @@ my %m4_builtin_alternate_name; # $HELP # ----- -$help = "Usage: $0 [OPTION] ... [FILES] +$help = "Usage: $0 [OPTION]... [FILES] Run GNU M4 on the FILES, avoiding useless runs. Output the traces if tracing, the frozen file if freezing, otherwise the expansion of the FILES. diff --git a/bin/autoreconf.in b/bin/autoreconf.in index 8b067fee9..923f8caf7 100644 --- a/bin/autoreconf.in +++ b/bin/autoreconf.in @@ -55,7 +55,7 @@ use strict; # $HELP # ----- -$help = "Usage: $0 [OPTION] ... [DIRECTORY] ... +$help = "Usage: $0 [OPTION]... [DIRECTORY]... Run `autoconf' (and `autoheader', `aclocal', `automake', `autopoint' (formerly `gettextize'), and `libtoolize' where appropriate) diff --git a/bin/autoscan.in b/bin/autoscan.in index 83fa6fcb1..18d9ac1ae 100644 --- a/bin/autoscan.in +++ b/bin/autoscan.in @@ -101,7 +101,7 @@ my @include = ('@datadir@'); # $help # ----- -$help = "Usage: $0 [OPTION] ... [SRCDIR] +$help = "Usage: $0 [OPTION]... [SRCDIR] Examine source files in the directory tree rooted at SRCDIR, or the current directory if none is given. Search the source files for diff --git a/bin/autoupdate.in b/bin/autoupdate.in index 644de19c2..d23048a1c 100644 --- a/bin/autoupdate.in +++ b/bin/autoupdate.in @@ -61,9 +61,9 @@ my $m4 = $ENV{"M4"} || '@M4@'; # $HELP # ----- -$help = "Usage: $0 [OPTION] ... [TEMPLATE-FILE...] +$help = "Usage: $0 [OPTION]... [TEMPLATE-FILE]... -Update the TEMPLATE-FILE... if given, or `configure.ac' if present, +Update each TEMPLATE-FILE if given, or `configure.ac' if present, or else `configure.in', to the syntax of the current version of Autoconf. The original files are backed up. diff --git a/bin/ifnames.in b/bin/ifnames.in index 6edc78570..5ee70d714 100644 --- a/bin/ifnames.in +++ b/bin/ifnames.in @@ -49,7 +49,7 @@ use Autom4te::FileUtils; # $HELP # ----- -$help = "Usage: $0 [OPTION] ... [FILE] ... +$help = "Usage: $0 [OPTION]... [FILE]... Scan all of the C source FILES (or the standard input, if none are given) and write to the standard output a sorted list of all the diff --git a/doc/autoconf.texi b/doc/autoconf.texi index 75c110e55..b99635694 100644 --- a/doc/autoconf.texi +++ b/doc/autoconf.texi @@ -1335,6 +1335,10 @@ Print the version number of Autoconf and exit. Print the names of the files it examines and the potentially interesting symbols it finds in them. This output can be voluminous. +@item --debug +@itemx -d +Don't remove temporary files. + @item --include=@var{dir} @itemx -I @var{dir} Append @var{dir} to the include path. Multiple invocations accumulate. @@ -1611,6 +1615,7 @@ Print a summary of the command line options and exit. Print the version number of Autoconf and exit. @item --verbose +@itemx -V Print the name of each directory @command{autoreconf} examines and the commands it runs. If given two or more times, pass @option{--verbose} to subordinate tools that support it. @@ -9984,7 +9989,7 @@ m4 --reload-state=4.m4f input.m4 @end example @item --freeze -@itemx -f +@itemx -F Produce a frozen state file. @command{autom4te} freezing is stricter than M4's: it must produce no warnings, and no output other than empty lines (a line with white space is @emph{not} empty) and comments @@ -18885,6 +18890,11 @@ Force the update even if the file has not changed. Disregard the cache. @itemx -I @var{dir} Also look for input files in @var{dir}. Multiple invocations accumulate. Directories are browsed from last to first. + +@item --prepend-include=@var{dir} +@itemx -B @var{dir} +Prepend directory @var{dir} to the search path. This is used to include +the language-specific files before any third-party macros. @end table @node Obsolete Macros diff --git a/doc/install.texi b/doc/install.texi index 070291cf4..f6620ec37 100644 --- a/doc/install.texi +++ b/doc/install.texi @@ -294,7 +294,14 @@ operates. @table @option @item --help @itemx -h -Print a summary of the options to @command{configure}, and exit. +Print a summary of all of the options to @command{configure}, and exit. + +@item --help=short +@itemx --help=recursive +Print a summary of the options unique to this package's +@command{configure}, and exit. The @code{short} variant lists options +used only in the top level, while the @code{recursive} variant lists +options also present in any nested packages. @item --version @itemx -V @@ -321,8 +328,24 @@ will still be shown). @item --srcdir=@var{dir} Look for the package's source code in directory @var{dir}. Usually @command{configure} can determine that directory automatically. + +@item --prefix=@var{dir} +Use @var{dir} as the installation prefix. @ref{Installation Names} +for more details, including other options available for fine-tuning +the installation locations. + +@item --no-create +@itemx -n +Run the configure checks, but stop before creating any output files. @end table @noindent @command{configure} also accepts some other, not widely useful, options. Run @samp{configure --help} for more details. + +@c Local Variables: +@c fill-column: 72 +@c ispell-local-dictionary: "american" +@c indent-tabs-mode: nil +@c whitespace-check-buffer-indent: nil +@c End: diff --git a/lib/autoconf/status.m4 b/lib/autoconf/status.m4 index d9729a3a4..ddc5f47fb 100644 --- a/lib/autoconf/status.m4 +++ b/lib/autoconf/status.m4 @@ -1392,19 +1392,20 @@ ac_cs_usage="\ \`$as_me' instantiates files from templates according to the current configuration. -Usage: $[0] [[OPTIONS]] [[FILE]]... +Usage: $[0] [[OPTION]]... [[FILE]]... -h, --help print this help, then exit -V, --version print version number and configuration settings, then exit - -q, --quiet do not print progress messages + -q, --quiet, --silent +[] do not print progress messages -d, --debug don't remove temporary files --recheck update $as_me by reconfiguring in the same conditions m4_ifdef([_AC_SEEN_CONFIG(FILES)], - [AS_HELP_STRING([[--file=FILE[:TEMPLATE]]], + [AS_HELP_STRING([[ --file=FILE[:TEMPLATE]]], [instantiate the configuration file FILE], [ ]) ])dnl m4_ifdef([_AC_SEEN_CONFIG(HEADERS)], - [AS_HELP_STRING([[--header=FILE[:TEMPLATE]]], + [AS_HELP_STRING([[ --header=FILE[:TEMPLATE]]], [instantiate the configuration header FILE], [ ]) ])dnl