Go to file
Tatsuhiro Tsujikawa 8b8325cafc * src/PeerChokeCommand.cc
(optUnchokingPeer): Updated according to the changes in Peer.
	(ResetDelta): Removed.
	(UploadFaster): Updated according to the changes in Peer.
	(DownloadFaster): Updated according to the changes in Peer.
	(execute): I clarify the meaning of "upload" and "download" 
here.
	"upload" means the transfer from localhost to remote host.
	"download" means the transfer from remote host to localhost.
	Based on this rule, I swapped orderByUploadRate and
	orderByDownloadRate.

	* src/PeerInteractionCommand.cc
	(PeerInteraction): Removed peerInteraction->setUploadLImit().
	(executeInternal): Removed the argument of
	peerInteraction->sendMessages().
	(receiveMessages): Rewritten download speed limit.
	(sendKeepAlive): Removed peerInteraction->sendMessages().

	* src/HttpResponseCommand.cc
	(handleDefaultEncoding): If file size is unknown in torrent 
request,
	do not call segmentMan->initBitfield() here.
	Disabled persistent connection feature in torrent request.

	* src/UrlRequestInfo.h
	(UrlRequestInfo): Removed const qualifier from option.

	* src/TorrentMan.h
	(TransferStat): New class.
	(deltaDownloadLength): Removed.
	(deltaUploadLength): Removed.
	(addDeltaDownloadLength): Removed.
	(getDeltaDownloadLength): Removed.
	(resetDeltaDownloadLength): Removed.
	(addDeltaUploadLength): Removed.
	(getDeltaUploadLength): Removed.
	(resetDeltaUploadLength): Removed.
	(addActivePeer): Added peer->activate().
	(deleteActivePeer): Added peer->deactivate().
	(calculateStat): New function.
	* src/TorrentMan.cc
	(TorrentMan): Removed deltaDownloadLength and deltaUploadLength.
	(calculateStat): New function.

	* src/PeerInteraction.h
	(uploadLimit): Removed.
	(option): New variable.
	(setUploadLimit): Removed.
	(getUploadSpeed): Removed.
	(sendMessages): Removed the argument "currentUploadSpeed".
	* src/PeerInteraction.cc
	(prefs.h): Included.
	(PeerInteraction): Removed uploadLimit. Added option.
	(sendMessages): Rewritten upload speed limit.
	(sendHandshake): Removed the argument from sendMessages().
	(sendBitfield): Removed the argument from sendMessages().

	* src/PeerAbstractCommand.cc
	(execute): Commented out the portion of upload limit.
	(onAbort): Removed peer->resetStatus().

	* src/TorrentRequestInfo.cc
	(timeoutSpecified): Declared extern.
	(execute): Set timeout to 180 if timeout is not specified by.
	command-line.

	* src/PieceMessage.cc
	(receivedAction): Added peer->updateDownloadLength().
	Removed peer->addPeerUpload().
	Removed torrentMan->addDeltaDownloadLength().
	(send): Added peer->updateUploadLength().
	Removed peer->addPeerDownload().
	Removed torrentMan->addDeltaUploadLength().

	* src/main.cc
	(timeoutSpecified): New variable.
	(main): Set timeoutSpecified to false.
	If the command-line option "--upload-limit" is specified, then
	timeoutSpecified is set to true. This option will remain in the 
next
	release, but be deprecated in the future release.

	* src/TorrentRequestInfo.h
	(TorrentRequestInfo): Removed const qualifier from op.

	* src/PeerStat.h
	(uploadSpeed): New variable.
	(PeerStat): Added default value to cuid.
	(calculateUploadSpeed): New function.
	(updateUploadLength): New function.
	(getMaxUploadSpeed): New function.
	(getAvgUploadSpeed): New function.
	(reset): Added uploadSpeed. Set status to IDLE.

	* src/TorrentDownloadEngine.h
	(cp): Declared as Time.
	(sessionDownloadLengthArray): Removed.
	(sessionUploadLengthArray): Removed.
	(currentCp): Removed.
	(lastCalcStat): New variable
	(lastElapsed): Removed.
	(sessionDownloadLength): Removed.
	(calculateStat): New function.
	* src/TorrentDownloadEngine.cc
	(initStatistics): Removed lastElapsed, cp[],
	sessionDownloadLengthArray[], sessionUploadLengthArray[],
	currentCp, sessionDownloadLength.
	Added cp.reset() and lastCalcStat.reset().
	(calculateSpeed): Changed the name of the argument.
	(calculateStatistics): Rewritten.
	(calculateStat): New function.

	* src/Peer.h
	(PeerStat.h): Included.
	(peerUpload): Removed.
	(peerDownload): Removed.
	(peerStat): New variable.
	(sessionUploadLength): New variable.
	(sessionDownloadLength): New variable.
	(deltaUpload): Removed.
	(deltaDownload): Removed.
	(resetStatus): Made private.
	(Peer): Added sessionUploadLength, sessionDownloadLength.
	Removed peerUpload, peerDownload.
	(updateUploadLength): New function.
	(addDeltaUpload): Removed.
	(updateDownloadLength): New function.
	(resetDeltaUpload): Removed.
	(getDeltaUpload): Removed.
	(addDeltaDownload): Removed.
	(calculateUploadSpeed): New function.
	(resetDeltaDownload): Removed.
	(getDeltaDownload): Removed.
	(calculateDownloadSpeed): New function.
	(getSessionUploadLength): New function.
	(getSessionDownloadLength): New function.
	(activate): New function.
	(deactivate): New function.
	(addPeerUpload): Removed.
	(setPeerUpload): Removed.
	(getPeerUpload): Removed.
	(addPeerDownload): Removed.
	(setPeerDownload): Removed.
	(getPeerDownload): Removed.
	
	* src/Peer.cc
	(resetStatus): Removed resetDeltaUpload() and 
resetDeltaDownload().
	
	* src/MetalinkRequestInfo.h
	(MetalinkRequestInfo): Removed const qualifier from op.

	* src/RequestInfo.h
	(op): Removed const qualifier.
	(RequestInfo): Removed const qualifier from op.
2006-09-21 13:49:06 +00:00
intl Added intl/* 2006-03-07 13:08:09 +00:00
lib * DownloadEngine.{h, cc}: 2006-03-02 10:43:00 +00:00
m4 Added m4/libcares.m4 2006-08-21 13:54:15 +00:00
po 2006-09-21 Tatsuhiro Tsujikawa <tujikawa at rednoah dot com> 2006-09-21 06:56:54 +00:00
src * src/PeerChokeCommand.cc 2006-09-21 13:49:06 +00:00
test 2006-09-19 Tatsuhiro Tsujikawa <tujikawa at rednoah dot com> 2006-09-19 14:52:59 +00:00
ABOUT-NLS * DownloadEngine.{h, cc}: 2006-03-02 10:43:00 +00:00
AUTHORS Initial import 2006-02-17 13:35:04 +00:00
COPYING Initial import 2006-02-17 13:35:04 +00:00
ChangeLog * src/PeerChokeCommand.cc 2006-09-21 13:49:06 +00:00
INSTALL Initial import 2006-02-17 13:35:04 +00:00
Makefile.am Added intl/* 2006-03-07 13:08:09 +00:00
Makefile.in 2006-08-21 Tatsuhiro Tsujikawa <tujikawa at rednoah dot com> 2006-08-21 13:18:51 +00:00
NEWS Initial import 2006-02-17 13:35:04 +00:00
README 2006-08-21 14:36:20 +00:00
TODO * src/PeerChokeCommand.cc 2006-09-21 13:49:06 +00:00
aclocal.m4 2006-08-21 Tatsuhiro Tsujikawa <tujikawa at rednoah dot com> 2006-08-21 13:18:51 +00:00
config.guess Initial import 2006-02-17 13:35:04 +00:00
config.h.in 2006-08-21 Tatsuhiro Tsujikawa <tujikawa at rednoah dot com> 2006-08-21 13:18:51 +00:00
config.rpath * DownloadEngine.{h, cc}: 2006-03-02 10:43:00 +00:00
config.sub Initial import 2006-02-17 13:35:04 +00:00
configure 2006-09-19 Tatsuhiro Tsujikawa <tujikawa at rednoah dot com> 2006-09-19 14:52:59 +00:00
configure.ac 2006-09-19 Tatsuhiro Tsujikawa <tujikawa at rednoah dot com> 2006-09-19 14:52:59 +00:00
depcomp Initial import 2006-02-17 13:35:04 +00:00
install-sh Initial import 2006-02-17 13:35:04 +00:00
missing Initial import 2006-02-17 13:35:04 +00:00
mkinstalldirs * DownloadEngine.{h, cc}: 2006-03-02 10:43:00 +00:00
stamp-h Initial import 2006-02-17 13:35:04 +00:00
stamp-h.in Initial import 2006-02-17 13:35:04 +00:00

README

aria2 - The high speed download utility

1. Disclaimer
-------------
This program comes with no warranty.
You must use this program at your own risk.

2. About aria2
--------------
aria2 has segmented downloading engine in its core. By segmented downloading,
it can download files very much faster than ordinary browsers.

aria2 is in very early development stage. Currently it has following features:
* HTTP/HTTPS GET support
* HTTP Proxy support
* HTTP BASIC authentication support
* HTTP Proxy authentication support
* FTP support(active, passive mode)
* FTP through HTTP proxy(GET command or tunneling)
* Segmented download
* Cookie support(currently aria2 ignores "expires")
* It can run as a daemon process.
* BitTorrent protocol support with fast extension.
* Selective download in multi-file torrent
* Metalink version 3.0 support(HTTP/FTP/BitTorrent).

3. How to build
---------------
$ ./configure
$ make

The executable is aria2c in src directory.

4. Dependency
-------------
In order to enable HTTPS support, you need GNU TLS or OpenSSL.
In order to enable BitTorrent support, you need GNU TLS+libgcrypt or OpenSSL.
In order to enable Metalink support, you need libxml2. Optionally GNU TLS+
libgcrypt or OpenSSL are required for checksum checking support(MD5, SHA1).

GNU TLS has precedence over OpenSSL if both libraries are installed.
If you prefer OpenSSL, run configure with "--without-gnutls".

You can disable BitTorrent, Metalink support by providing --disable-bittorrent,
--disable-metalink respectively to configure script.

In order to enable async DNS support, you need c-ares or ares.
c-ares: http://daniel.haxx.se/projects/c-ares/
ares: ftp://athena-dist.mit.edu/pub/ATHENA/ares

5. BitTorrrent
--------------
The filename of the downloaded file is determined as follows:

single-file mode:
    If "name" key is present in .torrent file, filename is the value of "name"
    key. Otherwise, filename is the basename of .torrent file appended by
    ".file". For example, .torrent file is "test.torrrent", then filename is
    "test.torrent.file".
    The directory to store the downloaded file can be specified by -d option.
multi-file mode:
    The complete directory/file structure mentioned in .torrent file is
    created.
    The directory to store the top directory of downloaded files can be
    specified by -d option.

In the default behavior, before download starts, complete directory structure
is created if needed. Then aria2 opens all files mentioned in .torrent file,
directly writes to and reads from these files.
NOTE: Even in selective download, all files are opened.

If "--direct-file-mapping" option set to be false, aria2 creates temporary
file in the store directory. The length of this file is the sum of length of
the files in .torrent file, so at least 2 times more disk space than the file
size itself is required. Writing and reading is done against this file.
After download completes, aria2 creates complete directory structure if needed,
and copies whole file or a part of it to the destination.

Note:
*  -o option is used to change the filename of downloaded .torrent file.
* This version only supports compact peers list format.
* The ports aria2c uses are 6881-6999.
* The maximum number of peers is 55.
* After selective download completes, aria2 is going to download rest of the
files.

6. Metalink
-----------
The current implementation supports HTTP/FTP/BitTorrent.
BitTorrent always has precedence over HTTP/FTP.
The other P2P protocols are ignored.

For checksum checking, both MD5 and SHA1 are supported. If both values are
provided, then aria2 uses SHA1. If checksum checking is failed, aria2 doesn't
retry the download and just exits with non-zero return code.

The supported user preferences are version, language and os.