~ubuntu-branches/ubuntu/quantal/aria2/quantal

Viewing changes to doc/aria2c.1

Committer: Bazaar Package Importer
Author(s): Kartik Mistry
Date: 2010-11-24 12:26:31 UTC
mfrom: (1.6.1 upstream) (2.3.8 experimental)
Revision ID: james.westby@ubuntu.com-20101124122631-upujekj1ek94h3x2

Tags: 1.10.6-1

http://bugs.debian.org/590257

http://bugs.debian.org/448390

* New upstream release:
  + Fixed FTBFS on alpha arch (Closes: #590257)
  + Added IPv6 support (Closes: #448390)
* debian/patches/ftbfs_kfreebsd.diff:
  + Dropped, merged upstream

files added:
m4/fallocate.m4

src/ChunkedDecodingStreamFilter.cc

src/ChunkedDecodingStreamFilter.h

src/DHTTaskExecutor.cc

src/DHTTaskExecutor.h

src/GZipDecodingStreamFilter.cc

src/GZipDecodingStreamFilter.h

src/NullSinkStreamFilter.cc

src/NullSinkStreamFilter.h

src/SinkStreamFilter.cc

src/SinkStreamFilter.h

src/StreamFilter.cc

src/StreamFilter.h

src/Triplet.h

src/XmlRpcRequest.cc

src/cookie_helper.cc

src/cookie_helper.h

src/uri.cc

src/uri.h

test/ChunkedDecodingStreamFilterTest.cc

test/CookieHelperTest.cc

test/DHTTaskExecutorTest.cc

test/GZipDecodingStreamFilterTest.cc

test/MockSegment.h

test/TripletTest.cc

test/UriTest.cc

files removed:
.pc

.pc/.version

.pc/applied-patches

.pc/ftbfs_kfreebsd.diff

.pc/ftbfs_kfreebsd.diff/ChangeLog

.pc/ftbfs_kfreebsd.diff/configure

.pc/ftbfs_kfreebsd.diff/configure.ac

debian/patches

debian/patches/ftbfs_kfreebsd.diff

debian/patches/series

src/ChunkedDecoder.cc

src/ChunkedDecoder.h

src/CookieParser.cc

src/CookieParser.h

test/ChunkedDecoderTest.cc

test/CookieParserTest.cc

files modified:
ChangeLog

Makefile.in

NEWS

README

README.html

aclocal.m4

config.guess

config.h.in

config.sub

configure

configure.ac

debian/changelog

doc/Makefile.in

doc/aria2c.1

doc/aria2c.1.html

doc/xmlrpc/aria2rpc

lib/Makefile.in

m4/libcares.m4

m4/openssl.m4

po/aria2.pot

po/bg.gmo

po/bg.po

po/ca.gmo

po/ca.po

po/da.gmo

po/da.po

po/de.gmo

po/de.po

po/el.gmo

po/el.po

po/en@boldquot.gmo

po/en@boldquot.po

po/en@quot.gmo

po/en@quot.po

po/es.gmo

po/es.po

po/fi.gmo

po/fi.po

po/fr.gmo

po/fr.po

po/he.gmo

po/he.po

po/hu.gmo

po/hu.po

po/id.gmo

po/id.po

po/it.gmo

po/it.po

po/ja.gmo

po/ja.po

po/ko.gmo

po/ko.po

po/nl.gmo

po/nl.po

po/nn.gmo

po/nn.po

po/pl.gmo

po/pl.po

po/pt.gmo

po/pt.po

po/pt_BR.gmo

po/pt_BR.po

po/ru.gmo

po/ru.po

po/sk.gmo

po/sk.po

po/sr.gmo

po/sr.po

po/sv.gmo

po/sv.po

po/th.gmo

po/th.po

po/tr.gmo

po/tr.po

po/uk.gmo

po/uk.po

po/vi.gmo

po/vi.po

po/zh_CN.gmo

po/zh_CN.po

po/zh_TW.gmo

po/zh_TW.po

src/A2STR.h

src/ARC4Decryptor.h

src/ARC4Encryptor.h

src/AbstractAuthResolver.h

src/AbstractBtMessage.h

src/AbstractCommand.cc

src/AbstractCommand.h

src/AbstractDiskWriter.cc

src/AbstractDiskWriter.h

src/AbstractProxyRequestCommand.cc

src/AbstractProxyRequestCommand.h

src/AbstractProxyResponseCommand.h

src/AbstractSingleDiskAdaptor.h

src/ActivePeerConnectionCommand.h

src/AdaptiveFileAllocationIterator.cc

src/AdaptiveFileAllocationIterator.h

src/AdaptiveURISelector.cc

src/AdaptiveURISelector.h

src/AlphaNumberDecorator.h

src/AnnounceList.cc

src/AnnounceList.h

src/AnnounceTier.h

src/AsyncNameResolver.cc

src/AsyncNameResolver.h

src/AuthConfig.h

src/AuthConfigFactory.h

src/AuthResolver.h

src/AutoSaveCommand.h

src/BNode.h

src/Base64.cc

src/Base64.h

src/BinaryStream.h

src/BitfieldMan.cc

src/BitfieldMan.h

src/BtAbortOutstandingRequestEvent.h

src/BtAllowedFastMessage.h

src/BtAnnounce.cc

src/BtAnnounce.h

src/BtBitfieldMessage.h

src/BtBitfieldMessageValidator.h

src/BtCancelMessage.h

src/BtCancelSendingPieceEvent.h

src/BtCheckIntegrityEntry.h

src/BtChokeMessage.h

src/BtChokingEvent.h

src/BtConstants.h

src/BtDependency.cc

src/BtDependency.h

src/BtExtendedMessage.h

src/BtFileAllocationEntry.h

src/BtHandshakeMessage.cc

src/BtHandshakeMessage.h

src/BtHandshakeMessageValidator.h

src/BtHaveAllMessage.h

src/BtHaveMessage.h

src/BtHaveNoneMessage.h

src/BtInteractive.h

src/BtInterestedMessage.h

src/BtKeepAliveMessage.h

src/BtLeecherStateChoke.cc

src/BtLeecherStateChoke.h

src/BtMessage.h

src/BtMessageDispatcher.h

src/BtMessageFactory.h

src/BtMessageReceiver.h

src/BtMessageValidator.h

src/BtNotInterestedMessage.h

src/BtPieceMessage.cc

src/BtPieceMessage.h

src/BtPieceMessageValidator.h

src/BtPortMessage.h

src/BtPostDownloadHandler.h

src/BtProgressInfoFile.h

src/BtRegistry.h

src/BtRejectMessage.h

src/BtRequestFactory.h

src/BtRequestMessage.h

src/BtRuntime.h

src/BtSeederStateChoke.cc

src/BtSeederStateChoke.h

src/BtSetup.cc

src/BtSetup.h

src/BtStopDownloadCommand.h

src/BtSuggestPieceMessage.h

src/BtUnchokeMessage.h

src/ByteArrayDiskWriter.h

src/ByteArrayDiskWriterFactory.h

src/CUIDCounter.h

src/CheckIntegrityCommand.h

src/CheckIntegrityDispatcherCommand.h

src/CheckIntegrityEntry.h

src/CheckIntegrityMan.h

src/Checksum.h

src/ChecksumCheckIntegrityEntry.cc

src/ChecksumCheckIntegrityEntry.h

src/ChunkChecksum.h

src/Command.h

src/ConsoleStatCalc.cc

src/ConsoleStatCalc.h

src/ContentTypeRequestGroupCriteria.cc

src/ContentTypeRequestGroupCriteria.h

src/Cookie.cc

src/Cookie.h

src/CookieStorage.cc

src/CookieStorage.h

src/CreateRequestCommand.h

src/DHKeyExchange.h

src/DHTAbstractMessage.h

src/DHTAbstractNodeLookupTask.h

src/DHTAbstractTask.h

src/DHTAnnouncePeerMessage.h

src/DHTAnnouncePeerReplyMessage.h

src/DHTAutoSaveCommand.cc

src/DHTAutoSaveCommand.h

src/DHTBucket.cc

src/DHTBucket.h

src/DHTBucketRefreshCommand.h

src/DHTBucketRefreshTask.h

src/DHTConnection.h

src/DHTConnectionImpl.cc

src/DHTConnectionImpl.h

src/DHTConstants.h

src/DHTEntryPointNameResolveCommand.cc

src/DHTEntryPointNameResolveCommand.h

src/DHTFindNodeMessage.h

src/DHTFindNodeReplyMessage.cc

src/DHTFindNodeReplyMessage.h

src/DHTGetPeersCommand.cc

src/DHTGetPeersCommand.h

src/DHTGetPeersMessage.cc

src/DHTGetPeersMessage.h

src/DHTGetPeersReplyMessage.cc

src/DHTGetPeersReplyMessage.h

src/DHTIDCloser.h

src/DHTInteractionCommand.h

src/DHTMessage.h

src/DHTMessageCallback.h

src/DHTMessageDispatcher.h

src/DHTMessageDispatcherImpl.h

src/DHTMessageEntry.h

src/DHTMessageFactory.h

src/DHTMessageFactoryImpl.cc

src/DHTMessageFactoryImpl.h

src/DHTMessageReceiver.h

src/DHTMessageTracker.cc

src/DHTMessageTracker.h

src/DHTMessageTrackerEntry.h

src/DHTNode.h

src/DHTNodeLookupEntry.h

src/DHTNodeLookupTask.h

src/DHTNodeLookupTaskCallback.h

src/DHTPeerAnnounceCommand.h

src/DHTPeerAnnounceEntry.cc

src/DHTPeerAnnounceEntry.h

src/DHTPeerAnnounceStorage.cc

src/DHTPeerAnnounceStorage.h

src/DHTPeerLookupTask.cc

src/DHTPeerLookupTask.h

src/DHTPeerLookupTaskCallback.h

src/DHTPingMessage.h

src/DHTPingReplyMessage.h

src/DHTPingReplyMessageCallback.h

src/DHTPingTask.h

src/DHTQueryMessage.h

src/DHTRegistry.cc

src/DHTRegistry.h

src/DHTReplaceNodeTask.cc

src/DHTReplaceNodeTask.h

src/DHTResponseMessage.h

src/DHTRoutingTable.h

src/DHTRoutingTableDeserializer.cc

src/DHTRoutingTableDeserializer.h

src/DHTRoutingTableSerializer.cc

src/DHTRoutingTableSerializer.h

src/DHTSetup.cc

src/DHTSetup.h

src/DHTTask.h

src/DHTTaskFactory.h

src/DHTTaskFactoryImpl.h

src/DHTTaskQueue.h

src/DHTTaskQueueImpl.cc

src/DHTTaskQueueImpl.h

src/DHTTokenTracker.cc

src/DHTTokenTracker.h

src/DHTTokenUpdateCommand.h

src/DHTUnknownMessage.h

src/DNSCache.h

src/Decoder.h

src/DefaultAuthResolver.h

src/DefaultBtAnnounce.cc

src/DefaultBtAnnounce.h

src/DefaultBtInteractive.cc

src/DefaultBtInteractive.h

src/DefaultBtMessageDispatcher.cc

src/DefaultBtMessageDispatcher.h

src/DefaultBtMessageFactory.h

src/DefaultBtMessageReceiver.h

src/DefaultBtProgressInfoFile.cc

src/DefaultBtProgressInfoFile.h

src/DefaultBtRequestFactory.cc

src/DefaultBtRequestFactory.h

src/DefaultDiskWriter.h

src/DefaultDiskWriterFactory.h

src/DefaultExtensionMessageFactory.cc

src/DefaultExtensionMessageFactory.h

src/DefaultPeerStorage.cc

src/DefaultPeerStorage.h

src/DefaultPieceStorage.cc

src/DefaultPieceStorage.h

src/Dependency.h

src/DirectDiskAdaptor.h

src/DiskAdaptor.h

src/DiskWriter.h

src/DiskWriterFactory.h

src/DlAbortEx.cc

src/DlAbortEx.h

src/DlRetryEx.h

src/DownloadCommand.cc

src/DownloadCommand.h

src/DownloadContext.cc

src/DownloadContext.h

src/DownloadEngine.cc

src/DownloadEngine.h

src/DownloadEngineFactory.cc

src/DownloadEngineFactory.h

src/DownloadFailureException.h

src/DownloadHandler.h

src/DownloadHandlerConstants.h

src/DownloadHandlerFactory.h

src/DownloadResult.h

src/DownloadResultCode.h

src/EpollEventPoll.cc

src/EpollEventPoll.h

src/Event.h

src/EventPoll.h

src/Exception.cc

src/Exception.h

src/ExpatMetalinkProcessor.cc

src/ExpatMetalinkProcessor.h

src/ExpatXmlRpcRequestProcessor.cc

src/ExpatXmlRpcRequestProcessor.h

src/ExtensionMessage.h

src/ExtensionMessageFactory.h

src/ExtensionMessageRegistry.h

src/FallocFileAllocationIterator.h

src/FatalException.h

src/FeatureConfig.cc

src/FeatureConfig.h

src/FeedbackURISelector.cc

src/FeedbackURISelector.h

src/File.cc

src/File.h

src/FileAllocationCommand.cc

src/FileAllocationCommand.h

src/FileAllocationDispatcherCommand.h

src/FileAllocationEntry.h

src/FileAllocationIterator.h

src/FileAllocationMan.h

src/FileEntry.cc

src/FileEntry.h

src/FillRequestGroupCommand.cc

src/FillRequestGroupCommand.h

src/FixedWidthNumberDecorator.h

src/FtpConnection.cc

src/FtpConnection.h

src/FtpDownloadCommand.h

src/FtpFinishDownloadCommand.cc

src/FtpFinishDownloadCommand.h

src/FtpInitiateConnectionCommand.cc

src/FtpInitiateConnectionCommand.h

src/FtpNegotiationCommand.cc

src/FtpNegotiationCommand.h

src/FtpTunnelRequestCommand.h

src/FtpTunnelResponseCommand.h

src/GZipDecoder.h

src/GZipEncoder.cc

src/GZipEncoder.h

src/GrowSegment.h

src/HandshakeExtensionMessage.cc

src/HandshakeExtensionMessage.h

src/HaveEraseCommand.h

src/HttpConnection.cc

src/HttpConnection.h

src/HttpDownloadCommand.cc

src/HttpDownloadCommand.h

src/HttpHeader.cc

src/HttpHeader.h

src/HttpHeaderProcessor.h

src/HttpInitiateConnectionCommand.cc

src/HttpInitiateConnectionCommand.h

src/HttpListenCommand.cc

src/HttpListenCommand.h

src/HttpProxyRequestCommand.h

src/HttpProxyResponseCommand.h

src/HttpRequest.cc

src/HttpRequest.h

src/HttpRequestCommand.cc

src/HttpRequestCommand.h

src/HttpResponse.cc

src/HttpResponse.h

src/HttpResponseCommand.cc

src/HttpResponseCommand.h

src/HttpServer.cc

src/HttpServer.h

src/HttpServerBodyCommand.h

src/HttpServerCommand.h

src/HttpServerResponseCommand.h

src/HttpSkipResponseCommand.cc

src/HttpSkipResponseCommand.h

src/InOrderURISelector.h

src/IndexBtMessage.h

src/IndexBtMessageValidator.h

src/InitiateConnectionCommand.cc

src/InitiateConnectionCommand.h

src/InitiateConnectionCommandFactory.h

src/InitiatorMSEHandshakeCommand.cc

src/InitiatorMSEHandshakeCommand.h

src/IntSequence.h

src/IteratableChecksumValidator.h

src/IteratableChunkChecksumValidator.cc

src/IteratableChunkChecksumValidator.h

src/IteratableValidator.h

src/KqueueEventPoll.cc

src/KqueueEventPoll.h

src/LibgcryptARC4Context.h

src/LibgcryptARC4Decryptor.h

src/LibgcryptARC4Encryptor.h

src/LibgcryptDHKeyExchange.h

src/LibgnutlsTLSContext.h

src/LibsslARC4Context.h

src/LibsslARC4Decryptor.h

src/LibsslARC4Encryptor.h

src/LibsslDHKeyExchange.h

src/LibsslTLSContext.h

src/LogFactory.h

src/Logger.h

src/LongestSequencePieceSelector.cc

src/LongestSequencePieceSelector.h

src/LpdDispatchMessageCommand.cc

src/LpdDispatchMessageCommand.h

src/LpdMessage.h

src/LpdMessageDispatcher.h

src/LpdMessageReceiver.cc

src/LpdMessageReceiver.h

src/LpdReceiveMessageCommand.h

src/MSEHandshake.cc

src/MSEHandshake.h

src/Makefile.am

src/Makefile.in

src/MemoryBufferPreDownloadHandler.h

src/MessageDigestHelper.cc

src/MessageDigestHelper.h

src/MetadataInfo.h

src/Metalink2RequestGroup.cc

src/Metalink2RequestGroup.h

src/MetalinkEntry.cc

src/MetalinkEntry.h

src/MetalinkHelper.h

src/MetalinkMetaurl.h

src/MetalinkParserController.h

src/MetalinkParserState.h

src/MetalinkParserStateImpl.h

src/MetalinkParserStateMachine.h

src/MetalinkParserStateV3Impl.cc

src/MetalinkParserStateV3Impl.h

src/MetalinkParserStateV4Impl.cc

src/MetalinkParserStateV4Impl.h

src/MetalinkPostDownloadHandler.h

src/MetalinkProcessor.h

src/MetalinkResource.h

src/Metalinker.cc

src/Metalinker.h

src/MultiDiskAdaptor.cc

src/MultiDiskAdaptor.h

src/MultiFileAllocationIterator.h

src/MultiUrlRequestInfo.cc

src/MultiUrlRequestInfo.h

src/NameMatchOptionHandler.h

src/NameResolver.h

src/Netrc.cc

src/Netrc.h

src/NetrcAuthResolver.h

src/NsCookieParser.cc

src/NsCookieParser.h

src/NullProgressInfoFile.h

src/NullStatCalc.h

src/NumberDecorator.h

src/Option.cc

src/Option.h

src/OptionHandler.h

src/OptionHandlerException.h

src/OptionHandlerFactory.cc

src/OptionHandlerFactory.h

src/OptionHandlerImpl.h

src/OptionParser.cc

src/OptionParser.h

src/PStringBuildVisitor.h

src/PStringDatum.h

src/PStringNumLoop.h

src/PStringSegment.h

src/PStringSelect.h

src/PStringVisitor.h

src/ParameterizedStringParser.cc

src/ParameterizedStringParser.h

src/Peer.cc

src/Peer.h

src/PeerAbstractCommand.h

src/PeerAddrEntry.h

src/PeerChokeCommand.h

src/PeerConnection.cc

src/PeerConnection.h

src/PeerInitiateConnectionCommand.h

src/PeerInteractionCommand.cc

src/PeerInteractionCommand.h

src/PeerListenCommand.cc

src/PeerListenCommand.h

src/PeerReceiveHandshakeCommand.cc

src/PeerReceiveHandshakeCommand.h

src/PeerSessionResource.cc

src/PeerSessionResource.h

src/PeerStat.h

src/PeerStorage.h

src/Piece.h

src/PieceHashCheckIntegrityEntry.cc

src/PieceHashCheckIntegrityEntry.h

src/PieceSelector.h

src/PieceStatMan.cc

src/PieceStatMan.h

src/PieceStorage.h

src/PiecedSegment.h

src/Platform.cc

src/Platform.h

src/PollEventPoll.h

src/PortEventPoll.cc

src/PortEventPoll.h

src/PostDownloadHandler.h

src/PreDownloadHandler.h

src/PriorityPieceSelector.h

src/ProgressAwareEntry.h

src/ProtocolDetector.cc

src/ProtocolDetector.h

src/Randomizer.h

src/Range.h

src/RangeBtMessage.h

src/RangeBtMessageValidator.h

src/RarestPieceSelector.cc

src/RarestPieceSelector.h

src/RealtimeCommand.h

src/ReceiverMSEHandshakeCommand.cc

src/ReceiverMSEHandshakeCommand.h

src/RecoverableException.cc

src/RecoverableException.h

src/Request.cc

src/Request.h

src/RequestGroup.cc

src/RequestGroup.h

src/RequestGroupCriteria.h

src/RequestGroupEntry.cc

src/RequestGroupEntry.h

src/RequestGroupMan.cc

src/RequestGroupMan.h

src/RequestSlot.h

src/SeedCheckCommand.h

src/SeedCriteria.h

src/Segment.h

src/SegmentMan.cc

src/SegmentMan.h

src/SelectEventPoll.cc

src/SelectEventPoll.h

src/Sequence.h

src/SequentialDispatcherCommand.h

src/SequentialPicker.h

src/ServerStat.h

src/ServerStatMan.cc

src/ServerStatMan.h

src/SessionSerializer.cc

src/SessionSerializer.h

src/ShareRatioSeedCriteria.h

src/SharedHandle.h

src/Signature.h

src/SimpleBtMessage.h

src/SimpleLogFormatter.cc

src/SimpleRandomizer.h

src/SingleFileAllocationIterator.cc

src/SingleFileAllocationIterator.h

src/SingletonHolder.h

src/SleepCommand.h

src/Socket.h

src/SocketBuffer.cc

src/SocketBuffer.h

src/SocketCore.cc

src/SocketCore.h

src/SpeedCalc.cc

src/SpeedCalc.h

src/Sqlite3CookieParser.cc

src/Sqlite3CookieParser.h

src/Sqlite3CookieParserImpl.cc

src/StatCalc.h

src/StreamCheckIntegrityEntry.h

src/StreamFileAllocationEntry.cc

src/StreamFileAllocationEntry.h

src/StringFormat.cc

src/StringFormat.h

src/TLSContext.h

src/TimeA2.cc

src/TimeA2.h

src/TimeBasedCommand.h

src/TimeSeedCriteria.h

src/TimedHaltCommand.cc

src/TimedHaltCommand.h

src/TimerA2.h

src/TrackerWatcherCommand.cc

src/TrackerWatcherCommand.h

src/TransferStat.h

src/TrueRequestGroupCriteria.h

src/URIResult.h

src/URISelector.h

src/UTMetadataDataExtensionMessage.cc

src/UTMetadataDataExtensionMessage.h

src/UTMetadataExtensionMessage.h

src/UTMetadataPostDownloadHandler.cc

src/UTMetadataPostDownloadHandler.h

src/UTMetadataRejectExtensionMessage.h

src/UTMetadataRequestExtensionMessage.cc

src/UTMetadataRequestExtensionMessage.h

src/UTMetadataRequestFactory.cc

src/UTMetadataRequestFactory.h

src/UTMetadataRequestTracker.h

src/UTPexExtensionMessage.cc

src/UTPexExtensionMessage.h

src/UnionSeedCriteria.h

src/UnknownLengthPieceStorage.cc

src/UnknownLengthPieceStorage.h

src/UriListParser.cc

src/UriListParser.h

src/XML2SAXMetalinkProcessor.cc

src/XML2SAXMetalinkProcessor.h

src/XORCloser.h

src/Xml2XmlRpcRequestProcessor.cc

src/Xml2XmlRpcRequestProcessor.h

src/XmlRpcElements.h

src/XmlRpcMethod.cc

src/XmlRpcMethod.h

src/XmlRpcMethodFactory.h

src/XmlRpcMethodImpl.cc

src/XmlRpcMethodImpl.h

src/XmlRpcRequest.h

src/XmlRpcRequestParserController.h

src/XmlRpcRequestParserState.h

src/XmlRpcRequestParserStateImpl.h

src/XmlRpcRequestParserStateMachine.h

src/XmlRpcRequestProcessor.h

src/XmlRpcResponse.cc

src/XmlRpcResponse.h

src/ZeroBtMessage.h

src/a2algo.h

src/a2functional.h

src/a2io.h

src/a2netcompat.h

src/a2time.h

src/array_fun.h

src/base32.cc

src/base32.h

src/bencode2.cc

src/bencode2.h

src/bitfield.h

src/bittorrent_helper.cc

src/bittorrent_helper.h

src/clock_gettime_mingw.h

src/clock_gettime_osx.h

src/common.h

src/daemon.h

src/download_helper.cc

src/download_helper.h

src/help_tags.h

src/magnet.cc

src/magnet.h

src/main.cc

src/message.h

src/messageDigest.cc

src/messageDigest.h

src/option_processing.cc

src/prefs.cc

src/prefs.h

src/timegm.h

src/timespec.h

src/usage_text.h

src/util.cc

src/util.h

src/version_usage.cc

test/AnnounceListTest.cc

test/AuthConfigFactoryTest.cc

test/BittorrentHelperTest.cc

test/BtRegistryTest.cc

test/CookieStorageTest.cc

test/CookieTest.cc

test/DHTBucketTest.cc

test/DHTConnectionImplTest.cc

test/DHTFindNodeReplyMessageTest.cc

test/DHTGetPeersMessageTest.cc

test/DHTGetPeersReplyMessageTest.cc

test/DHTMessageFactoryImplTest.cc

test/DHTRoutingTableDeserializerTest.cc

test/DHTRoutingTableSerializerTest.cc

test/DHTRoutingTableTest.cc

test/DefaultBtAnnounceTest.cc

test/DefaultBtProgressInfoFileTest.cc

test/DefaultExtensionMessageFactoryTest.cc

test/DefaultPeerStorageTest.cc

test/DefaultPieceStorageTest.cc

test/DownloadHelperTest.cc

test/FeatureConfigTest.cc

test/FileEntryTest.cc

test/FileTest.cc

test/FixedNumberRandomizer.h

test/FtpConnectionTest.cc

test/HttpHeaderTest.cc

test/HttpRequestTest.cc

test/HttpResponseTest.cc

test/InOrderPieceSelector.h

test/LpdMessageDispatcherTest.cc

test/MSEHandshakeTest.cc

test/MagnetTest.cc

test/Makefile.am

test/Makefile.in

test/Metalink2RequestGroupTest.cc

test/MockBtAnnounce.h

test/MockBtMessage.h

test/MockBtMessageDispatcher.h

test/MockBtMessageFactory.h

test/MockBtProgressInfoFile.h

test/MockBtRequestFactory.h

test/MockDHTMessage.h

test/MockDHTMessageCallback.h

test/MockDHTMessageDispatcher.h

test/MockDHTMessageFactory.h

test/MockDHTTask.h

test/MockDHTTaskFactory.h

test/MockDHTTaskQueue.h

test/MockExtensionMessage.h

test/MockExtensionMessageFactory.h

test/MockPeerStorage.h

test/MockPieceSelector.h

test/MockPieceStorage.h

test/NetrcTest.cc

test/NsCookieParserTest.cc

test/OptionHandlerTest.cc

test/RequestTest.cc

test/Sqlite3CookieParserTest.cc

test/TestUtil.cc

test/TestUtil.h

test/TimeTest.cc

test/UTMetadataPostDownloadHandlerTest.cc

test/UTMetadataRequestFactoryTest.cc

test/UTPexExtensionMessageTest.cc

test/UriListParserTest.cc

test/UtilTest.cc

test/XmlRpcMethodTest.cc

test/a2functionalTest.cc

test/array_funTest.cc

test/chromium_cookies.sqlite

test/cookies.sqlite

test/extension_message_test_helper.h

test/nscookietest.txt

Show diffs side-by-side

added added

removed removed

doc/aria2c.1

.\" Title: aria2c

.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]

.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>

.\" Date: 07/19/2010

.\" Date: 10/31/2010

.\" Manual: Aria2 Manual

.\" Source: Aria2 1.10.0

.\" Source: Aria2 1.10.6

.\" Language: English

.\"

.TH "ARIA2C" "1" "07/19/2010" "Aria2 1\&.10\&.0" "Aria2 Manual"

.TH "ARIA2C" "1" "10/31/2010" "Aria2 1\&.10\&.6" "Aria2 Manual"

.\" -----------------------------------------------------------------

.\" * Define some portability stuff

.\" -----------------------------------------------------------------

.PP

\fB\-V\fR, \fB\-\-check\-integrity\fR[=\fItrue\fR|\fIfalse\fR]

.RS 4

Check file integrity by validating piece hashes\&. This option has effect only in BitTorrent and Metalink downloads with chunk checksums\&. Use this option to re\-download a damaged portion of a file\&. Default:

Check file integrity by validating piece hashes or a hash of entire file\&. This option has effect only in BitTorrent and Metalink downloads with checksums\&. If piece hashes are provided, this option can detect damaged portions of a file and re\-download them\&. If a hash of entire file is provided, hash check is only done when file has benn already download\&. This is determined by file length\&. If hash check fails, file is re\-downloaded from scratch\&. If both piece hashes and a hash of entire file are provided, only piece hashes are used\&. Default:

\fIfalse\fR

.RE

.PP

174

\fI0\fR

175

.RE

176

.PP

177

\fB\-x\fR, \fB\-\-max\-connection\-per\-server\fR=NUM

178

.RS 4

179

The maximum number of connections to one server for each download\&. Default:

180

\fI1\fR

181

.RE

182

.PP

177

183

\fB\-\-max\-file\-not\-found\fR=NUM

178

184

.RS 4

179

185

If aria2 receives \(oqfile not found\(cq status from the remote HTTP/FTP servers NUM times without getting a single byte, then force the download to fail\&. Specify

190

196

\fI5\fR

191

197

.RE

192

198

.PP

199

\fB\-k\fR, \fB\-\-min\-split\-size\fR=SIZE

200

.RS 4

201

aria2 does not split less than 2*SIZE byte range\&. For example, let\(cqs consider downloading 20MiB file\&. If SIZE is 10M, aria2 can split file into 2 range [0\-10MiB) and [10MiB\-20MiB) and download it using 2 sources(if

202

\fB\-\-split\fR

203

>= 2, of course)\&. If SIZE is 15M, since 2*15M > 20MiB, aria2 does not split file and download it using 1 source\&. You can append

204

\fIK\fR

205

206

\fIM\fR(1K = 1024, 1M = 1024K)\&. Possible Values:

207

\fI1M\fR\-\fI1024M\fR

208

Default:

209

\fI20M\fR

210

.RE

211

.PP

193

212

\fB\-n\fR, \fB\-\-no\-netrc\fR

194

213

.RS 4

195

214

Disables netrc support\&. netrc support is enabled by default\&.

258

277

\fIfalse\fR

259

278

.RE

260

279

.PP

261

*\-\-reuse\-uri[=\fItrue\fR|\fIfalse\fR]

280

\fB\-\-reuse\-uri\fR[=\fItrue\fR|\fIfalse\fR]

262

281

.RS 4

263

282

Reuse already used URIs if no unused URIs are left\&. Default:

264

283

\fItrue\fR

417

436

\fB\-\-http\-proxy\fR

418

437

option\&.

419

438

.RE

420

.sp

421

\fB\-\-http\-proxy\-user\fR=USER:

422

.sp

423

.if n \{\

439

.PP

440

\fB\-\-http\-proxy\-user\fR=USER

424

441

.RS 4

425

.\}

426

.nf

427

Set user for *\-\-http\-proxy* option\&.

428

.fi

429

.if n \{\

442

Set user for

443

\fB\-\-http\-proxy\fR

444

option\&.

430

445

.RE

431

.\}

432

446

.PP

433

447

\fB\-\-https\-proxy\fR=PROXY

434

448

.RS 4

474

488

Enable HTTP/1\&.1 pipelining\&. Default:

475

489

\fIfalse\fR

476

490

.RE

491

.if n \{\

492

.sp

493

.\}

494

.RS 4

495

.it 1 an-trap

496

.nr an-no-space-flag 1

497

.nr an-break-flag 1

498

.br

499

.ps +1

500

\fBNote\fR

501

.ps -1

502

.br

503

.sp

504

In performance perspective, there is usually no advantage to enable this option\&.

505

.sp .5v

506

.RE

477

507

.PP

478

508

\fB\-\-header\fR=HEADER

479

509

.RS 4

620

650

\fIfalse\fR

621

651

.RE

622

652

.PP

653

\fB\-\-bt\-exclude\-tracker\fR=URI[,\&...]

654

.RS 4

655

Comma separated list of BitTorrent tracker\(cqs announce URI to remove\&. You can use special value "*" which matches all URIs, thus removes all announce URIs\&. When specifying "*" in shell command\-line, don\(cqt forget to escape or quote it\&. See also

656

\fB\-\-bt\-tracker\fR

657

option\&.

658

.RE

659

.PP

623

660

\fB\-\-bt\-external\-ip\fR=IPADDRESS

624

661

.RS 4

625

662

Specify the external IP address to report to a BitTorrent tracker\&. Although this function is named "external", it can accept any kind of IP addresses\&. IPADDRESS must be a numeric IP address\&.

721

758

\fI0\fR

722

759

.RE

723

760

.PP

761

\fB\-\-bt\-tracker\fR=URI[,\&...]

762

.RS 4

763

Comma separated list of additional BitTorrent tracker\(cqs announce URI\&. These URIs are not affected by

764

\fB\-\-bt\-exclude\-tracker\fR

765

option because they are added after URIs in

766

\fB\-\-bt\-exclude\-tracker\fR

767

option are removed\&.

768

.RE

769

.PP

724

770

\fB\-\-bt\-tracker\-connect\-timeout\fR=SEC

725

771

.RS 4

726

772

Set the connect timeout in seconds to establish connection to tracker\&. After the connection is established, this option makes no effect and

745

791

.PP

746

792

\fB\-\-dht\-entry\-point\fR=HOST:PORT

747

793

.RS 4

748

Set host and port as an entry point to DHT network\&.

794

Set host and port as an entry point to IPv4 DHT network\&.

795

.RE

796

.PP

797

\fB\-\-dht\-entry\-point6\fR=HOST:PORT

798

.RS 4

799

Set host and port as an entry point to IPv6 DHT network\&.

749

800

.RE

750

801

.PP

751

802

\fB\-\-dht\-file\-path\fR=PATH

752

803

.RS 4

753

Change the DHT routing table file to PATH\&. Default:

804

Change the IPv4 DHT routing table file to PATH\&. Default:

754

805

\fI$HOME/\&.aria2/dht\&.dat\fR

755

806

.RE

756

807

.PP

808

\fB\-\-dht\-file\-path6\fR=PATH

809

.RS 4

810

Change the IPv6 DHT routing table file to PATH\&. Default:

811

\fI$HOME/\&.aria2/dht6\&.dat\fR

812

.RE

813

.PP

814

\fB\-\-dht\-listen\-addr6\fR=ADDR

815

.RS 4

816

Specify address to bind socket for IPv6 DHT\&. It should be a global unicast IPv6 address of the host\&.

817

.RE

818

.PP

757

819

\fB\-\-dht\-listen\-port\fR=PORT\&...

758

820

.RS 4

759

Set UDP listening port for DHT\&. Multiple ports can be specified by using ",", for example:

821

Set UDP listening port for both IPv4 and IPv6 DHT\&. Multiple ports can be specified by using ",", for example:

760

822

\fI6881,6885\fR\&. You can also use "\-" to specify a range:

761

823

\fI6881\-6999\fR\&. "," and "\-" can be used together\&. Default:

762

824

\fI6881\-6999\fR

786

848

.PP

787

849

\fB\-\-enable\-dht\fR[=\fItrue\fR|\fIfalse\fR]

788

850

.RS 4

789

Enable DHT functionality\&. If a private flag is set in a torrent, aria2 doesn\(cqt use DHT for that download even if

851

Enable IPv4 DHT functionality\&. If a private flag is set in a torrent, aria2 doesn\(cqt use DHT for that download even if

790

852

\fItrue\fR

791

853

is given\&. Default:

792

854

\fItrue\fR

793

855

.RE

794

856

.PP

857

\fB\-\-enable\-dht6\fR[=\fItrue\fR|\fIfalse\fR]

858

.RS 4

859

Enable IPv6 DHT functionality\&. If a private flag is set in a torrent, aria2 doesn\(cqt use DHT for that download even if

860

\fItrue\fR

861

is given\&. Use

862

\fB\-\-dht\-listen\-port\fR

863

option to specify port number to listen on\&. See also

864

\fB\-\-dht\-listen\-addr6\fR

865

option\&.

866

.RE

867

.PP

795

868

\fB\-\-enable\-peer\-exchange\fR[=\fItrue\fR|\fIfalse\fR]

796

869

.RS 4

797

870

Enable Peer Exchange extension\&. If a private flag is set in a torrent, this feature is disabled for that download even if

1127

1200

\fIfalse\fR

1128

1201

.RE

1129

1202

.PP

1203

\fB\-\-enable\-async\-dns6\fR[=\fItrue\fR|\fIfalse\fR]

1204

.RS 4

1205

Enable IPv6 name resolution in asynchronous DNS resolver\&. This option will be ignored when

1206

\fB\-\-async\-dns\fR=\fIfalse\fR\&. Default:

1207

\fIfalse\fR

1208

.RE

1209

.PP

1130

1210

\fB\-\-enable\-direct\-io\fR[=\fItrue\fR|\fIfalse\fR]

1131

1211

.RS 4

1132

1212

Enable directI/O, which lowers cpu usage while allocating/checking files\&. Turn off if you encounter any error\&. Default:

1205

1285

.sp .5v

1206

1286

.RE

1207

1287

.PP

1208

\fB\-\-max\-connection\-per\-server\fR=NUM

1288

\fB\-\-max\-download\-result\fR=NUM

1209

1289

.RS 4

1210

The maximum number of connections to one server for each download\&. Possible Values:

1211

\fI1\fR\-\fI4\fR

1212

Default:

1213

\fI1\fR

1290

Set maximum number of download result kept in memory\&. The download results are completed/error/removed downloads\&. The download results are stored in FIFO queue and it can store at most NUM download results\&. When queue is full and new download result is created, oldest download result is removed from the front of the queue and new one is pushed to the back\&. Setting big number in this option may result high memory consumption after thousands of downloads\&. Specifying 0 means no download result is kept\&. Default:

1291

\fI1000\fR

1214

1292

.RE

1215

1293

.PP

1216

1294

\fB\-\-max\-resume\-failure\-tries\fR=N

1227

1305

\fI0\fR

1228

1306

.RE

1229

1307

.PP

1230

\fB\-\-min\-split\-size\fR=SIZE

1231

.RS 4

1232

1233

\fB\-\-split\fR

1234

>= 2, of course)\&. If SIZE is 15M, since 2*15M > 20MiB, aria2 does not split file and download it using 1 source\&. You can append

1235

\fIK\fR

1236

1237

\fIM\fR(1K = 1024, 1M = 1024K)\&. Possible Values:

1238

\fI1M\fR\-\fI1024M\fR

1239

Default:

1240

\fI20M\fR

1241

.RE

1242

.PP

1243

1308

\fB\-\-log\-level\fR=LEVEL

1244

1309

.RS 4

1245

1310

Set log level to output\&. LEVEL is either

1604

1669

.\}

1605

1670

.SS "dht\&.dat"

1606

1671

.sp

1607

By default, the routing table of DHT is saved to the path $HOME/\&.aria2/dht\&.dat\&.

1672

By default, the routing table of IPv4 DHT is saved to the path \fI$HOME/\&.aria2/dht\&.dat\fR and the routing table of IPv6 DHT is saved to the path \fI$HOME/\&.aria2/dht6\&.dat\fR\&.

1673

.SS "Netrc"

1674

.sp

1675

Netrc support is enabled by default for HTTP(S)/FTP\&. To disable netrc support, specify \fB\-n\fR option\&. Your \&.netrc file should have correct permissions(600)\&.

1676

.sp

1677

If machine name starts "\&.", aria2 performs domain match instead of exact match\&. This is an extension of aria2\&. For example of domain match, imagine the following \&.netrc entry:

1678

.sp

1679

.if n \{\

1680

.RS 4

1681

.\}

1682

.nf

1683

machine \&.example\&.org login myid password mypasswd

1684

.fi

1685

.if n \{\

1686

.RE

1687

.\}

1688

.sp

1689

In domain match, aria2\&.example\&.org matches \&.example\&.org and uses myid and mypasswd\&. example\&.org also matches \&.example\&.org\&. But example\&.net does not match \&.example\&.org\&.

1608

1690

.SS "Control File"

1609

1691

.sp

1610

1692

aria2 uses a control file to track the progress of a download\&. A control file is placed in the same directory as the downloading file and its filename is the filename of downloading file with "\&.aria2" appended\&. For example, if you are downloading file\&.zip, then the control file should be file\&.zip\&.aria2\&. (There is a exception for this naming convention\&. If you are downloading a multi torrent, its control file is the "top directory" name of the torrent with "\&.aria2" appended\&. The "top directory" name is a value of "name" key in "info" directory in a torrent file\&.)

1630

1712

.sp -1

1631

1713

.IP \(bu 2.3

1632

1714

.\}

1633

dir

1634

.RE

1635

.sp

1636

.RS 4

1637

.ie n \{\

1638

\h'-04'\(bu\h'+03'\c

1639

.\}

1640

.el \{\

1641

.sp -1

1642

.IP \(bu 2.3

1643

.\}

1644

check\-integrity

1645

.RE

1646

.sp

1647

.RS 4

1648

.ie n \{\

1649

\h'-04'\(bu\h'+03'\c

1650

.\}

1651

.el \{\

1652

.sp -1

1653

.IP \(bu 2.3

1654

.\}

1655

continue

1656

.RE

1657

.sp

1658

.RS 4

1659

.ie n \{\

1660

\h'-04'\(bu\h'+03'\c

1661

.\}

1662

.el \{\

1663

.sp -1

1664

.IP \(bu 2.3

1665

.\}

1666

all\-proxy

1667

.RE

1668

.sp

1669

.RS 4

1670

.ie n \{\

1671

\h'-04'\(bu\h'+03'\c

1672

.\}

1673

.el \{\

1674

.sp -1

1675

.IP \(bu 2.3

1676

.\}

1677

all\-proxy\-user

1678

.RE

1679

.sp

1680

.RS 4

1681

.ie n \{\

1682

\h'-04'\(bu\h'+03'\c

1683

.\}

1684

.el \{\

1685

.sp -1

1686

.IP \(bu 2.3

1687

.\}

1688

all\-proxy\-passwd

1689

.RE

1690

.sp

1691

.RS 4

1692

.ie n \{\

1693

\h'-04'\(bu\h'+03'\c

1694

.\}

1695

.el \{\

1696

.sp -1

1697

.IP \(bu 2.3

1698

.\}

1699

connect\-timeout

1700

.RE

1701

.sp

1702

.RS 4

1703

.ie n \{\

1704

\h'-04'\(bu\h'+03'\c

1705

.\}

1706

.el \{\

1707

.sp -1

1708

.IP \(bu 2.3

1709

.\}

1710

dry\-run

1711

.RE

1712

.sp

1713

.RS 4

1714

.ie n \{\

1715

\h'-04'\(bu\h'+03'\c

1716

.\}

1717

.el \{\

1718

.sp -1

1719

.IP \(bu 2.3

1720

.\}

1721

lowest\-speed\-limit

1722

.RE

1723

.sp

1724

.RS 4

1725

.ie n \{\

1726

\h'-04'\(bu\h'+03'\c

1727

.\}

1728

.el \{\

1729

.sp -1

1730

.IP \(bu 2.3

1731

.\}

1732

max\-file\-not\-found

1733

.RE

1734

.sp

1735

.RS 4

1736

.ie n \{\

1737

\h'-04'\(bu\h'+03'\c

1738

.\}

1739

.el \{\

1740

.sp -1

1741

.IP \(bu 2.3

1742

.\}

1743

max\-tries

1744

.RE

1745

.sp

1746

.RS 4

1747

.ie n \{\

1748

\h'-04'\(bu\h'+03'\c

1749

.\}

1750

.el \{\

1751

.sp -1

1752

.IP \(bu 2.3

1753

.\}

1754

no\-proxy

1755

.RE

1756

.sp

1757

.RS 4

1758

.ie n \{\

1759

\h'-04'\(bu\h'+03'\c

1760

.\}

1761

.el \{\

1762

.sp -1

1763

.IP \(bu 2.3

1764

.\}

1765

out

1766

.RE

1767

.sp

1768

.RS 4

1769

.ie n \{\

1770

\h'-04'\(bu\h'+03'\c

1771

.\}

1772

.el \{\

1773

.sp -1

1774

.IP \(bu 2.3

1775

.\}

1776

proxy\-method

1777

.RE

1778

.sp

1779

.RS 4

1780

.ie n \{\

1781

\h'-04'\(bu\h'+03'\c

1782

.\}

1783

.el \{\

1784

.sp -1

1785

.IP \(bu 2.3

1786

.\}

1787

remote\-time

1788

.RE

1789

.sp

1790

.RS 4

1791

.ie n \{\

1792

\h'-04'\(bu\h'+03'\c

1793

.\}

1794

.el \{\

1795

.sp -1

1796

.IP \(bu 2.3

1797

.\}

1798

split

1799

.RE

1800

.sp

1801

.RS 4

1802

.ie n \{\

1803

\h'-04'\(bu\h'+03'\c

1804

.\}

1805

.el \{\

1806

.sp -1

1807

.IP \(bu 2.3

1808

.\}

1809

timeout

1810

.RE

1811

.sp

1812

.RS 4

1813

.ie n \{\

1814

\h'-04'\(bu\h'+03'\c

1815

.\}

1816

.el \{\

1817

.sp -1

1818

.IP \(bu 2.3

1819

.\}

1820

http\-auth\-challenge

1821

.RE

1822

.sp

1823

.RS 4

1824

.ie n \{\

1825

\h'-04'\(bu\h'+03'\c

1826

.\}

1827

.el \{\

1828

.sp -1

1829

.IP \(bu 2.3

1830

.\}

1831

http\-no\-cache

1832

.RE

1833

.sp

1834

.RS 4

1835

.ie n \{\

1836

\h'-04'\(bu\h'+03'\c

1837

.\}

1838

.el \{\

1839

.sp -1

1840

.IP \(bu 2.3

1841

.\}

1842

http\-user

1843

.RE

1844

.sp

1845

.RS 4

1846

.ie n \{\

1847

\h'-04'\(bu\h'+03'\c

1848

.\}

1849

.el \{\

1850

.sp -1

1851

.IP \(bu 2.3

1852

.\}

1853

http\-passwd

1854

.RE

1855

.sp

1856

.RS 4

1857

.ie n \{\

1858

\h'-04'\(bu\h'+03'\c

1859

.\}

1860

.el \{\

1861

.sp -1

1862

.IP \(bu 2.3

1863

.\}

1864

http\-proxy

1865

.RE

1866

.sp

1867

.RS 4

1868

.ie n \{\

1869

\h'-04'\(bu\h'+03'\c

1870

.\}

1871

.el \{\

1872

.sp -1

1873

.IP \(bu 2.3

1874

.\}

1875

http\-proxy\-user

1876

.RE

1877

.sp

1878

.RS 4

1879

.ie n \{\

1880

\h'-04'\(bu\h'+03'\c

1881

.\}

1882

.el \{\

1883

.sp -1

1884

.IP \(bu 2.3

1885

.\}

1886

http\-proxy\-passwd

1887

.RE

1888

.sp

1889

.RS 4

1890

.ie n \{\

1891

\h'-04'\(bu\h'+03'\c

1892

.\}

1893

.el \{\

1894

.sp -1

1895

.IP \(bu 2.3

1896

.\}

1897

https\-proxy

1898

.RE

1899

.sp

1900

.RS 4

1901

.ie n \{\

1902

\h'-04'\(bu\h'+03'\c

1903

.\}

1904

.el \{\

1905

.sp -1

1906

.IP \(bu 2.3

1907

.\}

1908

https\-proxy\-user

1909

.RE

1910

.sp

1911

.RS 4

1912

.ie n \{\

1913

\h'-04'\(bu\h'+03'\c

1914

.\}

1915

.el \{\

1916

.sp -1

1917

.IP \(bu 2.3

1918

.\}

1919

https\-proxy\-passwd

1920

.RE

1921

.sp

1922

.RS 4

1923

.ie n \{\

1924

\h'-04'\(bu\h'+03'\c

1925

.\}

1926

.el \{\

1927

.sp -1

1928

.IP \(bu 2.3

1929

.\}

1930

referer

1931

.RE

1932

.sp

1933

.RS 4

1934

.ie n \{\

1935

\h'-04'\(bu\h'+03'\c

1936

.\}

1937

.el \{\

1938

.sp -1

1939

.IP \(bu 2.3

1940

.\}

1941

enable\-http\-keep\-alive

1942

.RE

1943

.sp

1944

.RS 4

1945

.ie n \{\

1946

\h'-04'\(bu\h'+03'\c

1947

.\}

1948

.el \{\

1949

.sp -1

1950

.IP \(bu 2.3

1951

.\}

1952

enable\-http\-pipelining

1953

.RE

1954

.sp

1955

.RS 4

1956

.ie n \{\

1957

\h'-04'\(bu\h'+03'\c

1958

.\}

1959

.el \{\

1960

.sp -1

1961

.IP \(bu 2.3

1962

.\}

1963

header

1964

.RE

1965

.sp

1966

.RS 4

1967

.ie n \{\

1968

\h'-04'\(bu\h'+03'\c

1969

.\}

1970

.el \{\

1971

.sp -1

1972

.IP \(bu 2.3

1973

.\}

1974

use\-head

1975

.RE

1976

.sp

1977

.RS 4

1978

.ie n \{\

1979

\h'-04'\(bu\h'+03'\c

1980

.\}

1981

.el \{\

1982

.sp -1

1983

.IP \(bu 2.3

1984

.\}

1985

user\-agent

1986

.RE

1987

.sp

1988

.RS 4

1989

.ie n \{\

1990

\h'-04'\(bu\h'+03'\c

1991

.\}

1992

.el \{\

1993

.sp -1

1994

.IP \(bu 2.3

1995

.\}

1996

ftp\-user

1997

.RE

1998

.sp

1999

.RS 4

2000

.ie n \{\

2001

\h'-04'\(bu\h'+03'\c

2002

.\}

2003

.el \{\

2004

.sp -1

2005

.IP \(bu 2.3

2006

.\}

2007

ftp\-passwd

2008

.RE

2009

.sp

2010

.RS 4

2011

.ie n \{\

2012

\h'-04'\(bu\h'+03'\c

2013

.\}

2014

.el \{\

2015

.sp -1

2016

.IP \(bu 2.3

2017

.\}

2018

ftp\-pasv

2019

.RE

2020

.sp

2021

.RS 4

2022

.ie n \{\

2023

\h'-04'\(bu\h'+03'\c

2024

.\}

2025

.el \{\

2026

.sp -1

2027

.IP \(bu 2.3

2028

.\}

2029

ftp\-proxy

2030

.RE

2031

.sp

2032

.RS 4

2033

.ie n \{\

2034

\h'-04'\(bu\h'+03'\c

2035

.\}

2036

.el \{\

2037

.sp -1

2038

.IP \(bu 2.3

2039

.\}

2040

ftp\-proxy\-user

2041

.RE

2042

.sp

2043

.RS 4

2044

.ie n \{\

2045

\h'-04'\(bu\h'+03'\c

2046

.\}

2047

.el \{\

2048

.sp -1

2049

.IP \(bu 2.3

2050

.\}

2051

ftp\-proxy\-passwd

2052

.RE

2053

.sp

2054

.RS 4

2055

.ie n \{\

2056

\h'-04'\(bu\h'+03'\c

2057

.\}

2058

.el \{\

2059

.sp -1

2060

.IP \(bu 2.3

2061

.\}

2062

ftp\-type

2063

.RE

2064

.sp

2065

.RS 4

2066

.ie n \{\

2067

\h'-04'\(bu\h'+03'\c

2068

.\}

2069

.el \{\

2070

.sp -1

2071

.IP \(bu 2.3

2072

.\}

2073

ftp\-reuse\-connection

2074

.RE

2075

.sp

2076

.RS 4

2077

.ie n \{\

2078

\h'-04'\(bu\h'+03'\c

2079

.\}

2080

.el \{\

2081

.sp -1

2082

.IP \(bu 2.3

2083

.\}

2084

no\-netrc

2085

.RE

2086

.sp

2087

.RS 4

2088

.ie n \{\

2089

\h'-04'\(bu\h'+03'\c

2090

.\}

2091

.el \{\

2092

.sp -1

2093

.IP \(bu 2.3

2094

.\}

2095

reuse\-uri

2096

.RE

2097

.sp

2098

.RS 4

2099

.ie n \{\

2100

\h'-04'\(bu\h'+03'\c

2101

.\}

2102

.el \{\

2103

.sp -1

2104

.IP \(bu 2.3

2105

.\}

2106

select\-file

2107

.RE

2108

.sp

2109

.RS 4

2110

.ie n \{\

2111

\h'-04'\(bu\h'+03'\c

2112

.\}

2113

.el \{\

2114

.sp -1

2115

.IP \(bu 2.3

2116

.\}

2117

bt\-enable\-lpd

2118

.RE

2119

.sp

2120

.RS 4

2121

.ie n \{\

2122

\h'-04'\(bu\h'+03'\c

2123

.\}

2124

.el \{\

2125

.sp -1

2126

.IP \(bu 2.3

2127

.\}

2128

bt\-external\-ip

2129

.RE

2130

.sp

2131

.RS 4

2132

.ie n \{\

2133

\h'-04'\(bu\h'+03'\c

2134

.\}

2135

.el \{\

2136

.sp -1

2137

.IP \(bu 2.3

2138

.\}

2139

bt\-hash\-check\-seed

2140

.RE

2141

.sp

2142

.RS 4

2143

.ie n \{\

2144

\h'-04'\(bu\h'+03'\c

2145

.\}

2146

.el \{\

2147

.sp -1

2148

.IP \(bu 2.3

2149

.\}

2150

bt\-max\-open\-files

2151

.RE

2152

.sp

2153

.RS 4

2154

.ie n \{\

2155

\h'-04'\(bu\h'+03'\c

2156

.\}

2157

.el \{\

2158

.sp -1

2159

.IP \(bu 2.3

2160

.\}

2161

bt\-max\-peers

2162

.RE

2163

.sp

2164

.RS 4

2165

.ie n \{\

2166

\h'-04'\(bu\h'+03'\c

2167

.\}

2168

.el \{\

2169

.sp -1

2170

.IP \(bu 2.3

2171

.\}

2172

bt\-metadata\-only

2173

.RE

2174

.sp

2175

.RS 4

2176

.ie n \{\

2177

\h'-04'\(bu\h'+03'\c

2178

.\}

2179

.el \{\

2180

.sp -1

2181

.IP \(bu 2.3

2182

.\}

2183

bt\-min\-crypto\-level

2184

.RE

2185

.sp

2186

.RS 4

2187

.ie n \{\

2188

\h'-04'\(bu\h'+03'\c

2189

.\}

2190

.el \{\

2191

.sp -1

2192

.IP \(bu 2.3

2193

.\}

2194

bt\-prioritize\-piece

2195

.RE

2196

.sp

2197

.RS 4

2198

.ie n \{\

2199

\h'-04'\(bu\h'+03'\c

2200

.\}

2201

.el \{\

2202

.sp -1

2203

.IP \(bu 2.3

2204

.\}

2205

bt\-require\-crypto

2206

.RE

2207

.sp

2208

.RS 4

2209

.ie n \{\

2210

\h'-04'\(bu\h'+03'\c

2211

.\}

2212

.el \{\

2213

.sp -1

2214

.IP \(bu 2.3

2215

.\}

2216

bt\-request\-peer\-speed\-limit

2217

.RE

2218

.sp

2219

.RS 4

2220

.ie n \{\

2221

\h'-04'\(bu\h'+03'\c

2222

.\}

2223

.el \{\

2224

.sp -1

2225

.IP \(bu 2.3

2226

.\}

2227

bt\-save\-metadata

2228

.RE

2229

.sp

2230

.RS 4

2231

.ie n \{\

2232

\h'-04'\(bu\h'+03'\c

2233

.\}

2234

.el \{\

2235

.sp -1

2236

.IP \(bu 2.3

2237

.\}

2238

bt\-seed\-unverified

2239

.RE

2240

.sp

2241

.RS 4

2242

.ie n \{\

2243

\h'-04'\(bu\h'+03'\c

2244

.\}

2245

.el \{\

2246

.sp -1

2247

.IP \(bu 2.3

2248

.\}

2249

bt\-stop\-timeout

2250

.RE

2251

.sp

2252

.RS 4

2253

.ie n \{\

2254

\h'-04'\(bu\h'+03'\c

2255

.\}

2256

.el \{\

2257

.sp -1

2258

.IP \(bu 2.3

2259

.\}

2260

bt\-tracker\-interval

2261

.RE

2262

.sp

2263

.RS 4

2264

.ie n \{\

2265

\h'-04'\(bu\h'+03'\c

2266

.\}

2267

.el \{\

2268

.sp -1

2269

.IP \(bu 2.3

2270

.\}

2271

bt\-tracker\-timeout

2272

.RE

2273

.sp

2274

.RS 4

2275

.ie n \{\

2276

\h'-04'\(bu\h'+03'\c

2277

.\}

2278

.el \{\

2279

.sp -1

2280

.IP \(bu 2.3

2281

.\}

2282

bt\-tracker\-connect\-timeout

2283

.RE

2284

.sp

2285

.RS 4

2286

.ie n \{\

2287

\h'-04'\(bu\h'+03'\c

2288

.\}

2289

.el \{\

2290

.sp -1

2291

.IP \(bu 2.3

2292

.\}

2293

enable\-peer\-exchange

2294

.RE

2295

.sp

2296

.RS 4

2297

.ie n \{\

2298

\h'-04'\(bu\h'+03'\c

2299

.\}

2300

.el \{\

2301

.sp -1

2302

.IP \(bu 2.3

2303

.\}

2304

follow\-torrent

2305

.RE

2306

.sp

2307

.RS 4

2308

.ie n \{\

2309

\h'-04'\(bu\h'+03'\c

2310

.\}

2311

.el \{\

2312

.sp -1

2313

.IP \(bu 2.3

2314

.\}

2315

index\-out

2316

.RE

2317

.sp

2318

.RS 4

2319

.ie n \{\

2320

\h'-04'\(bu\h'+03'\c

2321

.\}

2322

.el \{\

2323

.sp -1

2324

.IP \(bu 2.3

2325

.\}

2326

max\-upload\-limit

2327

.RE

2328

.sp

2329

.RS 4

2330

.ie n \{\

2331

\h'-04'\(bu\h'+03'\c

2332

.\}

2333

.el \{\

2334

.sp -1

2335

.IP \(bu 2.3

2336

.\}

2337

seed\-ratio

2338

.RE

2339

.sp

2340

.RS 4

2341

.ie n \{\

2342

\h'-04'\(bu\h'+03'\c

2343

.\}

2344

.el \{\

2345

.sp -1

2346

.IP \(bu 2.3

2347

.\}

2348

seed\-time

2349

.RE

2350

.sp

2351

.RS 4

2352

.ie n \{\

2353

\h'-04'\(bu\h'+03'\c

2354

.\}

2355

.el \{\

2356

.sp -1

2357

.IP \(bu 2.3

2358

.\}

2359

follow\-metalink

2360

.RE

2361

.sp

2362

.RS 4

2363

.ie n \{\

2364

\h'-04'\(bu\h'+03'\c

2365

.\}

2366

.el \{\

2367

.sp -1

2368

.IP \(bu 2.3

2369

.\}

2370

metalink\-servers

2371

.RE

2372

.sp

2373

.RS 4

2374

.ie n \{\

2375

\h'-04'\(bu\h'+03'\c

2376

.\}

2377

.el \{\

2378

.sp -1

2379

.IP \(bu 2.3

2380

.\}

2381

metalink\-language

2382

.RE

2383

.sp

2384

.RS 4

2385

.ie n \{\

2386

\h'-04'\(bu\h'+03'\c

2387

.\}

2388

.el \{\

2389

.sp -1

2390

.IP \(bu 2.3

2391

.\}

2392

metalink\-location

2393

.RE

2394

.sp

2395

.RS 4

2396

.ie n \{\

2397

\h'-04'\(bu\h'+03'\c

2398

.\}

2399

.el \{\

2400

.sp -1

2401

.IP \(bu 2.3

2402

.\}

2403

metalink\-os

2404

.RE

2405

.sp

2406

.RS 4

2407

.ie n \{\

2408

\h'-04'\(bu\h'+03'\c

2409

.\}

2410

.el \{\

2411

.sp -1

2412

.IP \(bu 2.3

2413

.\}

2414

metalink\-version

2415

.RE

2416

.sp

2417

.RS 4

2418

.ie n \{\

2419

\h'-04'\(bu\h'+03'\c

2420

.\}

2421

.el \{\

2422

.sp -1

2423

.IP \(bu 2.3

2424

.\}

2425

metalink\-preferred\-protocol

2426

.RE

2427

.sp

2428

.RS 4

2429

.ie n \{\

2430

\h'-04'\(bu\h'+03'\c

2431

.\}

2432

.el \{\

2433

.sp -1

2434

.IP \(bu 2.3

2435

.\}

2436

metalink\-enable\-unique\-protocol

2437

.RE

2438

.sp

2439

.RS 4

2440

.ie n \{\

2441

\h'-04'\(bu\h'+03'\c

2442

.\}

2443

.el \{\

2444

.sp -1

2445

.IP \(bu 2.3

2446

.\}

2447

allow\-overwrite

2448

.RE

2449

.sp

2450

.RS 4

2451

.ie n \{\

2452

\h'-04'\(bu\h'+03'\c

2453

.\}

2454

.el \{\

2455

.sp -1

2456

.IP \(bu 2.3

2457

.\}

2458

allow\-piece\-length\-change

2459

.RE

2460

.sp

2461

.RS 4

2462

.ie n \{\

2463

\h'-04'\(bu\h'+03'\c

2464

.\}

2465

.el \{\

2466

.sp -1

2467

.IP \(bu 2.3

2468

.\}

2469

async\-dns

2470

.RE

2471

.sp

2472

.RS 4

2473

.ie n \{\

2474

\h'-04'\(bu\h'+03'\c

2475

.\}

2476

.el \{\

2477

.sp -1

2478

.IP \(bu 2.3

2479

.\}

2480

auto\-file\-renaming

2481

.RE

2482

.sp

2483

.RS 4

2484

.ie n \{\

2485

\h'-04'\(bu\h'+03'\c

2486

.\}

2487

.el \{\

2488

.sp -1

2489

.IP \(bu 2.3

2490

.\}

2491

file\-allocation

2492

.RE

2493

.sp

2494

.RS 4

2495

.ie n \{\

2496

\h'-04'\(bu\h'+03'\c

2497

.\}

2498

.el \{\

2499

.sp -1

2500

.IP \(bu 2.3

2501

.\}

2502

max\-download\-limit

2503

.RE

2504

.sp

2505

.RS 4

2506

.ie n \{\

2507

\h'-04'\(bu\h'+03'\c

2508

.\}

2509

.el \{\

2510

.sp -1

2511

.IP \(bu 2.3

2512

.\}

2513

no\-file\-allocation\-limit

2514

.RE

2515

.sp

2516

.RS 4

2517

.ie n \{\

2518

\h'-04'\(bu\h'+03'\c

2519

.\}

2520

.el \{\

2521

.sp -1

2522

.IP \(bu 2.3

2523

.\}

2524

parameterized\-uri

2525

.RE

2526

.sp

2527

.RS 4

2528

.ie n \{\

2529

\h'-04'\(bu\h'+03'\c

2530

.\}

2531

.el \{\

2532

.sp -1

2533

.IP \(bu 2.3

2534

.\}

2535

realtime\-chunk\-checksum

2536

.RE

2537

.sp

2538

.RS 4

2539

.ie n \{\

2540

\h'-04'\(bu\h'+03'\c

2541

.\}

2542

.el \{\

2543

.sp -1

2544

.IP \(bu 2.3

2545

.\}

2546

remove\-control\-file

2547

.RE

2548

.sp

2549

.RS 4

2550

.ie n \{\

2551

\h'-04'\(bu\h'+03'\c

2552

.\}

2553

.el \{\

2554

.sp -1

2555

.IP \(bu 2.3

2556

.\}

2557

always\-resume

2558

.RE

2559

.sp

2560

.RS 4

2561

.ie n \{\

2562

\h'-04'\(bu\h'+03'\c

2563

.\}

2564

.el \{\

2565

.sp -1

2566

.IP \(bu 2.3

2567

.\}

2568

max\-resume\-failure\-tries

2569

.RE

2570

.sp

2571

.RS 4

2572

.ie n \{\

2573

\h'-04'\(bu\h'+03'\c

2574

.\}

2575

.el \{\

2576

.sp -1

2577

.IP \(bu 2.3

2578

.\}

2579

http\-accept\-gzip

2580

.RE

2581

.sp

2582

.RS 4

2583

.ie n \{\

2584

\h'-04'\(bu\h'+03'\c

2585

.\}

2586

.el \{\

2587

.sp -1

2588

.IP \(bu 2.3

2589

.\}

2590

max\-connection\-per\-server

2591

.RE

2592

.sp

2593

.RS 4

2594

.ie n \{\

2595

\h'-04'\(bu\h'+03'\c

2596

.\}

2597

.el \{\

2598

.sp -1

2599

.IP \(bu 2.3

2600

.\}

2601

min\-split\-size

2602

.RE

2603

.sp

2604

.RS 4

2605

.ie n \{\

2606

\h'-04'\(bu\h'+03'\c

2607

.\}

2608

.el \{\

2609

.sp -1

2610

.IP \(bu 2.3

2611

.\}

2612

conditional\-get

2613

.RE

2614

.sp

2615

These options have exactly same meaning of the ones in the command\-line options, but it just applies to the URIs it belongs to\&.

1715

1716

\fBall\-proxy\fR

1717

.RE

1718

.sp

1719

.RS 4

1720

.ie n \{\

1721

\h'-04'\(bu\h'+03'\c

1722

.\}

1723

.el \{\

1724

.sp -1

1725

.IP \(bu 2.3

1726

.\}

1727

1728

\fBall\-proxy\-passwd\fR

1729

.RE

1730

.sp

1731

.RS 4

1732

.ie n \{\

1733

\h'-04'\(bu\h'+03'\c

1734

.\}

1735

.el \{\

1736

.sp -1

1737

.IP \(bu 2.3

1738

.\}

1739

1740

\fBall\-proxy\-user\fR

1741

.RE

1742

.sp

1743

.RS 4

1744

.ie n \{\

1745

\h'-04'\(bu\h'+03'\c

1746

.\}

1747

.el \{\

1748

.sp -1

1749

.IP \(bu 2.3

1750

.\}

1751

1752

\fBallow\-overwrite\fR

1753

.RE

1754

.sp

1755

.RS 4

1756

.ie n \{\

1757

\h'-04'\(bu\h'+03'\c

1758

.\}

1759

.el \{\

1760

.sp -1

1761

.IP \(bu 2.3

1762

.\}

1763

1764

\fBallow\-piece\-length\-change\fR

1765

.RE

1766

.sp

1767

.RS 4

1768

.ie n \{\

1769

\h'-04'\(bu\h'+03'\c

1770

.\}

1771

.el \{\

1772

.sp -1

1773

.IP \(bu 2.3

1774

.\}

1775

1776

\fBalways\-resume\fR

1777

.RE

1778

.sp

1779

.RS 4

1780

.ie n \{\

1781

\h'-04'\(bu\h'+03'\c

1782

.\}

1783

.el \{\

1784

.sp -1

1785

.IP \(bu 2.3

1786

.\}

1787

1788

\fBasync\-dns\fR

1789

.RE

1790

.sp

1791

.RS 4

1792

.ie n \{\

1793

\h'-04'\(bu\h'+03'\c

1794

.\}

1795

.el \{\

1796

.sp -1

1797

.IP \(bu 2.3

1798

.\}

1799

1800

\fBauto\-file\-renaming\fR

1801

.RE

1802

.sp

1803

.RS 4

1804

.ie n \{\

1805

\h'-04'\(bu\h'+03'\c

1806

.\}

1807

.el \{\

1808

.sp -1

1809

.IP \(bu 2.3

1810

.\}

1811

1812

\fBbt\-enable\-lpd\fR

1813

.RE

1814

.sp

1815

.RS 4

1816

.ie n \{\

1817

\h'-04'\(bu\h'+03'\c

1818

.\}

1819

.el \{\

1820

.sp -1

1821

.IP \(bu 2.3

1822

.\}

1823

1824

\fBbt\-exclude\-tracker\fR

1825

.RE

1826

.sp

1827

.RS 4

1828

.ie n \{\

1829

\h'-04'\(bu\h'+03'\c

1830

.\}

1831

.el \{\

1832

.sp -1

1833

.IP \(bu 2.3

1834

.\}

1835

1836

\fBbt\-external\-ip\fR

1837

.RE

1838

.sp

1839

.RS 4

1840

.ie n \{\

1841

\h'-04'\(bu\h'+03'\c

1842

.\}

1843

.el \{\

1844

.sp -1

1845

.IP \(bu 2.3

1846

.\}

1847

1848

\fBbt\-hash\-check\-seed\fR

1849

.RE

1850

.sp

1851

.RS 4

1852

.ie n \{\

1853

\h'-04'\(bu\h'+03'\c

1854

.\}

1855

.el \{\

1856

.sp -1

1857

.IP \(bu 2.3

1858

.\}

1859

1860

\fBbt\-max\-open\-files\fR

1861

.RE

1862

.sp

1863

.RS 4

1864

.ie n \{\

1865

\h'-04'\(bu\h'+03'\c

1866

.\}

1867

.el \{\

1868

.sp -1

1869

.IP \(bu 2.3

1870

.\}

1871

1872

\fBbt\-max\-peers\fR

1873

.RE

1874

.sp

1875

.RS 4

1876

.ie n \{\

1877

\h'-04'\(bu\h'+03'\c

1878

.\}

1879

.el \{\

1880

.sp -1

1881

.IP \(bu 2.3

1882

.\}

1883

1884

\fBbt\-metadata\-only\fR

1885

.RE

1886

.sp

1887

.RS 4

1888

.ie n \{\

1889

\h'-04'\(bu\h'+03'\c

1890

.\}

1891

.el \{\

1892

.sp -1

1893

.IP \(bu 2.3

1894

.\}

1895

1896

\fBbt\-min\-crypto\-level\fR

1897

.RE

1898

.sp

1899

.RS 4

1900

.ie n \{\

1901

\h'-04'\(bu\h'+03'\c

1902

.\}

1903

.el \{\

1904

.sp -1

1905

.IP \(bu 2.3

1906

.\}

1907

1908

\fBbt\-prioritize\-piece\fR

1909

.RE

1910

.sp

1911

.RS 4

1912

.ie n \{\

1913

\h'-04'\(bu\h'+03'\c

1914

.\}

1915

.el \{\

1916

.sp -1

1917

.IP \(bu 2.3

1918

.\}

1919

1920

\fBbt\-request\-peer\-speed\-limit\fR

1921

.RE

1922

.sp

1923

.RS 4

1924

.ie n \{\

1925

\h'-04'\(bu\h'+03'\c

1926

.\}

1927

.el \{\

1928

.sp -1

1929

.IP \(bu 2.3

1930

.\}

1931

1932

\fBbt\-require\-crypto\fR

1933

.RE

1934

.sp

1935

.RS 4

1936

.ie n \{\

1937

\h'-04'\(bu\h'+03'\c

1938

.\}

1939

.el \{\

1940

.sp -1

1941

.IP \(bu 2.3

1942

.\}

1943

1944

\fBbt\-save\-metadata\fR

1945

.RE

1946

.sp

1947

.RS 4

1948

.ie n \{\

1949

\h'-04'\(bu\h'+03'\c

1950

.\}

1951

.el \{\

1952

.sp -1

1953

.IP \(bu 2.3

1954

.\}

1955

1956

\fBbt\-seed\-unverified\fR

1957

.RE

1958

.sp

1959

.RS 4

1960

.ie n \{\

1961

\h'-04'\(bu\h'+03'\c

1962

.\}

1963

.el \{\

1964

.sp -1

1965

.IP \(bu 2.3

1966

.\}

1967

1968

\fBbt\-stop\-timeout\fR

1969

.RE

1970

.sp

1971

.RS 4

1972

.ie n \{\

1973

\h'-04'\(bu\h'+03'\c

1974

.\}

1975

.el \{\

1976

.sp -1

1977

.IP \(bu 2.3

1978

.\}

1979

1980

\fBbt\-tracker\fR

1981

.RE

1982

.sp

1983

.RS 4

1984

.ie n \{\

1985

\h'-04'\(bu\h'+03'\c

1986

.\}

1987

.el \{\

1988

.sp -1

1989

.IP \(bu 2.3

1990

.\}

1991

1992

\fBbt\-tracker\-connect\-timeout\fR

1993

.RE

1994

.sp

1995

.RS 4

1996

.ie n \{\

1997

\h'-04'\(bu\h'+03'\c

1998

.\}

1999

.el \{\

2000

.sp -1

2001

.IP \(bu 2.3

2002

.\}

2003

2004

\fBbt\-tracker\-interval\fR

2005

.RE

2006

.sp

2007

.RS 4

2008

.ie n \{\

2009

\h'-04'\(bu\h'+03'\c

2010

.\}

2011

.el \{\

2012

.sp -1

2013

.IP \(bu 2.3

2014

.\}

2015

2016

\fBbt\-tracker\-timeout\fR

2017

.RE

2018

.sp

2019

.RS 4

2020

.ie n \{\

2021

\h'-04'\(bu\h'+03'\c

2022

.\}

2023

.el \{\

2024

.sp -1

2025

.IP \(bu 2.3

2026

.\}

2027

2028

\fBcheck\-integrity\fR

2029

.RE

2030

.sp

2031

.RS 4

2032

.ie n \{\

2033

\h'-04'\(bu\h'+03'\c

2034

.\}

2035

.el \{\

2036

.sp -1

2037

.IP \(bu 2.3

2038

.\}

2039

2040

\fBconditional\-get\fR

2041

.RE

2042

.sp

2043

.RS 4

2044

.ie n \{\

2045

\h'-04'\(bu\h'+03'\c

2046

.\}

2047

.el \{\

2048

.sp -1

2049

.IP \(bu 2.3

2050

.\}

2051

2052

\fBconnect\-timeout\fR

2053

.RE

2054

.sp

2055

.RS 4

2056

.ie n \{\

2057

\h'-04'\(bu\h'+03'\c

2058

.\}

2059

.el \{\

2060

.sp -1

2061

.IP \(bu 2.3

2062

.\}

2063

2064

\fBcontinue\fR

2065

.RE

2066

.sp

2067

.RS 4

2068

.ie n \{\

2069

\h'-04'\(bu\h'+03'\c

2070

.\}

2071

.el \{\

2072

.sp -1

2073

.IP \(bu 2.3

2074

.\}

2075

2076

\fBdir\fR

2077

.RE

2078

.sp

2079

.RS 4

2080

.ie n \{\

2081

\h'-04'\(bu\h'+03'\c

2082

.\}

2083

.el \{\

2084

.sp -1

2085

.IP \(bu 2.3

2086

.\}

2087

2088

\fBdry\-run\fR

2089

.RE

2090

.sp

2091

.RS 4

2092

.ie n \{\

2093

\h'-04'\(bu\h'+03'\c

2094

.\}

2095

.el \{\

2096

.sp -1

2097

.IP \(bu 2.3

2098

.\}

2099

2100

\fBenable\-async\-dns6\fR

2101

.RE

2102

.sp

2103

.RS 4

2104

.ie n \{\

2105

\h'-04'\(bu\h'+03'\c

2106

.\}

2107

.el \{\

2108

.sp -1

2109

.IP \(bu 2.3

2110

.\}

2111

2112

\fBenable\-http\-keep\-alive\fR

2113

.RE

2114

.sp

2115

.RS 4

2116

.ie n \{\

2117

\h'-04'\(bu\h'+03'\c

2118

.\}

2119

.el \{\

2120

.sp -1

2121

.IP \(bu 2.3

2122

.\}

2123

2124

\fBenable\-http\-pipelining\fR

2125

.RE

2126

.sp

2127

.RS 4

2128

.ie n \{\

2129

\h'-04'\(bu\h'+03'\c

2130

.\}

2131

.el \{\

2132

.sp -1

2133

.IP \(bu 2.3

2134

.\}

2135

2136

\fBenable\-peer\-exchange\fR

2137

.RE

2138

.sp

2139

.RS 4

2140

.ie n \{\

2141

\h'-04'\(bu\h'+03'\c

2142

.\}

2143

.el \{\

2144

.sp -1

2145

.IP \(bu 2.3

2146

.\}

2147

2148

\fBfile\-allocation\fR

2149

.RE

2150

.sp

2151

.RS 4

2152

.ie n \{\

2153

\h'-04'\(bu\h'+03'\c

2154

.\}

2155

.el \{\

2156

.sp -1

2157

.IP \(bu 2.3

2158

.\}

2159

2160

\fBfollow\-metalink\fR

2161

.RE

2162

.sp

2163

.RS 4

2164

.ie n \{\

2165

\h'-04'\(bu\h'+03'\c

2166

.\}

2167

.el \{\

2168

.sp -1

2169

.IP \(bu 2.3

2170

.\}

2171

2172

\fBfollow\-torrent\fR

2173

.RE

2174

.sp

2175

.RS 4

2176

.ie n \{\

2177

\h'-04'\(bu\h'+03'\c

2178

.\}

2179

.el \{\

2180

.sp -1

2181

.IP \(bu 2.3

2182

.\}

2183

2184

\fBftp\-passwd\fR

2185

.RE

2186

.sp

2187

.RS 4

2188

.ie n \{\

2189

\h'-04'\(bu\h'+03'\c

2190

.\}

2191

.el \{\

2192

.sp -1

2193

.IP \(bu 2.3

2194

.\}

2195

2196

\fBftp\-pasv\fR

2197

.RE

2198

.sp

2199

.RS 4

2200

.ie n \{\

2201

\h'-04'\(bu\h'+03'\c

2202

.\}

2203

.el \{\

2204

.sp -1

2205

.IP \(bu 2.3

2206

.\}

2207

2208

\fBftp\-proxy\fR

2209

.RE

2210

.sp

2211

.RS 4

2212

.ie n \{\

2213

\h'-04'\(bu\h'+03'\c

2214

.\}

2215

.el \{\

2216

.sp -1

2217

.IP \(bu 2.3

2218

.\}

2219

2220

\fBftp\-proxy\-passwd\fR

2221

.RE

2222

.sp

2223

.RS 4

2224

.ie n \{\

2225

\h'-04'\(bu\h'+03'\c

2226

.\}

2227

.el \{\

2228

.sp -1

2229

.IP \(bu 2.3

2230

.\}

2231

2232

\fBftp\-proxy\-user\fR

2233

.RE

2234

.sp

2235

.RS 4

2236

.ie n \{\

2237

\h'-04'\(bu\h'+03'\c

2238

.\}

2239

.el \{\

2240

.sp -1

2241

.IP \(bu 2.3

2242

.\}

2243

2244

\fBftp\-reuse\-connection\fR

2245

.RE

2246

.sp

2247

.RS 4

2248

.ie n \{\

2249

\h'-04'\(bu\h'+03'\c

2250

.\}

2251

.el \{\

2252

.sp -1

2253

.IP \(bu 2.3

2254

.\}

2255

2256

\fBftp\-type\fR

2257

.RE

2258

.sp

2259

.RS 4

2260

.ie n \{\

2261

\h'-04'\(bu\h'+03'\c

2262

.\}

2263

.el \{\

2264

.sp -1

2265

.IP \(bu 2.3

2266

.\}

2267

2268

\fBftp\-user\fR

2269

.RE

2270

.sp

2271

.RS 4

2272

.ie n \{\

2273

\h'-04'\(bu\h'+03'\c

2274

.\}

2275

.el \{\

2276

.sp -1

2277

.IP \(bu 2.3

2278

.\}

2279

2280

\fBheader\fR

2281

.RE

2282

.sp

2283

.RS 4

2284

.ie n \{\

2285

\h'-04'\(bu\h'+03'\c

2286

.\}

2287

.el \{\

2288

.sp -1

2289

.IP \(bu 2.3

2290

.\}

2291

2292

\fBhttp\-accept\-gzip\fR

2293

.RE

2294

.sp

2295

.RS 4

2296

.ie n \{\

2297

\h'-04'\(bu\h'+03'\c

2298

.\}

2299

.el \{\

2300

.sp -1

2301

.IP \(bu 2.3

2302

.\}

2303

2304

\fBhttp\-auth\-challenge\fR

2305

.RE

2306

.sp

2307

.RS 4

2308

.ie n \{\

2309

\h'-04'\(bu\h'+03'\c

2310

.\}

2311

.el \{\

2312

.sp -1

2313

.IP \(bu 2.3

2314

.\}

2315

2316

\fBhttp\-no\-cache\fR

2317

.RE

2318

.sp

2319

.RS 4

2320

.ie n \{\

2321

\h'-04'\(bu\h'+03'\c

2322

.\}

2323

.el \{\

2324

.sp -1

2325

.IP \(bu 2.3

2326

.\}

2327

2328

\fBhttp\-passwd\fR

2329

.RE

2330

.sp

2331

.RS 4

2332

.ie n \{\

2333

\h'-04'\(bu\h'+03'\c

2334

.\}

2335

.el \{\

2336

.sp -1

2337

.IP \(bu 2.3

2338

.\}

2339

2340

\fBhttp\-proxy\fR

2341

.RE

2342

.sp

2343

.RS 4

2344

.ie n \{\

2345

\h'-04'\(bu\h'+03'\c

2346

.\}

2347

.el \{\

2348

.sp -1

2349

.IP \(bu 2.3

2350

.\}

2351

2352

\fBhttp\-proxy\-passwd\fR

2353

.RE

2354

.sp

2355

.RS 4

2356

.ie n \{\

2357

\h'-04'\(bu\h'+03'\c

2358

.\}

2359

.el \{\

2360

.sp -1

2361

.IP \(bu 2.3

2362

.\}

2363

2364

\fBhttp\-proxy\-user\fR

2365

.RE

2366

.sp

2367

.RS 4

2368

.ie n \{\

2369

\h'-04'\(bu\h'+03'\c

2370

.\}

2371

.el \{\

2372

.sp -1

2373

.IP \(bu 2.3

2374

.\}

2375

2376

\fBhttp\-user\fR

2377

.RE

2378

.sp

2379

.RS 4

2380

.ie n \{\

2381

\h'-04'\(bu\h'+03'\c

2382

.\}

2383

.el \{\

2384

.sp -1

2385

.IP \(bu 2.3

2386

.\}

2387

2388

\fBhttps\-proxy\fR

2389

.RE

2390

.sp

2391

.RS 4

2392

.ie n \{\

2393

\h'-04'\(bu\h'+03'\c

2394

.\}

2395

.el \{\

2396

.sp -1

2397

.IP \(bu 2.3

2398

.\}

2399

2400

\fBhttps\-proxy\-passwd\fR

2401

.RE

2402

.sp

2403

.RS 4

2404

.ie n \{\

2405

\h'-04'\(bu\h'+03'\c

2406

.\}

2407

.el \{\

2408

.sp -1

2409

.IP \(bu 2.3

2410

.\}

2411

2412

\fBhttps\-proxy\-user\fR

2413

.RE

2414

.sp

2415

.RS 4

2416

.ie n \{\

2417

\h'-04'\(bu\h'+03'\c

2418

.\}

2419

.el \{\

2420

.sp -1

2421

.IP \(bu 2.3

2422

.\}

2423

2424

\fBindex\-out\fR

2425

.RE

2426

.sp

2427

.RS 4

2428

.ie n \{\

2429

\h'-04'\(bu\h'+03'\c

2430

.\}

2431

.el \{\

2432

.sp -1

2433

.IP \(bu 2.3

2434

.\}

2435

2436

\fBlowest\-speed\-limit\fR

2437

.RE

2438

.sp

2439

.RS 4

2440

.ie n \{\

2441

\h'-04'\(bu\h'+03'\c

2442

.\}

2443

.el \{\

2444

.sp -1

2445

.IP \(bu 2.3

2446

.\}

2447

2448

\fBmax\-connection\-per\-server\fR

2449

.RE

2450

.sp

2451

.RS 4

2452

.ie n \{\

2453

\h'-04'\(bu\h'+03'\c

2454

.\}

2455

.el \{\

2456

.sp -1

2457

.IP \(bu 2.3

2458

.\}

2459

2460

\fBmax\-download\-limit\fR

2461

.RE

2462

.sp

2463

.RS 4

2464

.ie n \{\

2465

\h'-04'\(bu\h'+03'\c

2466

.\}

2467

.el \{\

2468

.sp -1

2469

.IP \(bu 2.3

2470

.\}

2471

2472

\fBmax\-file\-not\-found\fR

2473

.RE

2474

.sp

2475

.RS 4

2476

.ie n \{\

2477

\h'-04'\(bu\h'+03'\c

2478

.\}

2479

.el \{\

2480

.sp -1

2481

.IP \(bu 2.3

2482

.\}

2483

2484

\fBmax\-resume\-failure\-tries\fR

2485

.RE

2486

.sp

2487

.RS 4

2488

.ie n \{\

2489

\h'-04'\(bu\h'+03'\c

2490

.\}

2491

.el \{\

2492

.sp -1

2493

.IP \(bu 2.3

2494

.\}

2495

2496

\fBmax\-tries\fR

2497

.RE

2498

.sp

2499

.RS 4

2500

.ie n \{\

2501

\h'-04'\(bu\h'+03'\c

2502

.\}

2503

.el \{\

2504

.sp -1

2505

.IP \(bu 2.3

2506

.\}

2507

2508

\fBmax\-upload\-limit\fR

2509

.RE

2510

.sp

2511

.RS 4

2512

.ie n \{\

2513

\h'-04'\(bu\h'+03'\c

2514

.\}

2515

.el \{\

2516

.sp -1

2517

.IP \(bu 2.3

2518

.\}

2519

2520

\fBmetalink\-enable\-unique\-protocol\fR

2521

.RE

2522

.sp

2523

.RS 4

2524

.ie n \{\

2525

\h'-04'\(bu\h'+03'\c

2526

.\}

2527

.el \{\

2528

.sp -1

2529

.IP \(bu 2.3

2530

.\}

2531

2532

\fBmetalink\-language\fR

2533

.RE

2534

.sp

2535

.RS 4

2536

.ie n \{\

2537

\h'-04'\(bu\h'+03'\c

2538

.\}

2539

.el \{\

2540

.sp -1

2541

.IP \(bu 2.3

2542

.\}

2543

2544

\fBmetalink\-location\fR

2545

.RE

2546

.sp

2547

.RS 4

2548

.ie n \{\

2549

\h'-04'\(bu\h'+03'\c

2550

.\}

2551

.el \{\

2552

.sp -1

2553

.IP \(bu 2.3

2554

.\}

2555

2556

\fBmetalink\-os\fR

2557

.RE

2558

.sp

2559

.RS 4

2560

.ie n \{\

2561

\h'-04'\(bu\h'+03'\c

2562

.\}

2563

.el \{\

2564

.sp -1

2565

.IP \(bu 2.3

2566

.\}

2567

2568

\fBmetalink\-preferred\-protocol\fR

2569

.RE

2570

.sp

2571

.RS 4

2572

.ie n \{\

2573

\h'-04'\(bu\h'+03'\c

2574

.\}

2575

.el \{\

2576

.sp -1

2577

.IP \(bu 2.3

2578

.\}

2579

2580

\fBmetalink\-servers\fR

2581

.RE

2582

.sp

2583

.RS 4

2584

.ie n \{\

2585

\h'-04'\(bu\h'+03'\c

2586

.\}

2587

.el \{\

2588

.sp -1

2589

.IP \(bu 2.3

2590

.\}

2591

2592

\fBmetalink\-version\fR

2593

.RE

2594

.sp

2595

.RS 4

2596

.ie n \{\

2597

\h'-04'\(bu\h'+03'\c

2598

.\}

2599

.el \{\

2600

.sp -1

2601

.IP \(bu 2.3

2602

.\}

2603

2604

\fBmin\-split\-size\fR

2605

.RE

2606

.sp

2607

.RS 4

2608

.ie n \{\

2609

\h'-04'\(bu\h'+03'\c

2610

.\}

2611

.el \{\

2612

.sp -1

2613

.IP \(bu 2.3

2614

.\}

2615

2616

\fBno\-file\-allocation\-limit\fR

2617

.RE

2618

.sp

2619

.RS 4

2620

.ie n \{\

2621

\h'-04'\(bu\h'+03'\c

2622

.\}

2623

.el \{\

2624

.sp -1

2625

.IP \(bu 2.3

2626

.\}

2627

2628

\fBno\-netrc\fR

2629

.RE

2630

.sp

2631

.RS 4

2632

.ie n \{\

2633

\h'-04'\(bu\h'+03'\c

2634

.\}

2635

.el \{\

2636

.sp -1

2637

.IP \(bu 2.3

2638

.\}

2639

2640

\fBno\-proxy\fR

2641

.RE

2642

.sp

2643

.RS 4

2644

.ie n \{\

2645

\h'-04'\(bu\h'+03'\c

2646

.\}

2647

.el \{\

2648

.sp -1

2649

.IP \(bu 2.3

2650

.\}

2651

2652

\fBout\fR

2653

.RE

2654

.sp

2655

.RS 4

2656

.ie n \{\

2657

\h'-04'\(bu\h'+03'\c

2658

.\}

2659

.el \{\

2660

.sp -1

2661

.IP \(bu 2.3

2662

.\}

2663

2664

\fBparameterized\-uri\fR

2665

.RE

2666

.sp

2667

.RS 4

2668

.ie n \{\

2669

\h'-04'\(bu\h'+03'\c

2670

.\}

2671

.el \{\

2672

.sp -1

2673

.IP \(bu 2.3

2674

.\}

2675

2676

\fBproxy\-method\fR

2677

.RE

2678

.sp

2679

.RS 4

2680

.ie n \{\

2681

\h'-04'\(bu\h'+03'\c

2682

.\}

2683

.el \{\

2684

.sp -1

2685

.IP \(bu 2.3

2686

.\}

2687

2688

\fBrealtime\-chunk\-checksum\fR

2689

.RE

2690

.sp

2691

.RS 4

2692

.ie n \{\

2693

\h'-04'\(bu\h'+03'\c

2694

.\}

2695

.el \{\

2696

.sp -1

2697

.IP \(bu 2.3

2698

.\}

2699

2700

\fBreferer\fR

2701

.RE

2702

.sp

2703

.RS 4

2704

.ie n \{\

2705

\h'-04'\(bu\h'+03'\c

2706

.\}

2707

.el \{\

2708

.sp -1

2709

.IP \(bu 2.3

2710

.\}

2711

2712

\fBremote\-time\fR

2713

.RE

2714

.sp

2715

.RS 4

2716

.ie n \{\

2717

\h'-04'\(bu\h'+03'\c

2718

.\}

2719

.el \{\

2720

.sp -1

2721

.IP \(bu 2.3

2722

.\}

2723

2724

\fBremove\-control\-file\fR

2725

.RE

2726

.sp

2727

.RS 4

2728

.ie n \{\

2729

\h'-04'\(bu\h'+03'\c

2730

.\}

2731

.el \{\

2732

.sp -1

2733

.IP \(bu 2.3

2734

.\}

2735

2736

\fBreuse\-uri\fR

2737

.RE

2738

.sp

2739

.RS 4

2740

.ie n \{\

2741

\h'-04'\(bu\h'+03'\c

2742

.\}

2743

.el \{\

2744

.sp -1

2745

.IP \(bu 2.3

2746

.\}

2747

2748

\fBseed\-ratio\fR

2749

.RE

2750

.sp

2751

.RS 4

2752

.ie n \{\

2753

\h'-04'\(bu\h'+03'\c

2754

.\}

2755

.el \{\

2756

.sp -1

2757

.IP \(bu 2.3

2758

.\}

2759

2760

\fBseed\-time\fR

2761

.RE

2762

.sp

2763

.RS 4

2764

.ie n \{\

2765

\h'-04'\(bu\h'+03'\c

2766

.\}

2767

.el \{\

2768

.sp -1

2769

.IP \(bu 2.3

2770

.\}

2771

2772

\fBselect\-file\fR

2773

.RE

2774

.sp

2775

.RS 4

2776

.ie n \{\

2777

\h'-04'\(bu\h'+03'\c

2778

.\}

2779

.el \{\

2780

.sp -1

2781

.IP \(bu 2.3

2782

.\}

2783

2784

\fBsplit\fR

2785

.RE

2786

.sp

2787

.RS 4

2788

.ie n \{\

2789

\h'-04'\(bu\h'+03'\c

2790

.\}

2791

.el \{\

2792

.sp -1

2793

.IP \(bu 2.3

2794

.\}

2795

2796

\fBtimeout\fR

2797

.RE

2798

.sp

2799

.RS 4

2800

.ie n \{\

2801

\h'-04'\(bu\h'+03'\c

2802

.\}

2803

.el \{\

2804

.sp -1

2805

.IP \(bu 2.3

2806

.\}

2807

2808

\fBuse\-head\fR

2809

.RE

2810

.sp

2811

.RS 4

2812

.ie n \{\

2813

\h'-04'\(bu\h'+03'\c

2814

.\}

2815

.el \{\

2816

.sp -1

2817

.IP \(bu 2.3

2818

.\}

2819

2820

\fBuser\-agent\fR

2821

.RE

2822

.sp

2823

These options have exactly same meaning of the ones in the command\-line options, but it just applies to the URIs it belongs to\&. Please note that for options in input file "\-\-" prefix must be stripped\&.

2616

2824

.sp

2617

2825

For example, the content of uri\&.txt is

2618

2826

.sp

2699

2907

.RE

2700

2908

.SS "Methods"

2701

2909

.sp

2702

\fBaria2\&.addUri\fR \fIuris[, options[, position]]\fR

2703

.sp

2704

This method adds new HTTP(S)/FTP/BitTorrent Magnet URI\&. \fIuris\fR is of type array and its element is URI which is of type string\&. For BitTorrent Magnet URI, \fIuris\fR must have only one element and it should be BitTorrent Magnet URI\&. URIs in \fIuris\fR must point to the same file\&. For example, a file chunkybaconlinux\&.iso is hosted in 2 locations: http://server/chunkybaconlinux\&.iso and http://mirror/chunkybaconlinux\&.iso\&. You can download this iso image using 2 URIs by issuing aria2\&.addUri([\fIhttp://server/chunkybaconlinux\&.iso\fR, \fIhttp://mirror/chunkybaconlinux\&.iso\fR])\&. Imagine there is an another file URI, say, http://mirror2/chunkydonutslinux\&.iso, which is different iso image\&. You cannot mix this URI with previous URIs in one aria2\&.addUri command\&. If you do, aria2 does not complain but download may fail\&. \fIoptions\fR is of type struct and its members are a pair of option name and value\&. See \fBOptions\fR below for more details\&. If \fIposition\fR is given as an integer starting from 0, the new download is inserted at \fIposition\fR in the waiting queue\&. If \fIposition\fR is not given or \fIposition\fR is larger than the size of the queue, it is appended at the end of the queue\&. This method returns GID of registered download\&.

2705

.sp

2706

\fBaria2\&.addTorrent\fR \fItorrent[, uris[, options[, position]]]\fR

2910

All code examples come from Python2\&.7 interpreter\&.

2911

.sp

2912

.it 1 an-trap

2913

.nr an-no-space-flag 1

2914

.nr an-break-flag 1

2915

.br

2916

.ps +1

2917

\fBaria2.addUri (uris[, options[, position]])\fR

2918

.RS 4

2919

.sp

2920

2921

.sp

2922

The following example adds http://example\&.org/file to aria2:

2923

.sp

2924

.if n \{\

2925

.RS 4

2926

.\}

2927

.nf

2928

>>> import xmlrpclib

2929

>>> s = xmlrpclib\&.ServerProxy(\*(Aqhttp://localhost:6800/rpc\*(Aq)

2930

>>> s\&.aria2\&.addUri([\*(Aqhttp://example\&.org/file\*(Aq])

2931

\*(Aq1\*(Aq

2932

.fi

2933

.if n \{\

2934

.RE

2935

.\}

2936

.sp

2937

The following example adds 2 sources and some options:

2938

.sp

2939

.if n \{\

2940

.RS 4

2941

.\}

2942

.nf

2943

>>> s\&.aria2\&.addUri([\*(Aqhttp://example\&.org/file\*(Aq], dict(dir="/tmp"))

2944

\*(Aq2\*(Aq

2945

.fi

2946

.if n \{\

2947

.RE

2948

.\}

2949

.sp

2950

The following example adds a download and insert it to the front of waiting downloads:

2951

.sp

2952

.if n \{\

2953

.RS 4

2954

.\}

2955

.nf

2956

>>> s\&.aria2\&.addUri([\*(Aqhttp://example\&.org/file\*(Aq], {}, 0)

2957

\*(Aq3\*(Aq

2958

.fi

2959

.if n \{\

2960

.RE

2961

.\}

2962

.RE

2963

.sp

2964

.it 1 an-trap

2965

.nr an-no-space-flag 1

2966

.nr an-break-flag 1

2967

.br

2968

.ps +1

2969

\fBaria2.addTorrent (torrent[, uris[, options[, position]]])\fR

2970

.RS 4

2707

2971

.sp

2708

2972

This method adds BitTorrent download by uploading \&.torrent file\&. If you want to add BitTorrent Magnet URI, use \fBaria2\&.addUri\fR method instead\&. \fItorrent\fR is of type base64 which contains Base64\-encoded \&.torrent file\&. \fIuris\fR is of type array and its element is URI which is of type string\&. \fIuris\fR is used for Web\-seeding\&. For single file torrents, URI can be a complete URI pointing to the resource or if URI ends with /, name in torrent file is added\&. For multi\-file torrents, name and path in torrent are added to form a URI for each file\&. \fIoptions\fR is of type struct and its members are a pair of option name and value\&. See \fBOptions\fR below for more details\&. If \fIposition\fR is given as an integer starting from 0, the new download is inserted at \fIposition\fR in the waiting queue\&. If \fIposition\fR is not given or \fIposition\fR is larger than the size of the queue, it is appended at the end of the queue\&. This method returns GID of registered download\&. Please note that the downloads added by this method are not saved by \fB\-\-save\-session\fR\&.

2709

2973

.sp

2710

\fBaria2\&.addMetalink\fR \fImetalink[, options[, position]]\fR

2974

The following example adds local file file\&.torrent to aria2:

2975

.sp

2976

.if n \{\

2977

.RS 4

2978

.\}

2979

.nf

2980

>>> import xmlrpclib

2981

>>> s = xmlrpclib\&.ServerProxy(\*(Aqhttp://localhost:6800/rpc\*(Aq)

2982

>>> s\&.aria2\&.addTorrent(xmlrpclib\&.Binary(open(\*(Aqfile\&.torrent\*(Aq)\&.read()))

2983

\*(Aq6\*(Aq

2984

.fi

2985

.if n \{\

2986

.RE

2987

.\}

2988

.RE

2989

.sp

2990

.it 1 an-trap

2991

.nr an-no-space-flag 1

2992

.nr an-break-flag 1

2993

.br

2994

.ps +1

2995

\fBaria2.addMetalink (metalink[, options[, position]])\fR

2996

.RS 4

2711

2997

.sp

2712

2998

This method adds Metalink download by uploading \&.metalink file\&. \fImetalink\fR is of type base64 which contains Base64\-encoded \&.metalink file\&. \fIoptions\fR is of type struct and its members are a pair of option name and value\&. See \fBOptions\fR below for more details\&. If \fIposition\fR is given as an integer starting from 0, the new download is inserted at \fIposition\fR in the waiting queue\&. If \fIposition\fR is not given or \fIposition\fR is larger than the size of the queue, it is appended at the end of the queue\&. This method returns array of GID of registered download\&. Please note that the downloads added by this method are not saved by \fB\-\-save\-session\fR\&.

2713

2999

.sp

2714

\fBaria2\&.remove\fR \fIgid\fR

3000

The following example adds local file file\&.meta4 to aria2:

3001

.sp

3002

.if n \{\

3003

.RS 4

3004

.\}

3005

.nf

3006

>>> import xmlrpclib

3007

>>> s = xmlrpclib\&.ServerProxy(\*(Aqhttp://localhost:6800/rpc\*(Aq)

3008

>>> s\&.aria2\&.addMetalink(xmlrpclib\&.Binary(open(\*(Aqfile\&.meta4\*(Aq)\&.read()))

3009

[\*(Aq8\*(Aq]

3010

.fi

3011

.if n \{\

3012

.RE

3013

.\}

3014

.RE

3015

.sp

3016

.it 1 an-trap

3017

.nr an-no-space-flag 1

3018

.nr an-break-flag 1

3019

.br

3020

.ps +1

3021

\fBaria2.remove (gid)\fR

3022

.RS 4

2715

3023

.sp

2716

3024

This method removes the download denoted by \fIgid\fR\&. \fIgid\fR is of type string\&. If specified download is in progress, it is stopped at first\&. The status of removed download becomes "removed"\&. This method returns GID of removed download\&.

2717

3025

.sp

2718

\fBaria2\&.forceRemove\fR \fIgid\fR

3026

The following example removes download whose GID is "3":

3027

.sp

3028

.if n \{\

3029

.RS 4

3030

.\}

3031

.nf

3032

>>> import xmlrpclib

3033

>>> s = xmlrpclib\&.ServerProxy(\*(Aqhttp://localhost:6800/rpc\*(Aq)

3034

>>> s\&.aria2\&.remove(\*(Aq3\*(Aq)

3035

\*(Aq3\*(Aq

3036

.fi

3037

.if n \{\

3038

.RE

3039

.\}

3040

.RE

3041

.sp

3042

.it 1 an-trap

3043

.nr an-no-space-flag 1

3044

.nr an-break-flag 1

3045

.br

3046

.ps +1

3047

\fBaria2.forceRemove (gid)\fR

3048

.RS 4

2719

3049

.sp

2720

3050

This method removes the download denoted by \fIgid\fR\&. This method behaves just like \fBaria2\&.remove\fR except that this method removes download without any action which takes time such as contacting BitTorrent tracker\&.

3051

.RE

2721

3052

.sp

2722

\fBaria2\&.pause\fR \fIgid\fR

3053

.it 1 an-trap

3054

.nr an-no-space-flag 1

3055

.nr an-break-flag 1

3056

.br

3057

.ps +1

3058

\fBaria2.pause (gid)\fR

3059

.RS 4

2723

3060

.sp

2724

3061

This method pauses the download denoted by \fIgid\fR\&. \fIgid\fR is of type string\&. The status of paused download becomes "paused"\&. If the download is active, the download is placed on the first position of waiting queue\&. As long as the status is "paused", the download is not started\&. To change status to "waiting", use \fBaria2\&.unpause\fR method\&. This method returns GID of paused download\&.

3062

.RE

2725

3063

.sp

2726

\fBaria2\&.pauseAll\fR

3064

.it 1 an-trap

3065

.nr an-no-space-flag 1

3066

.nr an-break-flag 1

3067

.br

3068

.ps +1

3069

\fBaria2.pauseAll ()\fR

3070

.RS 4

2727

3071

.sp

2728

3072

This method is equal to calling \fBaria2\&.pause\fR for every active/waiting download\&. This methods returns "OK" for success\&.

3073

.RE

2729

3074

.sp

2730

\fBaria2\&.forcePause\fR \fIpid\fR

3075

.it 1 an-trap

3076

.nr an-no-space-flag 1

3077

.nr an-break-flag 1

3078

.br

3079

.ps +1

3080

\fBaria2.forcePause (pid)\fR

3081

.RS 4

2731

3082

.sp

2732

3083

This method pauses the download denoted by \fIgid\fR\&. This method behaves just like \fBaria2\&.pause\fR except that this method pauses download without any action which takes time such as contacting BitTorrent tracker\&.

3084

.RE

2733

3085

.sp

2734

\fBaria2\&.forcePauseAll\fR

3086

.it 1 an-trap

3087

.nr an-no-space-flag 1

3088

.nr an-break-flag 1

3089

.br

3090

.ps +1

3091

\fBaria2.forcePauseAll ()\fR

3092

.RS 4

2735

3093

.sp

2736

3094

This method is equal to calling \fBaria2\&.forcePause\fR for every active/waiting download\&. This methods returns "OK" for success\&.

3095

.RE

2737

3096

.sp

2738

\fBaria2\&.unpause\fR \fIgid\fR

3097

.it 1 an-trap

3098

.nr an-no-space-flag 1

3099

.nr an-break-flag 1

3100

.br

3101

.ps +1

3102

\fBaria2.unpause (gid)\fR

3103

.RS 4

2739

3104

.sp

2740

3105

This method changes the status of the download denoted by \fIgid\fR from "paused" to "waiting"\&. This makes the download eligible to restart\&. \fIgid\fR is of type string\&. This method returns GID of unpaused download\&.

3106

.RE

2741

3107

.sp

2742

\fBaria2\&.unpauseAll\fR

3108

.it 1 an-trap

3109

.nr an-no-space-flag 1

3110

.nr an-break-flag 1

3111

.br

3112

.ps +1

3113

\fBaria2.unpauseAll ()\fR

3114

.RS 4

2743

3115

.sp

2744

3116

This method is equal to calling \fBaria2\&.unpause\fR for every active/waiting download\&. This methods returns "OK" for success\&.

2745

.sp

2746

\fBaria2\&.tellStatus\fR \fIgid\fR

2747

.sp

2748

This method returns download progress of the download denoted by \fIgid\fR\&. \fIgid\fR is of type string\&. The response is of type struct and it contains following keys\&. The value type is string\&.

3117

.RE

3118

.sp

3119

.it 1 an-trap

3120

.nr an-no-space-flag 1

3121

.nr an-break-flag 1

3122

.br

3123

.ps +1

3124

\fBaria2.tellStatus (gid[, keys])\fR

3125

.RS 4

3126

.sp

3127

This method returns download progress of the download denoted by \fIgid\fR\&. \fIgid\fR is of type string\&. \fIkeys\fR is array of string\&. If it is specified, the response contains only keys in \fIkeys\fR array\&. If \fIkeys\fR is empty or not specified, the response contains all keys\&. This is useful when you just want specific keys and avoid unnecessary transfers\&. For example, \fBaria2\&.tellStatus\fR("1", ["gid", "status"]) returns \fIgid\fR and \fIstatus\fR key\&. The response is of type struct and it contains following keys\&. The value type is string\&.

2749

3128

.PP

2750

3129

gid

2751

3130

.RS 4

2814

3193

.PP

2815

3194

errorCode

2816

3195

.RS 4

2817

The last error code occurred in this download\&. The value is of type string\&. The error codes are defined in EXIT STATUS section\&. This value is only available for stopped/completed downloads\&.

3196

The last error code occurred in this download\&. The value is of type string\&. The error codes are defined in

3197

\fBEXIT STATUS\fR

3198

section\&. This value is only available for stopped/completed downloads\&.

2818

3199

.RE

2819

3200

.PP

2820

3201

followedBy

2879

3260

.RE

2880

3261

.RE

2881

3262

.sp

2882

\fBaria2\&.getUris\fR \fIgid\fR

3263

The following example gets information about download whose GID is "1":

3264

.sp

3265

.if n \{\

3266

.RS 4

3267

.\}

3268

.nf

3269

>>> import xmlrpclib

3270

>>> from pprint import pprint

3271

>>> s = xmlrpclib\&.ServerProxy(\*(Aqhttp://localhost:6800/rpc\*(Aq)

3272

>>> r = s\&.aria2\&.tellStatus(\*(Aq1\*(Aq)

3273

>>> pprint(r)

3274

{\*(Aqbitfield\*(Aq: \*(Aqffff80\*(Aq,

3275

\*(AqcompletedLength\*(Aq: \*(Aq34896138\*(Aq,

3276

\*(Aqconnections\*(Aq: \*(Aq0\*(Aq,

3277

\*(Aqdir\*(Aq: \*(Aq/downloads\*(Aq,

3278

\*(AqdownloadSpeed\*(Aq: \*(Aq0\*(Aq,

3279

\*(AqerrorCode\*(Aq: \*(Aq0\*(Aq,

3280

\*(Aqfiles\*(Aq: [{\*(Aqindex\*(Aq: \*(Aq1\*(Aq,

3281

\*(Aqlength\*(Aq: \*(Aq34896138\*(Aq,

3282

\*(Aqpath\*(Aq: \*(Aq/downloads/file\*(Aq,

3283

\*(Aqselected\*(Aq: \*(Aqtrue\*(Aq,

3284

\*(Aquris\*(Aq: [{\*(Aqstatus\*(Aq: \*(Aqused\*(Aq,

3285

\*(Aquri\*(Aq: \*(Aqhttp://example\&.org/file\*(Aq}]}],

3286

\*(Aqgid\*(Aq: \*(Aq1\*(Aq,

3287

\*(AqnumPieces\*(Aq: \*(Aq17\*(Aq,

3288

\*(AqpieceLength\*(Aq: \*(Aq2097152\*(Aq,

3289

\*(Aqstatus\*(Aq: \*(Aqcomplete\*(Aq,

3290

\*(AqtotalLength\*(Aq: \*(Aq34896138\*(Aq,

3291

\*(AquploadLength\*(Aq: \*(Aq0\*(Aq,

3292

\*(AquploadSpeed\*(Aq: \*(Aq0\*(Aq}

3293

.fi

3294

.if n \{\

3295

.RE

3296

.\}

3297

.sp

3298

The following example gets information specifying keys you are interested in:

3299

.sp

3300

.if n \{\

3301

.RS 4

3302

.\}

3303

.nf

3304

>>> r = s\&.aria2\&.tellStatus(\*(Aq1\*(Aq, [\*(Aqgid\*(Aq, \*(AqtotalLength\*(Aq, \*(AqcompletedLength\*(Aq])

3305

>>> pprint(r)

3306

{\*(AqcompletedLength\*(Aq: \*(Aq34896138\*(Aq, \*(Aqgid\*(Aq: \*(Aq1\*(Aq, \*(AqtotalLength\*(Aq: \*(Aq34896138\*(Aq}

3307

.fi

3308

.if n \{\

3309

.RE

3310

.\}

3311

.RE

3312

.sp

3313

.it 1 an-trap

3314

.nr an-no-space-flag 1

3315

.nr an-break-flag 1

3316

.br

3317

.ps +1

3318

\fBaria2.getUris (gid)\fR

3319

.RS 4

2883

3320

.sp

2884

3321

This method returns URIs used in the download denoted by \fIgid\fR\&. \fIgid\fR is of type string\&. The response is of type array and its element is of type struct and it contains following keys\&. The value type is string\&.

2885

3322

.PP

2897

3334

if the URI is waiting in the queue\&.

2898

3335

.RE

2899

3336

.sp

2900

\fBaria2\&.getFiles\fR \fIgid\fR

3337

.if n \{\

3338

.RS 4

3339

.\}

3340

.nf

3341

>>> import xmlrpclib

3342

>>> from pprint import pprint

3343

>>> s = xmlrpclib\&.ServerProxy(\*(Aqhttp://localhost:6800/rpc\*(Aq)

3344

>>> r = s\&.aria2\&.getUris(\*(Aq1\*(Aq)

3345

>>> pprint(r)

3346

[{\*(Aqstatus\*(Aq: \*(Aqused\*(Aq, \*(Aquri\*(Aq: \*(Aqhttp://example\&.org/file\*(Aq}]

3347

.fi

3348

.if n \{\

3349

.RE

3350

.\}

3351

.RE

3352

.sp

3353

.it 1 an-trap

3354

.nr an-no-space-flag 1

3355

.nr an-break-flag 1

3356

.br

3357

.ps +1

3358

\fBaria2.getFiles (gid)\fR

3359

.RS 4

2901

3360

.sp

2902

3361

This method returns file list of the download denoted by \fIgid\fR\&. \fIgid\fR is of type string\&. The response is of type array and its element is of type struct and it contains following keys\&. The value type is string\&.

2903

3362

.PP

2932

3391

method\&.

2933

3392

.RE

2934

3393

.sp

2935

\fBaria2\&.getPeers\fR \fIgid\fR

3394

.if n \{\

3395

.RS 4

3396

.\}

3397

.nf

3398

>>> import xmlrpclib

3399

>>> from pprint import pprint

3400

>>> s = xmlrpclib\&.ServerProxy(\*(Aqhttp://localhost:6800/rpc\*(Aq)

3401

>>> r = s\&.aria2\&.getFiles(\*(Aq1\*(Aq)

3402

>>> pprint(r)

3403

[{\*(Aqindex\*(Aq: \*(Aq1\*(Aq,

3404

\*(Aqlength\*(Aq: \*(Aq34896138\*(Aq,

3405

\*(Aqpath\*(Aq: \*(Aq/downloads/file\*(Aq,

3406

\*(Aqselected\*(Aq: \*(Aqtrue\*(Aq,

3407

\*(Aquris\*(Aq: [{\*(Aqstatus\*(Aq: \*(Aqused\*(Aq,

3408

\*(Aquri\*(Aq: \*(Aqhttp://example\&.org/file\*(Aq}]}]

3409

.fi

3410

.if n \{\

3411

.RE

3412

.\}

3413

.RE

3414

.sp

3415

.it 1 an-trap

3416

.nr an-no-space-flag 1

3417

.nr an-break-flag 1

3418

.br

3419

.ps +1

3420

\fBaria2.getPeers (gid)\fR

3421

.RS 4

2936

3422

.sp

2937

3423

This method returns peer list of the download denoted by \fIgid\fR\&. \fIgid\fR is of type string\&. This method is for BitTorrent only\&. The response is of type array and its element is of type struct and it contains following keys\&. The value type is string\&.

2938

3424

.PP

2981

3467

"true" is this client is a seeder\&. Otherwise "false"\&.

2982

3468

.RE

2983

3469

.sp

2984

\fBaria2\&.getServers\fR \fIgid\fR

3470

.if n \{\

3471

.RS 4

3472

.\}

3473

.nf

3474

>>> import xmlrpclib

3475

>>> from pprint import pprint

3476

>>> s = xmlrpclib\&.ServerProxy(\*(Aqhttp://localhost:6800/rpc\*(Aq)

3477

>>> r = s\&.aria2\&.getPeers(\*(Aq1\*(Aq)

3478

>>> pprint(r)

3479

[{\*(AqamChoking\*(Aq: \*(Aqtrue\*(Aq,

3480

\*(Aqbitfield\*(Aq: \*(Aqffffffffffffffffffffffffffffffffffffffff\*(Aq,

3481

\*(AqdownloadSpeed\*(Aq: \*(Aq10602\*(Aq,

3482

\*(Aqip\*(Aq: \*(Aq10\&.0\&.0\&.9\*(Aq,

3483

\*(AqpeerChoking\*(Aq: \*(Aqfalse\*(Aq,

3484

\*(AqpeerId\*(Aq: \*(Aqaria2%2F1%2E10%2E5%2D%87%2A%EDz%2F%F7%E6\*(Aq,

3485

\*(Aqport\*(Aq: \*(Aq6881\*(Aq,

3486

\*(Aqseeder\*(Aq: \*(Aqtrue\*(Aq,

3487

\*(AquploadSpeed\*(Aq: \*(Aq0\*(Aq},

3488

{\*(AqamChoking\*(Aq: \*(Aqfalse\*(Aq,

3489

\*(Aqbitfield\*(Aq: \*(Aqffffeff0fffffffbfffffff9fffffcfff7f4ffff\*(Aq,

3490

\*(AqdownloadSpeed\*(Aq: \*(Aq8654\*(Aq,

3491

\*(Aqip\*(Aq: \*(Aq10\&.0\&.0\&.30\*(Aq,

3492

\*(AqpeerChoking\*(Aq: \*(Aqfalse\*(Aq,

3493

\*(AqpeerId\*(Aq: \*(Aqbittorrent client758\*(Aq,

3494

\*(Aqport\*(Aq: \*(Aq37842\*(Aq,

3495

\*(Aqseeder\*(Aq: \*(Aqfalse,

3496

\*(AquploadSpeed\*(Aq: \*(Aq6890\*(Aq}]

3497

.fi

3498

.if n \{\

3499

.RE

3500

.\}

3501

.RE

3502

.sp

3503

.it 1 an-trap

3504

.nr an-no-space-flag 1

3505

.nr an-break-flag 1

3506

.br

3507

.ps +1

3508

\fBaria2.getServers (gid)\fR

3509

.RS 4

2985

3510

.sp

2986

3511

This method returns currently connected HTTP(S)/FTP servers of the download denoted by \fIgid\fR\&. \fIgid\fR is of type string\&. The response is of type array and its element is of type struct and it contains following keys\&. The value type is string\&.

2987

3512

.PP

3010

3535

.RE

3011

3536

.RE

3012

3537

.sp

3013

\fBaria2\&.tellActive\fR

3014

.sp

3015

This method returns the list of active downloads\&. The response is of type array and its element is the same struct returned by \fBaria2\&.tellStatus\fR method\&.

3016

.sp

3017

\fBaria2\&.tellWaiting\fR \fIoffset, num\fR

3018

.sp

3019

This method returns the list of waiting download, including paused downloads\&. \fIoffset\fR is of type integer and specifies the offset from the download waiting at the front\&. \fInum\fR is of type integer and specifies the number of downloads to be returned\&.

3538

.if n \{\

3539

.RS 4

3540

.\}

3541

.nf

3542

>>> import xmlrpclib

3543

>>> from pprint import pprint

3544

>>> s = xmlrpclib\&.ServerProxy(\*(Aqhttp://localhost:6800/rpc\*(Aq)

3545

>>> r = s\&.aria2\&.getServers(\*(Aq1\*(Aq)

3546

>>> pprint(r)

3547

[{\*(Aqindex\*(Aq: \*(Aq1\*(Aq,

3548

\*(Aqservers\*(Aq: [{\*(AqcurrentUri\*(Aq: \*(Aqhttp://example\&.org/dl/file\*(Aq,

3549

\*(AqdownloadSpeed\*(Aq: \*(Aq20285\*(Aq,

3550

\*(Aquri\*(Aq: \*(Aqhttp://example\&.org/file\*(Aq}]}]

3551

.fi

3552

.if n \{\

3553

.RE

3554

.\}

3555

.RE

3556

.sp

3557

.it 1 an-trap

3558

.nr an-no-space-flag 1

3559

.nr an-break-flag 1

3560

.br

3561

.ps +1

3562

\fBaria2.tellActive ([keys])\fR

3563

.RS 4

3564

.sp

3565

This method returns the list of active downloads\&. The response is of type array and its element is the same struct returned by \fBaria2\&.tellStatus\fR method\&. For \fIkeys\fR parameter, please refer to \fBaria2\&.tellStatus\fR method\&.

3566

.RE

3567

.sp

3568

.it 1 an-trap

3569

.nr an-no-space-flag 1

3570

.nr an-break-flag 1

3571

.br

3572

.ps +1

3573

\fBaria2.tellWaiting (offset, num, [keys])\fR

3574

.RS 4

3575

.sp

3576

3020

3577

.sp

3021

3578

If offset is a positive integer, this method returns downloads in the range of [\fIoffset\fR, \fIoffset\fR+\fInum\fR)\&.

3022

3579

.sp

3025

3582

For example, imagine that three downloads "A","B" and "C" are waiting in this order\&. aria2\&.tellWaiting(0, 1) returns ["A"]\&. aria2\&.tellWaiting(1, 2) returns ["B", "C"]\&. aria2\&.tellWaiting(\-1, 2) returns ["C", "B"]\&.

3026

3583

.sp

3027

3584

The response is of type array and its element is the same struct returned by \fBaria2\&.tellStatus\fR method\&.

3028

.sp

3029

\fBaria2\&.tellStopped\fR \fIoffset, num\fR

3030

.sp

3031

This method returns the list of stopped download\&. \fIoffset\fR is of type integer and specifies the offset from the oldest download\&. \fInum\fR is of type integer and specifies the number of downloads to be returned\&.

3585

.RE

3586

.sp

3587

.it 1 an-trap

3588

.nr an-no-space-flag 1

3589

.nr an-break-flag 1

3590

.br

3591

.ps +1

3592

\fBaria2.tellStopped (offset, num, [keys])\fR

3593

.RS 4

3594

.sp

3595

3032

3596

.sp

3033

3597

\fIoffset\fR and \fInum\fR have the same semantics as \fBaria2\&.tellWaiting\fR method\&.

3034

3598

.sp

3035

3599

The response is of type array and its element is the same struct returned by \fBaria2\&.tellStatus\fR method\&.

3600

.RE

3036

3601

.sp

3037

\fBaria2\&.changePosition\fR \fIgid, pos, how\fR

3602

.it 1 an-trap

3603

.nr an-no-space-flag 1

3604

.nr an-break-flag 1

3605

.br

3606

.ps +1

3607

\fBaria2.changePosition (gid, pos, how)\fR

3608

.RS 4

3038

3609

.sp

3039

3610

This method changes the position of the download denoted by \fIgid\fR\&. \fIpos\fR is of type integer\&. \fIhow\fR is of type string\&. If \fIhow\fR is "POS_SET", it moves the download to a position relative to the beginning of the queue\&. If \fIhow\fR is "POS_CUR", it moves the download to a position relative to the current position\&. If \fIhow\fR is "POS_END", it moves the download to a position relative to the end of the queue\&. If the destination position is less than 0 or beyond the end of the queue, it moves the download to the beginning or the end of the queue respectively\&. The response is of type integer and it is the destination position\&.

3040

3611

.sp

3041

3612

For example, if GID#1 is placed in position 3, aria2\&.changePosition(1, \-1, POS_CUR) will change its position to 2\&. Additional aria2\&.changePosition(1, 0, POS_SET) will change its position to 0(the beginning of the queue)\&.

3042

3613

.sp

3043

\fBaria2\&.changeUri\fR \fIgid, fileIndex, delUris, addUris[, position]\fR

3614

The following example moves the download whose GID is "3" to the front of the waiting queue:

3615

.sp

3616

.if n \{\

3617

.RS 4

3618

.\}

3619

.nf

3620

>>> import xmlrpclib

3621

>>> s = xmlrpclib\&.ServerProxy(\*(Aqhttp://localhost:6800/rpc\*(Aq)

3622

>>> s\&.aria2\&.changePosition(\*(Aq3\*(Aq, 0, \*(AqPOS_SET\*(Aq)

3623

3624

.fi

3625

.if n \{\

3626

.RE

3627

.\}

3628

.RE

3629

.sp

3630

.it 1 an-trap

3631

.nr an-no-space-flag 1

3632

.nr an-break-flag 1

3633

.br

3634

.ps +1

3635

\fBaria2.changeUri (gid, fileIndex, delUris, addUris[, position])\fR

3636

.RS 4

3044

3637

.sp

3045

3638

This method removes URIs in \fIdelUris\fR from and appends URIs in \fIaddUris\fR to download denoted by \fIgid\fR\&. \fIdelUris\fR and \fIaddUris\fR are list of string\&. A download can contain multiple files and URIs are attached to each file\&. \fIfileIndex\fR is used to select which file to remove/attach given URIs\&. \fIfileIndex\fR is 1\-based\&. \fIposition\fR is used to specify where URIs are inserted in the existing waiting URI list\&. \fIposition\fR is 0\-based\&. When \fIposition\fR is omitted, URIs are appended to the back of the list\&. This method first execute removal and then addition\&. \fIposition\fR is the position after URIs are removed, not the position when this method is called\&. When removing URI, if same URIs exist in download, only one of them is removed for each URI in \fIdelUris\fR\&. In other words, there are three URIs "http://example\&.org/aria2" and you want remove them all, you have to specify (at least) 3 "http://example\&.org/aria2" in \fIdelUris\fR\&. This method returns a list which contains 2 integers\&. The first integer is the number of URIs deleted\&. The second integer is the number of URIs added\&.

3046

3639

.sp

3047

\fBaria2\&.getOption\fR \fIgid\fR

3640

The following example adds 1 URI http://example\&.org/file to the file whose index is "1" and belongs to the download whose GID is "2":

3641

.sp

3642

.if n \{\

3643

.RS 4

3644

.\}

3645

.nf

3646

>>> import xmlrpclib

3647

>>> s = xmlrpclib\&.ServerProxy(\*(Aqhttp://localhost:6800/rpc\*(Aq)

3648

>>> s\&.aria2\&.changeUri(\*(Aq2\*(Aq, 1, [], [\*(Aqhttp://example\&.org/file\*(Aq])

3649

[0, 1]

3650

.fi

3651

.if n \{\

3652

.RE

3653

.\}

3654

.RE

3655

.sp

3656

.it 1 an-trap

3657

.nr an-no-space-flag 1

3658

.nr an-break-flag 1

3659

.br

3660

.ps +1

3661

\fBaria2.getOption (gid)\fR

3662

.RS 4

3048

3663

.sp

3049

3664

This method returns options of the download denoted by \fIgid\fR\&. The response is of type struct\&. Its key is the name of option\&. The value type is string\&.

3050

3665

.sp

3051

\fBaria2\&.changeOption\fR \fIgid, options\fR

3666

The following example gets options of the download whose GID is "1":

3667

.sp

3668

.if n \{\

3669

.RS 4

3670

.\}

3671

.nf

3672

>>> import xmlrpclib

3673

>>> from pprint import pprint

3674

>>> s = xmlrpclib\&.ServerProxy(\*(Aqhttp://localhost:6800/rpc\*(Aq)

3675

>>> r = s\&.aria2\&.getOption(\*(Aq1\*(Aq)

3676

>>> pprint(r)

3677

{\*(Aqallow\-overwrite\*(Aq: \*(Aqfalse\*(Aq,

3678

\*(Aqallow\-piece\-length\-change\*(Aq: \*(Aqfalse\*(Aq,

3679

\*(Aqalways\-resume\*(Aq: \*(Aqtrue\*(Aq,

3680

\*(Aqasync\-dns\*(Aq: \*(Aqtrue\*(Aq,

3681

\&.\&.\&.\&.

3682

.fi

3683

.if n \{\

3684

.RE

3685

.\}

3686

.RE

3687

.sp

3688

.it 1 an-trap

3689

.nr an-no-space-flag 1

3690

.nr an-break-flag 1

3691

.br

3692

.ps +1

3693

\fBaria2.changeOption (gid, options)\fR

3694

.RS 4

3052

3695

.sp

3053

3696

This method changes options of the download denoted by \fIgid\fR dynamically\&. \fIgid\fR is of type string\&. \fIoptions\fR is of type struct and the available options are: \fBbt\-max\-peers\fR, \fBbt\-request\-peer\-speed\-limit\fR, \fBmax\-download\-limit\fR and \fBmax\-upload\-limit\fR\&. This method returns "OK" for success\&.

3054

3697

.sp

3055

\fBaria2\&.getGlobalOption\fR

3698

The following example sets \fBmax\-download\-limit\fR option to "20K" for the download whose GID is "1"\&.

3699

.sp

3700

.if n \{\

3701

.RS 4

3702

.\}

3703

.nf

3704

>>> import xmlrpclib

3705

>>> s = xmlrpclib\&.ServerProxy(\*(Aqhttp://localhost:6800/rpc\*(Aq)

3706

>>> s\&.aria2\&.changeOption(\*(Aq1\*(Aq, {\*(Aqmax\-download\-limit\*(Aq:\*(Aq20K\*(Aq})

3707

\*(AqOK\*(Aq

3708

.fi

3709

.if n \{\

3710

.RE

3711

.\}

3712

.RE

3713

.sp

3714

.it 1 an-trap

3715

.nr an-no-space-flag 1

3716

.nr an-break-flag 1

3717

.br

3718

.ps +1

3719

\fBaria2.getGlobalOption ()\fR

3720

.RS 4

3056

3721

.sp

3057

3722

This method returns global options\&. The response is of type struct\&. Its key is the name of option\&. The value type is string\&. Because global options are used as a template for the options of newly added download, the response contains keys returned by \fBaria2\&.getOption\fR method\&.

3723

.RE

3058

3724

.sp

3059

\fBaria2\&.changeGlobalOption\fR \fIoptions\fR

3725

.it 1 an-trap

3726

.nr an-no-space-flag 1

3727

.nr an-break-flag 1

3728

.br

3729

.ps +1

3730

\fBaria2.changeGlobalOption (options)\fR

3731

.RS 4

3060

3732

.sp

3061

3733

This method changes global options dynamically\&. \fIoptions\fR is of type struct and the available options are \fBmax\-concurrent\-downloads\fR, \fBmax\-overall\-download\-limit\fR, \fBmax\-overall\-upload\-limit\fR, \fBlog\-level\fR and \fBlog\fR\&. Using \fBlog\fR option, you can dynamically start logging or change log file\&. To stop logging, give empty string("") as a parameter value\&. Note that log file is always opened in append mode\&. This method returns "OK" for success\&.

3734

.RE

3062

3735

.sp

3063

\fBaria2\&.purgeDownloadResult\fR

3736

.it 1 an-trap

3737

.nr an-no-space-flag 1

3738

.nr an-break-flag 1

3739

.br

3740

.ps +1

3741

\fBaria2.purgeDownloadResult ()\fR

3742

.RS 4

3064

3743

.sp

3065

3744

This method purges completed/error/removed downloads to free memory\&. This method returns "OK"\&.

3745

.RE

3066

3746

.sp

3067

\fBaria2\&.getVersion\fR

3747

.it 1 an-trap

3748

.nr an-no-space-flag 1

3749

.nr an-break-flag 1

3750

.br

3751

.ps +1

3752

\fBaria2.getVersion ()\fR

3753

.RS 4

3068

3754

.sp

3069

3755

This method returns version of the program and the list of enabled features\&. The response is of type struct and contains following keys\&.

3070

3756

.PP

3078

3764

List of enabled features\&. Each feature name is of type string\&.

3079

3765

.RE

3080

3766

.sp

3081

\fBaria2\&.getSessionInfo\fR

3767

.if n \{\

3768

.RS 4

3769

.\}

3770

.nf

3771

>>> import xmlrpclib

3772

>>> from pprint import pprint

3773

>>> s = xmlrpclib\&.ServerProxy(\*(Aqhttp://localhost:6800/rpc\*(Aq)

3774

>>> r = s\&.aria2\&.getVersion()

3775

>>> pprint(r)

3776

{\*(AqenabledFeatures\*(Aq: [\*(AqAsync DNS\*(Aq,

3777

\*(AqBitTorrent\*(Aq,

3778

\*(AqFirefox3 Cookie\*(Aq,

3779

\*(AqGZip\*(Aq,

3780

\*(AqHTTPS\*(Aq,

3781

\*(AqMessage Digest\*(Aq,

3782

\*(AqMetalink\*(Aq,

3783

\*(AqXML\-RPC\*(Aq],

3784

\*(Aqversion\*(Aq: \*(Aq1\&.10\&.5\*(Aq}

3785

.fi

3786

.if n \{\

3787

.RE

3788

.\}

3789

.RE

3790

.sp

3791

.it 1 an-trap

3792

.nr an-no-space-flag 1

3793

.nr an-break-flag 1

3794

.br

3795

.ps +1

3796

\fBaria2.getSessionInfo ()\fR

3797

.RS 4

3082

3798

.sp

3083

3799

This method returns session information\&. The response is of type struct and contains following key\&.

3084

3800

.PP

3087

3803

Session ID, which is generated each time when aria2 is invoked\&.

3088

3804

.RE

3089

3805

.sp

3090

\fBaria2\&.shutdown\fR

3806

.if n \{\

3807

.RS 4

3808

.\}

3809

.nf

3810

>>> import xmlrpclib

3811

>>> s = xmlrpclib\&.ServerProxy(\*(Aqhttp://localhost:6800/rpc\*(Aq)

3812

>>> s\&.aria2\&.getSessionInfo()

3813

{\*(AqsessionId\*(Aq: \*(Aqcd6a3bc6a1de28eb5bfa181e5f6b916d44af31a9\*(Aq}

3814

.fi

3815

.if n \{\

3816

.RE

3817

.\}

3818

.RE

3819

.sp

3820

.it 1 an-trap

3821

.nr an-no-space-flag 1

3822

.nr an-break-flag 1

3823

.br

3824

.ps +1

3825

\fBaria2.shutdown ()\fR

3826

.RS 4

3091

3827

.sp

3092

3828

This method shutdowns aria2\&. This method returns "OK"\&.

3829

.RE

3093

3830

.sp

3094

\fBaria2\&.forceShutdown\fR

3831

.it 1 an-trap

3832

.nr an-no-space-flag 1

3833

.nr an-break-flag 1

3834

.br

3835

.ps +1

3836

\fBaria2.forceShutdown ()\fR

3837

.RS 4

3095

3838

.sp

3096

3839

This method shutdowns aria2\&. This method behaves like \fBaria2\&.shutdown\fR except that any actions which takes time such as contacting BitTorrent tracker are skipped\&. This method returns "OK"\&.

3840

.RE

3097

3841

.sp

3098

\fBsystem\&.multicall\fR \fImethods\fR

3842

.it 1 an-trap

3843

.nr an-no-space-flag 1

3844

.nr an-break-flag 1

3845

.br

3846

.ps +1

3847

\fBsystem.multicall (methods)\fR

3848

.RS 4

3099

3849

.sp

3100

3850

This methods encapsulates multiple method calls in a single request\&. \fImethods\fR is of type array and its element is struct\&. The struct contains two keys: "methodName" and "params"\&. "methodName" is the method name to call and "params" is array containing parameters to the method\&. This method returns array of responses\&. The element of array will either be a one\-item array containing the return value of each method call or struct of fault element if an encapsulated method call fails\&.

3851

.sp

3852

In the following example, we add 2 downloads\&. First one is http://example\&.org/file and second one is file\&.torrent:

3853

.sp

3854

.if n \{\

3855

.RS 4

3856

.\}

3857

.nf

3858

>>> import xmlrpclib

3859

>>> s = xmlrpclib\&.ServerProxy(\*(Aqhttp://localhost:6800/rpc\*(Aq)

3860

>>> mc = xmlrpclib\&.MultiCall(s)

3861

>>> mc\&.aria2\&.addUri([\*(Aqhttp://example\&.org/file\*(Aq])

3862

>>> mc\&.aria2\&.addTorrent(xmlrpclib\&.Binary(open(\*(Aqfile\&.torrent\*(Aq)\&.read()))

3863

>>> r = mc()

3864

>>> tuple(r)

3865

(\*(Aq2\*(Aq, \*(Aq3\*(Aq)

3866

.fi

3867

.if n \{\

3868

.RE

3869

.\}

3870

.RE

3101

3871

.SS "Error Handling"

3102

3872

.sp

3103

3873

In case of error, aria2 returns faultCode=1 and the error message in faultString\&.

3149

3919

.if n \{\

3150

3920

.RE

3151

3921

.\}

3922

.sp

3923

Following example adds a download with 2 options: dir and header\&. header option has 2 values, so it uses a list:

3924

.sp

3925

.if n \{\

3926

.RS 4

3927

.\}

3928

.nf

3929

>>> import xmlrpclib

3930

>>> s = xmlrpclib\&.ServerProxy(\*(Aqhttp://localhost:6800/rpc\*(Aq)

3931

>>> opts = dict(dir=\*(Aq/tmp\*(Aq,

3932

\&.\&.\&. header=[\*(AqAccept\-Language: ja\*(Aq,

3933

\&.\&.\&. \*(AqAccept\-Charset: utf\-8\*(Aq])

3934

>>> s\&.aria2\&.addUri([\*(Aqhttp://example\&.org/file\*(Aq], opts)

3935

\*(Aq1\*(Aq

3936

.fi

3937

.if n \{\

3938

.RE

3939

.\}

3152

3940

.SS "Sample XML\-RPC Client Code"

3153

3941

.sp

3154

3942

The following Ruby script adds \fIhttp://localhost/aria2\&.tar\&.bz2\fR to aria2c operated on localhost with option \fB\-\-dir\fR=\fI/downloads\fR and prints its reponse\&.

3251

4039

.nr an-break-flag 1

3252

4040

.br

3253

4041

.ps +1

4042

\fBDownload a file from 1 host using 2 connections\fR

4043

.RS 4

4044

.sp

4045

.if n \{\

4046

.RS 4

4047

.\}

4048

.nf

4049

aria2c \-x2 \-k1M "http://host/file\&.zip"

4050

.fi

4051

.if n \{\

4052

.RE

4053

.\}

4054

.RE

4055

.sp

4056

.it 1 an-trap

4057

.nr an-no-space-flag 1

4058

.nr an-break-flag 1

4059

.br

4060

.ps +1

3254

4061

\fBDownload a file from HTTP and FTP servers\fR

3255

4062

.RS 4

3256

4063

.sp

3845

4652

.nr an-break-flag 1

3846

4653

.br

3847

4654

.ps +1

3848

\fBEnable DHT\fR

4655

\fBEnable IPv4 DHT\fR

3849

4656

.RS 4

3850

4657

.sp

3851

4658

.if n \{\

3874

4681

.sp .5v

3875

4682

.RE

3876

4683

.RE

4684

.sp

4685

.it 1 an-trap

4686

.nr an-no-space-flag 1

4687

.nr an-break-flag 1

4688

.br

4689

.ps +1

4690

\fBEnable IPv6 DHT\fR

4691

.RS 4

4692

.sp

4693

.if n \{\

4694

.RS 4

4695

.\}

4696

.nf

4697

aria2c \-\-enable\-dht6 \-\-dht\-listen\-port=6881 \-\-dht\-listen\-addr6=YOUR_GLOBAL_UNICAST_IPV6_ADDR \-\-enable\-async\-dns6

4698

.fi

4699

.if n \{\

4700

.RE

4701

.\}

4702

.if n \{\

4703

.sp

4704

.\}

4705

.RS 4

4706

.it 1 an-trap

4707

.nr an-no-space-flag 1

4708

.nr an-break-flag 1

4709

.br

4710

.ps +1

4711

\fBNote\fR

4712

.ps -1

4713

.br

4714

.sp

4715

If aria2c is not built with c\-ares, \fB\-\-enable\-async\-dns6\fR is unnecessary\&. aria2 shares same port between IPv4 and IPv6 DHT\&.

4716

.sp .5v

4717

.RE

4718

.RE

4719

.sp

4720

.it 1 an-trap

4721

.nr an-no-space-flag 1

4722

.nr an-break-flag 1

4723

.br

4724

.ps +1

4725

\fBAdd and remove tracker URI\fR

4726

.RS 4

4727

.sp

4728

Removes all tracker announce URIs described in file\&.torrent and use "http://tracker1/announce" and "http://tracker2/announce" instead\&.

4729

.sp

4730

.if n \{\

4731

.RS 4

4732

.\}

4733

.nf

4734

aria2c \-\-bt\-exclude\-tracker="*" \-\-bt\-tracker="http://tracker1/announce,http://tracker2/announce" file\&.torrent

4735

.fi

4736

.if n \{\

4737

.RE

4738

.\}

4739

.RE

3877

4740

.SS "More advanced HTTP features"

3878

4741

.sp

3879

4742

.it 1 an-trap

4167

5030

.sp

4168

5031

Metalink Homepage: http://www\&.metalinker\&.org/

4169

5032

.sp

4170

The Metalink Download Description Format: http://www\&.rfc\-editor\&.org/rfc/rfc5854\&.txt

5033

The Metalink Download Description Format: http://tools\&.ietf\&.org/html/rfc5854

4171

5034

.SH "COPYRIGHT"

4172

5035

.sp

4173

5036

Older »