Difference between revisions of "HowTo Compile In Gentoo"

From AMule Project FAQ
Jump to: navigation, search
m
(The SVN ebuild - updated the ChangeLog)
 
(112 intermediate revisions by 22 users not shown)
Line 1: Line 1:
Compiling a recent version of amule on Gentoo should be a breeze by just typing
+
<center>
'emerge -av amule'
+
'''English''' |
but due to several facts it isn't quite that easy right now. So here's a little Step by Step explanation. Please read the whole document before doing anything as there are several ways you can use and each of them will have a different outcome.
+
[[HowTo_Compile_In_Gentoo-de|Deutsch]] |
 +
[[HowTo_Compile_In_Gentoo-es|Español]]
 +
</center>
  
=Stable amule from portage=
+
English version updated: 01.08.2009 - Newest Gentoo Version are now 2.2.5.
  
If you just ''emerge amule'' you will most likely get the latest package that is marked as stable in portage. This is amule-1.2.8 which is more than 12 months old, lacks several bugfixes and features which could seriously lower your download or make it impossible to connect to some servers. So that is not really an option.
+
== Introduction ==
 +
Gentoo is known for choices. As such, [[aMule]] comes in a variety of versions. This article will cover the installation of the last PORTAGE version, and of [[aMule SVN]] through a personal overlay.
  
=Unstable amule from portage=
+
== Methods of Installation ==
Gentoo classifies amule2.0.0rc ebuilds as unstable because they are ReleaseCandidates. The latest one available is amule2.0.0rc7. There is an (inofficial) ebuild for rc8, but as rc8 depends on wxGTK2.5.3 to build the amule daemon and wxGTK2.5.3 is hardmasked in portage it isn't available through portage.
+
=== amule-2.2.5.ebuild ===
 +
This ebuild matches the 2.2.5 stable [[aMule]] release, it is available 28.08.2009 in portage.
  
However, if rc7 is "new enough" for you enter the following things as root into a console:
+
Dependencies: >=x11-libs/wxGTK-2.8*; >=dev-libs/crypto++-5.5.2; >=sys-libs/zlib-1.2.1
  
<code>mkdir /etc/portage</code> (this could give an error message if the directory already exists, just ignore that)<br>
+
Conditional dependencies: >=dev-libs/geoip for geoip support; >=net-libs/libupnp for Intel UPnP stack support; >=media-libs/libpng-1.2.0 for remote support; >=media-libs/gd-2.0.26 for unicode support and or statistic reporting.
<code>echo 'net-p2p/amule ~x86' >> /etc/portage/package.keywords<br>
+
emerge -av amule</code>
+
  
However rc7 is getting quite old now, so it is the best thing to use either rc8 or even a recent cvs tarball and compile amule manually.
+
== Installation instructions ==
  
=Recent amule manual installation=
+
=== amule-2.2.5.ebuild ===
Per default Gentoo uses gtk2 in all recent profiles. When it comes to wxGTK (which is needed by amule) this can be some trouble. The recent stable wxGTK in portage is wxGTK2.4.2 which should never be linked against GTK2. It causes random crashes, freezes, inpredictable behaviour and may even harm your pet dog!
+
1. Show what will be done:
 +
  emerge -pv amule
 +
2. Adjust your USE flags for amule into ''/etc/portage/package.use
  
So there are two possible ways to go: choose wxGTK2.4.2 linked against GTK1.2 (which should be fine for everybody who doesn't want to use amuled, the amule daemon) or choose wxGTK2.5.3 linked either against GTK1.2 or GTK2 (for those who want to try amuled as amuled doesn't work with wxGTK prior to 2.5.3).
+
3. Emerge amule:
 +
  emerge -a amule
  
Another thing is unicode support: You can't enable unicode support when using GTK1.2 and enabling unicode with GTK2 causes huge memleaks (100MB and more in 24h). So I will just disable it in these examples.
+
=== amule SVN ===
 +
It is no ebuild for the current [[aMule SVN]] so we need to add one in portage. For that, we will make use of a personal portage overlay. If you don't already have one, just follow this HOWTO article: [http://en.gentoo-wiki.com/wiki/Overlay#Creating_a_local_overlay Overlay: Creating_a_local_overlay]
  
==wxGTK2.4.2==
+
We will also follow the naming scheme of portage. SVN ebuild from a SVN tarball are not named as '''package_name-SVN''' but as '''package_name-version_date_of_the_tarball'''. That is to distinguish them from real SVN ebuilds (the so called live ebuilds) named as '''package_name-9999''' and using keywords="". As aMule is using the revision to name the tarball, we will use it for the '''version_date_of_the_tarball'''.
If you don't want to use amuled then wxGTK2.4.2 is just fine for. You only need to tell it that it should link against GTK1.2. To do this grab a console and enter (as root):
+
  
<code>mkdir /etc/portage</code> (this may give you an error if the directory already exists, just ignore that)<br>
+
1. Define ''PORTDIR_OVERLAY''. Open up ''/etc/make.conf'' with your favourite text editor and define the ''PORTDIR_OVERLAY'' variable. We will use:
<code> echo 'x11-libs/wxGTK -gtk2 -unicode' >> /etc/portage/package-use<br>
+
  PORTDIR_OVERLAY="/usr/local/portage"
emerge -av wxGTK</code>
+
  
This should (re-)emerge wxGTK2.4.2 linked against GTK1.2. Now you can go on to [[HowTo_Compile_In_Gentoo#compiling_amule|compiling amule]].
+
2. Create overlay for amule-svn:
 +
  mkdir -p /usr/local/net-p2p/amule
  
==wxGTK2.5.3==
+
3. Add to ''package.keywords'':
If you want to use amuled then you need at least wxGTK2.5.3. This is currently hardmasked in portage due to problems when compiling with opengl support. But as amule is no 3D egoshooter we can safely disable opengl support and use it anyway. To do so enter the following into a console as root:
+
  echo "net-p2p/amule ~x86" >> /etc/portage/package.keywords
  
<code>mkdir /etc/portage</code> (this may give you an error if the directory already exists, just ignore that)<br>
+
4. Copy the following ebuild into ''{PORTDIR_OVERLAY}/net-p2p/amule/amule-9732.ebuild''
<code>echo '=x11-libs/wxGTK-2.5*' >> /etc/portage/package.unmask<br>
+
echo 'x11-libs/wxGTK ~x86' >> /etc/portage/package.keywords<br></code>
+
  
If you want to use GTK1.2 (recommended):<br>
+
I use here the tarball from 31 July 2009 revision 9732 that was working fine for me, but you can change the revision like you want. Be careful to choose a version number available on the [http://amule.sourceforge.net/tarballs/ tarballs page], otherwise your ebuild will fail.
<code>echo 'x11-libs/wxGTK -gtk2 -unicode -opengl' >> /etc/portage/package.use<br></code>
+
  
If you want to use GTK2 (not thoroughly tested yet):<br>
+
==== The SVN ebuild ====
<code>echo 'x11-libs/wxGTK -unicode -opengl' >> /etc/portage/package.use<br></code>
+
ChangeLog:
 +
* 01-08-2009 Initial SVN ebuild
 +
* 04-08-2009 Updated DEPEND + RDEPEND
 +
* 27-08-2009 Updated for the 2_2_X trunk
 +
* 12-04-2011 USE flag change
 +
* 16-04-2011 Updated to EAPI="3
 +
* 14-10-2011 Workaround debian specific test with USE=plasma
 +
* 04-05-2012 Plasma need kde4-base that need EAPI="3" (Change in portage?). Fix it.
 +
For more details, see the [http://forum.amule.org/index.php?topic=17143.0 forum thread].
  
<code>emerge -av wxGTK</code>
+
# Copyright 1999-2011 Gentoo Foundation
 +
# Distributed under the terms of the GNU General Public License v2
 +
# $Header: $
 +
 +
EAPI="3"
 +
 +
inherit eutils flag-o-matic kde4-base wxwidgets
 +
 +
MY_P="aMule-SVN-r${PV}"
 +
S="${WORKDIR}"/${MY_P}
 +
 +
DESCRIPTION="aMule, the all-platform eMule p2p client"
 +
HOMEPAGE="http://www.amule.org/"
 +
SRC_URI="http://amule.sourceforge.net/tarballs/${MY_P}.tar.bz2"
 +
 +
LICENSE="GPL-2"
 +
SLOT="0"
 +
KEYWORDS="~alpha ~amd64 ~hppa ~ppc ~ppc64 ~sparc ~x86"
 +
IUSE="daemon debug ed2k fileview geoip gtk mmap nls plasma remote static stats unicode upnp xchat"
 +
 +
RESTRICT="nomirror"
 +
 +
DEPEND="=x11-libs/wxGTK-2.8.12*
 +
>=dev-libs/crypto++-5.5.2
 +
>=sys-libs/zlib-1.2.1
 +
stats? ( >=media-libs/gd-2.0.26[jpeg] )
 +
geoip? ( dev-libs/geoip )
 +
plasma? ( kde-base/kdelibs )
 +
upnp? ( >=net-libs/libupnp-1.6.6 )
 +
remote? ( >=media-libs/libpng-1.2.0
 +
unicode? ( >=media-libs/gd-2.0.26 ) )"
 +
 +
RDEPEND="$DEPEND
 +
xchat? ( net-irc/xchat[perl] )"
 +
 +
 +
pkg_setup() {
 +
if ! use gtk && ! use remote && ! use daemon; then
 +
eerror ""
 +
eerror "You have to specify at least one of gtk, remote or daemon"
 +
eerror "USE flag to build amule."
 +
eerror ""
 +
die "Invalid USE flag set"
 +
fi
 +
 +
if use stats && ! use gtk; then
 +
einfo "Note: You would need both the gtk and stats USE flags"
 +
einfo "to compile aMule Statistics GUI."
 +
einfo "I will now compile console versions only."
 +
fi
 +
}
 +
 +
pkg_preinst() {
 +
if use daemon || use remote; then
 +
enewgroup p2p
 +
enewuser p2p -1 -1 /home/p2p p2p
 +
fi
 +
}
 +
 +
src_configure() {
 +
local myconf
 +
 +
WX_GTK_VER="2.8"
 +
 +
if use gtk; then
 +
einfo "wxGTK with gtk support will be used"
 +
need-wxwidgets unicode
 +
else
 +
einfo "wxGTK without X support will be used"
 +
need-wxwidgets base
 +
fi
 +
 +
if use gtk ; then
 +
use stats && myconf="${myconf}
 +
--enable-wxcas
 +
--enable-alc"
 +
use remote && myconf="${myconf}
 +
--enable-amule-gui"
 +
else
 +
myconf="
 +
--disable-monolithic
 +
--disable-amule-gui
 +
--disable-wxcas
 +
--disable-alc"
 +
fi
 +
 +
econf \
 +
--with-wx-config=${WX_CONFIG} \
 +
--enable-amulecmd \
 +
$(use_enable debug) \
 +
$(use_enable !debug optimize) \
 +
$(use_enable daemon amule-daemon) \
 +
$(use_enable ed2k) \
 +
$(use_enable fileview) \
 +
$(use_enable geoip) \
 +
$(use_enable mmap) \
 +
$(use_enable nls) \
 +
$(use_enable plasma plasmamule ) \
 +
$(use_enable remote webserver) \
 +
$(use_enable static) \
 +
$(use_enable stats cas) \
 +
$(use_enable stats alcc) \
 +
$(use_enable upnp) \
 +
$(use_enable xchat xas) \
 +
${myconf} || die
 +
}
 +
 +
src_compile() {
 +
cd ${S}
 +
emake
 +
}
 +
 +
src_install() {
 +
emake DESTDIR="${D}" install || die
 +
 +
if use daemon; then
 +
newconfd "${FILESDIR}"/amuled.confd amuled
 +
newinitd "${FILESDIR}"/amuled.initd amuled
 +
fi
 +
if use remote; then
 +
newconfd "${FILESDIR}"/amuleweb.confd amuleweb
 +
newinitd "${FILESDIR}"/amuleweb.initd amuleweb
 +
fi
 +
}
 +
  
==Compiling amule==
 
Grab either amule2.0.0rc8 from [http://www.amule.org http://www.amule.org] or (especially if you want to use amuled) a recent cvs tarball from [http://amule.hirnriss.net http://amule.hirnriss.net]. Untar it by entering <code>tar -xvjf aMule-foo.tar.bz2</code> and cd to the new directory.
 
  
check <code>./configure --help</code> for a summary of all configure options. Pick the ones you want and run (as an example building the monolithic client and amulecmd)<br>
+
5. Change directory:
<code>./configure --enable-amulecmd</code>
+
  cd /usr/local/portage/net-p2p/amule/
  
Check the configure output for errors and if everything seems fine type <code>make</code>. Once amule is done compiling change to a root account and type <code>make install</code> to install amule. Now you're done and can start enjoying your amule experience.
+
6. Copy the files directory from PORTAGE:
 +
  cp -r /usr/portage/net-p2p/amule/files files
 +
 
 +
7. Remove the unneeded files:
 +
  rm files/*.patch
 +
 
 +
8. Digest the ebuild:
 +
  ebuild amule-9732.ebuild digest
 +
 
 +
9. As you can see, this ebuild depend on x11-libs/wxGTK-2.8.12 which is not yet in portage. You can find it at [http://bugs.gentoo.org/show_bug.cgi?id=363319 Gentoo's Bugzilla – Bug 363319]. What you have to do is to dpwnload the ebuild from bugzilla and put it into the x11-libs/wxGTK directory of your overlay. You must also copy the files directory from PORTAGE and digest the ebuild:
 +
  cd /usr/local/portage/x11-libs/wxGTK
 +
  cp -r /usr/portage/x11-libs/wxGTK/files files
 +
  ebuild wxGTK-2.8.12.ebuild digest
 +
 
 +
10. Review installation flags:
 +
  emerge amule -pv
 +
 
 +
11. Modify ''/etc/portage/package.use'' to suit your needs (please note that ''debug'' is enabled regardless of ''USE'' flag):
 +
  net-p2p/amule -amuled -debug geoip gtk nls -remote -stats unicode
 +
 
 +
This would install amule without deamon and remote support.
 +
To activate deamons and remote options, leave out the '-' like this:
 +
 
 +
  net-p2p/amule amuled -debug geoip gtk nls remote -stats unicode
 +
 
 +
As aMule needs unicode support or it won't compile, you might also want to add a line to enable unicode in x11-libs/wxGTK
 +
  x11-libs/wxGTK unicode
 +
 
 +
12. Install [[aMule SVN]]:
 +
  emerge amule
 +
 
 +
'''PLEASE''' do ''emerge amule -pv'' before installing to determine how you want to compile [[aMule]].
 +
 
 +
13. As other programs can depend on wxGTK, it can be a good opportunity to update your system as usual. emerge --sync, and so on as explained into the handbook.
 +
 
 +
==== Possible crash ====
 +
On my ~amd64 system, I get a crash at amule startup with recent libcrypto++ versions.
 +
To avoid it, mask it into /etc/portage/package.mask:
 +
echo =dev-libs/crypto++-5.6.0 >> /etc/portage/package.mask
 +
echo =dev-libs/crypto++-5.6.0-r1 >> /etc/portage/package.mask
 +
echo dev-libs/crypto++-5.6.1 >> /etc/portage/package.mask
 +
emerge -a crypto++ amule
 +
revdep-rebuild
 +
Revdep-rebuild didn't find anything into my system, but it is safer to run it anyway.
 +
 
 +
Another solution is to use the ebuild and the patch in [http://bugs.gentoo.org/show_bug.cgi?id=322713 bug 322713] for merging the last version of libcrypto++.
 +
 
 +
'''Update:''' It look like to be fixed. If it should append again with the same crypto++ version, please ask to reopen this bug.

Latest revision as of 16:58, 9 May 2012

English | Deutsch | Español

English version updated: 01.08.2009 - Newest Gentoo Version are now 2.2.5.

Introduction

Gentoo is known for choices. As such, aMule comes in a variety of versions. This article will cover the installation of the last PORTAGE version, and of aMule SVN through a personal overlay.

Methods of Installation

amule-2.2.5.ebuild

This ebuild matches the 2.2.5 stable aMule release, it is available 28.08.2009 in portage.

Dependencies: >=x11-libs/wxGTK-2.8*; >=dev-libs/crypto++-5.5.2; >=sys-libs/zlib-1.2.1

Conditional dependencies: >=dev-libs/geoip for geoip support; >=net-libs/libupnp for Intel UPnP stack support; >=media-libs/libpng-1.2.0 for remote support; >=media-libs/gd-2.0.26 for unicode support and or statistic reporting.

Installation instructions

amule-2.2.5.ebuild

1. Show what will be done:

 emerge -pv amule

2. Adjust your USE flags for amule into /etc/portage/package.use

3. Emerge amule:

 emerge -a amule

amule SVN

It is no ebuild for the current aMule SVN so we need to add one in portage. For that, we will make use of a personal portage overlay. If you don't already have one, just follow this HOWTO article: Overlay: Creating_a_local_overlay

We will also follow the naming scheme of portage. SVN ebuild from a SVN tarball are not named as package_name-SVN but as package_name-version_date_of_the_tarball. That is to distinguish them from real SVN ebuilds (the so called live ebuilds) named as package_name-9999 and using keywords="". As aMule is using the revision to name the tarball, we will use it for the version_date_of_the_tarball.

1. Define PORTDIR_OVERLAY. Open up /etc/make.conf with your favourite text editor and define the PORTDIR_OVERLAY variable. We will use:

 PORTDIR_OVERLAY="/usr/local/portage"

2. Create overlay for amule-svn:

 mkdir -p /usr/local/net-p2p/amule

3. Add to package.keywords:

 echo "net-p2p/amule ~x86" >> /etc/portage/package.keywords

4. Copy the following ebuild into {PORTDIR_OVERLAY}/net-p2p/amule/amule-9732.ebuild

I use here the tarball from 31 July 2009 revision 9732 that was working fine for me, but you can change the revision like you want. Be careful to choose a version number available on the tarballs page, otherwise your ebuild will fail.

The SVN ebuild

ChangeLog:

  • 01-08-2009 Initial SVN ebuild
  • 04-08-2009 Updated DEPEND + RDEPEND
  • 27-08-2009 Updated for the 2_2_X trunk
  • 12-04-2011 USE flag change
  • 16-04-2011 Updated to EAPI="3
  • 14-10-2011 Workaround debian specific test with USE=plasma
  • 04-05-2012 Plasma need kde4-base that need EAPI="3" (Change in portage?). Fix it.

For more details, see the forum thread.

# Copyright 1999-2011 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
# $Header: $

EAPI="3"

inherit eutils flag-o-matic kde4-base wxwidgets

MY_P="aMule-SVN-r${PV}"
S="${WORKDIR}"/${MY_P}

DESCRIPTION="aMule, the all-platform eMule p2p client"
HOMEPAGE="http://www.amule.org/"
SRC_URI="http://amule.sourceforge.net/tarballs/${MY_P}.tar.bz2"

LICENSE="GPL-2"
SLOT="0"
KEYWORDS="~alpha ~amd64 ~hppa ~ppc ~ppc64 ~sparc ~x86"
IUSE="daemon debug ed2k fileview geoip gtk mmap nls plasma remote static stats unicode upnp xchat"

RESTRICT="nomirror"

DEPEND="=x11-libs/wxGTK-2.8.12*
	>=dev-libs/crypto++-5.5.2
	>=sys-libs/zlib-1.2.1
	stats? ( >=media-libs/gd-2.0.26[jpeg] )
	geoip? ( dev-libs/geoip )
	plasma? ( kde-base/kdelibs )
	upnp? ( >=net-libs/libupnp-1.6.6 )
	remote? ( >=media-libs/libpng-1.2.0
	unicode? ( >=media-libs/gd-2.0.26 ) )"

RDEPEND="$DEPEND
	xchat? ( net-irc/xchat[perl] )"


pkg_setup() {
	if ! use gtk && ! use remote && ! use daemon; then
		eerror ""
		eerror "You have to specify at least one of gtk, remote or daemon"
		eerror "USE flag to build amule."
		eerror ""
		die "Invalid USE flag set"
	fi

	if use stats && ! use gtk; then
		einfo "Note: You would need both the gtk and stats USE flags"
		einfo "to compile aMule Statistics GUI."
		einfo "I will now compile console versions only."
	fi
}

pkg_preinst() {
	if use daemon || use remote; then
		enewgroup p2p
		enewuser p2p -1 -1 /home/p2p p2p
	fi
}

src_configure() {
	local myconf

	WX_GTK_VER="2.8"

	if use gtk; then
		einfo "wxGTK with gtk support will be used"
		need-wxwidgets unicode
	else
		einfo "wxGTK without X support will be used"
		need-wxwidgets base
	fi

	if use gtk ; then
		use stats && myconf="${myconf}
			--enable-wxcas
			--enable-alc"
		use remote && myconf="${myconf}
			--enable-amule-gui"
	else
		myconf="
			--disable-monolithic
			--disable-amule-gui
			--disable-wxcas
			--disable-alc"
	fi

	econf \
		--with-wx-config=${WX_CONFIG} \
		--enable-amulecmd \
		$(use_enable debug) \
		$(use_enable !debug optimize) \
		$(use_enable daemon amule-daemon) \
		$(use_enable ed2k) \
		$(use_enable fileview) \
		$(use_enable geoip) \
		$(use_enable mmap) \
		$(use_enable nls) \
		$(use_enable plasma plasmamule ) \
		$(use_enable remote webserver) \
		$(use_enable static) \
		$(use_enable stats cas) \
		$(use_enable stats alcc) \
		$(use_enable upnp) \
		$(use_enable xchat xas) \
		${myconf} || die
}

src_compile() {
	cd ${S}
	emake
}

src_install() {
	emake DESTDIR="${D}" install || die

	if use daemon; then
		newconfd "${FILESDIR}"/amuled.confd amuled
		newinitd "${FILESDIR}"/amuled.initd amuled
	fi
	if use remote; then
		newconfd "${FILESDIR}"/amuleweb.confd amuleweb
		newinitd "${FILESDIR}"/amuleweb.initd amuleweb
	fi
}


5. Change directory:

 cd /usr/local/portage/net-p2p/amule/

6. Copy the files directory from PORTAGE:

 cp -r /usr/portage/net-p2p/amule/files files

7. Remove the unneeded files:

 rm files/*.patch

8. Digest the ebuild:

 ebuild amule-9732.ebuild digest

9. As you can see, this ebuild depend on x11-libs/wxGTK-2.8.12 which is not yet in portage. You can find it at Gentoo's Bugzilla – Bug 363319. What you have to do is to dpwnload the ebuild from bugzilla and put it into the x11-libs/wxGTK directory of your overlay. You must also copy the files directory from PORTAGE and digest the ebuild:

 cd /usr/local/portage/x11-libs/wxGTK
 cp -r /usr/portage/x11-libs/wxGTK/files files
 ebuild wxGTK-2.8.12.ebuild digest

10. Review installation flags:

 emerge amule -pv

11. Modify /etc/portage/package.use to suit your needs (please note that debug is enabled regardless of USE flag):

 net-p2p/amule -amuled -debug geoip gtk nls -remote -stats unicode

This would install amule without deamon and remote support. To activate deamons and remote options, leave out the '-' like this:

 net-p2p/amule amuled -debug geoip gtk nls remote -stats unicode

As aMule needs unicode support or it won't compile, you might also want to add a line to enable unicode in x11-libs/wxGTK

 x11-libs/wxGTK unicode

12. Install aMule SVN:

 emerge amule

PLEASE do emerge amule -pv before installing to determine how you want to compile aMule.

13. As other programs can depend on wxGTK, it can be a good opportunity to update your system as usual. emerge --sync, and so on as explained into the handbook.

Possible crash

On my ~amd64 system, I get a crash at amule startup with recent libcrypto++ versions. To avoid it, mask it into /etc/portage/package.mask:

echo =dev-libs/crypto++-5.6.0 >> /etc/portage/package.mask
echo =dev-libs/crypto++-5.6.0-r1 >> /etc/portage/package.mask
echo dev-libs/crypto++-5.6.1 >> /etc/portage/package.mask
emerge -a crypto++ amule
revdep-rebuild

Revdep-rebuild didn't find anything into my system, but it is safer to run it anyway.

Another solution is to use the ebuild and the patch in bug 322713 for merging the last version of libcrypto++.

Update: It look like to be fixed. If it should append again with the same crypto++ version, please ask to reopen this bug.