diff --git a/ChangeLog b/ChangeLog index e80de095..60ba1c90 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,10 @@ +2010-10-22 Tatsuhiro Tsujikawa + + Fixed formatting errors. Added toc list to aria2c.1.html. Escaped + URI properly. + * doc/aria2c.1.txt + * doc/makeman + 2010-10-19 Tatsuhiro Tsujikawa Release 1.10.5 diff --git a/doc/aria2c.1 b/doc/aria2c.1 index 8cf7a4b6..2412dce2 100644 --- a/doc/aria2c.1 +++ b/doc/aria2c.1 @@ -2,12 +2,12 @@ .\" Title: aria2c .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.75.2 -.\" Date: 10/19/2010 +.\" Date: 10/22/2010 .\" Manual: Aria2 Manual .\" Source: Aria2 1.10.5 .\" Language: English .\" -.TH "ARIA2C" "1" "10/19/2010" "Aria2 1\&.10\&.5" "Aria2 Manual" +.TH "ARIA2C" "1" "10/22/2010" "Aria2 1\&.10\&.5" "Aria2 Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -417,18 +417,13 @@ Set password for \fB\-\-http\-proxy\fR option\&. .RE -.sp -\fB\-\-http\-proxy\-user\fR=USER: -.sp -.if n \{\ +.PP +\fB\-\-http\-proxy\-user\fR=USER .RS 4 -.\} -.nf -Set user for *\-\-http\-proxy* option\&. -.fi -.if n \{\ +Set user for +\fB\-\-http\-proxy\fR +option\&. .RE -.\} .PP \fB\-\-https\-proxy\fR=PROXY .RS 4 @@ -473,17 +468,22 @@ Enable HTTP/1\&.1 persistent connection\&. Default: .RS 4 Enable HTTP/1\&.1 pipelining\&. Default: \fIfalse\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -In performance perspective, there is no advantage to enable this -option for normal case\&. -.fi -.if n \{\ .RE +.if n \{\ +.sp .\} +.RS 4 +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.ps +1 +\fBNote\fR +.ps -1 +.br +.sp +In performance perspective, there is usually no advantage to enable this option\&. +.sp .5v .RE .PP \fB\-\-header\fR=HEADER @@ -2816,7 +2816,7 @@ GID(or gid) is the key to manage each download\&. Each download has an unique GI .sp \fBaria2\&.addUri\fR \fIuris[, options[, position]]\fR .sp -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\&. +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(["http://server/chunkybaconlinux\&.iso", "http://mirror/chunkybaconlinux\&.iso"])\&. 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\&. .sp \fBaria2\&.addTorrent\fR \fItorrent[, uris[, options[, position]]]\fR .sp diff --git a/doc/aria2c.1.html b/doc/aria2c.1.html index 95d3080f..65a47444 100644 --- a/doc/aria2c.1.html +++ b/doc/aria2c.1.html @@ -435,7 +435,7 @@ div#toc a:visited { color: blue; } - + @@ -1051,7 +1055,7 @@ response header.

Use this proxy server for HTTP. To erase previously defined proxy, use "". See also --all-proxy option. This affects all URIs. The - format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT] + format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]

@@ -1062,13 +1066,14 @@ response header. Set password for --http-proxy option.

- -

--http-proxy-user=USER:

-
-
-
Set user for *--http-proxy* option.
-
-
+
+--http-proxy-user=USER +
+
+

+ Set user for --http-proxy option. +

+
--https-proxy=PROXY
@@ -1076,7 +1081,7 @@ response header.

Use this proxy server for HTTPS. To erase previously defined proxy, use "". See also --all-proxy option. This affects all URIs. The - format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT] + format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]

@@ -1131,12 +1136,18 @@ response header. Enable HTTP/1.1 pipelining. Default: false

-
-
-
In performance perspective, there is no advantage to enable this
-option for normal case.
-
+
+
+ + + +
+
Note
+		In performance perspective, there is usually no advantage to enable +this option.
+
+
--header=HEADER
@@ -1239,7 +1250,7 @@ and Chromium/Google Chrome cookie format.

Use this proxy server for FTP. To erase previously defined proxy, use "". See also --all-proxy option. This affects all URIs. The - format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT] + format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]

@@ -2544,7 +2555,7 @@ as exit status.

aria2 recognizes the following environment variables.

-http_proxy [http://][USER:PASSWORD@]HOST[:PORT] +http_proxy [http://][USER:PASSWORD@]HOST[:PORT]

@@ -2554,7 +2565,7 @@ http_proxy [http://][USER:PASSWORD@

-https_proxy [http://][USER:PASSWORD@]HOST[:PORT] +https_proxy [http://][USER:PASSWORD@]HOST[:PORT]

@@ -2564,7 +2575,7 @@ https_proxy [http://][USER:PASSWORD

-ftp_proxy [http://][USER:PASSWORD@]HOST[:PORT] +ftp_proxy [http://][USER:PASSWORD@]HOST[:PORT]

@@ -2574,7 +2585,7 @@ ftp_proxy [http://][USER:PASSWORD@]

-all_proxy [http://][USER:PASSWORD@]HOST[:PORT] +all_proxy [http://][USER:PASSWORD@]HOST[:PORT]

@@ -3259,12 +3270,12 @@ type array and its element is URI which is of type string. For BitTorrent Magnet URI, uris must have only one element and it should be BitTorrent Magnet URI. URIs in uris 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 +locations: http://server/chunkybaconlinux.iso and +http://mirror/chunkybaconlinux.iso. You can download this iso image using 2 URIs by issuing -aria2.addUri([http://server/chunkybaconlinux.iso, -http://mirror/chunkybaconlinux.iso]). Imagine there is an another -file URI, say, http://mirror2/chunkydonutslinux.iso, which is +aria2.addUri(["http://server/chunkybaconlinux.iso", +"http://mirror/chunkybaconlinux.iso"]). 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. options is of type struct and its members are a @@ -4412,7 +4423,7 @@ files in the program, then also delete it here.

diff --git a/doc/aria2c.1.txt b/doc/aria2c.1.txt index cfe67d99..0161095d 100644 --- a/doc/aria2c.1.txt +++ b/doc/aria2c.1.txt @@ -87,7 +87,7 @@ HTTP/FTP Options defined proxy, use "". You can override this setting and specify a proxy server for a particular protocol using *--http-proxy*, *--https-proxy* and *--ftp-proxy* options. This affects all URIs. - The format of PROXY is [\http://][USER:PASSWORD@]HOST[:PORT] + The format of PROXY is [\\http://][USER:PASSWORD@]HOST[:PORT] [NOTE] @@ -286,13 +286,13 @@ response header. Use this proxy server for HTTP. To erase previously defined proxy, use "". See also *--all-proxy* option. This affects all URIs. The - format of PROXY is [\http://][USER:PASSWORD@]HOST[:PORT] + format of PROXY is [\\http://][USER:PASSWORD@]HOST[:PORT] *--http-proxy-passwd*=PASSWD:: Set password for *--http-proxy* option. -*--http-proxy-user*=USER: +*--http-proxy-user*=USER:: Set user for *--http-proxy* option. @@ -300,7 +300,7 @@ response header. Use this proxy server for HTTPS. To erase previously defined proxy, use "". See also *--all-proxy* option. This affects all URIs. The - format of PROXY is [\http://][USER:PASSWORD@]HOST[:PORT] + format of PROXY is [\\http://][USER:PASSWORD@]HOST[:PORT] *--https-proxy-passwd*=PASSWD:: @@ -327,8 +327,10 @@ response header. Enable HTTP/1.1 pipelining. Default: 'false' - In performance perspective, there is no advantage to enable this - option for normal case. +[NOTE] + +In performance perspective, there is usually no advantage to enable +this option. *--header*=HEADER:: Append HEADER to HTTP request header. @@ -384,7 +386,7 @@ FTP Specific Options Use this proxy server for FTP. To erase previously defined proxy, use "". See also *--all-proxy* option. This affects all URIs. The - format of PROXY is [\http://][USER:PASSWORD@]HOST[:PORT] + format of PROXY is [\\http://][USER:PASSWORD@]HOST[:PORT] *--ftp-proxy-passwd*=PASSWD:: @@ -1144,22 +1146,22 @@ ENVIRONMENT ----------- aria2 recognizes the following environment variables. -http_proxy [\http://][USER:PASSWORD@]HOST[:PORT]:: +http_proxy [\\http://][USER:PASSWORD@]HOST[:PORT]:: Specify proxy server for use in HTTP. Overrides http-proxy value in configuration file. The command-line option *--http-proxy* overrides this value. -https_proxy [\http://][USER:PASSWORD@]HOST[:PORT]:: +https_proxy [\\http://][USER:PASSWORD@]HOST[:PORT]:: Specify proxy server for use in HTTPS. Overrides https-proxy value in configuration file. The command-line option *--https-proxy* overrides this value. -ftp_proxy [\http://][USER:PASSWORD@]HOST[:PORT]:: +ftp_proxy [\\http://][USER:PASSWORD@]HOST[:PORT]:: Specify proxy server for use in FTP. Overrides ftp-proxy value in configuration file. The command-line option *--ftp-proxy* overrides this value. -all_proxy [\http://][USER:PASSWORD@]HOST[:PORT]:: +all_proxy [\\http://][USER:PASSWORD@]HOST[:PORT]:: Specify proxy server for use if no protocol-specific proxy is specified. Overrides all-proxy value in configuration file. The command-line option *--all-proxy* overrides this value. @@ -1449,12 +1451,12 @@ type array and its element is URI which is of type string. For BitTorrent Magnet URI, 'uris' must have only one element and it should be BitTorrent Magnet URI. URIs in 'uris' 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 +locations: \http://server/chunkybaconlinux.iso and +\http://mirror/chunkybaconlinux.iso. You can download this iso image using 2 URIs by issuing -aria2.addUri(['http://server/chunkybaconlinux.iso', -'http://mirror/chunkybaconlinux.iso']). Imagine there is an another -file URI, say, http://mirror2/chunkydonutslinux.iso, which is +aria2.addUri(["http://server/chunkybaconlinux.iso", +"http://mirror/chunkybaconlinux.iso"]). 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. 'options' is of type struct and its members are a diff --git a/doc/makeman b/doc/makeman index c33911e8..dedd0bea 100755 --- a/doc/makeman +++ b/doc/makeman @@ -2,4 +2,4 @@ a2x -f manpage aria2c.1.txt -asciidoc -d manpage -b xhtml11 aria2c.1.txt +asciidoc -d manpage -b xhtml11 -a toc -a max-width=55em aria2c.1.txt