AMule Project FAQ - User contributions [en]

Ban

2010-11-12T09:03:48Z

Marcell: English spelling fixes.

<center>
'''English''' | [[Ban-de|Deutsch]]
</center>

When a [[client]] is banned it means that no one is going to [[upload]] or [[download]] files to/from that client. In other words, a [[client]] which has been banned will be ignored by the other clients.

A [[client]] can be banned, because of [[leech|leeching]] or because it is of potential damage to the [[FAQ_eD2k-Kademlia|network]] or other [[client]]s, such as [[aggressive client]]s.

It is important to know the basic difference between a ban and [[leech|leeching]]. A banned [[client]] cannot upload nor download, while a [[leech|leecher]] doesn't [[upload]] but takes advantage of [[download|downloading]].

Development Information

2010-06-18T18:27:36Z

Marcell: Added content to "How to document the code" section.

== Introduction ==
This page was created to help new developers understand how aMule is implemented. Basically the best way to learn about aMule is to take a look at the code itself. This however takes quite some time and is difficult to begin with when you are new to the project and don't know about the components and their interactions. Read on to get some help on getting started improving the application. We wish you success!

aMule comes with different [[FAQ_utils|utilities]] and is therefore not the only part of the aMule project. This wiki page however focuses on the aMule client application only!

'''Note:''' This site is work in progress. It was started by Marcell, because he found aMule was lacking documentation for developers.

== The big picture ==
To get a first glimpse about aMule with a little insight into the boring details look at the [http://www.amule.org/aMule.dev.mmap.png aMule mind-map].

'''Note:''' This mind-map is based on the current knowledge of Marcell regarding the aMule client.

== Translations ==
Here is a helpful documentation how the gettext catalogs and portable object files work: [http://fplanque.net/Blog/devblog/2003/08/18/introducing_gettext_and_po_files click me!]
It is a must read if you want to know the idea behind the gettext translation system and how developers and translators interact by using the appropriate conventions.

=== Updating translations ===
Updating translations is done by checking translated text marked as fuzzy or by adding missing translations for text string. Check the [http://amule.sourceforge.net/translations/trunk/current_status.xml translation statistics] page to find out whether you can help completing the language of your choice. If the status of the specific language is below 100% it means that we need your help. Here is what you have to do to help the aMule project:

#Download the proper .po file for the language
#Add .old to the file name. Example:
#* ''mv hu.po hu.po.old''
#Open the file with a gettext catalog editor (e.g: poedit)
#Complete as much of the missing and fuzzy content as you can
#Save your changes into a new .po file (e.g: hu.po.new)
#Read the next section to find out how you can submit your changes

'''Note:''' For updating man pages and submitting the changes please read the wiki part related to [http://wiki.amule.org/index.php/Translating_Docs#Submitting_the_translation Translating the Documentation].

=== Submit the changes ===
Visit the [http://forum.amule.org/index.php?board=40.0 aMule forum translations board] and post a message in the proper topic of the language and attach the .po file to it. This step requires you to register to the aMule forum.
That's it. [http://wiki.amule.org/index.php/Soon Soon] a [[aMule_devs|developer]] will apply your changes and you can have good conscience having helped the aMule community.

=== Commit the changes ===
You have to be a developer for this, but devs need reminders too. :-)
#copy the hu.po to the po directory
#dos2unix hu.po
#make hu.po-update
#commit it

== Documented code ==
The source code of aMule is documented inline with Doxygen compatible comments. This enables the generation of linked HTML documentation using [http://www.stack.nl/~dimitri/doxygen Doxygen]. 
[http://members.chello.hu/balla.gyorgy/aMule/aMule-doxydoc.7z Here] you can find the newest compressed version of the aMule Doxygen documentation (based on SVN-10220). Download and uncompress it, open the index.html file and start browsing.

=== Intention ===
The intention of this HTML documentation is to give you a fast and complete insight into all the classes and methods that are part of the aMule source code. It lets you browse any part that you are interested in and read about what is available and how it is implemented. This is especially useful when:

# You are completely new to the aMule project
# You want to implement something and don't know where the right place for it is
# You would like to look at the source code in an interactive way without having to manually open dependent files and related sections

'''Note:''' The Doxygen documentation is not an official one and is provided by Marcell himself. Because of that it might be outdated and thus not reflect the most recent state of the code itself.

=== How to document the code ===
Documentation should go inside the header files. Methods and members have to be documented at least with a brief description of their purpose. In the implementation files standard C++ comments can be used to point out what is happening in the lines of code. Obeying these guidlines ensures a consistent style of documentation and a useful autogenerated developers manual.

In simple cases (e.g. where a method has no parameters and the use can be described in one sentence) it is enought to use basic (brief) description comments:
class CKnownFile
{
//! Returns the numbers of 9MB parts that are already hashed.
uint16 GetPartCount() const { return m_iPartCount; }
...
uint16 m_iPartCount; //! Number of parts the file is split into.
}

In those cases where a detailed description is necessary (e.g. when a method has different parameters or does some complicated job) a special doxygen syntax should be used:
class CKnownFile
{
...
/**
* Updates the requency of uploading parts from with the data the client provides.
*
* @param client The clients whoose uploading parts should be considered.
* @param increment If true, the counts are incremented, otherwise they are decremented.
* @return THIS LINE IS ONLY NECESSARY IF THE METHOD HAS A NON-VOID RETURN VALUE
*
* This functions updates the frequency list of file-upparts, using the clients
* upparts-status. This function should be called by clients every time they update their
* upparts-status, or when they are added or removed from the file.
*/
void UpdateUpPartsFrequency( CUpDownClient* client, bool increment );
...
}
If the method requires a detailed description but has no return value (void) then the @return marker can be omitted. In other cases of detailed comments the @return marker should describe the purpose of the value returned by the function. Visit the [http://www.stack.nl/~dimitri/doxygen/docblocks.html doxygen website] to find out more about the doxygen syntax of comments. But please only use the ones shown above.

== Subversion ==
Subversion (or in its short form: SVN) is the source versioning tool used to maintain the code of aMule. A very helpful e-book about its functionality can be found [http://svnbook.red-bean.com/ here]. This section sums up to most common commands you will make use of if you have access to the aMule SVN repository.

* <code>svn co [svn-url] [target-dir]</code>
: Initial checkout of the source tree
* <code>svn update</code>
: Update your local working copy to the latest shared revision
* <code>svn update -r [revision-num]</code>
: Update your local copy to the revision specified by [revision-num]
* <code>svn commit -m [brief-msg]</code>
: Write the changes you made to the shared repository
* <code>svn revert</code>
: Undo all the changes you made to your local working copy
* <code>svn status</code>
: Show a status of changed files in your local copy
* <code>svn diff</code>
: Show the exact differences made to files in your local copy
* <code>svn log</code>
: Show a list of messages for each available revision number

Durring the commitment of changes you have to keep an eye out for resolving conflicts regarding changes made to the same file by different users. Before applying your changes to the shared repository, always update the local working copy first.

Development Information

2010-06-18T18:02:00Z

Marcell: New doxygen documentation is based on SVN 10220.

== Introduction ==
This page was created to help new developers understand how aMule is implemented. Basically the best way to learn about aMule is to take a look at the code itself. This however takes quite some time and is difficult to begin with when you are new to the project and don't know about the components and their interactions. Read on to get some help on getting started improving the application. We wish you success!

aMule comes with different [[FAQ_utils|utilities]] and is therefore not the only part of the aMule project. This wiki page however focuses on the aMule client application only!

'''Note:''' This site is work in progress. It was started by Marcell, because he found aMule was lacking documentation for developers.

== The big picture ==
To get a first glimpse about aMule with a little insight into the boring details look at the [http://www.amule.org/aMule.dev.mmap.png aMule mind-map].

'''Note:''' This mind-map is based on the current knowledge of Marcell regarding the aMule client.

== Translations ==
Here is a helpful documentation how the gettext catalogs and portable object files work: [http://fplanque.net/Blog/devblog/2003/08/18/introducing_gettext_and_po_files click me!]
It is a must read if you want to know the idea behind the gettext translation system and how developers and translators interact by using the appropriate conventions.

=== Updating translations ===
Updating translations is done by checking translated text marked as fuzzy or by adding missing translations for text string. Check the [http://amule.sourceforge.net/translations/trunk/current_status.xml translation statistics] page to find out whether you can help completing the language of your choice. If the status of the specific language is below 100% it means that we need your help. Here is what you have to do to help the aMule project:

#Download the proper .po file for the language
#Add .old to the file name. Example:
#* ''mv hu.po hu.po.old''
#Open the file with a gettext catalog editor (e.g: poedit)
#Complete as much of the missing and fuzzy content as you can
#Save your changes into a new .po file (e.g: hu.po.new)
#Read the next section to find out how you can submit your changes

'''Note:''' For updating man pages and submitting the changes please read the wiki part related to [http://wiki.amule.org/index.php/Translating_Docs#Submitting_the_translation Translating the Documentation].

=== Submit the changes ===
Visit the [http://forum.amule.org/index.php?board=40.0 aMule forum translations board] and post a message in the proper topic of the language and attach the .po file to it. This step requires you to register to the aMule forum.
That's it. [http://wiki.amule.org/index.php/Soon Soon] a [[aMule_devs|developer]] will apply your changes and you can have good conscience having helped the aMule community.

=== Commit the changes ===
You have to be a developer for this, but devs need reminders too. :-)
#copy the hu.po to the po directory
#dos2unix hu.po
#make hu.po-update
#commit it

== Documented code ==
The source code of aMule is documented inline with Doxygen compatible comments. This enables the generation of linked HTML documentation using [http://www.stack.nl/~dimitri/doxygen Doxygen]. 
[http://members.chello.hu/balla.gyorgy/aMule/aMule-doxydoc.7z Here] you can find the newest compressed version of the aMule Doxygen documentation (based on SVN-10220). Download and uncompress it, open the index.html file and start browsing.

=== Intention ===
The intention of this HTML documentation is to give you a fast and complete insight into all the classes and methods that are part of the aMule source code. It lets you browse any part that you are interested in and read about what is available and how it is implemented. This is especially useful when:

# You are completely new to the aMule project
# You want to implement something and don't know where the right place for it is
# You would like to look at the source code in an interactive way without having to manually open dependent files and related sections

'''Note:''' The Doxygen documentation is not an official one and is provided by Marcell himself. Because of that it might be outdated and thus not reflect the most recent state of the code itself.

=== How to document the code ===
Brief description about how Doxygen documentation is done inside the code.

== Subversion ==
Subversion (or in its short form: SVN) is the source versioning tool used to maintain the code of aMule. A very helpful e-book about its functionality can be found [http://svnbook.red-bean.com/ here]. This section sums up to most common commands you will make use of if you have access to the aMule SVN repository.

* <code>svn co [svn-url] [target-dir]</code>
: Initial checkout of the source tree
* <code>svn update</code>
: Update your local working copy to the latest shared revision
* <code>svn update -r [revision-num]</code>
: Update your local copy to the revision specified by [revision-num]
* <code>svn commit -m [brief-msg]</code>
: Write the changes you made to the shared repository
* <code>svn revert</code>
: Undo all the changes you made to your local working copy
* <code>svn status</code>
: Show a status of changed files in your local copy
* <code>svn diff</code>
: Show the exact differences made to files in your local copy
* <code>svn log</code>
: Show a list of messages for each available revision number

Durring the commitment of changes you have to keep an eye out for resolving conflicts regarding changes made to the same file by different users. Before applying your changes to the shared repository, always update the local working copy first.

Development Information

2010-02-01T20:37:39Z

Marcell: Fixed numbering of the SVN chapter.

== Introduction ==
This page was created to help new developers understand how aMule is implemented. Basically the best way to learn about aMule is to take a look at the code itself. This however takes quite some time and is difficult to begin with when you are new to the project and don't know about the components and their interactions. Read on to get some help on getting started improving the application. We wish you success!

aMule comes with different [[FAQ_utils|utilities]] and is therefore not the only part of the aMule project. This wiki page however focuses on the aMule client application only!

'''Note:''' This site is work in progress. It was started by Marcell, because he found aMule was lacking documentation for developers.

== The big picture ==
To get a first glimpse about aMule with a little insight into the boring details look at the [http://www.amule.org/aMule.dev.mmap.png aMule mind-map].

'''Note:''' This mind-map is based on the current knowledge of Marcell regarding the aMule client.

== Translations ==
Here is a helpful documentation how the gettext catalogs and portable object files work: [http://fplanque.net/Blog/devblog/2003/08/18/introducing_gettext_and_po_files click me!]
It is a must read if you want to know the idea behind the gettext translation system and how developers and translators interact by using the appropriate conventions.

=== Updating translations ===
Updating translations is done by checking translated text marked as fuzzy or by adding missing translations for text string. Check the [http://amule.sourceforge.net/translations/trunk/current_status.xml translation statistics] page to find out whether you can help completing the language of your choice. If the status of the specific language is below 100% it means that we need your help. Here is what you have to do to help the aMule project:

#Download the proper .po file for the language
#Add .old to the file name. Example:
#* ''mv hu.po hu.po.old''
#Open the file with a gettext catalog editor (e.g: poedit)
#Complete as much of the missing and fuzzy content as you can
#Save your changes into a new .po file (e.g: hu.po.new)
#Read the next section to find out how you can submit your changes

'''Note:''' For updating man pages and submitting the changes please read the wiki part related to [http://wiki.amule.org/index.php/Translating_Docs#Submitting_the_translation Translating the Documentation].

=== Submit the changes ===
Visit the [http://forum.amule.org/index.php?board=40.0 aMule forum translations board] and post a message in the proper topic of the language and attach the .po file to it. This step requires you to register to the aMule forum.
That's it. [http://wiki.amule.org/index.php/Soon Soon] a [[aMule_devs|developer]] will apply your changes and you can have good conscience having helped the aMule community.

=== Commit the changes ===
You have to be a developer for this, but devs need reminders too. :-)
#copy the hu.po to the po directory
#dos2unix hu.po
#make hu.po-update
#commit it

== Documented code ==
The source code of aMule is documented inline with Doxygen compatible comments. This enables the generation of linked HTML documentation using [http://www.stack.nl/~dimitri/doxygen Doxygen]. 
[http://members.chello.hu/balla.gyorgy/aMule/aMule-doxydoc.7z Here] you can find the newest compressed version of the aMule Doxygen documentation (based on SVN-9866). Download and uncompress it, open the index.html file and start browsing.

=== Intention ===
The intention of this HTML documentation is to give you a fast and complete insight into all the classes and methods that are part of the aMule source code. It lets you browse any part that you are interested in and read about what is available and how it is implemented. This is especially useful when:

# You are completely new to the aMule project
# You want to implement something and don't know where the right place for it is
# You would like to look at the source code in an interactive way without having to manually open dependent files and related sections

'''Note:''' The Doxygen documentation is not an official one and is provided by Marcell himself. Because of that it might be outdated and thus not reflect the most recent state of the code itself.

=== How to document the code ===
Brief description about how Doxygen documentation is done inside the code.

== Subversion ==
Subversion (or in its short form: SVN) is the source versioning tool used to maintain the code of aMule. A very helpful e-book about its functionality can be found [http://svnbook.red-bean.com/ here]. This section sums up to most common commands you will make use of if you have access to the aMule SVN repository.

* <code>svn co [svn-url] [target-dir]</code>
: Initial checkout of the source tree
* <code>svn update</code>
: Update your local working copy to the latest shared revision
* <code>svn update -r [revision-num]</code>
: Update your local copy to the revision specified by [revision-num]
* <code>svn commit -m [brief-msg]</code>
: Write the changes you made to the shared repository
* <code>svn revert [brief-msg]</code>
: Undo all the changes you made to your local working copy
* <code>svn status</code>
: Show a status of changed files in your local copy
* <code>svn diff</code>
: Show the exact differences made to files in your local copy
* <code>svn log</code>
: Show a list of messages for each available revision number

Durring the commitment of changes you have to keep an eye out for resolving conflicts regarding changes made to the same file by different users. Before applying your changes to the shared repository, always update the local working copy first.

Development Information

2010-02-01T20:37:13Z

Marcell: Added short introduction to SVN.

== Introduction ==
This page was created to help new developers understand how aMule is implemented. Basically the best way to learn about aMule is to take a look at the code itself. This however takes quite some time and is difficult to begin with when you are new to the project and don't know about the components and their interactions. Read on to get some help on getting started improving the application. We wish you success!

aMule comes with different [[FAQ_utils|utilities]] and is therefore not the only part of the aMule project. This wiki page however focuses on the aMule client application only!

'''Note:''' This site is work in progress. It was started by Marcell, because he found aMule was lacking documentation for developers.

== The big picture ==
To get a first glimpse about aMule with a little insight into the boring details look at the [http://www.amule.org/aMule.dev.mmap.png aMule mind-map].

'''Note:''' This mind-map is based on the current knowledge of Marcell regarding the aMule client.

== Translations ==
Here is a helpful documentation how the gettext catalogs and portable object files work: [http://fplanque.net/Blog/devblog/2003/08/18/introducing_gettext_and_po_files click me!]
It is a must read if you want to know the idea behind the gettext translation system and how developers and translators interact by using the appropriate conventions.

=== Updating translations ===
Updating translations is done by checking translated text marked as fuzzy or by adding missing translations for text string. Check the [http://amule.sourceforge.net/translations/trunk/current_status.xml translation statistics] page to find out whether you can help completing the language of your choice. If the status of the specific language is below 100% it means that we need your help. Here is what you have to do to help the aMule project:

#Download the proper .po file for the language
#Add .old to the file name. Example:
#* ''mv hu.po hu.po.old''
#Open the file with a gettext catalog editor (e.g: poedit)
#Complete as much of the missing and fuzzy content as you can
#Save your changes into a new .po file (e.g: hu.po.new)
#Read the next section to find out how you can submit your changes

'''Note:''' For updating man pages and submitting the changes please read the wiki part related to [http://wiki.amule.org/index.php/Translating_Docs#Submitting_the_translation Translating the Documentation].

=== Submit the changes ===
Visit the [http://forum.amule.org/index.php?board=40.0 aMule forum translations board] and post a message in the proper topic of the language and attach the .po file to it. This step requires you to register to the aMule forum.
That's it. [http://wiki.amule.org/index.php/Soon Soon] a [[aMule_devs|developer]] will apply your changes and you can have good conscience having helped the aMule community.

=== Commit the changes ===
You have to be a developer for this, but devs need reminders too. :-)
#copy the hu.po to the po directory
#dos2unix hu.po
#make hu.po-update
#commit it

== Documented code ==
The source code of aMule is documented inline with Doxygen compatible comments. This enables the generation of linked HTML documentation using [http://www.stack.nl/~dimitri/doxygen Doxygen]. 
[http://members.chello.hu/balla.gyorgy/aMule/aMule-doxydoc.7z Here] you can find the newest compressed version of the aMule Doxygen documentation (based on SVN-9866). Download and uncompress it, open the index.html file and start browsing.

=== Intention ===
The intention of this HTML documentation is to give you a fast and complete insight into all the classes and methods that are part of the aMule source code. It lets you browse any part that you are interested in and read about what is available and how it is implemented. This is especially useful when:

# You are completely new to the aMule project
# You want to implement something and don't know where the right place for it is
# You would like to look at the source code in an interactive way without having to manually open dependent files and related sections

'''Note:''' The Doxygen documentation is not an official one and is provided by Marcell himself. Because of that it might be outdated and thus not reflect the most recent state of the code itself.

=== How to document the code ===
Brief description about how Doxygen documentation is done inside the code.

=== Subversion ===
Subversion (or in its short form: SVN) is the source versioning tool used to maintain the code of aMule. A very helpful e-book about its functionality can be found [http://svnbook.red-bean.com/ here]. This section sums up to most common commands you will make use of if you have access to the aMule SVN repository.

* <code>svn co [svn-url] [target-dir]</code>
: Initial checkout of the source tree
* <code>svn update</code>
: Update your local working copy to the latest shared revision
* <code>svn update -r [revision-num]</code>
: Update your local copy to the revision specified by [revision-num]
* <code>svn commit -m [brief-msg]</code>
: Write the changes you made to the shared repository
* <code>svn revert [brief-msg]</code>
: Undo all the changes you made to your local working copy
* <code>svn status</code>
: Show a status of changed files in your local copy
* <code>svn diff</code>
: Show the exact differences made to files in your local copy
* <code>svn log</code>
: Show a list of messages for each available revision number

Durring the commitment of changes you have to keep an eye out for resolving conflicts regarding changes made to the same file by different users. Before applying your changes to the shared repository, always update the local working copy first.

Development Information

2010-02-01T20:21:52Z

Marcell: Added a note referring to updating man pages.

Known.met file

2010-01-01T22:01:18Z

Marcell: Created the page. Don't know what "tags" are yet.

== File ==

'''Name:''' ''known.met''

'''Location:'''
* Unix: ''~/.aMule''
* Windows: ''C:\Documents and Settings\username\Application Data\aMule''
* Mac: ''~/Library/Application Support/aMule''

== Description ==

This file stores the hashes and some details (name, size, date, priority, notes) of your shared files. This avoids the need to recalculate their hashes, which can take some time for large (think of Gigabytes) files.

== Format ==

One variable length binary block for each file. The length of a block depends on the number of available tags for the file.

== Example ==

None, because of the file format being binary.

== Notes ==

This file gets updated each time a hashing has taken place. It is also update when aMule is shutting down.

Development Information

2009-11-09T18:48:45Z

Marcell: Updated file info about Doxygen archive

Development Information

2009-11-09T18:37:13Z

Marcell: Extended the "Documented code" section

Development Information

2009-10-09T20:21:37Z

Marcell: Added information on creating and submitting translations.

Development Information

2009-10-01T14:03:08Z

Marcell: Added link to aMule mind-map.

Development Information

2009-09-13T19:22:13Z

Marcell: Created page with '== Introduction == This page was created to help new developers understand how aMule is implemented. Basically the best way to learn about aMule is to take a look at the code its…'

Compilation Installation

2009-06-13T15:12:07Z

Marcell: Changed one appearance of wxGTK to wxWidgets, which was missed before.

<center>
[[Compilation_Installation|English]] |
[[Compilation_Installation-de|Deutsch]] |
[[Compilation_Installation-es|Español]] |
[[Compilation_Installation-fr|Français]] |
[[Compilation_Installation-it|Italiano]] |
[[Compilation_Installation-nl|Nederlands]] |
[[Compilation_Installation-pl|Polish]] |
[[Compilation_Installation-br|Português]] |
[[Compilation_Installation-ru|Russian]]
</center>

== Compiling from Sources ==
'''WARNING:''' Make sure you have '''no''' copies of [[wxWidgets]] installed. If you already have [[wxWidgets]] installed, check [[How to uninstall wxWidgets]] before starting a new installation. If you continue have problems, then [[Check_if_wx_is_installed_twice|check if wx is installed twice]], since that's a common compilation and runtime problem.

There are different versions of the wxWidgets for different platforms. wxGTK is used for Linux, Solaris and BSD, wxMSW for Windows and wxMac for Mac OS X. Here we'll explain the compilation using wxGTK, but it differs only slightly for other toolkits.

Please see the specific articles for more detailed instructions.
*[[HowTo_compile_on_Mac|Compile aMule on Mac]]
*[[HowTo compile on Win32|Compile aMule on Windows]]

=== Step 1: [[wxWidgets]] ===
*Download [[wxWidgets]]: [http://prdownloads.sourceforge.net/wxwindows/wxWidgets-2.8.10.tar.gz wxWidgets-2.8.10.tar.gz]

*Compile [[wxWidgets]]
**''tar -jxvf wxWidgets-2.8.10.tar.gz''
**''cd wxWidgets-2.8.10''
**''Linked against [http://www.gtk.org GTK]2: ./configure --enable-unicode --enable-optimise
**''make''

*As '''root''' (in some distributions simply use "sudo" before):
**''make install''
**''ldconfig''

==== Disable the GUI ====
*To compile wxWidgets without a graphical User Interface, ''use the option --disable-gui''

=== Step 2: [[aMule]] ===
*Download the latest [[aMule SVN|source tarball]]: [http://www.hirnriss.net/?area=cvs Download aMule]

*Compile [[aMule]] (please check the [[configure|configure article]]) ->
**''tar -zxvf aMule-X.X.X.tar.gz'' (replace X with the right version number..)
**''cd aMule-X.X.X''
**''./configure --disable-debug --enable-optimize''
**''make''

*As '''root''' (in some distributions simply use "sudo" before):
**''make install''

*Run [[aMule]] as a regular user from console by typing ''amule'', or run [[aMule]] through a link from the proper application menu of your operating system

Compilation Installation

2009-06-13T15:11:04Z

Marcell: Changed numbering to proper value: 2. Minor restructuring of content.

<center>
[[Compilation_Installation|English]] |
[[Compilation_Installation-de|Deutsch]] |
[[Compilation_Installation-es|Español]] |
[[Compilation_Installation-fr|Français]] |
[[Compilation_Installation-it|Italiano]] |
[[Compilation_Installation-nl|Nederlands]] |
[[Compilation_Installation-pl|Polish]] |
[[Compilation_Installation-br|Português]] |
[[Compilation_Installation-ru|Russian]]
</center>

== Compiling from Sources ==
'''WARNING:''' Make sure you have '''no''' copies of [[wxWidgets]] installed. If you already have [[wxWidgets]] installed, check [[How to uninstall wxWidgets]] before starting a new installation. If you continue have problems, then [[Check_if_wx_is_installed_twice|check if wx is installed twice]], since that's a common compilation and runtime problem.

There are different versions of the wxWidgets for different platforms. wxGTK is used for Linux, Solaris and BSD, wxMSW for Windows and wxMac for Mac OS X. Here we'll explain the compilation using wxGTK, but it differs only slightly for other toolkits.

Please see the specific articles for more detailed instructions.
*[[HowTo_compile_on_Mac|Compile aMule on Mac]]
*[[HowTo compile on Win32|Compile aMule on Windows]]

=== Step 1: [[wxWidgets]] ===
*Download [[wxWidgets]]: [http://prdownloads.sourceforge.net/wxwindows/wxWidgets-2.8.10.tar.gz wxWidgets-2.8.10.tar.gz]

*Compile [[wxWidgets|wxGTK]]
**''tar -jxvf wxWidgets-2.8.10.tar.gz''
**''cd wxWidgets-2.8.10''
**''Linked against [http://www.gtk.org GTK]2: ./configure --enable-unicode --enable-optimise
**''make''

*As '''root''' (in some distributions simply use "sudo" before):
**''make install''
**''ldconfig''

==== Disable the GUI ====
*To compile wxWidgets without a graphical User Interface, ''use the option --disable-gui''

=== Step 2: [[aMule]] ===
*Download the latest [[aMule SVN|source tarball]]: [http://www.hirnriss.net/?area=cvs Download aMule]

*Compile [[aMule]] (please check the [[configure|configure article]]) ->
**''tar -zxvf aMule-X.X.X.tar.gz'' (replace X with the right version number..)
**''cd aMule-X.X.X''
**''./configure --disable-debug --enable-optimize''
**''make''

*As '''root''' (in some distributions simply use "sudo" before):
**''make install''

*Run [[aMule]] as a regular user from console by typing ''amule'', or run [[aMule]] through a link from the proper application menu of your operating system

Compilation Installation

2009-06-13T15:07:43Z

Marcell: Updated wxWidgets installation to version 2.8.10. Minor restructuring of content.

<center>
[[Compilation_Installation|English]] |
[[Compilation_Installation-de|Deutsch]] |
[[Compilation_Installation-es|Español]] |
[[Compilation_Installation-fr|Français]] |
[[Compilation_Installation-it|Italiano]] |
[[Compilation_Installation-nl|Nederlands]] |
[[Compilation_Installation-pl|Polish]] |
[[Compilation_Installation-br|Português]] |
[[Compilation_Installation-ru|Russian]]
</center>

== Compiling from Sources ==
'''WARNING:''' Make sure you have '''no''' copies of [[wxWidgets]] installed. If you already have [[wxWidgets]] installed, check [[How to uninstall wxWidgets]] before starting a new installation. If you continue have problems, then [[Check_if_wx_is_installed_twice|check if wx is installed twice]], since that's a common compilation and runtime problem.

There are different versions of the wxWidgets for different platforms. wxGTK is used for Linux, Solaris and BSD, wxMSW for Windows and wxMac for Mac OS X. Here we'll explain the compilation using wxGTK, but it differs only slightly for other toolkits.

Please see the specific articles for more detailed instructions.
*[[HowTo_compile_on_Mac|Compile aMule on Mac]]
*[[HowTo compile on Win32|Compile aMule on Windows]]

=== Step 1: [[wxWidgets]] ===
*Download [[wxWidgets]]: [http://prdownloads.sourceforge.net/wxwindows/wxWidgets-2.8.10.tar.gz wxWidgets-2.8.10.tar.gz]

*Compile [[wxWidgets|wxGTK]]
**''tar -jxvf wxWidgets-2.8.10.tar.gz''
**''cd wxWidgets-2.8.10''
**''Linked against [http://www.gtk.org GTK]2: ./configure --enable-unicode --enable-optimise
**''make''

*As '''root''' (in some distributions simply use "sudo" before):
**''make install''
**''ldconfig''

==== Disable the GUI ====
*To compile wxWidgets without a graphical User Interface, ''use the option --disable-gui''

=== Step 3: [[aMule]] ===
*Download the latest [[aMule SVN|source tarball]] -> [http://www.hirnriss.net/?area=cvs Download aMule]

*Compile [[aMule]] (please check the [[configure|configure article]]) ->
**''tar -zxvf aMule-X.X.X.tar.gz'' (replace X with the right version number..)
**''cd aMule-X.X.X''
**''./configure --disable-debug --enable-optimize && make''

*As '''root''':
**''make install''

*Run [[aMule]] as a regular user from console by typing -> ''amule''

Nodes.dat file

2009-05-26T19:33:59Z

Marcell: Cleaned the wiki code and improved the python script to view the nodes.dat content.

<center>
'''English''' | [[Nodes.dat_file-de|Deutsch]]
</center>

== File ==
'''Name:''' ''nodes.dat''

'''Location:''' ''~/.aMule/''

== Description ==
This file stores details about known [[Kademlia]] [[client]]s (also known as Kad [[node]]s).

It is used to [[bootstrap]] the Kad network when aMule starts.

== Format (version 0) ==
This format was used for aMule up to 2.1.3 , and it is no more used

All fields are stored without any separator character. This is done like this because all the fields have a specific size:
*''Number of contacts'': Number of contacts that will be listed (4 bytes)

After specifying the number of contacts that will be listed, the file lists them. Each contact takes 25 bytes, splitted into the following fields:
*''ClientID'': The contact's [[ID|ClientID]] (16 bytes)
*''IP'': The contact's [[IP address|IP]] (4 bytes)
*''UDP Port'': The [http://www.ietf.org/rfc/rfc768.txt UDP] [[port]] to [[connect]] to when trying to reach the contact (2 bytes)
*''TCP Port'': The [http://www.ietf.org/rfc/rfc793.txt TCP] [[port]] to [[connect]] to when trying to reach the contact (2 bytes)
*''Type'': This indicates the [[type]] of the contact, which is how much you can be confident on that contact (a scale from ''0'' to ''4'', being ''0'' the best and ''4'' the worst). (1 byte)

Once this data is put together, it is stored in little-endian.

=== Example of nodes.dat version 0 file ===
The following is a hex dump of an hypothetic ''nodes.dat'' file:

''0200000012257425DBA4EDDBD097150757404486E55E04DE40123612021F64632587A31EC2FC8566C4A9BAB184E6E9B7D44012361202''

In the above example, the following data can be seen:

*Number of contacts: ''2'' (In hex: ''02000000'', remember it's in [[little endian]])
*Contact #1:
**ClientID: ''12257425DBA4EDDBD097150757404486''
**IP: ''222.4.94.229'' (In hex: ''E55E04DE'', remember it's in [[little endian]])
**[http://www.ietf.org/rfc/rfc768.txt UDP] Port: ''1240'' (In hex: ''4012'', remember it's in [[little endian]])
**[http://www.ietf.org/rfc/rfc793.txt TCP] Port: ''1236'' (In hex: ''3612'', remember it's in [[little endian]])
**Type: ''2'' (In hex: ''02'')
*Contact #2:
**ClientID: ''1F64632587A31EC2FC8566C4A9BAB184''
**IP: ''212.183.233.230'' (In hex: ''E6E9B7D4'', remember it's in [[little endian]])
**[http://www.ietf.org/rfc/rfc768.txt UDP] Port: ''1240'' (In hex: ''4012'', remember it's in [[little endian]])
**[http://www.ietf.org/rfc/rfc793.txt TCP] Port: ''1236'' (In hex: ''3612'', remember it's in [[little endian]])
**Type: ''2'' (In hex: ''02'')

== Format (version 2) ==
This format is used in aMule version 2.2.0 and later.

Here again, all fields are stored without any separator character. This is done like this because all the fields have a specific size.

The file begins with 4 bytes storing the null value (hex 0x00000000)
Then follows the fields:

*''Version number'': value 2 stored in little endian (0x02000000 , 4 bytes)
*''Number of contacts'': Number of contacts that will be listed (4 bytes)
After specifying the number of contacts that will be listed, the file lists them.
Each contact takes 34 bytes, splitted into the following fields:
*''ClientID'' (16 bytes): The contact's [[ID|ClientID]]
*''IP'' (4 bytes): The contact's [[IP address|IP]]
*''UDP Port'' (2 bytes): The [http://www.ietf.org/rfc/rfc768.txt UDP] [[port]] to [[connect]] to when trying to reach the contact
*''TCP Port'' (2 bytes): The [http://www.ietf.org/rfc/rfc793.txt TCP] [[port]] to [[connect]] to when trying to reach the contact
*''Version'' (1 byte): Kademlia protocol version. '0' means a Kad v1 node, any value > 0 means a Kad v2 node and determines what kind of packets can be sent to a node, what features it supports, etc.
*''KadUDPKey'' (8 bytes): In Kad v2, Sender's 32-bit key (node version >5), bound to the receiver (local) IP . It is used in encrypted communication to verify node validity.
*''Verified'': (1 byte) Any value different from 0 states the contact has been verified.

Once this data is put together, it is stored in little-endian.

== Extra ==
Since the ''number of contacts'' field is 4 bytes long, the maximum number of [[node]]s you could store in this file is 4294967296 (~4300M), which should be far enough. Anyway, since this number is so big, [[aMule]], [[eMule]] and all clients have hard limitted the amount of contacts that can be stored ([[aMule]]'s hard limit is ''5000'').

Since ''Type 4'' contacts are those which are marked for deletion, there should never be any ''Type 4'' contact in the ''nodes.dat'' file. If there was, it would just be ignored when reading the file.

== Script for dumping nodes.dat ==
Here's a python script which can be used for dumping contents of the nodes.dat v0 and v2 files:
<pre>
#!/usr/bin/env python
# this code belongs to public domain

import struct
import sys

version = 0
count = 0

# check number of command line arguments
if len(sys.argv) != 2:
sys.exit("Please supply a nodes.dat file!")

nodefile = open(sys.argv[1], 'r')
(count,) = struct.unpack("<I", nodefile.read(4))
if (count == 0) : (version,) = struct.unpack("<I", nodefile.read(4))
if (version >= 1) : (count,) = struct.unpack("<I", nodefile.read(4))
if (version >= 0 & version < 3) :
print 'Nodes.dat file version = %d' %(version)
print 'Node count = %d' %(count)
print ' '
if (version == 0):
print ' idx type IP address udp tcp'
else :
print ' idx Ver IP address udp tcp kadUDPKey verified'

for i in xrange(count):
if (version == 0):
(clientid, ip1, ip2, ip3, ip4, udpport, tcpport, type) = \
struct.unpack("<16s4BHHB", nodefile.read(25))
ipaddr = '%d.%d.%d.%d' % (ip1, ip2, ip3, ip4)
print '%4d %4d %-15s %5d %5d' % (i, type, ipaddr, udpport, tcpport)
else :
(clientid, ip1, ip2, ip3, ip4, udpport, tcpport, type, kadUDPkey, verified) = \
struct.unpack("<16s4BHHBQB", nodefile.read(34))
ipaddr = '%d.%d.%d.%d' % (ip1, ip2, ip3, ip4)
VV = 'Y'
if (verified == 0): VV='N'
print '%4d %3d %-15s %5d %5d %16x %s' % (i, type, ipaddr, udpport, tcpport, kadUDPkey,VV)

else :
print 'Cannot handle nodes.dat version %d !' (version)

nodefile.close()
</pre>

Using gdb and valgrind

2009-05-11T19:31:13Z

Marcell: valgrind options updated and suppression explanation clearified

The two programs, [http://www.gnu.org/software/gdb/gdb.html gdb] and [http://valgrind.kde.org valgrind], are fabulous tools to find errors in your code. The standard gnu debugger is [http://www.gnu.org/software/gdb/gdb.html gdb], very powerfull, virtually every debugger in [http://www.gnu.org GNU] is [http://www.gnu.org/software/gdb/gdb.html gdb]-based. So, you need to learn some [http://www.gnu.org/software/gdb/gdb.html gdb]. Another invaluable tool is [http://valgrind.kde.org valgrind]. It allows you to track memory usage, stopping the program whenever an invalid operation has been made.

Both [http://valgrind.kde.org valgrind] and [http://www.gnu.org/software/gdb/gdb.html gdb] can be used together, so that you can actually debug the program that is beeing analysed. This is possible due to a [http://www.gnu.org/software/gdb/gdb.html gdb] feature that makes it possible to attach any running process to a [http://www.gnu.org/software/gdb/gdb.html gdb] session.

The first step is to setup '''valgrind''', but first, some interesting links about [http://valgrind.kde.org valgrind]:

* Home page: http://valgrind.org/
* Documentation: http://developer.kde.org/~sewardj/docs-2.0.0/manual.html
* How To: http://www.tldp.org/HOWTO/Valgrind-HOWTO/
* FAQ: http://valgrind.org/docs/manual/faq.html

== Running [http://valgrind.kde.org valgrind] ==
----

I personaly use the following call:

<code>valgrind -v --tool=memcheck --leak-check=yes --num-callers=10 --suppressions=amule.sup --gen-suppressions=yes ~/programs/amule/amule-dev-cvs/src/amule --enable-stdin</code>

This way, leak-check is enabled, and whenever a problem is detected, the user will be prompted for whether he wants to start [http://www.gnu.org/software/gdb/gdb.html gdb] at the current position. This is a great moment to see the beast exactly at the moment of falilure. The parameter ''--num-callers'', which defaults to 4, is the number of backtrace lines that [http://valgrind.kde.org valgrind] shows you, 4 is too little.

Finally, there is ''--gen-suppressions'' and ''--suppressions''. Suppressions are a way that [http://valgrind.kde.org valgrind] provides us so that we don't have to see '''every''' single problem that the program has. Eventually, other libraries your program is using, like X itself, will show memory usage problems, and [http://valgrind.kde.org valgrind] will show them. So, on the first few runs of [http://valgrind.kde.org valgrind], we will have to build a suppression file, which is specified by ''--suppressions='' and we tell [http://valgrind.kde.org valgrind] to generate suppressions on screen. ''--gen-suppressions=yes'' will do this. Suppressions are a few lines that you may copy/paste in the suppressions file, all you have to do is give each suppression a name and that's it. So first run [http://valgrind.kde.org valgrind] with the ''--gensuppressions=yes'' option and copy the output to the desired file. On the next run add the ''--suppressions='' option instead.

When set up that way, each time [http://valgrind.kde.org valgrind] finds something wrong, it will show you a few lines describing the problem and then it will ask you if you want it to generate the suppressions. If you say yes, the suppression appears on the screen, and you can copy/paste it in the suppressions file, so that next time you run valgring this error is not reported.

Now, after prompting the user for printing the suppression, [http://valgrind.kde.org valgrind] will prompt the user again whether or not he should start [http://www.gnu.org/software/gdb/gdb.html gdb]. If you say accept, [http://www.gnu.org/software/gdb/gdb.html gdb] will attach the running process and you will be debugging the program exactly at the point of the invalid operation.

== A few [http://www.gnu.org/software/gdb/gdb.html gdb] useful commands ==
----
;'''''bt''''': backtrace, shows the stack frames (subroutine calls) that lead to the position you are now in code.
;'''''bt full''''': shows every frame with the values of the local variables, usually too much verbose, only do this if you want to send the output to another person to analyse.
;'''''up/down number''''': e.g.: ''up 5'': goes up 5 stack frames. By default, whenever you enter [http://www.gnu.org/software/gdb/gdb.html gdb], you will be placed in frame number 0. '''With the aid of the source code of the program''' you should be able to select the subroutine where you want to inspect the variables.
;'''''frame number''''': goes straight to the selected frame.
;'''''info locals''''': prints the value of all local variables belonging to the current frame.
;'''''p variable''''': e.g.: ''p *cur_src''. Prints the named variable. Usually C like syntax will be allowed here.
;'''''l''''': prints 10 lines of source code around the current line. A separate editor for source browsing is usualy better, but this can be a quick way to see the code.
;'''''help/help command''''': Do I need to explain that? :)

There are other commands, but usualy these described will suffice. It's worth mentioning that [http://www.gnu.org/software/gdb/gdb.html gdb] can be run with the core file, i.e., that big file that is produced after a crash. To do that, type

''gdb '''program_path''' '''core_file_path'''''

Also there are GUI front ends to [http://www.gnu.org/software/gdb/gdb.html gdb] that make it a little bit more friendly (like [http://kgdb.sourceforge.net kdbg]). GUI front ends are great to inspect several different variables by clicking with the mouse. But learning to use [http://www.gnu.org/software/gdb/gdb.html gdb] from the console is by far the fastest way to do the job, not to mention that you can do it '''quickly''' in a remote terminal session.

Also note that practice makes it perfect, so the only way to realy learn how to do this is by doing it. You will see that you will quickly learn how to move around [http://www.gnu.org/software/gdb/gdb.html gdb], in spite of its daunting console interface. Soon it will become your friend. :)

'''NOTE:''' [[aMule]] is a '''separate''' project from [http://www.gnu.org/software/gdb/gdb.html gdb], [http://valgrind.kde.org valgrind] or any other project refered in this text, and is '''not''' related to any of them.

Using gdb and valgrind

2009-05-11T19:11:48Z

Marcell:

The two programs, [http://www.gnu.org/software/gdb/gdb.html gdb] and [http://valgrind.kde.org valgrind], are fabulous tools to find errors in your code. The standard gnu debugger is [http://www.gnu.org/software/gdb/gdb.html gdb], very powerfull, virtually every debugger in [http://www.gnu.org GNU] is [http://www.gnu.org/software/gdb/gdb.html gdb]-based. So, you need to learn some [http://www.gnu.org/software/gdb/gdb.html gdb]. Another invaluable tool is [http://valgrind.kde.org valgrind]. It allows you to track memory usage, stopping the program whenever an invalid operation has been made.

Both [http://valgrind.kde.org valgrind] and [http://www.gnu.org/software/gdb/gdb.html gdb] can be used together, so that you can actually debug the program that is beeing analysed. This is possible due to a [http://www.gnu.org/software/gdb/gdb.html gdb] feature that makes it possible to attach any running process to a [http://www.gnu.org/software/gdb/gdb.html gdb] session.

The first step is to setup '''valgrind''', but first, some interesting links about [http://valgrind.kde.org valgrind]:

* Home page: http://valgrind.org/
* Documentation: http://developer.kde.org/~sewardj/docs-2.0.0/manual.html
* How To: http://www.tldp.org/HOWTO/Valgrind-HOWTO/
* FAQ: http://valgrind.org/docs/manual/faq.html

== Running [http://valgrind.kde.org valgrind] ==
----

I personaly use the following call:

<code>valgrind -v --tool=memcheck --leak-check=yes --gdb-attach=yes --num-callers=10 --suppressions=amule.sup --gen-suppressions=yes ~/programs/amule/amule-dev-cvs/src/amule --enable-stdin</code>

This way, leak-check is enabled, and whenever a problem is detected, the user will be prompted for whether he wants to start [http://www.gnu.org/software/gdb/gdb.html gdb] at the current position. This is a great moment to see the beast exactly at the moment of falilure. The parameter ''--num-callers'', which defaults to 4, is the number of backtrace lines that [http://valgrind.kde.org valgrind] shows you, 4 is too little.

Finally, there is ''--gen-suppressions'' and ''--suppressions''. Suppressions are a way that [http://valgrind.kde.org valgrind] provides us so that we don't have to see '''every''' single problem that the program has. Eventually, other libraries your program is using, like X itself, will show memory usage problems, and [http://valgrind.kde.org valgrind] will show them. So, on the first few runs of [http://valgrind.kde.org valgrind], we will have to build a suppression file, which is specified by ''--suppressions='' and we tell [http://valgrind.kde.org valgrind] to generate suppressions on screen. ''--gen-suppressions=yes'' will do this. Suppressions are a few lines that you may copy/paste in the suppressions file, all you have to do is give each suppression a name and that's it.

When set up that way, each time [http://valgrind.kde.org valgrind] finds something wrong, it will show you a few lines describing the problem and then it will ask you if you want it to generate the suppressions. If you say yes, the suppression appears on the screen, and you can copy/paste it in the suppressions file, so that next time you run valgring this error is not reported.

Now, after prompting the user for printing the suppression, [http://valgrind.kde.org valgrind] will prompt the user again whether or not he should start [http://www.gnu.org/software/gdb/gdb.html gdb]. If you say accept, [http://www.gnu.org/software/gdb/gdb.html gdb] will attach the running process and you will be debugging the program exactly at the point of the invalid operation.

== A few [http://www.gnu.org/software/gdb/gdb.html gdb] useful commands ==
----
;'''''bt''''': backtrace, shows the stack frames (subroutine calls) that lead to the position you are now in code.
;'''''bt full''''': shows every frame with the values of the local variables, usually too much verbose, only do this if you want to send the output to another person to analyse.
;'''''up/down number''''': e.g.: ''up 5'': goes up 5 stack frames. By default, whenever you enter [http://www.gnu.org/software/gdb/gdb.html gdb], you will be placed in frame number 0. '''With the aid of the source code of the program''' you should be able to select the subroutine where you want to inspect the variables.
;'''''frame number''''': goes straight to the selected frame.
;'''''info locals''''': prints the value of all local variables belonging to the current frame.
;'''''p variable''''': e.g.: ''p *cur_src''. Prints the named variable. Usually C like syntax will be allowed here.
;'''''l''''': prints 10 lines of source code around the current line. A separate editor for source browsing is usualy better, but this can be a quick way to see the code.
;'''''help/help command''''': Do I need to explain that? :)

There are other commands, but usualy these described will suffice. It's worth mentioning that [http://www.gnu.org/software/gdb/gdb.html gdb] can be run with the core file, i.e., that big file that is produced after a crash. To do that, type

''gdb '''program_path''' '''core_file_path'''''

Also there are GUI front ends to [http://www.gnu.org/software/gdb/gdb.html gdb] that make it a little bit more friendly (like [http://kgdb.sourceforge.net kdbg]). GUI front ends are great to inspect several different variables by clicking with the mouse. But learning to use [http://www.gnu.org/software/gdb/gdb.html gdb] from the console is by far the fastest way to do the job, not to mention that you can do it '''quickly''' in a remote terminal session.

Also note that practice makes it perfect, so the only way to realy learn how to do this is by doing it. You will see that you will quickly learn how to move around [http://www.gnu.org/software/gdb/gdb.html gdb], in spite of its daunting console interface. Soon it will become your friend. :)

'''NOTE:''' [[aMule]] is a '''separate''' project from [http://www.gnu.org/software/gdb/gdb.html gdb], [http://valgrind.kde.org valgrind] or any other project refered in this text, and is '''not''' related to any of them.

Using gdb and valgrind

2009-05-11T19:07:48Z

Marcell:

The two programs, [http://www.gnu.org/software/gdb/gdb.html gdb] and [http://valgrind.kde.org valgrind], are fabulous tools to find errors in your code. The standard gnu debugger is [http://www.gnu.org/software/gdb/gdb.html gdb], very powerfull, virtually every debugger in [http://www.gnu.org GNU] is [http://www.gnu.org/software/gdb/gdb.html gdb]-based. So, you need to learn some [http://www.gnu.org/software/gdb/gdb.html gdb]. Another invaluable tool is [http://valgrind.kde.org valgrind]. It allows you to track memory usage, stopping the program whenever an invalid operation has been made.

Both [http://valgrind.kde.org valgrind] and [http://www.gnu.org/software/gdb/gdb.html gdb] can be used together, so that you can actually debug the program that is beeing analysed. This is possible due to a [http://www.gnu.org/software/gdb/gdb.html gdb] feature that makes it possible to attach any running process to a [http://www.gnu.org/software/gdb/gdb.html gdb] session.

The first step is to setup '''valgrind''', but first, some interesting links about [http://valgrind.kde.org valgrind]:

* Home page: http://valgrind.org/
* Documentation: http://developer.kde.org/~sewardj/docs-2.0.0/manual.html
* How To: http://www.tldp.org/HOWTO/Valgrind-HOWTO/
* FAQ: http://valgrind.kde.org/faq.html
* Nice article explaining how to use: http://www.linux-mag.com/2003-05/compile_03.html

== Running [http://valgrind.kde.org valgrind] ==
----

I personaly use the following call:

<code>valgrind -v --tool=memcheck --leak-check=yes --gdb-attach=yes --num-callers=10 --suppressions=amule.sup --gen-suppressions=yes ~/programs/amule/amule-dev-cvs/src/amule --enable-stdin</code>

This way, leak-check is enabled, and whenever a problem is detected, the user will be prompted for whether he wants to start [http://www.gnu.org/software/gdb/gdb.html gdb] at the current position. This is a great moment to see the beast exactly at the moment of falilure. The parameter ''--num-callers'', which defaults to 4, is the number of backtrace lines that [http://valgrind.kde.org valgrind] shows you, 4 is too little.

Finally, there is ''--gen-suppressions'' and ''--suppressions''. Suppressions are a way that [http://valgrind.kde.org valgrind] provides us so that we don't have to see '''every''' single problem that the program has. Eventually, other libraries your program is using, like X itself, will show memory usage problems, and [http://valgrind.kde.org valgrind] will show them. So, on the first few runs of [http://valgrind.kde.org valgrind], we will have to build a suppression file, which is specified by ''--suppressions='' and we tell [http://valgrind.kde.org valgrind] to generate suppressions on screen. ''--gen-suppressions=yes'' will do this. Suppressions are a few lines that you may copy/paste in the suppressions file, all you have to do is give each suppression a name and that's it.

When set up that way, each time [http://valgrind.kde.org valgrind] finds something wrong, it will show you a few lines describing the problem and then it will ask you if you want it to generate the suppressions. If you say yes, the suppression appears on the screen, and you can copy/paste it in the suppressions file, so that next time you run valgring this error is not reported.

Now, after prompting the user for printing the suppression, [http://valgrind.kde.org valgrind] will prompt the user again whether or not he should start [http://www.gnu.org/software/gdb/gdb.html gdb]. If you say accept, [http://www.gnu.org/software/gdb/gdb.html gdb] will attach the running process and you will be debugging the program exactly at the point of the invalid operation.

== A few [http://www.gnu.org/software/gdb/gdb.html gdb] useful commands ==
----
;'''''bt''''': backtrace, shows the stack frames (subroutine calls) that lead to the position you are now in code.
;'''''bt full''''': shows every frame with the values of the local variables, usually too much verbose, only do this if you want to send the output to another person to analyse.
;'''''up/down number''''': e.g.: ''up 5'': goes up 5 stack frames. By default, whenever you enter [http://www.gnu.org/software/gdb/gdb.html gdb], you will be placed in frame number 0. '''With the aid of the source code of the program''' you should be able to select the subroutine where you want to inspect the variables.
;'''''frame number''''': goes straight to the selected frame.
;'''''info locals''''': prints the value of all local variables belonging to the current frame.
;'''''p variable''''': e.g.: ''p *cur_src''. Prints the named variable. Usually C like syntax will be allowed here.
;'''''l''''': prints 10 lines of source code around the current line. A separate editor for source browsing is usualy better, but this can be a quick way to see the code.
;'''''help/help command''''': Do I need to explain that? :)

There are other commands, but usualy these described will suffice. It's worth mentioning that [http://www.gnu.org/software/gdb/gdb.html gdb] can be run with the core file, i.e., that big file that is produced after a crash. To do that, type

''gdb '''program_path''' '''core_file_path'''''

Also there are GUI front ends to [http://www.gnu.org/software/gdb/gdb.html gdb] that make it a little bit more friendly (like [http://kgdb.sourceforge.net kdbg]). GUI front ends are great to inspect several different variables by clicking with the mouse. But learning to use [http://www.gnu.org/software/gdb/gdb.html gdb] from the console is by far the fastest way to do the job, not to mention that you can do it '''quickly''' in a remote terminal session.

Also note that practice makes it perfect, so the only way to realy learn how to do this is by doing it. You will see that you will quickly learn how to move around [http://www.gnu.org/software/gdb/gdb.html gdb], in spite of its daunting console interface. Soon it will become your friend. :)

'''NOTE:''' [[aMule]] is a '''separate''' project from [http://www.gnu.org/software/gdb/gdb.html gdb], [http://valgrind.kde.org valgrind] or any other project refered in this text, and is '''not''' related to any of them.

AMule Project FAQ:Help-de

2009-05-11T08:45:40Z

Marcell:

<center>[[AMule_Project_FAQ:Help|English]] | '''Deutsch'''</center>

Diese Seite beschreibt, wie das aMule Wiki benutzt wird. Für die Hauptseite mit Anleitungen und Hilfestellungen [[Main_Page-de|siehe hier]].

[http://richard.cyganiak.de/2002/wiki_und_wcms/wiki_und_wcms/ar01s02.html Wiki] ist ein revolutionäres Konzept der Webseitenbetreuung. Es besteht daraus, andere Leute alles (oder fast alles) bearbeiten zu lassen, so entsteht die Seite durch "Spenden".

Anstatt ein traditionelles [http://www.w3.org/MarkUp HTML] tag zu benutzen, verwendet es alternative, einfachere und intuitivere tags und Konzepte. Dieses Hilfedokument versucht sie dir beizubringen.

Bitte lese sie sorgfältig, und beteilige dich an allem, von dem du denkst, dass du es kannst. 
Danke.

== Vorwort ==
Du kannst schreiben was du willst, solange es zum Titel des Artikels passt (lies auch den [[aMule_Project_FAQ:Policy-de|Wikikodex]]).

== Neue Artikel erstellen ==
Um einen neuen Artikel zu erstellen, besorg dir die URL eines existierenden Artikels, entferne den Namen des Artikels aus dem URL und füge an dieser Stelle den Namen ein, den dein neuer Artikel tragen soll. Danach gehe mit deinem Browser auf diese Seite und klicke auf "Diesen Artikel bearbeiten".

== Zeilen Umbrüche ==
Als erstes, um einen Zeilenumbruch zu erzeugen, nutze entweder am Ende der Zeile (dadurch wird die nächste Zeile direkt unter der aktuellen angezeigt), oder lass eine leeren Zeile zwischen den beiden Zeilen (bewirkt einen neuen Absatz). Mehrere leere Zeilen im Text haben den selben Effekt wie eine leere Zeile. Wenn du mehr als eine leere Zeile haben willst, nutzte hierzu ebenfalls . 
Hier gibt es keine Beispiele, weil es einfach zu viel Platz auf dieser Seite verbrauchen würde. Probier es halt einfach beim Bearbeiten irgendeiner Wiki-Seite aus.

== Leerzeichen ==
Leerzeichen sind auch Zeichen die weggelassen werden, wenn hiervon mehrere hintereinander stehen. Ist das der Fall, wird nur eines angezeigt. 
Falls du wirklich mehrere Leerzeichen hintereinander haben möchtest, schreib ''&nbsp;'' anstelle der Leerzeichen. 
Beispiele:

'''''Code:''''' Ich schreibe hier      ein paar Leerzeichen 
'''''Anzeige:''''' Ich schreibe hier ein paar Leerzeichen

'''''Code:''''' Ich schreibe hier &nbsp;&nbsp;&nbsp;&nbsp; ein paar Leerzeichen 
'''''Anzeige:''''' Ich schreibe hier      ein paar Leerzeichen

== Tabulatoren ==
Ein '':'' am Anfang einer Zeile wirkt wie ein '''tabulator'''. Je mehr '':'' du schreibst, desto weiter wird der Text eingerückt. 
Beispiele:

'''''Code:''''' 
<nowiki>:Hier ist ein Tabulator</nowiki> 
<nowiki>::Hier sind zwei Tabulatoren</nowiki> 
<nowiki>::::Hier sind vier Tabulatoren</nowiki> 
<nowiki>:Hier ist wieder nur ein Tabulator</nowiki> 

'''''Anzeige:''''' 
:Hier ist ein Tabulator
::Hier sind zwei Tabulatoren
::::Hier sind vier Tabulatoren
:Hier ist wieder nur ein Tabulator

== Fettdruck ==
Wenn du einzelne Wörter hervorheben willst, kannst du sie '''Fett''' machen, indem du drei einzelne Anführungszeichen drumherum schreibst (''<nowiki>'''</nowiki>''), ungfähr so:

'''''Code:''''' <nowiki>'''Dies wird Fett angezeigt'''</nowiki> 
'''''Anzeige:''''' '''Dies wird Fett angezeigt'''

== Kursivschrift ==
Wenn du einzelne Wörter hervorheben willst, kannst du sie ''kursiv'' machen, indem du zwei einzelne Anführungszeichen drumherum schreibst (''<nowiki>''</nowiki>''), ungfähr so:

'''''Code:''''' <nowiki>''Dies wird kursiv angezeigt''</nowiki> 
'''''Anzeige:''''' ''Dies wird kursiv angezeigt''

== Fette Kursivschrift ==
Wenn du einige Wörter '''''fett und kursiv''''' darstellen willst, verpacke sie einfach in fünf einzelne Anführungszeichen (''<nowiki>'''''</nowiki>''), ungfähr so:

'''''Code:''''' ''<nowiki>'''''Dies wird fett und kursiv angezeigt'''''</nowiki>'' 
'''''Anzeige:''''' '''''Dies wird fett und kursiv angezeigt'''''

== Verlinken ==
Es gibt zwei verschiedene Arten von Links:
*Wiki Links
*Externe Links

=== Wiki Links ===
''[http://richard.cyganiak.de/2002/wiki_und_wcms/wiki_und_wcms/ar01s02.html Wiki] Links'' sind Links die auf eine Seite im selben [http://richard.cyganiak.de/2002/wiki_und_wcms/wiki_und_wcms/ar01s02.html Wiki] verweisen. 
Zum Beispiel, die Seite ''FAQ_aMule-de'' existiert in diesem [http://richard.cyganiak.de/2002/wiki_und_wcms/wiki_und_wcms/ar01s02.html Wiki] und enthält die [[FAQ_aMule-de|aMule FAQ]], also ist das ein [http://richard.cyganiak.de/2002/wiki_und_wcms/wiki_und_wcms/ar01s02.html Wiki] Link. 
Diese Links werden erzeugt, indem man den Seitennamen zwischen ''[['' und '']]'' einträgt. Beachte, dass Seitennamen [http://de.wikipedia.org/wiki/Gro%C3%9Fschreibung#Informatik case sensitive]. 
Dazu einige Beispiele:

'''''Code:''''' <nowiki>[[FAQ_aMule-de]]</nowiki> 
'''''Preview:''''' [[FAQ_aMule-de]]

Beachte auch, dass Unterstriche (''_'') in Seitennamen durch Leerzeichen eresetzt werden können. 

'''''Code:''''' <nowiki>[[FAQ aMule-de]]</nowiki> 
'''''Anzeige:''''' [[FAQ aMule-de]]

Meistens wirst du einen Text anstelle des Namens anzeigen wollen. 
Das wird erreicht, durch ein Pipe-Zeichen ('''|''') nach dem Seitennamen gefolgt vom gewünschten Text. 
Beispiele:

'''''Code:''''' <nowiki>[[FAQ_aMule-de|FAQ über aMule]]</nowiki> 
'''''Anzeige:''''' [[FAQ_aMule-de|FAQ über aMule]]

'''''Code:''''' <nowiki>Lies [[FAQ_aMule-de|dies]] hier, bitte</nowiki> 
'''''Anzeige:''''' Lies [[FAQ_aMule-de|dies]] hier, bitte

Alles was direkt nach einem Link steht, wird als Teil des Links dargestellt. Was direkt davor steht allerdings nicht. 
Beispiele:

'''''Code:''''' <nowiki>[[FAQ aMule-de]]rs</nowiki> 
'''''Anzeige:''''' [[FAQ aMule-de]]rs

'''''Code:''''' <nowiki>Vorangestelltes wird nicht verlinkt, vor[[FAQ aMule-de]]nach</nowiki> 
'''''Anzeige:''''' Vorangestelltes wird nicht verlinkt, vor[[FAQ aMule-de]]nach

=== Externe Links ===
Externe Links verweisen auf Seiten ausserhalb des [http://richard.cyganiak.de/2002/wiki_und_wcms/wiki_und_wcms/ar01s02.html Wiki]. 
Wenn du nur die URL anzeigen willst, schreib sie einfach in den Text:

'''''Code:''''' <nowiki>http://www.amule.org</nowiki> 
'''''Anzeige:''''' http://www.amule.org

Falls du dem Link einen Namen geben willst, schließt du das Ganze einfach in ''['' und '']'' ein. Dort kommt dann '''erst''' die URL, und dann der Text mit einem Leerzeichen getrennt:

'''''Code:''''' ''Dies verweist auf die <nowiki>[http://www.amule.org aMule WebSeite]</nowiki>'' 
'''''Anzeige:''''' ''Dies verweist auf die [http://www.amule.org aMule WebSeite]''

Wenn du den Link in ''['' und '']'' einschließt, aber keine Beschreibung dazu schreibst, werden sie fortlaufend Nummeriert:

'''''Code:''''' <nowiki>[http://www.amule.org]</nowiki> 
'''''Anzeige:''''' [http://www.amule.org]

== Überschriften ==
Überschriften werden in ''==''-Zeichen eingeschlossen: 

''<nowiki>== Überschriften ==</nowiki>''

Bei Unterkapiteln, werden weitere ''=''-Zeichen ergänzt: 

''<nowiki>== Überschriften ==</nowiki>'' 
''<nowiki>=== Unterkapitel ===</nowiki>'' 
''<nowiki>==== UnterUnterKapitel ====</nowiki>''

Diese ''==''-Zeichen müssen der Anfang und das Ende der Zeile darstellen, ansonsten werden sie als Text angezeigt.

== Listen ==
Es gibt zwei Arten von Listen: 
*Einfache Listen 
*Nummerierte Listen

=== Einfache Listen ===
Dies sind Listen, die nicht mehr als einen Punkt zum Auseinanderhalten aufweisen. 
Du kannst sie durch Eingabe eines Sternchens (''*'') am Anfang der Zeile erzeugen. Die Anzahl der Sternchen bestimmt die Ebene in der Liste. 
Beachte das keine '' ''-Tags benutzt werden sollten. 
Beispiele folgen:

'''''Code:''''' 
<nowiki>*Das ist eine Liste</nowiki> 
<nowiki>*Mit ihrem zweiten Element</nowiki> 
<nowiki>**Und einem Unterpunkt</nowiki> 
<nowiki>**Und noch einem</nowiki> 
<nowiki>***Sogar noch Unter-Unterpunkte</nowiki> 
<nowiki>*Und zurück zur Obersten Ebene</nowiki>

'''''Anzeige:'''''
*Das ist eine Liste
*Mit ihrem zweiten Element
**Und einem Unterpunkt
**Und noch einem
***Sogar noch Unter-Unterpunkte
*Und zurück zur Obersten Ebene

=== Nummerierte Listen ===
Diese Listen geben jedem Element automatisch eine Nummer. 
Du kannst sie durch tippen eines Doppelkreuzes (''#'') am Anfang der Zeile erzeugen. Die Anzahl dieser Zeichen (''#'') bestimmt die Ebene in der Liste. 
Beachte das keine '' ''-Tags benutzt werden sollten und dass die Zeilen direkt aufeinander folgen müssen, um korrekt gekennzeichnet zu werden. 
Beispiele folgen:

'''''Code:''''' 
<nowiki>#Das ist eine nummerierte Liste</nowiki> 
<nowiki>#Mit ihrem zweiten Element</nowiki> 
<nowiki>##Und einem Unterpunkt</nowiki> 
<nowiki>##Und noch einem</nowiki> 
<nowiki>###Sogar noch Unter-Unterpunkte</nowiki> 
<nowiki>#Und zurück zur Obersten Ebene</nowiki>

'''''Anzeige:'''''
#Das ist eine nummerierte Liste
#Mit ihrem zweiten Element
##Und einem Unterpunkt
##Und noch einem
###Sogar noch Unter-Unterpunkte
#Und zurück zur Obersten Ebene

== Das Kleiner-Als Zeichen (<) und Kaufmanns-Und (&) anzeigen==
Das Kleiner-Als Zeichen (<) ist recht schwer in [http://www.w3.org/MarkUp HTML] Seiten einzubetten, weil es den Beginn eines tags kennzeichnet. 
Wann immer du es nutzen willst, und dies nicht für ein [http://www.w3.org/MarkUp HTML] tag geschieht, schreib ''&lt;'' anstatt ''<'':

'''''Code:''''' ''5 &lt; 7 == true'' 
'''''Anzeige:''''' ''5 < 7 == true''

Das Kaufmanns-Und (&) könnte auch Probleme bereiten, sobald es vor einer Zahl oder einer Buchstabenfolge steht und dies zusätzlich mit einem Semikolon (;) abgeschlossen wird (keine Leerzeichen dazwischen). 
Falls das bei dir der Fall ist, nutze anstatt dieses Zeichens die Folge ''&amp;'':

'''''Code:''''' ''Dies ist ein Kaufmanns-Und: &amp;'' 
'''''Anzeige:''''' ''Dies ist ein Kaufmanns-Und: &''

== Ignorieren von [http://richard.cyganiak.de/2002/wiki_und_wcms/wiki_und_wcms/ar01s02.html Wiki] Tags ==
Es kann vorkommen das du Text verwenden willst, der als Wikitag interpretiert werden würde, schließe diesen in <nowiki> und </nowiki> ein:

'''''Code:''''' <nowiki><nowiki>Dies wird nicht '''fett''' oder ''kursiv''</nowiki></nowiki> 
'''''Anzeige:''''' <nowiki>Dies wird nicht '''fett''' oder ''kursiv''</nowiki>

== Bilder einfügen ==
Um Bilder einzufügen, schreibe einfach deren URL. Beispiel:

'''''Code:''''' <nowiki>http://www.amule.org/images/logo.gif</nowiki> 
'''''Anzeige:''''' http://www.amule.org/images/logo.gif

== Weiterführendes ==
Natürlich, da alles [http://www.w3.org/MarkUp HTML] ist oder wird, kannst du auch jedes gewünschte [http://www.w3.org/MarkUp HTML] Tag verwenden, um die Gestaltungsmöglichkeiten zu erweitern.

== Seitennamen ==
Die Seitennamen haben folgendem Schema zu entsprechen:
*Mehrere Worte '''niemals''' zusammen schreiben. Nutze ''_'' um sie zu trennen. Zum Beispiel: ''Dies_sind_mehrere_Worte''
*Wenn mehr als ein Wort genutzt wird, schreib sie klein, es sei denn es ist ein Name. Zum Beispiel: ''Hier_war_John''
*Wenn eines der Worte einen anderen Großbuchstaben enthällt, schreib ihn dementsprechend groß. Zum Beispiel: ''Das_ist_aMule''
*Wenn du [[translating Wiki-de|eine Seite übersetzt]], benutze den Originalnamen gefolgt von einem Minus (''-'') und dem Sprachkürzel deiner Übersetzung. Zum Beispiel: ''Translated_to_german-de''

== Die [[Main Page-de|Übersicht]] übersetzen==
Lies bitte [[translating Wiki-de|dieses Dokument]].

== Test Seiten ==
Wenn du ausprobieren möchtest, was du jetzt gelernt hast, nutze '''nicht''' einen vorhandenen Artikel zum Testen. Erstelle stattdessen eine neue Seite, die mit dem Text "test:" beginnt.

Du solltest '''niemals''' nützliche Informationen als Sicherung oder für später auf solch einer Seite ablegen. Testseiten können jederzeit kommentarlos gelöscht werden.

== Mehr Informationen ==
*http://meta.wikimedia.org/wiki/MediaWiki_User%27s_Guide#For_editors
*http://de.wikipedia.org/wiki/Hilfe:Seite_bearbeiten

== Version ==
Erstellt von Vollstrecker am 18.09.07 um 08:40 
Aktualisiert von Vollstrecker am 24.01.08 um 11:37 
Aktualisiert von Marcell am 11.06.09 um 10:45

AMule Project FAQ:Help-de

2009-05-10T20:39:19Z

Marcell: Tipp- und Rechtschreibfehler entfernt.

<center>[[AMule_Project_FAQ:Help|English]] | '''Deutsch'''</center>

Diese Seite beschreibt, wie das aMule Wiki benutzt wird. Für die Hauptseite mit Anleitungen und Hilfestellungen [[Main_Page-de|siehe hier]].

[http://richard.cyganiak.de/2002/wiki_und_wcms/wiki_und_wcms/ar01s02.html Wiki] ist ein revolutionäres Konzept der Webseiten Betreuung. Es besteht daraus, andere Leute alles (oder fast alles) bearbeiten zu lassen, so entsteht die Seite durch "Spenden".

Anstatt ein traditionelles [http://www.w3.org/MarkUp HTML] tags zu benutzen, nutzt es alternative, einfachere und intuitivere tags und Konzepte. Dieses Hilfedokument versucht sie dir beizubringen.

Bitte lese sie sorgfätig, und beteilige dich an allem, von dem du denkst, dass du es kannst. 
Danke.

== Vorwort ==
Du kannst schreiben was du willst, solange es zum Titel des Artikels passt (lies auch den [[aMule_Project_FAQ:Policy-de|Wikikodex]]).

== Neue Artikel erstellen ==
Um einen neuen Artikel zu erstellen, besorg dir die URL eines existierenden Artikels, entferne den Namen des Artikels aus dem URL und füge an dieser Stelle den Namen ein, den dein neuer Artikel tragen soll. Danach gehe mit deinem Browser auf diese Seite und klicke auf "Diesen Artikel bearbeiten".

== Zeilen Umbrüche ==
Als erstes, um einen Zeilenumbruch zu erzeugen, nutze entweder am Ende der Zeile (dadurch wird die nächste Zeile direkt unter der aktuellen angezeigt werden), oder lasse eine leeren Zeile zwischen den beiden Zeilen (bewirkt einen neuien Absatz). Mehrere leere Zeilen haben keinen andere Effekt als nur eine. Wenn du mehr als eine leere Zeile haben willst, nutzte auch . 
Hier gibt es keine Beispiele, weil es einfach zu viel Platz auf dieser Seite verbrauchen würde. Probier es halt einfach beim Bearbeiten irgendeiner Wiki-Seite aus.

== Leerzeichen ==
Leerzeichen sind auch Zeichen die ignoriert werden wenn mehr als eines vorhanden ist. Ist das der Fall, wird nur eines angezeigt. 
Falls du wirklich mehr Leerzeichen haben willst, schreibe ''&nbsp;'' anstelle des Leerzeichens. 
Beispiele:

'''''Code:''''' Ich schreibe hier      ein paar Leerzeichen 
'''''Anzeige:''''' Ich schreibe hier ein paar Leerzeichen

'''''Code:''''' Ich schreibe hier &nbsp;&nbsp;&nbsp;&nbsp; ein paar Leerzeichen 
'''''Anzeige:''''' Ich schreibe hier      ein paar Leerzeichen

== Tabulatoren ==
Ein '':'' am Anfang einer Zeile wirkt wie ein '''tabulator'''. Je mehr '':'' du schreibst, desto weiter wird der Text eingerückt. 
Beispiele:

'''''Code:''''' 
<nowiki>:Hier ist ein Tabulator</nowiki> 
<nowiki>::Hier sind zwei Tabulatoren</nowiki> 
<nowiki>::::Hier sind vier Tabulatoren</nowiki> 
<nowiki>:Hier ist wieder nur ein Tabulator</nowiki> 

'''''Anzeige:''''' 
:Hier ist ein Tabulator
::Hier sind zwei Tabulatoren
::::Hier sind vier Tabulatoren
:Hier ist wieder nur ein Tabulator

== Fettdruck ==
Wenn du einzelne Worte hervorheben willst, kannst du sie '''Fett''' machen indem die drei einzelne Anführungszeichen darum herum schreibst (''<nowiki>'''</nowiki>''), ungfähr so:

'''''Code:''''' <nowiki>'''Dies wird Fett angezeigt'''</nowiki> 
'''''Anzeige:''''' '''Dies wird Fett angezeigt'''

== Kursivschrift ==
Wenn du einzelne Worte hervorheben willst, kannst du sie ''kursiv'' machen indem die zwei einzelne Anführungszeichen darum herum schreibst (''<nowiki>''</nowiki>''), ungfähr so:

'''''Code:''''' <nowiki>''Dies wird kursiv angezeigt''</nowiki> 
'''''Anzeige:''''' ''Dies wird kursiv angezeigt''

== Fette Kursivschrift ==
Wenn du einige Worte '''''fett und kursiv''''' darstellen willst, verpacke sie einfach in fünf einzelne Anführungszeichen (''<nowiki>'''''</nowiki>''), ungfähr so:

'''''Code:''''' ''<nowiki>'''''Dies wird fett und kursiv angezeigt'''''</nowiki>'' 
'''''Anzeige:''''' '''''Dies wird fett und kursiv angezeigt'''''

== Verlinken ==
Es gibt zwei verschiedene Arten von Links:
*Wiki Links
*Externe Links

=== Wiki Links ===
''[http://richard.cyganiak.de/2002/wiki_und_wcms/wiki_und_wcms/ar01s02.html Wiki] Links'' sind Links die auf eine Seite im selben [http://richard.cyganiak.de/2002/wiki_und_wcms/wiki_und_wcms/ar01s02.html Wiki] verweisen. 
Zum Beispiel, die Seite ''FAQ_aMule-de'' existiert in diesem [http://richard.cyganiak.de/2002/wiki_und_wcms/wiki_und_wcms/ar01s02.html Wiki] und enthält die [[FAQ_aMule-de|aMule FAQ]], also ist das ein [http://richard.cyganiak.de/2002/wiki_und_wcms/wiki_und_wcms/ar01s02.html Wiki] Link. 
Diese Links werden erzeugt indem man den Seitennamen zwischen ''[['' und '']]'' einträgt. Beachte das Seitennamen [http://de.wikipedia.org/wiki/Gro%C3%9Fschreibung#Informatik case sensitive]. 
Dazu einige Beispiele:

'''''Code:''''' <nowiki>[[FAQ_aMule-de]]</nowiki> 
'''''Preview:''''' [[FAQ_aMule-de]]

Beachte auch, das Unterstriche (''_'') in Seitennamen durch Leerzeichen eresetzt werden können. 

'''''Code:''''' <nowiki>[[FAQ aMule-de]]</nowiki> 
'''''Anzeige:''''' [[FAQ aMule-de]]

Meistens wirst du einen Text anstelle des Namens anzeigen wollen. 
Das wird erreicht, durch ein Pipe-Zeichen ('''|''') nach dem Seitennamen gefolgt vom gewünschten Text. 
Beispiele:

'''''Code:''''' <nowiki>[[FAQ_aMule-de|FAQ über aMule]]</nowiki> 
'''''Anzeige:''''' [[FAQ_aMule-de|FAQ über aMule]]

'''''Code:''''' <nowiki>Lies [[FAQ_aMule-de|dies]] hier, bitte</nowiki> 
'''''Anzeige:''''' Lies [[FAQ_aMule-de|dies]] hier, bitte

Alles was direkt nach einem Link steht, wird als Teil des Links dargestellt. Was direkt davor steht allerdings nicht. 
Beispiele:

'''''Code:''''' <nowiki>[[FAQ aMule-de]]rs</nowiki> 
'''''Anzeige:''''' [[FAQ aMule-de]]rs

'''''Code:''''' <nowiki>Vorangestelltes wird nicht gelinkt, vor[[FAQ aMule-de]]nach</nowiki> 
'''''Anzeige:''''' Vorangestelltes wird nicht gelinkt, vor[[FAQ aMule-de]]nach

=== Externe Links ===
Externe Links verweisen auf Seiten ausserhalb des [http://richard.cyganiak.de/2002/wiki_und_wcms/wiki_und_wcms/ar01s02.html Wiki]. 
Wenn du nur die URL anzeigen willst, schreibe sie einfach in den Text:

'''''Code:''''' <nowiki>http://www.amule.org</nowiki> 
'''''Anzeige:''''' http://www.amule.org

Falls du dem Link einen Namen geben willst, schließt du das Ganz einfach in ''['' und '']'' ein, dort kommt dann '''erst''' die URL, und dann der Text mit einem Leerzeichen getrennt:

'''''Code:''''' ''Dies verweist auf die <nowiki>[http://www.amule.org aMule WebSeite]</nowiki>'' 
'''''Anzeige:''''' ''Dies verweist auf die [http://www.amule.org aMule WebSeite]''

Wenn du den Link in ''['' und '']'' einschließt, aber keine Beschreibung dazu schreibst, werden die fortlaufend Nummeriert:

'''''Code:''''' <nowiki>[http://www.amule.org]</nowiki> 
'''''Anzeige:''''' [http://www.amule.org]

== Überschriften ==
Überschriften werden in ''==''-Zeichen eingeschlossen: 

''<nowiki>== Überschriften ==</nowiki>''

Bei Unterkapiteln, werden weiter ''=''-Zeichen ergänzt: 

''<nowiki>== Überschriften ==</nowiki>'' 
''<nowiki>=== Unterkapitel ===</nowiki>'' 
''<nowiki>==== UnterUnterKapitel ====</nowiki>''

Diese ''==''-Zeichen müssen der Anfang und das Ende der Zeile darstellen, ansonsten werden sie ignoriert und angezeigt.

== Listen ==
Es gibt zwei Arten von Listen: 
*Einfache Listen 
*Nummerierte Listen

=== Einfache Listen ===
Dies sind Listen die nicht mehr als einen Punkt zum auseinanderhalten aufweisen. 
Du kannst sie durch Eingabe eines Sternchen (''*'') am Anfang der Zeile erzeugen. Die Anzahl der Sternchen bestimmt die Ebene auf der Liste. 
Beachte das keine '' ''-Tags benutzt werden sollten. 
Beispiele folgen:

'''''Code:''''' 
<nowiki>*Das ist eine Liste</nowiki> 
<nowiki>*Mit ihrem zweiten Element</nowiki> 
<nowiki>**Und einem Unterpunkt</nowiki> 
<nowiki>**Und noch einem</nowiki> 
<nowiki>***Sogar noch Unter-Unterpunkte</nowiki> 
<nowiki>*Und zurück zur Obersten Ebene</nowiki>

'''''Anzeige:'''''
*Das ist eine Liste
*Mit ihrem zweiten Element
**Und einem Unterpunkt
**Und noch einem
***Sogar noch Unter-Unterpunkte
*Und zurück zur Obersten Ebene

=== Nummerierte Listen ===
Diese Listen geben jedem Element Automatisch eine Nummer. 
Du kannst sie durch tippen eines Doppelkreuzes (''#'') am Anfang der Zeile erzeugen. Die Anzahl dieser Zeichen (''#'') bestimmt die Ebene auf der Liste. 
Beachte das keine '' ''-Tags benutzt werden sollten Und dass die Zeilen direkt aufeinander folgen müssen um korrekt gekennzeichnet zu werden. 
Beispiele folgen:

'''''Code:''''' 
<nowiki>#Das ist eine nummerierte Liste</nowiki> 
<nowiki>#Mit ihrem zweiten Element</nowiki> 
<nowiki>##Und einem Unterpunkt</nowiki> 
<nowiki>##Und noch einem</nowiki> 
<nowiki>###Sogar noch Unter-Unterpunkte</nowiki> 
<nowiki>#Und zurück zur Obersten Ebene</nowiki>

'''''Anzeige:'''''
#Das ist eine nummerierte Liste
#Mit ihrem zweiten Element
##Und einem Unterpunkt
##Und noch einem
###Sogar noch Unter-Unterpunkte
#Und zurück zur Obersten Ebene

== Das Kleiner-Als Zeichen (<) und Kaufmanns-Und (&) anzeigen==
Das Kleiner-Als Zeichen (<) ist recht schwer in [http://www.w3.org/MarkUp HTML] Seiten zu erzeugen, weil es den Beginn eines Tags anzeigt. 
Wann immer du es nutzen willst, und das nicht in einem [http://www.w3.org/MarkUp HTML] Tag geschieht, schreibe ''&lt;'' anstatt ''<'':

'''''Code:''''' ''5 &lt; 7 == true'' 
'''''Anzeige:''''' ''5 < 7 == true''

Das Kaufmanns-Und (&) könnte auch Probleme bereiten, sobald es vor einer Zahl oder einer Buchstabenfolge steht und das alles mit einem Semikolon (;) abgeschlossen wird (keine Leerzeichen dazwischen). 
Falls das bei dir der Fall ist, nutze anstatt dieses Zeichen die Folge ''&amp;'':

'''''Code:''''' ''Dies ist ein Kaufmanns-Und: &amp;'' 
'''''Anzeige:''''' ''Dies ist ein Kaufmanns-Und: &''

== Ignorieren von [http://richard.cyganiak.de/2002/wiki_und_wcms/wiki_und_wcms/ar01s02.html Wiki] Tags ==
Es kann vorkommen das du Text verwenden willst, der als Wikitag interpretiert werden würde, schließe diesen in <nowiki> und </nowiki> ein:

'''''Code:''''' <nowiki><nowiki>Dies wird nicht '''fett''' oder ''kursiv''</nowiki></nowiki> 
'''''Anzeige:''''' <nowiki>Dies wird nicht '''fett''' oder ''kursiv''</nowiki>

== Bilder einfügen ==
Um Bilder einzufügen, schreibe einfach die URL. Beispiel:

'''''Code:''''' <nowiki>http://www.amule.org/images/logo.gif</nowiki> 
'''''Anzeige:''''' http://www.amule.org/images/logo.gif

== Weiterführendes ==
Natürlich, da alles [http://www.w3.org/MarkUp HTML] ist oder wird, kannst du auch jedes gewünschte [http://www.w3.org/MarkUp HTML] Tag verwenden, um deine Gestaltungsmöglichkeiten zu erweitern.

== Seitennamen ==
Die Seitennamen haben folgendem Schema zu entsprechen:
*Mehrere Worte '''niemals''' zusammen schreiben. Nutze ''_'' um sie zu trennen. Zum Beispiel: ''Dies_sind_mehrere_Worte''
*Wenn mehr als ein Wort genutzt wird, schreibe sie klein, es sei denn es ist ein Name. Zum Beispiel: ''Hier_war_John''
*Wenn eines der Worte einen anderen Großbuchstaben enthällt, nutze ihn. Zum Beispiel: ''Das_ist_aMule''
*Wenn du [[translating Wiki-de|eine Seite übersetzt]], benutze den Original Namen gefolgt von einem Minus (''-'') und dem Sprachkürze deiner Übersetzung. Zum Beispiel: ''Translated_to_german-de''

== Die [[Main Page-de|Übersicht]] übersetzen==
Lies bitte [[translating Wiki-de|dieses Dokument]].

== Test Seiten ==
Wenn du ausprobieren willst was du jetzt gelernt hast, nutze '''nicht''' einen vorhandenen Artikel zum testen. Erstelle stattdessen eine neue Seite, die mit ''test:'' beginnt.

'''Niemals''' solltest du nützliche Informationen als Sicherung oder für später auf solch einer Seite ablegen. Testseiten können jederzeit kommentarlos gelöscht werden.

== Mehr Informationen ==
*http://meta.wikimedia.org/wiki/MediaWiki_User%27s_Guide#For_editors
*http://de.wikipedia.org/wiki/Hilfe:Seite_bearbeiten

== Version ==
Erstellt von Vollstrecker am 18.09.07 um 08:40 
Aktualisiert von Vollstrecker am 24.01.08 um 11:37