Skip to content

Commit 003aaf4

Browse files
tatsuhiro-ttatsuhiro-t
committed
Converted README.asciidoc into README.rst
1 parent eec761e commit 003aaf4

File tree

3 files changed

+64
-74
lines changed

3 files changed

+64
-74
lines changed

‎Makefile.am

+3-5
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,9 @@ ACLOCAL_AMFLAGS = -I m4 --install
44

55
EXTRA_DIST = config.rpath
66

7-
dist_doc_DATA = README README.asciidoc README.html
7+
dist_doc_DATA = README README.rst README.html
88

99
dist_noinst_DATA = LICENSE.OpenSSL
1010

11-
if HAVE_ASCIIDOC
12-
README.html: README.asciidoc
13-
@ASCIIDOC@ -d article -b xhtml11 -n README.asciidoc
14-
endif # HAVE_ASCIIDOC
11+
README.html: README.rst
12+
rst2html README.rst > README.html

‎README

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
See README.asciidoc
1+
See README.rst

‎README.asciidoc ‎README.rst

+60-68
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,8 @@ downloading a file like BitTorrent.
2121

2222
The project page is located at http://aria2.sourceforge.net/.
2323

24-
See http://aria2.sourceforge.net/aria2c.1.html[aria2 Online Manual]
25-
and http://sourceforge.net/apps/trac/aria2/wiki/UsageExample[the usage
26-
example] to learn how to use aria2.
24+
See `aria2 Online Manual <http://aria2.sourceforge.net/manual/en/html/>`_
25+
and `the usage examples <http://sourceforge.net/apps/trac/aria2/wiki/UsageExample>`_ to learn how to use aria2.
2726

2827
Features
2928
--------
@@ -55,7 +54,7 @@ Here is a list of features:
5554
* FTP through HTTP Proxy
5655
* Download/Upload speed throttling
5756
* BitTorrent extensions: Fast extension, DHT, PEX, MSE/PSE, Multi-Tracker
58-
* BitTorrent http://getright.com/seedtorrent.html[WEB-Seeding]. aria2
57+
* BitTorrent `WEB-Seeding <http://getright.com/seedtorrent.html>`_. aria2
5958
requests chunks more than piece size to reduce the request
6059
overhead. It also supports pipelined requests with piece size.
6160
* BitTorrent Local Peer Discovery
@@ -79,49 +78,48 @@ How to get source code
7978
We maintain the source code at Github:
8079
https://github.com/tatsuhiro-t/aria2
8180

82-
To download the latest source code, run following command:
81+
To get the latest source code, run following command::
8382

84-
------------------------------------------------
85-
git clone git://github.com/tatsuhiro-t/aria2.git
86-
------------------------------------------------
83+
$ git clone git://github.com/tatsuhiro-t/aria2.git
8784

8885
This will create aria2 directory in your current directory and source
8986
files are stored there.
9087

9188
Dependency
9289
----------
9390

94-
.External Library Dependency
95-
[options="header"]
96-
|==================================================================
97-
|features |dependency
98-
|HTTPS |GnuTLS or OpenSSL
99-
|BitTorrent |libnettle+libgmp or libgcrypt or OpenSSL
100-
|Metalink |libxml2 or Expat.
101-
|Checksum |libnettle or libgcrypt or OpenSSL
102-
|gzip, deflate in HTTP |zlib
103-
|Async DNS |C-Ares
104-
|Firefox3/Chromium cookie|libsqlite3
105-
|XML-RPC |libxml2 or Expat.
106-
|JSON-RPC over WebSocket |libnettle or libgcrypt or OpenSSL
107-
|==================================================================
108-
109-
Note;;
91+
92+
======================== ========================================
93+
features dependency
94+
======================== ========================================
95+
HTTPS GnuTLS or OpenSSL
96+
BitTorrent libnettle+libgmp or libgcrypt or OpenSSL
97+
Metalink libxml2 or Expat.
98+
Checksum libnettle or libgcrypt or OpenSSL
99+
gzip, deflate in HTTP zlib
100+
Async DNS C-Ares
101+
Firefox3/Chromium cookie libsqlite3
102+
XML-RPC libxml2 or Expat.
103+
JSON-RPC over WebSocket libnettle or libgcrypt or OpenSSL
104+
======================== ========================================
105+
106+
107+
.. note::
110108

111109
libxml2 has precedence over Expat if both libraries are installed.
112-
If you prefer Expat, run configure with \--without-libxml2.
110+
If you prefer Expat, run configure with ``--without-libxml2``.
113111

114-
Note;;
112+
.. note::
115113

116114
GnuTLS has precedence over OpenSSL if both libraries are installed.
117-
If you prefer OpenSSL, run configure with \--without-gnutls
118-
\--with-openssl.
115+
If you prefer OpenSSL, run configure with ``--without-gnutls``
116+
``--with-openssl``.
119117

120-
Note;;
118+
.. note::
121119

122120
libnettle has precedence over libgcrypt if both libraries are
123121
installed. If you prefer libgcrypt, run configure with
124-
\--without-libnettle \--with-libgcrypt. If OpenSSL is selected over
122+
``--without-libnettle --with-libgcrypt``. If OpenSSL is selected over
125123
GnuTLS, neither libnettle nor libgcrypt will be used.
126124

127125
A user can have one of the following configurations for SSL and crypto
@@ -133,9 +131,9 @@ libraries:
133131
* GnuTLS + libgcrypt
134132
* GnuTLS + libnettle
135133

136-
You can disable BitTorrent, Metalink support by providing
137-
\--disable-bittorrent, \--disable-metalink respectively to configure
138-
script.
134+
You can disable BitTorrent and Metalink support by providing
135+
``--disable-bittorrent`` and ``--disable-metalink`` to the configure
136+
script respectively.
139137

140138
In order to enable async DNS support, you need c-ares.
141139

@@ -176,21 +174,17 @@ gcc, gcc-c++, kernel-devel, libgcrypt-devel, libgcrypt-devel, libxml2-devel, ope
176174

177175
If you downloaded source code from git repository, you have to run
178176
following command to generate configure script and other files
179-
necessary to build the program:
177+
necessary to build the program::
180178

181-
---------------
182-
$ autoreconf -i
183-
---------------
179+
$ autoreconf -i
184180

185181
If you are building aria2 for Mac OS X, take a look at
186182
build_osx_release.sh, which builds OSX universal binary DMG.
187183

188-
The quickest way to build aria2 is just type following commands:
184+
The quickest way to build aria2 is just type following commands::
189185

190-
-------------
191-
$ ./configure
192-
$ make
193-
-------------
186+
$ ./configure
187+
$ make
194188

195189
The configure script checks available libraries and enables the features
196190
as much as possible because all the features are enabled by default.
@@ -200,43 +194,40 @@ If you build with HTTPS support, I recommend to supply the path to the
200194
CA bundle file. For example, in Debian the path to CA bundle file is
201195
'/etc/ssl/certs/ca-certificates.crt' (in ca-certificates package). This
202196
may vary depending on your distribution. You can give it to
203-
configure script using \--with-ca-bundle option:
197+
configure script using ``--with-ca-bundle option``::
204198

205-
-------------------------------------------------------------------
206-
$ ./configure --with-ca-bundle='/etc/ssl/certs/ca-certificates.crt'
207-
$ make
208-
-------------------------------------------------------------------
199+
$ ./configure --with-ca-bundle='/etc/ssl/certs/ca-certificates.crt'
200+
$ make
209201

210-
Without \--with-ca-bundle option, you will encounter the error when
202+
Without ``--with-ca-bundle`` option, you will encounter the error when
211203
accessing HTTPS servers because the certificate cannot be verified
212204
without CA bundle. In such case, you can specify the CA bundle file
213-
using aria2's \--ca-certificate option. If you don't have CA bundle
205+
using aria2's ``--ca-certificate`` option. If you don't have CA bundle
214206
file installed, then the last resort is disable the certificate
215-
validation using \--check-certificate=false.
207+
validation using ``--check-certificate=false``.
216208

217209
The executable is 'aria2c' in src directory.
218210

219-
aria2 uses CppUnit for automated unit testing. To run the unit test:
211+
aria2 uses CppUnit for automated unit testing. To run the unit test::
220212

221-
------------
222-
$ make check
223-
------------
213+
$ make check
224214

225215
BitTorrrent
226216
-----------
217+
227218
About filename
228219
~~~~~~~~~~~~~~
229220
The filename of the downloaded file is determined as follows:
230221

231-
single-file mode::
222+
single-file mode
232223
If "name" key is present in .torrent file, filename is the value
233224
of "name" key. Otherwise, filename is the basename of .torrent
234225
file appended by ".file". For example, .torrent file is
235226
"test.torrrent", then filename is "test.torrent.file". The
236227
directory to store the downloaded file can be specified by -d
237228
option.
238229

239-
multi-file mode::
230+
multi-file mode
240231
The complete directory/file structure mentioned in .torrent file
241232
is created. The directory to store the top directory of
242233
downloaded files can be specified by -d option.
@@ -245,7 +236,7 @@ Before download starts, a complete directory structure is created if
245236
needed. By default, aria2 opens at most 100 files mentioned in
246237
.torrent file, and directly writes to and reads from these files.
247238
The number of files to open simultaneously can be controlled by
248-
\--bt-max-open-files option.
239+
``--bt-max-open-files`` option.
249240

250241
DHT
251242
~~~
@@ -260,14 +251,14 @@ Other things should be noted
260251

261252
* -o option is used to change the filename of .torrent file itself,
262253
not a filename of a file in .torrent file. For this purpose, use
263-
--index-out option instead.
254+
``--index-out`` option instead.
264255
* The port numbers that aria2 uses by default are 6881-6999 for TCP
265256
and UDP.
266257
* aria2 doesn't configure port-forwarding automatically. Please
267258
configure your router or firewall manually.
268259
* The maximum number of peers is 55. This limit may be exceeded when
269260
download rate is low. This download rate can be adjusted using
270-
\--bt-request-peer-speed-limit option.
261+
``--bt-request-peer-speed-limit`` option.
271262
* As of release 0.10.0, aria2 stops sending request message after
272263
selective download completes.
273264

@@ -306,7 +297,7 @@ piece with selected file are also created.
306297
If relative URI is specified in metalink:url or metalink:metaurl
307298
element, aria2 uses the URI of Metalink file as base URI to resolve
308299
the relative URI. If relative URI is found in Metalink file which is
309-
read from local disk, aria2 uses the value of --metalink-base-uri
300+
read from local disk, aria2 uses the value of ``--metalink-base-uri``
310301
option as base URI. If this option is not specified, the relative URI
311302
will be ignored.
312303

@@ -318,7 +309,7 @@ understands Digest header fields and check whether it matches the
318309
digest value from other sources. If it differs, drop connection.
319310
aria2 also uses this digest value to perform checksum verification
320311
after download finished. aria2 recognizes geo value. To tell aria2
321-
which location you prefer, you can use --metalink-location option.
312+
which location you prefer, you can use ``--metalink-location`` option.
322313

323314
netrc
324315
-----
@@ -334,10 +325,11 @@ defined in RFC 6455. The supported protocol version is 13.
334325

335326
References
336327
----------
337-
* http://aria2.sourceforge.net/aria2c.1.html[aria2 Online Manual]
338-
* http://aria2.sourceforge.net/
339-
* http://sourceforge.net/apps/trac/aria2/wiki
340-
* https://github.com/tatsuhiro-t/aria2
341-
* http://tools.ietf.org/html/rfc5854
342-
* http://tools.ietf.org/html/rfc6249
343-
* http://tools.ietf.org/html/rfc6455
328+
329+
* `aria2 Online Manual <http://aria2.sourceforge.net/manual/en/html/>`_
330+
* http://aria2.sourceforge.net/
331+
* http://sourceforge.net/apps/trac/aria2/wiki
332+
* https://github.com/tatsuhiro-t/aria2
333+
* http://tools.ietf.org/html/rfc5854
334+
* http://tools.ietf.org/html/rfc6249
335+
* http://tools.ietf.org/html/rfc6455

0 commit comments

Comments
 (0)