Configure script: Difference between revisions

Revision as of 07:51, 25 February 2015

Latest revision as of 14:35, 17 March 2025

(46 intermediate revisions by 28 users not shown)

Line 1:

{{Short description|Shell script for generating build configuration files on a Unix-like environment}}

{{lowercase}}

{{Lowercase title}}

[[Image:Autoconf-automake-process.svg|thumb|400px|Flow diagram including configure, [[autoconf]] and [[automake]], three tools in the GNU build system]]

When installing a package on a [[Unix]] or [[Unix-like]] environment, a '''configure script''' is a [[shell script]] that generates [[software build|build]] configuration files for a [[codebase]] to facilitate cross-platform support. It generates files tailoring for the host system {{endash}} the environment on which the codebase is built and run.

A '''Configure script''' is an executable script designed to aid in developing a [[computer program|program]] to be run on a wide number of different computers. It matches the [[Library (computer science)|libraries]] on the user's computer, with those required by the program, just before [[compiler|compiling]] it from its [[source code]].

Even though there are no standards for such a script, the pattern is so ubiquitous that many developers are familiar with and even expect a script named ''configure'' that has this functionality. The script can be and originally was hand-coded. Today, multiple tools are available for generating a configure script based on special configuration files. One commonly used tool is [[Autotools]] which generates a [[Bash (Unix shell)|Bash]] script.

As a common practice, all configure scripts are named "configure". Usually, configure scripts are written for the [[Bourne shell]], but they may be written for execution in any desired shell.

Obtaining a software package as [[source code]] and [[compiler|compiling]] it locally is a common scenario on [[Unix]] and [[Unix-like]] environments. Typically, this process involves the following steps:

==Usage==

Obtaining software directly from the source code (a standard procedure on [[Unix]] computers) generally involves the following three steps: configuring the [[makefile]], compiling the code, and finally installing the executable in the appropriate places. A configure script accomplishes the first of these steps. Using configure scripts is an automated method of generating [[makefile]]s before compilation to tailor the software to the system on which the executable is to be compiled and run. The final executable software is most commonly obtained by executing the following commands in a shell that is currently pointing to the directory containing the source code:

# Generate build configuration files

./configure

# Build the code

make

# Install the result to an accessible ___location

make install

A configure script accomplishes the first step by generating a [[makefile]] that is configured for the host system. This includes using the [[Library (computer science)|libraries]] of the host as required by the codebase.

One must type <code>./configure</code> (''dot slash'' configure) rather than simply <code>configure</code> to indicate to the shell that the script is in ".", i.e. the current directory. By default, for security reasons, [[Unix]] operating systems do not search the current directory for executables so one must give the full path explicitly to avoid an error.<ref>{{cite web |url=http://www.control-escape.com/linux/lx-swinstall-tar.html |title=Compiling Linux Software from Source Code |publisher=Control-Escape's Linux Help Engine |accessdate=20 November 2010}}</ref>

==Usage Use ==

Upon its completion, <code>configure</code> prints a report to <code>config.log</code>. Running <code>./configure --help</code> gives a list of command line arguments, for enabling or disabling additional features such as:

OneAfter mustnavigating typea <code>./configure</code>command-line [[Shell (''dot slash'' configurecomputing) rather than simply <code>configure</code> to indicate|shell]] to the shelldirectory that the script is in ".", i.e.contains the currentsource directory. By defaultcode, for security reasons, [[Unix]] operating systems do not search the currentfollowing directorycommands forare executablestypically so one must give the full path explicitly to avoid an error.executed:<ref>{{cite web |url=http://www.control-escape.com/linux/lx-swinstall-tar.html |title=Compiling Linux Software from Source Code |publisher=Control-Escape's Linux Help Engine |accessdateaccess-date=20 November 2010}}</ref>

./configure --libs="-lmpfr -lgmp"

./configure --prefix=/home/myname/apps

<syntaxhighlight lang="sh">

The first line includes the <code>mpfr</code> and <code>gmp</code> libraries. The second line tells [[make (software)|make]] to install the final version in <code>/home/myname/apps</code>. Note that if you have a space character in your argument, you will need to enclose the text in quotation marks as shown on the first line. The <code>INSTALL</code> file contains instructions should the prescribed steps fail.

./configure

make

make install

</syntaxhighlight>

For the Autotools, the configure script logs status and errors to file ''config.log'', and the command <code>./configure --help</code> outputs command line help information.

==Generating <code>configure</code>==

Software developers simplify the challenge of [[cross-platform]] software development by using GNU's [[Autotools]].<ref>{{cite web |url=http://www.gnu.org/software/autoconf/ |title=Autoconf - GNU Project - Free Software Foundation (FSF) |publisher=GNU Operating System |accessdate=20 November 2010}}</ref> These scripts query the system on which they run for: environment settings, platform architecture, and the existence and ___location of required build and runtime dependencies. They store the gathered information in <code>configure.ac</code> or (the now deprecated) <code>configure.in</code> to be read by <code>configure</code> during the installation phase.

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

== Dependency checking ==

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

==History Generating ==

The first program to come with a '''Configure script''' was [[rn (newsreader)|rn]] by [[Larry Wall]] in 1984.

Notable for its wry and jocular running commentary, that script was written entirely by hand and still survives as part of the build system of the '''trn''' program.

SoftwareAutotools developerssimplifies simplifysome of the challengechallenges of [[cross-platform software]] software development by using GNU's [[Autotools]].<ref>{{cite web |url=httphttps://www.gnu.org/software/autoconf/ |title=Autoconf - GNU Project - Free Software Foundation (FSF) |publisher=GNU Operating System |accessdateaccess-date=20 November 2010}}</ref> These scriptstools query the host system on which they run for: environment settings, platform architecture, and the existence and ___location of required build and runtime dependencies. They store the gathered information in <code>configure.ac</code> or (the now deprecated) <code>configure.in</code> to be read by <code>configure</code> during the installation phase.

Since then, an ecosystem of programs has grown up to automate the creation of '''Configure script'''s as far as possible, of which the most common is the GNU Autoconf system described above.

In new development, library dependency checking hascan beenbe doneaccomplished in great part usingvia [[pkg-config]] via the [[M4 (computer language)|m4]] macro, PKG_CHECK_MODULES. Before pkg-config's gained popularity, separate m4 macros were created to locate files known to be included in the distribution of libraries depended upon.

== See also ==

* A succinct introduction<ref>{{cite web |url=http://sunybow-programminglanguage.blogspot.de/2009/01/introduction-to-gnu-build-tools.html |title=Introduction to GNU Build Tools |author=Neelakanth Nadgir |date=June 2001 |accessdate=4 April 2013}}</ref>

== See alsoHistory ==

* A verbose introduction<ref>{{cite web |url=http://www.airs.com/ian/configure/ |title=The GNU configure and build system |first=Ian Lance |last=Taylor |publisher=airs.com |accessdate=20 November 2010}}</ref>

The first program to come with a configure script was [[rn (newsreader)|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.<ref>{{cite web |url=https://github.com/acli/trn/blob/613a7e97aca06dd807fb225990fa804e8c744574/Configure|title= Configure script of trn |publisher=GitHub |access-date=10 December 2020}}</ref>

* [[Autoconf]]

* [[Software build]]

Since then, an ecosystem of programstools hashave grownbeen updeveloped to automate the creation of '''Configureconfigure script'''s as far as possiblescripts, of which the most common is the GNU [[Autoconf system described above]].

* [[GNU build system]]

== References ==