Autoconf Creating Automatic Configuration Scripts for version 2.60, 23 June 2006 David MacKenzie Ben Elliston Akim Demaille This manual is for GNU Autoconf (version 2.60, 23 June 2006), a package for creating scripts to configure source code packages using templates and an M4 macro package. Copyright c 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, with the Front-Cover texts being “A GNU Manual,” and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled “GNU Free Documentation License.” (a) The FSF’s Back-Cover Text is: “You have freedom to copy and modify this GNU Manual, like GNU software. Copies published by the Free Software Foundation raise funds for GNU development.” i Table of Contents 1 Introduction............................... 1 2 The GNU Build System .................... 3 2.1 Automake .................................................. 3 2.2 Gnulib ..................................................... 3 2.3 Libtool ..................................................... 4 2.4 Pointers .................................................... 4 3 Making configure Scripts................... 5 3.1 Writing ‘configure.ac’...................................... 6 3.1.1 A Shell Script Compiler ................................. 6 3.1.2 The Autoconf Language ................................. 7 3.1.3 Standard ‘configure.ac’ Layout ........................ 8 3.2 Using autoscan to Create ‘configure.ac’ .................... 9 3.3 Using ifnames to List Conditionals .......................... 10 3.4 Using autoconf to Create configure ........................ 10 3.5 Using autoreconf to Update configure Scripts .............. 13 4 Initialization and Output Files............. 15 4.1 Initializing configure ...................................... 15 4.2 Notices in configure ....................................... 16 4.3 Finding configure Input ................................... 16 4.4 Outputting Files ........................................... 17 4.5 Performing Configuration Actions ........................... 18 4.6 Creating Configuration Files ................................ 20 4.7 Substitutions in Makefiles ................................... 20 4.7.1 Preset Output Variables................................ 21 4.7.2 Installation Directory Variables ......................... 23 4.7.3 Changed Directory Variables ........................... 26 4.7.4 Build Directories ...................................... 27 4.7.5 Automatic Remaking .................................. 28 4.8 Configuration Header Files .................................. 29 4.8.1 Configuration Header Templates ........................ 30 4.8.2 Using autoheader to Create ‘config.h.in’.............. 31 4.8.3 Autoheader Macros .................................... 32 4.9 Running Arbitrary Configuration Commands ................. 33 4.10 Creating Configuration Links............................... 34 4.11 Configuring Other Packages in Subdirectories................ 34 4.12 Default Prefix............................................. 35 ii Autoconf 5 Existing Tests ............................ 37 5.1 Common Behavior ......................................... 37 5.1.1 Standard Symbols ..................................... 37 5.1.2 Default Includes ....................................... 37 5.2 Alternative Programs ....................................... 39 5.2.1 Particular Program Checks ............................. 39 5.2.2 Generic Program and File Checks ....................... 41 5.3 Files ...................................................... 43 5.4 Library Files ............................................... 44 5.5 Library Functions .......................................... 45 5.5.1 Portability of C Functions .............................. 45 5.5.2 Particular Function Checks ............................. 48 5.5.3 Generic Function Checks ............................... 54 5.6 Header Files ............................................... 55 5.6.1 Portability of Headers .................................. 56 5.6.2 Particular Header Checks............................... 57 5.6.3 Generic Header Checks ................................. 62 5.7 Declarations ............................................... 63 5.7.1 Particular Declaration Checks .......................... 63 5.7.2 Generic Declaration Checks............................. 63 5.8 Structures ................................................. 64 5.8.1 Particular Structure Checks ............................ 64 5.8.2 Generic Structure Checks............................... 65 5.9 Types ..................................................... 66 5.9.1 Particular Type Checks ................................ 66 5.9.2 Generic Type Checks .................................. 68 5.10 Compilers and Preprocessors ............................... 68 5.10.1 Specific Compiler Characteristics ...................... 69 5.10.2 Generic Compiler Characteristics ...................... 69 5.10.3 C Compiler Characteristics ............................ 70 5.10.4 C++ Compiler Characteristics......................... 74 5.10.5 Objective C Compiler Characteristics .................. 75 5.10.6 Erlang Compiler and Interpreter Characteristics......... 75 5.10.7 Fortran Compiler Characteristics....................... 76 5.11 System Services ........................................... 80 5.12 Posix Variants ............................................ 82 5.13 Erlang Libraries........................................... 82 6 Writing Tests............................. 85 6.1 Language Choice ........................................... 85 6.2 Writing Test Programs ..................................... 86 6.2.1 Guidelines for Test Programs ........................... 87 6.2.2 Test Functions......................................... 87 6.2.3 Generating Sources .................................... 88 6.3 Running the Preprocessor ................................... 90 6.4 Running the Compiler ...................................... 91 6.5 Running the Linker......................................... 92 6.6 Checking Runtime Behavior................................. 92 iii 6.7 Systemology ............................................... 94 6.8 Multiple Cases ............................................. 94 7 Results of Tests........................... 97 7.1 Defining C Preprocessor Symbols ............................ 97 7.2 Setting Output Variables ................................... 98 7.3 Special Characters in Output Variables ..................... 100 7.4 Caching Results ........................................... 100 7.4.1 Cache Variable Names ................................ 102 7.4.2 Cache Files .......................................... 102 7.4.3 Cache Checkpointing.................................. 103 7.5 Printing Messages ......................................... 103 8 Programming in M4 ..................... 105 8.1 M4 Quotation............................................. 105 8.1.1 Active Characters .................................... 105 8.1.2 One Macro Call ...................................... 106 8.1.3 Quotation and Nested Macros ......................... 107 8.1.4 changequote is Evil .................................. 108 8.1.5 Quadrigraphs......................................... 109 8.1.6 Quotation Rule Of Thumb ............................ 110 8.2 Using autom4te ........................................... 111 8.2.1 Invoking autom4te.................................... 111 8.2.2 Customizing autom4te ................................ 115 8.3 Programming in M4sugar .................................. 116 8.3.1 Redefined M4 Macros ................................. 116 8.3.2 Looping constructs ................................... 117 8.3.3 Evaluation Macros .................................... 117 8.3.4 Text processing Macros ............................... 118 8.3.5 Forbidden Patterns ................................... 118 8.4 Programming in M4sh ..................................... 119 8.5 File Descriptor Macros .................................... 120 9 Writing Autoconf Macros ................ 123 9.1 Macro Definitions ......................................... 123 9.2 Macro Names ............................................. 123 9.3 Reporting Messages ....................................... 124 9.4 Dependencies Between Macros ............................. 125 9.4.1 Prerequisite Macros ................................... 125 9.4.2 Suggested Ordering ................................... 126 9.4.3 One-Shot Macros ..................................... 127 9.5 Obsoleting Macros ........................................ 127 9.6 Coding Style .............................................. 128 iv Autoconf 10 Portable Shell Programming ............ 131 10.1 Shellology ............................................... 131 10.2 Here-Documents ......................................... 133 10.3 File Descriptors .......................................... 134 10.4 File System Conventions .................................. 136 10.5 Shell Substitutions ....................................... 138 10.6 Assignments ............................................. 141 10.7 Parentheses in Shell Scripts ............................... 142 10.8 Slashes in Shell Scripts