Jump to content

configure script

From Wikipedia, the free encyclopedia
This is an old revision of this page, as edited by Stevebroshar (talk | contribs) at 12:44, 15 December 2024 (Organize the info; increase intro size; move more detailed info to sub-sections; keep intro high level). The present address (URL) is a permanent link to this revision, which may differ significantly from the current revision.
Flow diagram including configure, autoconf and automake, three tools in the GNU Build System

As generated by the GNU Build System, a configure script is a Bash shell script that generates build configuration files for a codebase to facilitate cross-platform support. It generates files tailoring for the host system – the environment on which the codebase is built and run.

Obtaining a software package as source code and compiling it locally is a common scenario on Unix and Unix-like environments. Via the GNU Build System, this process involves the following steps:

  1. Generate build configuration files
  2. Build the code
  3. Install the result to an accessible location

A configure script accomplishes the first step by generating a makefile that is configured for the host system. This includes using the libraries of the host as required by the codebase.

Use

After navigating a command-line shell to the directory that contains the source code, the following commands are typically executed:[1] 

./configure
make
make install

The configure script logs status and errors to file config.log.

Command ./configure --help outputs command line help information.

Often, a document with instructions is included with the codebase; often in a file named INSTALL. It can be helpful if the configure script fails.

Generating

GNU Build System simplifies some of the challenges of cross-platform software development.[2] These tools query the host system for environment settings, platform architecture, and the existence and location of required build and runtime dependencies. They store the gathered information in configure.ac or the now deprecated configure.in to be read by configure during the installation phase.

Dependency checking

In new development, library dependency checking has been done in great part using pkg-config via the m4 macro, PKG_CHECK_MODULES. Before pkg-config gained popularity, separate m4 macros were created to locate files known to be included in the distribution of libraries depended upon.

History

The first program to come with a configure script was rn by Larry Wall in 1984. The script was written by hand and produced a jocular running commentary when executed. It still survives as part of the build system of the trn program.[3]

Since then, an ecosystem of tools have been developed to automate the creation of configure scripts, of which the most common is Autoconf.

References

  1. ^ "Compiling Linux Software from Source Code". Control-Escape's Linux Help Engine. Retrieved 20 November 2010.
  2. ^ "Autoconf - GNU Project - Free Software Foundation (FSF)". GNU Operating System. Retrieved 20 November 2010.
  3. ^ "Configure script of trn". GitHub. Retrieved 10 December 2020.
Retrieved from "https://en.wikipedia.org/w/index.php?title=Configure_script&oldid=1263226575"