AMule Project FAQ - User contributions [en]

Usage Preferences

2005-12-29T00:21:41Z

203.217.79.88: Copy-edit of first bit.

[[Usage aMule|Back to Index]]

== Description ==

The Preferences window allows you to set aMule's settings.

http://www.amule.org/dev-up/window_prefs1.jpg

== Usage ==

The preferences options are divided into sections. Each section groups options with similar targets. You can view the available options by clicking th apropiate section in the list by the left side of the window.

http://www.amule.org/dev-up/window_prefs32.jpg

=== General ===

This section contains options regarding general aspects of aMule.

http://www.amule.org/dev-up/window_prefs2.jpg

The descritpion for each item follows:
*'''Nick''': [[Username]] to use;
*'''Language''': the language in which the text will be displayed (on UNIX systems, this requires the appropiate LC_ALL (or LC_MESSAGES) variable). ''System default'' sets the system's language
*'''Misc Options''';
**'''Check for new versions at startup''': if ticked, when aMule starts it will check whether new aMule releases are available; if this is the case, it will show a message to that effect;
**'''Start minimized''': this will minimize aMule when it starts;
**'''Prompt on exit''': when closing aMule, you'll then be asked for confirmation;
**'''Enable Tray Icon''': you'll be shown a [[Usage Tray icon|tray icon]] for aMule;
**'''Minimize to trayicon''': when minimizing aMule, this will hide the window completely so it can only be unminimized from the systray icon (see the [[usage tray icon|usage article about tray icon]]). This option will only be available when '''Enable Tray Icon''' option is enabled;
**'''Tooltip Delay Time in secs''': the number of seconds it takes for the systray tooltip to appear (see the [[usage tray icon|usage article about tray icon]])
*'''Browser Selection''': Select the browser you want aMule to use when opening web sites
*'''Custom Browser''': When selecting ''Custom browser'' in the browser selection list, this box will be active so you can enter the browser command to use to start a browser. Use the '''Browse''' button to browse the filesystem for the browser
*'''Open in new tab if possible''': Some browsers allow for pages to be started in new tabs rather than overriding the web site it was viewing so, if possible, when this option is enabled, open web sites in a new tab

=== Connection ===

This section contains options regarding connections aMule.

http://www.amule.org/dev-up/window_prefs3.jpg

The description for each item follows:

*'''Bandwidth Limits'''
**'''Download''': Maximum download speed to allow
**'''Upload''': Maximum upload speed to allow
**'''Slot Allocation''': Define speed for every [[slot allocation|allocated slot]]
*'''Line Capacities'''
**'''Download''': Download speed your line is capable of performing. This is only used for [[Usage_Statistics|Statistics]] and the speed bar in the [[Usage_Tray icon|SysTray icon]]
**'''Upload''': Upload speed your line is capable of performing. This is only used for [[Usage_Statistics|Statistics]] and the speed bar in the [[Usage_Tray icon|SysTray icon]]
*'''Standard client TCP Port''': [[Standard client TCP port]] aMule will use
*'''Extended client UDP Port'''
**'''Extended client UDP Port''': [[Extended client UDP port]] aMule will use
**'''disable''': Disable the Extended client UDP port. This will decrease aMule's performance and usage in some apsects, but will free a port
*'''UDP port for extended server requests''': This field cannot be modified. It is there only so that the user remembers about the [[extended server requests UDP port]]'s existence and easily knows which numbre it is assigned
*'''Max Sources per File''': Maximum amount of sources that will be remembered for every file
*'''Connection Limits''': Maximum amount of simoultanous connections
*'''Networks'''
**'''ED2K''': Enable the ED2K network. If disabled, it will only be possible to connect by explicitly doing so from the [[Usage_Networks|Networks]] window
**'''Kademlia''': Enable the Kademlia network. If disabled, it will only be possible to connect by explicitly doing so from the [[Usage_Networks|Networks]] window
*'''Autoconnect on startup''': Connect aMule to the enabled netwrks when it starts
*'''Reconnect on loss''': Atempt to connect to a server when disconnected. If it was disconnected because of an error, it will attempt to connect to the same server it was connected to. Otherwise, if it was explicitly disconnected by the server, it will attempt to connect to just any other server
*'''Show overhead bandwidth''': Show in the [[Usage_Statusbar|Status bar]] the bandwidth that control packets take

=== Proxy ===

This section contains options regarding connection aMule through a proxy.

http://www.amule.org/dev-up/window_prefs4.jpg

The descritpion for each item follows:

*'''General'''
**'''Enable Proxy''': Enable the use of a proxy
**'''Proxy type''': Select the type of proxy it is
**'''Proxy host''': The proxy's address
**'''Proxy port''': The port through which the proxy should be accessed
*'''Authentication'''
**'''Enable authentication''': Enable this option to use a username and password to log into the proxy. If disabled, anonymous log in will be performed
**'''Username''': Username to use to log into the proxy
**'''Password''': Password to use to log into the proxy
*'''Automatic server connect without proxy''': This option is ignored currently

=== Message Filter ===

This section contains options regarding messages filtering in aMule.

http://www.amule.org/dev-up/window_prefs5.jpg

The descritpion for each item follows:

*'''Filter incoming messages''': Filter incoming messages with the rules set underneath. Messages which are already open (in the [[Usage_Messages|Messages]] window) will no be closed
*'''Filtering Options'''
**'''Filter all messages''': Ignore all incoming messages
**'''Filter messages from people not on your friend list''': Ingore all messages coming from users not in the friends list in Messages window)
**'''Filter messages from unknown clients''': Ignore messages coming from clients which aren't in any of your upload or download queues
**'''Filter messages containing''': Ignore all messages containing the strings listed in the box below. This words must be separated with a coma ('','') only (all other characters will be takes as part of the string to filter)

=== Remote Controls ===

This section contains options regarding controling aMule remotely.

http://www.amule.org/dev-up/window_prefs6.jpg

The descritpion for each item follows:

*'''Webserver Parameters'''
**'''Webserver port''': Port where the swebserver will be listening for incoming connections
**'''page Refresh Time''': Time between refreshes in the web pages
**'''Enable Gzip compression''': Compress packets transfered from/to aMule from/to aMuleWeb
**'''Enable Low rights User''': Enable the use of a low rights account to log into the webserver with view capabilities but no administration rights
**'''Full rights password''': Password for administration from the webserver
**'''Low rights password''': Password users with low rights can use to log into the websever
**'''Web template''': Template to use for the webserver (also known as webserver skins)
*'''External Connection Parameters'''
**'''Accept external connections''': Allow aMule to accept [[External Connections]] requests from remote applications (such as aMuleWeb, aMuleGUI or aMuleCMD)
**'''IP of the listening interface''': [[IP]] of the host running aMule. This field is optional
**'''TCP port''': TCP port where aMule will listen for external connections
**'''Password''': Password remote applications must supply to succesfully perform External Connections requests

=== Online Signature ===

This section contains options regarding aMule's [[Online Signature]].

http://www.amule.org/dev-up/window_prefs7.jpg

The descritpion for each item follows:

*'''Enable Online-Signature''': Enable aMule to write the [[Online Signature]]
*'''Update Frequency''': Refresh interval aMule waits to update the Online Signature
*'''Online Signature Directory''': Locations where the Online Signature must be written to

=== Server ===

This section contains options regarding connecting aMule to [[server]]s.

http://www.amule.org/dev-up/window_prefs8.jpg

The descritpion for each item follows:

*'''Remove dead server''': Enable this option to remove servers which aren't acessible (unable to connect or ping them)
*'''Remove dead server after X retries''': If the above option is enabled, this specifies how many times a server can fail to connect (or ping) before it is removed from the servers list
*'''Auto-update serverlist at startup''': Enable this option to have aMule download the serverlist set in the serverlists list window (see the '''List''' button)
*'''List''': By clicking this a window will popup where you can enter the URLs to servers lists you want aMule to download an use at startup when the '''Auto-update serverlist at startup''' option is enabled
*'''Update serverlist when connecting to a server''': When connecting to a server, sak this server for other servers it knows about and add them to the servers list
*'''Update serverlist when a client connect''': When connecting to a client, ask this client what server it is connected to and add this server to the servers list
*'''Use priority system''': When connecting to any server, use the priority system to decide which servers to attempt to connect first and which to attempt to conenct the last
*'''Use smart LowID check on connect''': This option is ignored currently
*'''Safe connect''': If ennabled, when aMule is asked to connect to any server, it will only try connecting to on server at a time. If disabled, it will try two at a time simoultaneosuly (although only one will be eventually connected)
*'''Autoconnect to servers in static list only''': When setting aMule to connecto to any server, only attempt to connect to connect to those tagged as static
*'''Set manually added servers to High Priority''': When a server is manually added thorugh the Networks window, set its priority to ''High''

=== Files ===

This section contains options regarding aMule's downloading [[file]]s.

http://www.amule.org/dev-up/window_prefs9.jpg

The descritpion for each item follows:

*'''Intelligent Corruption Handling'''
**'''I.C.H. active''': Enable [[ICH]]
**'''AICH trusts every hash''': Enable [[AICH]]
*'''Add fiels to download in pause mode''': When a new file is added to download, add it [[pause]]d
*'''Add files to download with auto priority''': Whe a new file is added to download, set its [[priotiy]] to ''Auto''
*'''Try to download first and last chunks first''': When downloading a file, always try to download the beginning and the end of the file first. This is useful to quickly be able to preview the audio and video files
*'''Add new shared files with auto priority''': When a file is added to any of the shared directories or whne a file is completly downloaded, set its share priority to ''Auto''
*'''Try to transfer full chunks to all uploads''': When this option is enabled (recommended) once you begin uploading to a client no other client can gain its slot until it gets the whole chunk size. Ff disabled, the client with the highest score in the upload queue will always be given an upload score
*'''Start next paused file when a file completed''': If enabled, when a file is completed, the highest priority paused file will be resumed
*'''From the same category''': When enabled, if '''Start next paused file when a file completed''' is enabled, it will resume the highest priority file in the same category (if there is any paused file in the same category, just any other paused file if there isn't)
*'''Save 10 sources on rare files''': When closing aMule save 10 sources for those files which have few sources, so those sources can be reused on next startup (if it is quickly restarted)
*'''Disk space'''
**'''Check Disk Space''': If enabled, aMule will stop files when the free disk space in the filesystem would be lower than the value set in '''Min Disk Space'''
**'''Min Disk Space''': If '''Check Disk Space''' is enabled, this is, in MB, the minimum free disk space that should remain
*'''Execute command on file completion'''
**'''Enable command execution''': If enabled, when a file is completed the command in '''Command''' will be executed
**'''Command''': If '''Enable command execution''' is enabled, the command in this box will be executed when a file is completed. The following substitutions will be performed in the string provided:

{|+ Command execution keys
| '''''Key''''' || '''Description'''
|-
| ''%FILE'' || File's file name
|-
| ''%HASH'' || File's hash
|}

=== Sources Dropping ===

This section contains options regarding aMule source dropping algorithm.

http://www.amule.org/dev-up/window_prefs10.jpg

The descritpion for each item follows:

*'''Sources with no needed file-parts''': Decide what aMule should do with those sources which are in a file for which you already have the parts of the file those sources have
*'''Enable auto drop Full Queue Sources''': If a source's queue is full, ignore it
*'''Enable auto drop High Queue Rating Sources''': Ingore sources who have given you a [[queue rank]] higher than the value in '''High Queue Rating value'''
*'''Auto Drop Sources Timer''': Time a source can be known before it is ignored

=== Directores ===

This section contains options regarding aMule's directories.

http://www.amule.org/dev-up/window_prefs11.jpg

The descritpion for each item follows:

*'''Incoming Directory''': Directory where the completed files will be stored. You can use the '''Browse button by its side to select the directory
*'''Temporary Directory''': Directory where imcomplete files will be or are placed. You can use the '''Browse button by its side to select the directory
*'''Shared Directories''': Select the directories who's files you want to share. To select a directory, double click over its icon. To select all its contents recursively right-click over its icon. The following codes are used to display the shared status of a directory:
**''Normal font'': The directory is not marked as shared
**''Bold font'': The directory is marked as shared
**''Yellow folder icon'': The directory does not contain any subdirectory marked as shared (ths doesn't mean this directory isn't marked as shared either)
**''Red folder icon'': The directory contains subdirectories which are marked as shared
*'''Share hidden files''': Share hidden files in the shared directories too
*'''Video Player''': Command to execute when selectign to preview an audio or video file. The appropiate filename will be appended at the end of the command line
*'''Create Backup to preview''': When previewing a file, do not preview directly the file aMule is suing, but instead copy it to a temporary file and preview this other file

=== Statistics ===

This section contains options regarding aMule's statistics.

http://www.amule.org/dev-up/window_prefs12.jpg

The descritpion for each item follows:

*'''Graphs'''
**'''Update delay''': Refresh interval for the statistics graphs
**'''Time for average graph''': Time interval used to calculate the average values in the statistics graphs (the ''Running Average'')
**'''Connections Graph Scale''': Amount of connections the connections graph can repersent
**'''Select Statistcs Colors''': Here yo can select the colours used in the statistics. Select the item from the menu and then select the colour from the '''Select''' button
*'''Statistics Tree'''
**'''Update delay''': Refresh interval for the statistics tree
**'''Number of Client Versions shown''': Maximum amount of clients versions to be displayed for each client application listed in the tree

=== Security ===

This section contains options regarding aMule's security.

http://www.amule.org/dev-up/window_prefs13.jpg

The descritpion for each item follows:

*'''File Options'''
**'''Who can see shared files''': Select who can see your shared files. It is recommended to hide them to everyone
**'''Default Permissions'''
***'''Files''': Permissions newly created files will be given. Please note that this may collision with your ''umask'' system value see [[problems|umask|this article]] for more information
***'''Directories''': Permissions newly created directories will be given. Please note that this may collision with your ''umask'' system value see [[problems|umask|this article]] for more information
*'''IP-Filtering'''
**'''Enable IP-Filtering''': Enable filtering IPs known to be bad
**'''Reload List''': Reload the list of filtered IPs and check that all connections are properly filtered
**'''Auto-update ipfilter at startup''': Make aMule download the url in the '''URL''' box at startup
**'''Update now''': Update the list of filtered IPS now from the url in the '''URL''' box
**'''Filtering Level''': Select the filtering level, See the [[IP Filter]] article
**'''Always filter LAN IPs''': Always filter IPs claiming to be in your local LAN
*'''Use Secure Identification''': Use the [[SUI|Secure User Identiication]] protocol to identify against other clients (recommended)

=== GUI Tweaks ===

This section contains advanced options regarding aMule's GUI.

http://www.amule.org/dev-up/window_prefs14.jpg

The descritpion for each item follows:

*'''Download Queue Files Progress'''
**'''Show percentage''': Show the completed percentage value for every file in the downloads queue (over the progress bar if the progress bar is also visible)
**'''Show progressbar''': Show a progress bar displayed the availability of the chuns for every file in the downloads queue
**'''Progressbar Style''': Select the styl of the progress bar when '''Show progressbar''' is enabled
*'''Skin Support'''
**'''Use skin file to set aMule bitmaps''': Not yet supported
**'''Skin file''': Not yet supported
*'''Auto-sort files in the download queue''': When enabled, the downlods list will be resorted more frequently (not recommended, consumes many CPU cycles)
*'''Misc GUI Tweaks'''
**'''Show Fast ED2K Links Handler''': Show the [[Usage_ED2K Link Handler|ED2K Link Handler]] in all the windows, not only in the [[Usage_Searches|Searches]] window
**'''Show extended info on categories tabs''': When enabled, the tabs titles for categories in the [[Usage_Transfer|Transfer]] window will also display the amount of downloading files in the category and the total amount of files in the category
**'''Show transfer rates on title''': Show transfer speeds in the title text
**'''Vertical toolbar orientation''': Show the toolbar horizontally (disabled) or vertically (enabled)

=== Core Tweaks ===

This section contains advanced options regarding aMule's core system.

http://www.amule.org/dev-up/window_prefs15.jpg

The descritpion for each item follows:

*'''Max new connections / 5 secs''': Maximum amount of new connections to establish per every 5 seconds
*'''File Buffer Size''': Maximum amount of memory each file can take
*'''Upload Queue Size''': Maximum amount of clients to be queued in the uload queue
*'''Server connection refresh interval''': Ping intervals to the server (to avoid being disconnected because of lack of transmission)

=== Debugging ===

This section contains advanced options for debugging aMule.

http://www.amule.org/dev-up/window_prefs16.jpg

You may enable extra debugging output to your [[logfile_file|aMule log]] by enabling the '''Enable Verbose Debug-Logging.''' checkbox.

Once enabled, you may define what exact debug messages you want to get in the log by enabling/disabling the options in the '''Message Categories''' list.

This whole debugging preferences window '''should not be touched''' unless you know what you are doing. Therefore, its options will not be described.

<center>[[Usage aMule|Back to Index]]</center>

Usage Shared Files

2005-12-29T00:12:38Z

203.217.79.88: Copy-edit

[[Usage aMule|Back to Index]]

== Description ==

The Shared Files window allows you to see and manage the [[shared file|files you are sharing]].

It looks like this:

http://www.amule.org/dev-up/window_sharefiles1.jpg

Remember that a shared file is:
*any file in the directories you are sharing (see [[Usage Preferences|Preferences]]);
*any file you have [[complete]]d and is still in the [[Incoming dir]]ectory; or
*any file you are downloading that has already a [[chunk]] completed (only the completed chunks are shared).

== Usage ==

There are three things you can do from this window:
*see the properties of any shared file that you highlight;
*see the statistics of any shared file that you highlight; and
*manage your [[share]]d [[file]]s.

=== Files properties ===

The window has a big box listing all of the files you are sharing.

http://www.amule.org/dev-up/window_sharefiles2.jpg

The properties of your shared files and statistics on them appear in this list:
*'''Filename''' is the name of a file;
*'''Size''' is its total size;
*'''Type''' is its media type;
*'''Priority''' is its currently set [[priority|upload priority]]
*'''FileID''' is its [[hash]];
*'''Requests''' shows the number of requests for a file in the current session and, in parentheses, the total number of requests for that file your client has ever recieved (explained further in the [[Usage_Shared_Files#Files statistics|statistics]] section);
*'''Accepted Requests''' shows the number of times you have uploaded parts of this file in the current session and, in parentheses, the total number of times you have ever uploaded parts of this file (explained further in the [[Usage_Shared_Files#Files statistics|statistics]] section);
*'''Transferred Data''' shows the number of bytes you have uploaded for this file in the current session and, in brackets, the total number of bytes you have ever uploaded of this file (explained further in the [[Usage_Shared_Files#Files statistics|statistics]] section);
*'''Obtained Parts''' shows the parts that other clients are known to have, shown in blue; the darker the blue, the more people have them); the parts that no client is known to have appear in red;
*'''Complete Sources''' shows an estimation of the number of clients who have the whole file; and
*'''Directory Path''' shows the directory in which the shared file is located. If a file is currently being downloaded, it will display ''[PartFile]''

You may want to read about [[Usage General#Lists|using lists]].

=== Managing files ===

By selecting a file (or files) in the shared files list and right-clicking it (option-click on the Mac) you can perform operations on it.

http://www.amule.org/dev-up/window_sharefiles4.jpg

==== General ====

The following operations are available:
*'''Priority''' allows you to set a priority to the file;
*'''Add Comment/Rating''' allows you to set a comment and/or rating (described later in this article)
*'''Rename''' allows you to rename the file on your local system (described later);
*'''Get Razorback2's stats for this file''' opens a Razoback2's statistics page for that file on your web browser;
*'''Copy ED2k link to clipboard''' copies the file's [[ed2k link]] to the clipboard
*'''Copy ED2k link to clipboard (Source)''' copies the file's [[ed2k link]] to the clipboard, adding you as a source to the link, so that other [[client]]s who are downloading the file from that link will know you have that file from the very beginning and try to download it from you;
*'''Copy ED2k link to clipboard (Hostname)''' does the same as '''Copy ED2k link to clipboard (Source)''', but tries to resolve your hostname address instead of providing your IP (this option might be disabled if your hostname is not known); and
*'''Copy ED2k link to clipboard (AICH)''' copies the file's [[ed2k link]] to the clipboard and provides the [[AICH]] [[Root Hash]] in the link.

==== Add a comment/rate ====

Files can have [[comment]]s and/or [[rate]]s. This helps other clients to estimate the quality (e.g., the resolution) of a file before completing its download.

===== Comment =====

When adding a comment/rate, the following window will appear:

http://www.amule.org/dev-up/window_sharefiles5.jpg

In this window you can enter some useful text (comment) for other [[user]]s who are downloading the same file. This text should be strictly related to the file and should comprise no more than 50 characters.

http://www.amule.org/dev-up/window_sharefiles8.jpg

By clicking the '''Clear''' button the text (comment) box will be cleared so you can write a new comment. Changes will not apply until you click the '''Apply''' button or press the ENTER key in the keyboard.

http://www.amule.org/dev-up/window_sharefiles9.jpg

You can cancel your changes regarding the file's comment and/or rate by clicking '''Cancel'''.

http://www.amule.org/dev-up/window_sharefiles10.jpg

When a file has a comment, you will see a [[comment icon]] by its name.

===== Rate =====

[[Rate]]s allow other users to get a rough idea of the quality of a file. You can rate the file by selecting what you think about the file in the rate menu in the comment/rate window.

http://www.amule.org/dev-up/window_sharefiles11.jpg

You might want to read about [[rate|rate values]].

Changes will not apply until you click the '''Apply''' button or press the ENTER key in the keyboard, as it has been explained before. Again, you can cancel your changes regarding a comment and/or rating by clicking '''Cancel''', as above.

==== Rename ====

This allows you to rename the files on your storage device. When selecting to rename a file, the following window will appear:

http://www.amule.org/dev-up/window_sharefiles6.jpg

Here, you will need to enter in the text box your new name for the file (it will intially have the original filename); by clicking '''OK''' after entering the new name, it will be instantly changed.

http://www.amule.org/dev-up/window_sharefiles12.jpg

By clicking '''Cancel''' you will retain the existing name.

http://www.amule.org/dev-up/window_sharefiles13.jpg

=== Files statistics ===

Once you select a file, you can take a look at the statistics below:

http://www.amule.org/dev-up/window_sharefiles3.jpg

This statistics display information about the popularity of your files and how heavily they are requested.

==== Session statistics ====

To the left of the box are the values corresponding to the current session:

The first value displays the number of clients who have requested the selected file(s) in the current [[session]].

http://www.amule.org/dev-up/window_sharefiles14.jpg

The second value displays the number of clients to whom you are actively [[upload]]ing the selected file(s) during the current session.

http://www.amule.org/dev-up/window_sharefiles15.jpg

The third value displays the number of [[byte]] (or KB, or MB or TB) of the file(s) that have been uploaded during the current session.

http://www.amule.org/dev-up/window_sharefiles16.jpg

==== Session percentages ====

In the middle of the box you can see a graphical representation of the files corresponding percentage among the other files for the values in the current session:

The first bar shows which percentage of requests the selected file(s) have received in the current session.

http://www.amule.org/dev-up/window_sharefiles17.jpg

The second bar shows which percentage of the active uploads during the current session that have been uploading the selected file(s).

http://www.amule.org/dev-up/window_sharefiles18.jpg

The third bar shows which percentage of the bytes transfered during the current session correspond to the selected file(s).

http://www.amule.org/dev-up/window_sharefiles19.jpg

==== Total statistics ====

To the right of the box are the total statistics, that is, since aMule was installed (or since the last time its configuration was reset):

*The first value displays the number of clients who have requested the selected file(s).

http://www.amule.org/dev-up/window_sharefiles20.jpg

*The second value displays the number of clients to whom you have [[upload]]ed parts of the selected file(s).

http://www.amule.org/dev-up/window_sharefiles21.jpg

The third value displays the number of bytes (or KB, MB or TB) of the file(s) that have been uploaded.

http://www.amule.org/dev-up/window_sharefiles22.jpg

=== Reload files ===

You can reload the list of shared files when external changes occur (e.g., files in some shared directory change, a download file has been renamed, files have been moved, ...). To do this, just click on the button with two green arrows.

http://www.amule.org/dev-up/window_sharefiles7.jpg

== Overview ==

{|
|+ Shared Files window
|colspan=2| http://www.amule.org/dev-up/window_sharefiles23.jpg
|-
| '''Number''' || '''''Description'''''
|-
| 1 || ''Shared files list''
|-
| 2 || ''Shared file''
|-
| 3 || ''Reload shared files list''
|-
| 4 || ''File statistics''
|-
| 5 || ''Transfered bytes of selected file(s) in current session''
|-
| 6 || ''Times parts of the selected file(s) has been uploaded in current session''
|-
| 7 || ''Times the selected file(s) has been requested in current session''
|-
| 8 || ''Percentage of times the selected file(s) has been requested''
|-
| 9 || ''Percentage of times parts of the selected file(s) has been uploaded''
|-
| 10 || ''Percentage of transfered bytes of selected file(s)''
|-
| 11 || ''Transfered bytes of selected file(s) ever''
|-
| 12 || ''Times parts of the selected file(s) has been uploaded ever''
|-
| 13 || ''Times the selected file(s) has been requested ever''
|}

{|
|+ Add friend window
|colspan=2| http://www.amule.org/dev-up/window_sharefiles24.jpg
|-
| '''Number''' || '''''Description'''''
|-
| 1 || ''Rate file quality''
|-
| 2 || ''Comment on the file''
|-
| 3 || ''Apply changes''
|-
| 4 || ''Clear comment box''
|-
| 5 || ''Close the window ignoring changes''
|}

{|
|+ Add friend window
|colspan=2| http://www.amule.org/dev-up/window_sharefiles25.jpg
|-
| '''Number''' || '''''Description'''''
|-
| 1 || ''New file name''
|-
| 2 || ''Cancel changes and close window''
|-
| 3 || ''Rename file''
|}

{|
|+ Add friend window
|colspan=2| http://www.amule.org/dev-up/window_sharefiles26.jpg
|-
| '''Number''' || '''''Description'''''
|-
| 1 || ''Set file(s) upload priority''
|-
| 2 || ''Add comment and/or rating to the file''
|-
| 3 || ''Rename file''
|-
| 4 || ''Get statistics from razorback2 about file''
|-
| 5 || ''Copy file's ed2k link to clipboard''
|-
| 6 || ''Copy file's ed2k link to clipboard with source''
|-
| 7 || ''Copy file's ed2k link to clipboard with hostname (might not be available)''
|-
| 8 || ''Copy file's ed2k link to clipboard with AICH root hash''
|}

<center>[[Usage aMule|Back to Index]]</center>

FAQ network

2005-12-28T23:34:24Z

203.217.79.88: Copy-edit down to 'Example'.

= Network speed: what you should know before asking questions =
by Froenchenko Leonid, lfroen@gmail.com

== Preface ==
The purpose of this document is to clarify issues regarding network
speed that arise from time to time in the [[aMule]] [[forum]]. Generally speaking, there are several reasons for questions about "[[FAQ_ed2k|aMule network]]":

* the speed reported by [[aMule]] doesn't match your provider's given rate;
* poor performance of [[aMule]] itself or another network application on the same computer; or
* the key factors influencing network performance while [[aMule]] is running.

The intended audience for this document is users who want to gain a better understanding of network functionality in general, and, in particular, its implications for [[aMule]] functionality.

However, this page is not a comprehensive, general purpose "[[FAQ_ed2k|Network FAQ]]". If you were expecting something else, you might be interested in the [[aMule is slow|aMule is slow FAQ]].

== Network speed - how fast is it? ==
When talking about network speed, people use the unit "bps", which means
"bits per second". The reason that a ''bit'' is used rather than a ''byte'' is mostly historical, but also arises from the engineering behind the system, specifically, the fact that not all networks in the world transfer their traffic in bytes.

There is a convention to use a capital "B" in "Bps" when speed is marked
in "bytes per second". However, this convention is not widely accepted. In particular, organizations like the [http://www.ietf.org/ IETF] and [http://www.ieee.org/ IEEE] have stuck to the original "bps".

== Prefixes ==
Since their invention, networks have made a lot of progress. Today we have networks that transfer billions of bits per second. For measuring these speeds, we use prefixes such as ''"kilo"'', ''"mega"'', ''"giga"'', ''"tera"''.

It is a common mistake to think that values with those prefixes are the same as in computer science, i.e., powers of 2. The truth is that, for historical reasons, prefixes in networking have a decimal, not a binary base.

{| cellpadding="2" cellspacing="2" border="1" width="100%" title="Table 1"
| valign="middle" title="Table 1" align="center" bgcolor="#33ff33" | Prefix
| valign="middle" align="center" bgcolor="#33ff33" | meaning in computers
| valign="middle" title="Table 1" align="center" bgcolor="#33ff33" | meaning in networks
| valign="middle" align="center" bgcolor="#33ff33" | difference, %%
|-
| valign="top" | k (kilo)
| valign="top" | 2^10 = 1024
| valign="top" | 10^3 = 1000
| valign="top" | 2%
|-
| valign="top" | M (mega)
| valign="top" | 2^20 = 1,048,576
| valign="top" | 10^6 = 1,000,000
| valign="top" | 5%
|-
| valign="top" | G (giga)
| valign="top" | 2^30 = 1,073,741,624
| valign="top" | 10^9 = 1,000,000,000
| valign="top" | 7%
|-
| valign="top" | T (tera)
| valign="top" | 2^40 = 1,099,511,627,776
| valign="top" | 10^12 = 1,000,000,000,000
| valign="top" | 9%
|}

As you can see from the table above, the error in calculation is about 5% when the prefix is incorrectly interpreted. Please note that the speed your provider quotes you is the "speed in network units"; i.e., calculated on a decimal basis. For example when your provider tells you that your link is "ADSL 256/128", they mean 256000/128000 bps (bits per second). This means that the speed of your connection is 32000/16000 bps (bytes per second), since there are eight bits to a byte.

== Protocol overhead - what is it about? ==
When [[aMule]] is running, it constantly "talks" with other [[client]]s and [[server]]s.
This data exchange is needed to perform such tasks as identifying itself, requesting information about
available [[FAQ_eD2k-Kademlia#What_is_a_source?|source]]s and [[file]]s, and performing [[search]]es.

Since this information has no direct use to the user itself, it is called "overhead"; i.e., a necessary addition to the data you want to [[upload]] or [[download]].

[[aMule]] calls this "''connection overhead''". However the number that [[aMule]] presents includes only the size of the actual data that [[aMule]] itself sends to the network stack. Later, these data are sent out on the network with even more overhead - that of the network protocols.
How much is it? - let's see that in the next section.

== Network overhead ==
First of all - we're talking about the [[IPv4]] network. Once upon a time, there
was only one type of [[IP]] network. Now there are two - [[IPv4|IP version 4]], the old protocol that we all know; and [[IPv6|IP version 6]] - the new protocol made to fix the limitations of [[IPv4]].

[[FAQ ed2k|ED2K protocol]] by design, is unable to talk over [[IPv6]] network, so users who have it (in Japan and China for example) will not be able to connect "as is". Using [[IPv4]] means, that each packet ([http://www.ietf.org/rfc/rfc793.txt TCP], [http://www.ietf.org/rfc/rfc768.txt UDP], [http://www.ietf.org/rfc/rfc792.txt ICMP]) will have an [[IPv4]] header.

The minimum size of this header is 20 bytes. The header can have optional parts (each of 4 bytes) and that is up to your provider - for example, mine adds an optional [dword].

When talking to other clients and servers on [[FAQ ed2k|ed2k network]], [[aMule]] uses the widely known [http://www.ietf.org/rfc/rfc793.txt TCP] protocol. [http://www.ietf.org/rfc/rfc768.txt UDP] is also used, but on a much smaller scale. As you may already know, [http://www.ietf.org/rfc/rfc793.txt TCP] is a reliable protocol, i.e. it guarantees that data that is sent from one side will arrive on the other or an error will be reported.

To achieve this, [http://www.ietf.org/rfc/rfc793.txt TCP] sends its own data in addition to the actual "payload" data being transferred. These data include [http://www.ietf.org/rfc/rfc793.txt TCP] client initial negotiation, checksums, sequence numbers and acknowledgments. All of this is in the ''[http://www.ietf.org/rfc/rfc793.txt TCP] header'' that is added to each packet sent. The size of this header is a minimum of 20 bytes.

While being only a small overhead for a large bulk transfer, it can take significant part of bandwidth when small amounts of data are being exchanged. This is exactly what happens on [[FAQ_ed2k#What_is_a_source?|source]] discovery part of [[aMule]].

Our [[client]] is trying to establish a connection and negotiate with a large number of other [[client]]s. Doing this, [[aMule]] opens new [http://www.ietf.org/rfc/rfc793.txt TCP] connections ''all the time''. The number of connections opened is controlled by the ''"Maximum number of connections in 5 seconds"'' setting in the preferences.

A typical number is about 100. Each [http://www.ietf.org/rfc/rfc793.txt TCP] connection results in at least three packets traveling on the net - one is a SYN packet, i.e. connection request, and one an ACK or a RST when the connection is accepted or refused, and SYN+ACK to establish the session.

There's more overhead of [http://www.ietf.org/rfc/rfc1034.txt DNS] queries when an address is resolved, retries when a host doesn't reply and so on.

=== At low level ===
After passing [http://www.ietf.org/rfc/rfc793.txt TCP] and [[IP]] layers packets go down to the network interface driver. What kind of driver this is depends on the way your computer is connected to the internet. For the sake of simplicity, we will assume that this computer is connected to the ISP directly; i.e., that you have no LAN (or switch or router) between.

Common setups include:

* an analog modem, connected to a telephone line (ISDN modem falls in this category too);
* a cable modem, connected through ethernet, ISP gives you an [[IP]] address through [http://www.ietf.org/rfc/rfc2131.txt DHCP];
* a cable modem, connected through ethernet, ISP requires you to configure PPPoE or PPTP tunnel;
* an ADSL modem, connected through ethernet. You must have a PPPoE or PPTP tunnel;
* a variation on these, e.g., a modem connected to a computer via USB.

In each of the these setups there are different protocols in use, and different headers are added to transmitted packets. There's one important thing to note: ''ethernet frames travel between cable/ADSL modem and computer, and don't reach the ISP''. Consequently, they're not counted in rate calculations. [http://www.ietf.org/rfc/rfc2516.txt PPPoE]; in constrast,
[http://www.ietf.org/rfc/rfc2637.txt PPTP] headers ''do reach the ISP''. In this respect, your particular provider may or may not choose to include them in their rate calculations. For this reason, we have excluded those headers from our calculations.

If you think that your ISP includes it, add 4 bytes to the size of each packet.

=== Example ===
Let's see how much network overhead we have on a typical network. Our connection is a cable modem connected via an ethernet link to a PC directly (no router between them).

In this setup we have [[IPv4]] packets sent over ethernet.

Lets say we have 10 new connections opened each second, and all are being accepted (successfully established [http://www.ietf.org/rfc/rfc793.txt TCP] session). This alone sums up to (I'm counting data going up - from my computer to the net):

''10 connection * 2 packets * (20 bytes of TCP + 20 bytes of [[IPv4]]) = 800 bytes of overhead.''

This means that we are starting with 1.16*8 Kbps of "''invisible"''
overhead caused by the very way the network works. Now, let's assume that
after each connection is established our amule sends something to the other side and waits to receive an answer.

''Total of 800 bytes + 800 bytes = 1600 bytes per second = 6400 bps = 6.4 Kbps''

What we have here is 6.4 Kbps of network overhead alone. Taking into account
that amule has other data to send (uploads) and it is not the only network
application running we will have the following picture:

Most likely the link to your provider is not that fast. [[aMule]] will ''try'' to open 10 connections per second and will ''try'' to upload on the specified speed.

Your operating system will share all available bandwidth between those and between [[aMule]] and other network applications (browser for example). Actual results will vary depending on specific OS settings.

== ACK bottleneck ==
In all calculations above there was one assumption - zero download. But downloading is what amule was built for. So let's examine how the overhead
above affects your downloading speed. The answer is in [http://www.ietf.org/rfc/rfc793.txt TCP] protocol.

When [http://www.ietf.org/rfc/rfc793.txt TCP] is sending data, it requires that the other side acknowledge the reception. So if client A is sending data to [[client]] B by [http://www.ietf.org/rfc/rfc793.txt TCP], B has to send a special ACK packets to A which tells B "ok, I got it". If, however, A doesn't receive the ACK packets in time, he will assume that either packet is lost.

So, without going deeply into [http://www.ietf.org/rfc/rfc793.txt TCP] specification: ''if B fails to send ACK to A, as a result A will transmit slower''.

Now let's see the situation in [[aMule]]. We saw in the previous chapter, that the uplink stream is congested by connection requests and uploads. As a result, there's a good chance that ACK packets for a file we are downloading ''will not be sent on time''.

The remote party will notice this and slow down. This is one more reason why the upstream should better not be too congested.

== Is there anything I can do? ==
OK, now that you understood why your network is so slow while [[aMule]] is
running you will maybe look for a way to fix this. The answer in 2 words: "rate limit".

The first thing you should do is to assign realistic rate limits in [[aMule]]
itself. If you have a uplink rate of 128 Kbps don't set [[aMule]]'s [[upload]] limit to 16 (kilobytes per second) just because 128/8 = 16.

A better, but far more complicated solution is to use the QoS and packet scheduling services of your OS. For example, you can give a higher priority to ACK packets to solve the above mentioned "ACK bottleneck" problem.

The QoS topic, however, is beyond the scope of this article.

== Router (switch, home network): is there any difference? ==
When the cable coming from your ISP is connected to some switching or routing
device, which in turn is connected to several PC's, bandwidth is shared between
them.

So, having N computers connected, an ideal device would simply provide
each one of them with 1/N of the total bandwidth. The situation may vary in real life, and your particular device may have different idea about fairness.

Since you're not going to have the hardware specs of your router chipset the only advice here is "try and see yourself".

== Multiple links ==
Until now, we talked about computers that are connected to the network through
single interface. While being most frequent, this is not mandatory. A user
may choose to connect via 2 (or more links) provided by different ISP's.
There're 2 reasons for this decision that I know about: link redundancy and
load balancing.

=== Link redundancy ===
In a case of link redundancy second link becomes operational when primary
link fails. This can be done automatically, or by explicit user command.
When this setup used, [[aMule]] along with other network applications must be
restarted when links are being switched. This will allow to bind new address,
reconnect to server and receive new ID. If [[aMule]] is connected via  [http://www.ietf.org/rfc/rfc3022.txt NAT]]
enabled router (it doesn't matter if you have [[FAQ_ed2k#What_is_LowID_and_HighID?|low or high ID]]), and links
are switched ''on the router'', restart not needed.

=== Load balancing ===
This is a far more complicated case. Both (all) links are simultaneously active,
and traffic is being distributed between them. The problem is that [[aMule]]
binds to ''all interfaces on the system'' i.e. 0.0.0.0. But, on [[FAQ ed2k|ed2k]]
your ID is your [[IP]] address, ''and you can not have two''. 
So the problem is that [[aMule]] does not explicitly choose the source
address for ''outgoing'' [http://www.ietf.org/rfc/rfc793.txt TCP] connections. Note, that it ''doesn't
matter'' on which interface it listens. This is exactly ''opposite''
to ''server'' applications like FTP or HTTP. When a client
tries to connect to a server it discovers its IP address by resolving DNS. Resolver
replies will contain all [[IP]] addresses of the specified host and a client should try them all. The server, in turn, may choose not to listen on
one of them and thus prevent the client from using this interface. In our case
[[aMule]] ''is a [[client]]'', and the [[server|ed2k server]] discovers its address from the
[[FAQ_ed2k#What_is_a_source?|source]] [[IP]] in the connection request. That's where the [[server|ed2k server]] will try to connect.
If the connection succeeds the client is [[client]] assigned a [[FAQ_ed2k#What_is_LowID_and_HighID?|high ID]], if it doesn't the client gets a Low ID.
The only solution in this situation (until [[aMule]] will have an ability to
bind to specific address) is to use [[aMule]] on your "primary" link. 
You can, however, cause [http://www.kernel.org Linux] to send packet through interface of your choice.
But, most probably they will be dropped by your ISP's router as "spoofed" because the source [[IP]] address doesn't match the address the ISP assigned to that interface.