Difference between revisions of "Configure"

From AMule Project FAQ
Jump to: navigation, search
Line 148: Line 148:
  
 
{| border=1
 
{| border=1
−
|+ Optional features
+
|+ Developer options
 
|-
 
|-
 
| ''--enable-maintainer-mode'' || Activate some extra instructions only useful for developers (and totaly non-recommended to normal users)
 
| ''--enable-maintainer-mode'' || Activate some extra instructions only useful for developers (and totaly non-recommended to normal users)
Line 156: Line 156:
 
| ''--enable-dependency-tracking'' || Keep a track of the dependencies so that on next build, only changed files will be recompiled. It slows down the compilation a little. This is the default
 
| ''--enable-dependency-tracking'' || Keep a track of the dependencies so that on next build, only changed files will be recompiled. It slows down the compilation a little. This is the default
 
|-
 
|-
 +
| ''--enable-ccache'' || Enable CCache. This will make following compilations faster since only the non-modified bits of code will be recompilated. If you don't plan to compile [[aMule]] very often, don't enable this, since it takes longer to compile on the first compilation and it requires lots of disk space
 +
|-
 +
| ''--enable-profile'' || Enable code profiling (which allows to see how much time and resources are spent on each part of the code, though it will make [[aMule]] run much slower, so, in most cases, don't use it). The output file is ''gmon.out'' and can be viewed with ''gprof''. For more information, ''man gprof'' and ''man gcc'' (in the man pages of ''gcc'', search for the command line option ''-pg'')
 +
|}
 +
 +
{|
 +
|+ Compilation tweaks
 
| ''--disable-debug'' || Disables outputing information of the application execution. This information is useful to track bugs, so you might not want to use this option or you will not be able to report bugs propperly
 
| ''--disable-debug'' || Disables outputing information of the application execution. This information is useful to track bugs, so you might not want to use this option or you will not be able to report bugs propperly
 
|-
 
|-
Line 162: Line 169:
 
| ''--enable-optimise'' || Same as ''--enable-optimize'', but is deprecated (it is still there only for backwards compatibility)
 
| ''--enable-optimise'' || Same as ''--enable-optimize'', but is deprecated (it is still there only for backwards compatibility)
 
|-
 
|-
−
| ''--enable-profile'' || Enable code profiling (which allows to see how much time and resources are spent on each part of the code, though it will make [[aMule]] run much slower, so, in most cases, don't use it). The output file is ''gmon.out'' and can be viewed with ''gprof''. For more information, ''man gprof'' and ''man gcc'' (in the man pages of ''gcc'', search for the command line option ''-pg'')
+
| ''--disable-rpath'' || Do not write the libraries' path into the binnary. Useful only if you plan to move the binnary to other systems or if you move your libraries often. Only use it if you know what you're doing, since it will make [[aMule]] run slower
 
|-
 
|-
 
| ''--enable-static'' || Creates statically linked executables, which means that they will need no libraries since any needed library will be included inthe executable file. The executable might run faster, and will be easily portable between systems using the same platform, but will be incredibly bigger in size
 
| ''--enable-static'' || Creates statically linked executables, which means that they will need no libraries since any needed library will be included inthe executable file. The executable might run faster, and will be easily portable between systems using the same platform, but will be incredibly bigger in size
−
|-
+
|}
 +
 
 +
{|
 +
|+ Compilation of external libraries
 
| ''--disable-embedded_crypto'' || Do not use [[aMule]]'s cryptography code, instead, use external libraries' code. This option is not recommended and it could possibly break the compilation
 
| ''--disable-embedded_crypto'' || Do not use [[aMule]]'s cryptography code, instead, use external libraries' code. This option is not recommended and it could possibly break the compilation
 
|-
 
|-
 +
| ''--disable-gsocket'' || Do not use [[aMule]]'s ''gsocket.c'' implementation. Do not use it unless you are '''very''' sure of what you are doing! (On [[wxWidgets]] 2.4, the default ''gsocket.c'' code gives [[Low ID]]s on restart)
 +
|-
 +
| ''--disable-nls'' || Do not use Native Language Support. It will disable translations, so better don't use it
 +
|}
 +
 +
{|
 +
|+ Compilation hardcodings
 +
| ''--disable-gtk'' || Disable using pure GTK code in [[aMule]] (pure GTK code is only used in little parts of code where no universal code could be used). Do not disable it unless you know what you're doing (since some features may not be compiled)
 +
|-
 +
| ''--disable-systray'' || Do not include a SysTray into the [[aMule]] build. Only [[wxWidgets]] 2.4.2 users with no GTK should use it. Others should disable SysTray in [[aMule]]'s preferences
 +
|-
 +
| ''--enable-utf8-systray'' || Use UTF-8 encoded strings in [[aMule]]'s SysTray
 +
|}
 +
 +
{|
 +
|+ [[aMule]] binnaries selection
 
| ''--enable-amulecmd'' || Compile the aMule command line client
 
| ''--enable-amulecmd'' || Compile the aMule command line client
 
|-
 
|-
Line 189: Line 215:
 
|-
 
|-
 
| ''--enable-alcc'' || Compile aMuleLinkCreator for console
 
| ''--enable-alcc'' || Compile aMuleLinkCreator for console
−
|-
 
−
| ''--disable-gsocket'' || Do not use [[aMule]]'s ''gsocket.c'' implementation. Do not use it unless you are '''very''' sure of what you are doing! (On [[wxWidgets]] 2.4, the default ''gsocket.c'' code gives [[Low ID]]s on restart)
 
−
|-
 
−
| ''--disable-gtk'' || Disable using pure GTK code in [[aMule]] (pure GTK code is only used in little parts of code where no universal code could be used). Do not disable it unless you know what you're doing (since some features may not be compiled)
 
−
|-
 
−
| ''--disable-systray'' || Do not include a SysTray into the [[aMule]] build. Only [[wxWidgets]] 2.4.2 users with no GTK should use it. Others should disable SysTray in [[aMule]]'s preferences
 
−
|-
 
−
| ''--enable-utf8-systray'' || Use UTF-8 encoded strings in [[aMule]] SysTray
 
 
|-
 
|-
 
| ''--disable-monolithic'' || disable building of the monolithic aMule app. This is normally not recommended, unless you really know what you are doing (e.g. to compile only the daemon version)
 
| ''--disable-monolithic'' || disable building of the monolithic aMule app. This is normally not recommended, unless you really know what you are doing (e.g. to compile only the daemon version)
−
|-
+
|}
 +
 
 +
{|
 +
|+ Configure tweaks
 
| ''--disable-gtktest'' || Do not try to compile a test GTK (either GTK1 or GTK2 depending on your system's configuration) program to see if your system has a proper GTK configuration. This will make the ''configure'' script run a (very) little faster, but you should still not use it unless you know what you are doing, since the ''configure'' script could miss some tests.
 
| ''--disable-gtktest'' || Do not try to compile a test GTK (either GTK1 or GTK2 depending on your system's configuration) program to see if your system has a proper GTK configuration. This will make the ''configure'' script run a (very) little faster, but you should still not use it unless you know what you are doing, since the ''configure'' script could miss some tests.
−
|-
 
−
| ''--disable-rpath'' || Do not write the libraries' path into the binnary. Useful only if you plan to move the binnary to other systems or if you move your libraries often. Only use it if you know what you're doing, since it will make [[aMule]] run slower
 
−
|-
 
−
| ''--disable-nls'' || Do not use Native Language Support. It will disable translations, so better don't use it
 
−
|-
 
−
| ''--enable-ccache'' || Enable CCache. This will make following compilations faster since only the non-modified bits of code will be recompilated. If you don't plan to compile [[aMule]] very often, don't enable this, since it takes longer to compile on the first compilation and it requires lots of disk space
 
 
|}
 
|}
  

Revision as of 07:18, 29 March 2005

Introduction

configure configures aMule to adapt to many kinds of systems.

Its purpose is to make it easy to port it to many platforms and to compile it and use it in all platforms in the very same way.

You can set lots of parameters in it to adapt it to your system and to tweak it's features.

NOTE: This article is focused in aMule's configure. Other configure scripts work in a similar way, but their options will differ. This article maight be usefull for them as well, but have in mind that they might have options not listed here and lack some listed here too.

Main usage

It's usage is ./configure [OPTION]... [VARIABLE=VALUE]...

So, as you can see, you can define its behaviour both through options and through variables

Options

You can define one or more options. The available options in aMule's configure are listed below. To better understand their meaning, they have been grouped into several tables with options which affect the behaviour of configure in a similar way.

Please note that configure will (in most cases) not complain if you enter a non valid options or variables. So make sure you enter the options correctly (no typos) or they wil not only just do nothing, but also don't behave in the way you expected for taht specific options.

Main options

This options should exist in any configure script around the world. <They won't run the configure script to configure your application's compilation, but only output information you might need.

Basic options
-h or --help This will display a help message summing up all configure options
-V or --version This will display the version information

Non-compilation common options

This options should also exist on any configure script around the world. They will set some non-compilation related preferences.

Options directly related to the configure script
-q or --quiet or --silent Do not print the `checking...' messages, only the final summed up ouput
--cache-file=FILE Store the checkings' ouputs in FILE in a script format, so you can reuse without the need to rerun configure (read the cached file for more information)
-C or --config-cache Same as --cache-file=config.cache
-n or --no-create Just run configure, but do not create any file
--srcdir=DIR Look for the sources in DIR. By default, the configure dir or its parent (../)

Common options

This options should also exist on any configure script around the world. This time, this ones will affect the compilation of the application, so be careful when using them. You should take a close look at the application's README document (if available) if you want to use any of them (and even if you don't, still take a look at it, since you might have to use some).

Installation directories options
--prefix=PREFIX Set where to install architecture-independent files (data) in PREFIX. By dafault, this is set to /usr/local
--exec-prefix=EPREFIX Set where to install architecture-dependent files (mainly binaries) in EPREFIX. By default, this is set to the same value as PREFIX.
Advanced installation directories options
--bindir=DIR Where to store user executables. By default, EPREFIX/bin
--sbindir=DIR Where to store system administrator executables. By default, EPREFIX/sbin
--libexecdir=DIR Where to store program executable. By default EPREFIX/libexeec
--datadir=DIR Where to store read-only architecture independent data. By default, EPREFIX/share
--sysconfdir=DIR Where to install read-only single-machine data. By default, PREFIX/etc
--sharedstatedir=DIR Directory with hangable architacture-independent data. By default PREFIX/com
--localstatedir=DIR Modifiable single-machine data. By default, PREFIX/var
--libdir=DIR Directory to search libs object code libraries. By default, EPREFIX/lib
--includedir=DIR Directory containing the C header files. By default, PREFIX/include
--oldincludedir=DIR Directory containing C header files for non-GCC. By default, /usr/include
--infodir=DIR Where to store info and documentation files. By default, EPREFIX/info
--mandir=DIR Where to store man pages. By default, EPREFIX/man
General rule to program enabling and dirs specification
--PROGRAM-prefix=PREFIX Prepend PREFIX to installed PROGRAM directories
--PROGRAM-suffix=SUFFIX Append SUFFIX to installed PROGRAM directories
--PROGRAM-transform-name=SUBST Run sed SUBST on installed PROGRAM names
General rule to enabling or disabling features (sometimes it enables or disables the compilation of a program)
--disable-FEATURE Do not include FEATURE. Equivalent to --enable-FEATURE=no (see below)
--enable-FEATURE Include FEATURE'. Equivalent to --enable-FEATURE=yes (see below)
--enable-FEATURE=VALUE Include FEATURE and specify it's value to VALUE. The meaning of the value should be explained in the configure --help output of the script
--without-PACKAGE Do not use PACKAGE. Equivalent to --with-PACKAGE=no (see below)
--with-PACKAGE use PACKAGE. Equivalent to --with-PACKAGE=yes (see below)
--with-PACKAGE=VALUE Use PACKAGE and set its value to VALUE
System specifications
--build=BUILD Configure for building on BUILD platform. By default, it guesses the platform it is being run on
--host=HOST Cross-compile to build programs to run on HOST platforms. By default, same as BUILD
--target=TARGET Configure for building compilers for TARGET platfroms. By default, same as HOST

Very-common options

In most configure scripts you will also be able to use this options.

Quite common compiler options
--with-gnu-ld Use as the linker, without testing if it is the default linker in the system
X directory specifications
--with-x Use the X Window System
--x-includes=DIR DIR contains X's include files
--x-libraries=DIR DIR contains X's libraries

aMule options

The following options are specific to aMule's configure script. They will allow you to enable and disable them, so you should really take a look at them or you might sadly find out you lack things you would like to have in you aMule system ;-)

Developer options
--enable-maintainer-mode Activate some extra instructions only useful for developers (and totaly non-recommended to normal users)
--disable-dependency-tracking Makes the application compile faster since it does not track the dependencies so that they are not rebuild if not changed on when compiled again. If you do not plan to compile the application again with those same sources, you can safely use this option
--enable-dependency-tracking Keep a track of the dependencies so that on next build, only changed files will be recompiled. It slows down the compilation a little. This is the default
--enable-ccache Enable CCache. This will make following compilations faster since only the non-modified bits of code will be recompilated. If you don't plan to compile aMule very often, don't enable this, since it takes longer to compile on the first compilation and it requires lots of disk space
--enable-profile Enable code profiling (which allows to see how much time and resources are spent on each part of the code, though it will make aMule run much slower, so, in most cases, don't use it). The output file is gmon.out and can be viewed with gprof. For more information, man gprof and man gcc (in the man pages of gcc, search for the command line option -pg)
Compilation tweaks
--disable-debug Disables outputing information of the application execution. This information is useful to track bugs, so you might not want to use this option or you will not be able to report bugs propperly
--enable-optimize Optimizes the code to run (a little) faster. Using this option will not allow you to create useful bug reports so you might not want to enable it
--enable-optimise Same as --enable-optimize, but is deprecated (it is still there only for backwards compatibility)
--disable-rpath Do not write the libraries' path into the binnary. Useful only if you plan to move the binnary to other systems or if you move your libraries often. Only use it if you know what you're doing, since it will make aMule run slower
--enable-static Creates statically linked executables, which means that they will need no libraries since any needed library will be included inthe executable file. The executable might run faster, and will be easily portable between systems using the same platform, but will be incredibly bigger in size
Compilation of external libraries
--disable-embedded_crypto Do not use aMule's cryptography code, instead, use external libraries' code. This option is not recommended and it could possibly break the compilation
--disable-gsocket Do not use aMule's gsocket.c implementation. Do not use it unless you are very sure of what you are doing! (On wxWidgets 2.4, the default gsocket.c code gives Low IDs on restart)
--disable-nls Do not use Native Language Support. It will disable translations, so better don't use it
Compilation hardcodings
--disable-gtk Disable using pure GTK code in aMule (pure GTK code is only used in little parts of code where no universal code could be used). Do not disable it unless you know what you're doing (since some features may not be compiled)
--disable-systray Do not include a SysTray into the aMule build. Only wxWidgets 2.4.2 users with no GTK should use it. Others should disable SysTray in aMule's preferences
--enable-utf8-systray Use UTF-8 encoded strings in aMule's SysTray
aMule binnaries selection
--enable-amulecmd Compile the aMule command line client
--enable-amulecmdgui Compile aMule command line client (GUI version)
--enable-amule-gui Compile aMule remote GUI
--enable-amule-daemon Compile aMule daemon version
--enable-webserver Compile aMule's WebServer
--enable-webservergui Compile aMule's WebServer (GUI version)
--enable-cas Compile C aMule Statistics
--enable-wxcas Compile aMule GUI Statistics
--disable-ed2k Don't compile aMule's ed2k links handler
--enable-alc Compile aMuleLinkCreator GUI version
--enable-alcc Compile aMuleLinkCreator for console
--disable-monolithic disable building of the monolithic aMule app. This is normally not recommended, unless you really know what you are doing (e.g. to compile only the daemon version)
Configure tweaks
--disable-gtktest Do not try to compile a test GTK (either GTK1 or GTK2 depending on your system's configuration) program to see if your system has a proper GTK configuration. This will make the configure script run a (very) little faster, but you should still not use it unless you know what you are doing, since the configure script could miss some tests.

aMule compilation settings

This options are specific to aMule's configure script, but they are not directly related to aMule. They just tell were some libraries or headers are located in your system, so that aMule can find them when compiling. Use them if you have those files in non-standard paths or when you know what you are doing.

To better understand this options, take a look at the common options chapter in this article.

zLib
--with-zlib=PREFIX Look for zLib files in PREFIX
Curl
--with-curl-config=CONFIG CONFIG is the path of curl-config
--with-curl-prefix=PREFIX Look for Curl files in PREFIX
GDLib
--with-gdlib-prefix=PREFIX Look for GDLib files in PREFIX
--with-gdlib-exec-prefix=PREFIX exec prefix where gdlib is installed (optional) TODO
--with-gdlib-config=CONFIG 'CONFIG is the path of gdlib-config
LibPNG
--with-libpng-prefix=PREFIX Look for LibPNG files in PREFIX
--with-libpng-exec-prefix=PREFIX exec prefix where libpng is installed TODO
--with-libpng-config=CONFIG CONFIG is the path of libpng-config
wxWidgets
--with-wx-prefix=PREFIX Look for wxWidgets files in PREFIX
--with-wx-exec-prefix=PREFIX exec prefix where wxWidgets is installed (optional) TODO
--with-wx-config=CONFIG CONFIG is the path of wx-config
wxBase
--with-wxbase-prefix=PREFIX Look for wxBase files in PREFIX
--with-wxbase-exec-prefix=PREFIX exec prefix where wxWidgetsbase is installed (optional) TODO
--with-wxbase-config=CONFIG CONFIG is the path of wxbase-config
GTK
--with-gtk-prefix=PREFIX Look for GTK files in PREFIX
--with-gtk-exec-prefix=PREFIX exec prefix where GTK is installed (optional) TODO
Crypto++
--with-crypto-prefix=PREFIX Look for Crypto++ files in PREFIX
LibIConv
--with-libiconv-prefix=PREFIX Look for LibIConv files in PREFIX/include and PREFIX/lib
--without-libiconv-prefix Don't search for libiconv in includedir and libdir TODO
GetText
--with-included-gettext Use the GNU gettext library included here TODO
LibIntl
--with-libintl-prefix=PREFIX Look for LibIntl files in PREFIX/include' and PREFIX/lib'
--without-libintl-prefix Don't search for libintl in includedir and libdir TODO
CCache
--with-ccache-prefix=PREFIX Look for CCache files in PREFIX

Variables

Before you take a look at the variables and what they mean, you must take a look at the two variable's usage types available.

Usage types

You can either use environmental variables or you can enter variables directly into the configure command.

Environmental variables

If you plan to use environmental variables, you will affect the behaviour of configure and any other program you run in that same shell untill you end your session. You must set them before running configure. To set them, run 

export VAR=VALUE'

where VAR is the name of the environmental variable and VALUE is it's value.

Configure variables

If you don't want to use environmental variables, you can pass them into the configure command, this way: 

configure VAR=VALUE

where VAR stands for the variable name and VALUE is its value.

Variables and what they mean

Do NOT touch this variables if you don't know what you are doing!

This are some of the most commonly used environmental for configure:

Environmental variables
CC C compiler command to use
CXX C++ compiler command to use (e.g. g++)
CPP C preprocessor command to use
CFLAGS C compiler flags
CXXCPP C++ preprocessor command to use
CXXFLAGS C++ compiler flags
LDFLAGS Linker flags. Usually used to specify additional library directories (e.g. LDFLAGS="-L/usr/lib")
CPPFLAGS C/C++ preprocessor flags (e.g. CPPFLAGS="-I/usr/include")

More information

This article is mainly an explanation (dummy-proof) of the output of configure --help.

Anyway, it could (rarely) be out of date. So, if tehre's something you want to do with configure that is not listed here, run configure --help and see if it is listed there.

Of course, you can always take a look at the GNU configure page.

Retrieved from "http://wiki.amule.org/t/index.php?title=Configure&oldid=2712"