Home | History | Annotate | Line # | Download | only in dist
      1      1.1  macallan #! /bin/sh
      2  1.1.1.5       mrg # Common wrapper for a few potentially missing GNU and other programs.
      3      1.1  macallan 
      4  1.1.1.5       mrg scriptversion=2024-06-07.14; # UTC
      5      1.1  macallan 
      6  1.1.1.5       mrg # shellcheck disable=SC2006,SC2268 # we must support pre-POSIX shells
      7  1.1.1.5       mrg 
      8  1.1.1.5       mrg # Copyright (C) 1996-2024 Free Software Foundation, Inc.
      9  1.1.1.4       mrg # Originally written by Fran,cois Pinard <pinard (at] iro.umontreal.ca>, 1996.
     10      1.1  macallan 
     11      1.1  macallan # This program is free software; you can redistribute it and/or modify
     12      1.1  macallan # it under the terms of the GNU General Public License as published by
     13      1.1  macallan # the Free Software Foundation; either version 2, or (at your option)
     14      1.1  macallan # any later version.
     15      1.1  macallan 
     16      1.1  macallan # This program is distributed in the hope that it will be useful,
     17      1.1  macallan # but WITHOUT ANY WARRANTY; without even the implied warranty of
     18      1.1  macallan # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     19      1.1  macallan # GNU General Public License for more details.
     20      1.1  macallan 
     21      1.1  macallan # You should have received a copy of the GNU General Public License
     22  1.1.1.4       mrg # along with this program.  If not, see <https://www.gnu.org/licenses/>.
     23      1.1  macallan 
     24      1.1  macallan # As a special exception to the GNU General Public License, if you
     25      1.1  macallan # distribute this file as part of a program that contains a
     26      1.1  macallan # configuration script generated by Autoconf, you may include it under
     27      1.1  macallan # the same distribution terms that you use for the rest of that program.
     28      1.1  macallan 
     29      1.1  macallan if test $# -eq 0; then
     30  1.1.1.3       mrg   echo 1>&2 "Try '$0 --help' for more information"
     31      1.1  macallan   exit 1
     32      1.1  macallan fi
     33      1.1  macallan 
     34  1.1.1.4       mrg case $1 in
     35      1.1  macallan 
     36  1.1.1.4       mrg   --is-lightweight)
     37  1.1.1.4       mrg     # Used by our autoconf macros to check whether the available missing
     38  1.1.1.4       mrg     # script is modern enough.
     39  1.1.1.4       mrg     exit 0
     40  1.1.1.4       mrg     ;;
     41      1.1  macallan 
     42  1.1.1.4       mrg   --run)
     43  1.1.1.4       mrg     # Back-compat with the calling convention used by older automake.
     44  1.1.1.4       mrg     shift
     45  1.1.1.4       mrg     ;;
     46      1.1  macallan 
     47      1.1  macallan   -h|--h|--he|--hel|--help)
     48      1.1  macallan     echo "\
     49      1.1  macallan $0 [OPTION]... PROGRAM [ARGUMENT]...
     50      1.1  macallan 
     51  1.1.1.4       mrg Run 'PROGRAM [ARGUMENT]...', returning a proper advice when this fails due
     52  1.1.1.4       mrg to PROGRAM being missing or too old.
     53      1.1  macallan 
     54      1.1  macallan Options:
     55      1.1  macallan   -h, --help      display this help and exit
     56      1.1  macallan   -v, --version   output version information and exit
     57      1.1  macallan 
     58      1.1  macallan Supported PROGRAM values:
     59  1.1.1.5       mrg aclocal autoconf autogen  autoheader autom4te automake autoreconf
     60  1.1.1.5       mrg bison   flex     help2man lex        makeinfo perl     yacc
     61  1.1.1.3       mrg 
     62  1.1.1.3       mrg Version suffixes to PROGRAM as well as the prefixes 'gnu-', 'gnu', and
     63  1.1.1.3       mrg 'g' are ignored when checking the name.
     64      1.1  macallan 
     65  1.1.1.5       mrg Report bugs to <bug-automake (at] gnu.org>.
     66  1.1.1.5       mrg GNU Automake home page: <https://www.gnu.org/software/automake/>.
     67  1.1.1.5       mrg General help using GNU software: <https://www.gnu.org/gethelp/>."
     68      1.1  macallan     exit $?
     69      1.1  macallan     ;;
     70      1.1  macallan 
     71      1.1  macallan   -v|--v|--ve|--ver|--vers|--versi|--versio|--version)
     72  1.1.1.5       mrg     echo "missing (GNU Automake) $scriptversion"
     73      1.1  macallan     exit $?
     74      1.1  macallan     ;;
     75      1.1  macallan 
     76      1.1  macallan   -*)
     77  1.1.1.4       mrg     echo 1>&2 "$0: unknown '$1' option"
     78  1.1.1.3       mrg     echo 1>&2 "Try '$0 --help' for more information"
     79      1.1  macallan     exit 1
     80      1.1  macallan     ;;
     81      1.1  macallan 
     82      1.1  macallan esac
     83      1.1  macallan 
     84  1.1.1.4       mrg # Run the given program, remember its exit status.
     85  1.1.1.4       mrg "$@"; st=$?
     86      1.1  macallan 
     87  1.1.1.4       mrg # If it succeeded, we are done.
     88  1.1.1.4       mrg test $st -eq 0 && exit 0
     89      1.1  macallan 
     90  1.1.1.4       mrg # Also exit now if we it failed (or wasn't found), and '--version' was
     91  1.1.1.4       mrg # passed; such an option is passed most likely to detect whether the
     92  1.1.1.4       mrg # program is present and works.
     93  1.1.1.4       mrg case $2 in --version|--help) exit $st;; esac
     94  1.1.1.4       mrg 
     95  1.1.1.4       mrg # Exit code 63 means version mismatch.  This often happens when the user
     96  1.1.1.4       mrg # tries to use an ancient version of a tool on a file that requires a
     97  1.1.1.4       mrg # minimum version.
     98  1.1.1.4       mrg if test $st -eq 63; then
     99  1.1.1.4       mrg   msg="probably too old"
    100  1.1.1.4       mrg elif test $st -eq 127; then
    101  1.1.1.4       mrg   # Program was missing.
    102  1.1.1.4       mrg   msg="missing on your system"
    103  1.1.1.4       mrg else
    104  1.1.1.4       mrg   # Program was found and executed, but failed.  Give up.
    105  1.1.1.4       mrg   exit $st
    106  1.1.1.4       mrg fi
    107      1.1  macallan 
    108  1.1.1.4       mrg perl_URL=https://www.perl.org/
    109  1.1.1.4       mrg flex_URL=https://github.com/westes/flex
    110  1.1.1.4       mrg gnu_software_URL=https://www.gnu.org/software
    111  1.1.1.4       mrg 
    112  1.1.1.4       mrg program_details ()
    113  1.1.1.4       mrg {
    114  1.1.1.4       mrg   case $1 in
    115  1.1.1.5       mrg     aclocal|automake|autoreconf)
    116  1.1.1.4       mrg       echo "The '$1' program is part of the GNU Automake package:"
    117  1.1.1.4       mrg       echo "<$gnu_software_URL/automake>"
    118  1.1.1.4       mrg       echo "It also requires GNU Autoconf, GNU m4 and Perl in order to run:"
    119  1.1.1.4       mrg       echo "<$gnu_software_URL/autoconf>"
    120  1.1.1.4       mrg       echo "<$gnu_software_URL/m4/>"
    121  1.1.1.4       mrg       echo "<$perl_URL>"
    122  1.1.1.4       mrg       ;;
    123  1.1.1.4       mrg     autoconf|autom4te|autoheader)
    124  1.1.1.4       mrg       echo "The '$1' program is part of the GNU Autoconf package:"
    125  1.1.1.4       mrg       echo "<$gnu_software_URL/autoconf/>"
    126  1.1.1.4       mrg       echo "It also requires GNU m4 and Perl in order to run:"
    127  1.1.1.4       mrg       echo "<$gnu_software_URL/m4/>"
    128  1.1.1.4       mrg       echo "<$perl_URL>"
    129  1.1.1.4       mrg       ;;
    130  1.1.1.5       mrg     *)
    131  1.1.1.5       mrg       :
    132  1.1.1.5       mrg       ;;
    133  1.1.1.4       mrg   esac
    134  1.1.1.4       mrg }
    135  1.1.1.4       mrg 
    136  1.1.1.4       mrg give_advice ()
    137  1.1.1.4       mrg {
    138  1.1.1.4       mrg   # Normalize program name to check for.
    139  1.1.1.4       mrg   normalized_program=`echo "$1" | sed '
    140  1.1.1.4       mrg     s/^gnu-//; t
    141  1.1.1.4       mrg     s/^gnu//; t
    142  1.1.1.4       mrg     s/^g//; t'`
    143  1.1.1.4       mrg 
    144  1.1.1.4       mrg   printf '%s\n' "'$1' is $msg."
    145  1.1.1.4       mrg 
    146  1.1.1.4       mrg   configure_deps="'configure.ac' or m4 files included by 'configure.ac'"
    147  1.1.1.5       mrg   autoheader_deps="'acconfig.h'"
    148  1.1.1.5       mrg   automake_deps="'Makefile.am'"
    149  1.1.1.5       mrg   aclocal_deps="'acinclude.m4'"
    150  1.1.1.4       mrg   case $normalized_program in
    151  1.1.1.5       mrg     aclocal*)
    152  1.1.1.5       mrg       echo "You should only need it if you modified $aclocal_deps or"
    153  1.1.1.5       mrg       echo "$configure_deps."
    154  1.1.1.5       mrg       ;;
    155  1.1.1.4       mrg     autoconf*)
    156  1.1.1.5       mrg       echo "You should only need it if you modified $configure_deps."
    157  1.1.1.5       mrg       ;;
    158  1.1.1.5       mrg     autogen*)
    159  1.1.1.5       mrg       echo "You should only need it if you modified a '.def' or '.tpl' file."
    160  1.1.1.5       mrg       echo "You may want to install the GNU AutoGen package:"
    161  1.1.1.5       mrg       echo "<$gnu_software_URL/autogen/>"
    162  1.1.1.4       mrg       ;;
    163  1.1.1.4       mrg     autoheader*)
    164  1.1.1.5       mrg       echo "You should only need it if you modified $autoheader_deps or"
    165  1.1.1.4       mrg       echo "$configure_deps."
    166  1.1.1.4       mrg       ;;
    167  1.1.1.4       mrg     automake*)
    168  1.1.1.5       mrg       echo "You should only need it if you modified $automake_deps or"
    169  1.1.1.4       mrg       echo "$configure_deps."
    170  1.1.1.4       mrg       ;;
    171  1.1.1.5       mrg     autom4te*)
    172  1.1.1.4       mrg       echo "You might have modified some maintainer files that require"
    173  1.1.1.4       mrg       echo "the 'autom4te' program to be rebuilt."
    174  1.1.1.5       mrg       ;;
    175  1.1.1.5       mrg     autoreconf*)
    176  1.1.1.5       mrg       echo "You should only need it if you modified $aclocal_deps or"
    177  1.1.1.5       mrg       echo "$automake_deps or $autoheader_deps or $automake_deps or"
    178  1.1.1.5       mrg       echo "$configure_deps."
    179  1.1.1.4       mrg       ;;
    180  1.1.1.4       mrg     bison*|yacc*)
    181  1.1.1.4       mrg       echo "You should only need it if you modified a '.y' file."
    182  1.1.1.4       mrg       echo "You may want to install the GNU Bison package:"
    183  1.1.1.4       mrg       echo "<$gnu_software_URL/bison/>"
    184  1.1.1.4       mrg       ;;
    185  1.1.1.4       mrg     help2man*)
    186  1.1.1.4       mrg       echo "You should only need it if you modified a dependency" \
    187  1.1.1.4       mrg            "of a man page."
    188  1.1.1.4       mrg       echo "You may want to install the GNU Help2man package:"
    189  1.1.1.4       mrg       echo "<$gnu_software_URL/help2man/>"
    190  1.1.1.4       mrg     ;;
    191  1.1.1.5       mrg     lex*|flex*)
    192  1.1.1.5       mrg       echo "You should only need it if you modified a '.l' file."
    193  1.1.1.5       mrg       echo "You may want to install the Fast Lexical Analyzer package:"
    194  1.1.1.5       mrg       echo "<$flex_URL>"
    195  1.1.1.5       mrg       ;;
    196  1.1.1.4       mrg     makeinfo*)
    197  1.1.1.4       mrg       echo "You should only need it if you modified a '.texi' file, or"
    198  1.1.1.4       mrg       echo "any other file indirectly affecting the aspect of the manual."
    199  1.1.1.4       mrg       echo "You might want to install the Texinfo package:"
    200  1.1.1.4       mrg       echo "<$gnu_software_URL/texinfo/>"
    201  1.1.1.4       mrg       echo "The spurious makeinfo call might also be the consequence of"
    202  1.1.1.4       mrg       echo "using a buggy 'make' (AIX, DU, IRIX), in which case you might"
    203  1.1.1.4       mrg       echo "want to install GNU make:"
    204  1.1.1.4       mrg       echo "<$gnu_software_URL/make/>"
    205  1.1.1.4       mrg       ;;
    206  1.1.1.5       mrg     perl*)
    207  1.1.1.5       mrg       echo "You should only need it to run GNU Autoconf, GNU Automake, "
    208  1.1.1.5       mrg       echo "  assorted other tools, or if you modified a Perl source file."
    209  1.1.1.5       mrg       echo "You may want to install the Perl 5 language interpreter:"
    210  1.1.1.5       mrg       echo "<$perl_URL>"
    211  1.1.1.5       mrg       ;;
    212  1.1.1.4       mrg     *)
    213  1.1.1.4       mrg       echo "You might have modified some files without having the proper"
    214  1.1.1.4       mrg       echo "tools for further handling them.  Check the 'README' file, it"
    215  1.1.1.4       mrg       echo "often tells you about the needed prerequisites for installing"
    216  1.1.1.4       mrg       echo "this package.  You may also peek at any GNU archive site, in"
    217  1.1.1.4       mrg       echo "case some other package contains this missing '$1' program."
    218  1.1.1.4       mrg       ;;
    219  1.1.1.4       mrg   esac
    220  1.1.1.5       mrg   program_details "$normalized_program"
    221  1.1.1.4       mrg }
    222  1.1.1.4       mrg 
    223  1.1.1.4       mrg give_advice "$1" | sed -e '1s/^/WARNING: /' \
    224  1.1.1.4       mrg                        -e '2,$s/^/         /' >&2
    225  1.1.1.4       mrg 
    226  1.1.1.4       mrg # Propagate the correct exit status (expected to be 127 for a program
    227  1.1.1.4       mrg # not found, 63 for a program that failed due to version mismatch).
    228  1.1.1.4       mrg exit $st
    229      1.1  macallan 
    230      1.1  macallan # Local variables:
    231  1.1.1.4       mrg # eval: (add-hook 'before-save-hook 'time-stamp)
    232      1.1  macallan # time-stamp-start: "scriptversion="
    233      1.1  macallan # time-stamp-format: "%:y-%02m-%02d.%02H"
    234  1.1.1.4       mrg # time-stamp-time-zone: "UTC0"
    235  1.1.1.3       mrg # time-stamp-end: "; # UTC"
    236      1.1  macallan # End:
    237