2008-11-09 Tatsuhiro Tsujikawa <t-tujikawa@users.sourceforge.net>

Updated man page * doc/aria2c.1.txt
2008-11-09 08:59:05 +00:00 · 2008-11-09 08:59:05 +00:00 · 52749ba3c8
parent 0308785bd8
commit 52749ba3c8
4 changed files with 325 additions and 69 deletions
--- a/5
+++ b/5
@ -1,3 +1,8 @@
+2008-11-09  Tatsuhiro Tsujikawa  <t-tujikawa@users.sourceforge.net>
+
+	Updated man page
+	* doc/aria2c.1.txt
+
 2008-11-09  Tatsuhiro Tsujikawa  <t-tujikawa@users.sourceforge.net>

 	Added --no-proxy option. It receives comman separated hostname or
--- a/doc/aria2c.1
+++ b/doc/aria2c.1
@ -1,11 +1,11 @@
 .\"     Title: aria2c
 .\"    Author: 
 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
-.\"      Date: 10/14/2008
+.\"      Date: 11/09/2008
 .\"    Manual: 
 .\"    Source: 
 .\"
-.TH "ARIA2C" "1" "10/14/2008" "" ""
+.TH "ARIA2C" "1" "11/09/2008" "" ""
 .\" disable hyphenation
 .nh
 .\" disable justification (adjust text to left margin only)
@ -72,6 +72,16 @@ Default:
 .RE
 .SS "HTTP/FTP Options"
 .PP
+\fB\-\-all\-proxy\fR=PROXY
+.RS 4
+Use this proxy server in the all protocols\&. You can override this setting and specify a proxy server for particular proctol using
+\fB\-\-http\-proxy\fR,
+\fB\-\-https\-proxy\fR
+and
+\fB\-\-ftp\-proxy\fR
+options\&. This affects all URLs\&. The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]
+.RE
+.PP
 \fB\-\-connect\-timeout\fR=SEC
 .RS 4
 Set the connect timeout in seconds to establish connection to HTTP/FTP/proxy server\&. After the connection is established, this option makes no effect and
@ -107,10 +117,26 @@ means unlimited\&. Default:
 \fI5\fR
 .RE
 .PP
+\fB\-\-no\-proxy\fR=DOMAINS
+.RS 4
+Specify comma separated hostnames or domains to which proxy should not be used\&.
+.RE
+.PP
 \fB\-o\fR, \fB\-\-out\fR=FILE
 .RS 4
 The file name of the downloaded file\&.
 .RE
+.PP
+\fB\-\-proxy\-method\fR=METHOD
+.RS 4
+Set the method to use in proxy request\&.
+\fIMETHOD\fR
+is either
+\fIget\fR
+or
+\fItunnel\fR\&. Default:
+\fItunnel\fR
+.RE
 .sp
 .it 1 an-trap
 .nr an-no-space-flag 1
@ -191,6 +217,27 @@ options\&. Default:
 .RE
 .SS "HTTP Specific Options"
 .PP
+\fB\-\-ca\-certificate\fR=FILE
+.RS 4
+Use the certificate authorities in FILE to verify the peers\&. The certificate file must be in PEM format and can contain multiple CA certificates\&. Use
+\fB\-\-check\-certificate\fR
+option to enable verification\&.
+.RE
+.PP
+\fB\-\-certificate\fR=FILE
+.RS 4
+Use the client certificate in FILE\&. The certificate must be in PEM format\&. You may use
+\fB\-\-private\-key\fR
+option to specify the private key\&.
+.RE
+.PP
+\fB\-\-check\-certificate\fR[=\fItrue\fR|\fIfalse\fR]
+.RS 4
+Verify the peer using certificates specified in
+\fB\-\-ca\-certificate\fR
+option\&.
+.RE
+.PP
 \fB\-\-http\-auth\-scheme\fR=SCHEME
 .RS 4
 Set HTTP authentication scheme\&. Currently,
@ -209,30 +256,25 @@ Set HTTP user\&. This affects all URLs\&.
 Set HTTP password\&. This affects all URLs\&.
 .RE
 .PP
-\fB\-\-http\-proxy\fR=HOST:PORT
+\fB\-\-http\-proxy\fR=PROXY
 .RS 4
-Use HTTP proxy server\&. This affects all URLs\&.
+Use this proxy server for HTTP\&. See also
+\fB\-\-all\-proxy\fR
+option\&. This affects all URLs\&. The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]
 .RE
 .PP
-\fB\-\-http\-proxy\-user\fR=USER
+\fB\-\-https\-proxy\fR=PROXY
 .RS 4
-Set HTTP proxy user\&. This affects all URLs\&.
+Use this proxy server for HTTPS\&. See also
+\fB\-\-all\-proxy\fR
+option\&. This affects all URLs\&. The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]
 .RE
 .PP
-\fB\-\-http\-proxy\-passwd\fR=PASSWD
+\fB\-\-private\-key\fR=FILE
 .RS 4
-Set HTTP proxy password\&. This affects all URLs\&.
-.RE
-.PP
-\fB\-\-http\-proxy\-method\fR=METHOD
-.RS 4
-Set the method to use in proxy request\&.
-\fIMETHOD\fR
-is either
-\fIget\fR
-or
-\fItunnel\fR\&. Default:
-\fItunnel\fR
+Use the private key in FILE\&. The private key must be decrypted and in PEM format\&. See also
+\fB\-\-certificate\fR
+option\&.
 .RE
 .PP
 \fB\-\-referer\fR=REFERER
@ -295,6 +337,13 @@ Set FTP password\&. This affects all URLs\&. Default:
 Use passive mode in FTP\&.
 .RE
 .PP
+\fB\-\-ftp\-proxy\fR=PROXY
+.RS 4
+Use this proxy server for FTP\&. See also
+\fB\-\-all\-proxy\fR
+option\&. This affects all URLs\&. The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]
+.RE
+.PP
 \fB\-\-ftp\-type\fR=TYPE
 .RS 4
 Set FTP transfer type\&. TYPE is either
@ -310,15 +359,6 @@ Reuse connection in FTP\&. Default:
 \fItrue\fR
 .RE
 .PP
-\fB\-\-ftp\-via\-http\-proxy\fR=METHOD
-.RS 4
-Use HTTP proxy in FTP\&. METHOD is either
-\fIget\fR
-or
-\fItunnel\fR\&. Default:
-\fItunnel\fR
-.RE
-.PP
 \fB\-n\fR, \fB\-\-no\-netrc\fR
 .RS 4
 Disables netrc support\&. netrc support is enabled by default\&.
@ -1351,6 +1391,43 @@ ftp\-pasv=true
 .SS "dht\&.dat"
 By default, the routing table of DHT is saved to the path $HOME/\&.aria2/dht\&.dat\&.
 .sp
+.SH "ENVIRONMENT"
+aria2 recognizes the following environment variables\&.
+.PP
+http_proxy [http://][USER:PASSWORD@]HOST[:PORT]
+.RS 4
+Specify proxy server for use in HTTP\&. Overrides http\-proxy value in configuration file\&. The command\-line option
+\fB\-\-http\-proxy\fR
+overrides this value\&.
+.RE
+.PP
+https_proxy [http://][USER:PASSWORD@]HOST[:PORT]
+.RS 4
+Specify proxy server for use in HTTPS\&. Overrides https\-proxy value in configuration file\&. The command\-line option
+\fB\-\-https\-proxy\fR
+overrides this value\&.
+.RE
+.PP
+ftp_proxy [http://][USER:PASSWORD@]HOST[:PORT]
+.RS 4
+Specify proxy server for use in FTP\&. Overrides ftp\-proxy value in configuration file\&. The command\-line option
+\fB\-\-ftp\-proxy\fR
+overrides this value\&.
+.RE
+.PP
+all_proxy [http://][USER:PASSWORD@]HOST[:PORT]
+.RS 4
+Specify proxy server for use if no protocol\-specific proxy is specified\&. Overrides all\-proxy value in configuration file\&. The command\-line option
+\fB\-\-all\-proxy\fR
+overrides this value\&.
+.RE
+.PP
+no_proxy [DOMAIN,\&...]
+.RS 4
+Specify comma\-separated hostname or domains to which proxy should not be used\&. Overrides no\-proxy value in configuration file\&. The command\-line option
+\fB\-\-no\-proxy\fR
+overrides this value\&.
+.RE
 .SH "RESOURCES"
 Project web site: http://aria2\&.sourceforge\&.net/
 .sp
--- a/doc/aria2c.1.html
+++ b/doc/aria2c.1.html
@ -462,6 +462,18 @@ ARIA2C(1) Manual Page
 <h3 id="_http_ftp_options">HTTP/FTP Options</h3><div style="clear:left"></div>
 <div class="vlist"><dl>
 <dt>
+<strong>--all-proxy</strong>=PROXY
+</dt>
+<dd>
+<p>
+  Use this proxy server in the all protocols.
+  You can override this setting and specify a proxy server for particular
+  proctol using <strong>--http-proxy</strong>, <strong>--https-proxy</strong> and <strong>--ftp-proxy</strong> options.
+  This affects all URLs.
+  The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]
+</p>
+</dd>
+<dt>
 <strong>--connect-timeout</strong>=SEC
 </dt>
 <dd>
@ -507,6 +519,15 @@ ARIA2C(1) Manual Page
 </p>
 </dd>
 <dt>
+<strong>--no-proxy</strong>=DOMAINS
+</dt>
+<dd>
+<p>
+  Specify comma separated hostnames or domains to which proxy should not be
+  used.
+</p>
+</dd>
+<dt>
 <strong>-o</strong>, <strong>--out</strong>=FILE
 </dt>
 <dd>
@ -514,6 +535,16 @@ ARIA2C(1) Manual Page
  The file name of the downloaded file.
 </p>
 </dd>
+<dt>
+<strong>--proxy-method</strong>=METHOD
+</dt>
+<dd>
+<p>
+  Set the method to use in proxy request.
+  <em>METHOD</em> is either <em>get</em> or <em>tunnel</em>.
+  Default: <em>tunnel</em>
+</p>
+</dd>
 </dl></div>
 <div class="admonitionblock">
 <table><tr>
@ -621,6 +652,35 @@ aria2c -o myfile.zip <a href="http://mirror1/file.zip">http://mirror1/file.zip</
 <h3 id="_http_specific_options">HTTP Specific Options</h3><div style="clear:left"></div>
 <div class="vlist"><dl>
 <dt>
+<strong>--ca-certificate</strong>=FILE
+</dt>
+<dd>
+<p>
+  Use the certificate authorities in FILE to verify the peers.
+  The certificate file must be in PEM format and can contain multiple CA
+  certificates.
+  Use <strong>--check-certificate</strong> option to enable verification.
+</p>
+</dd>
+<dt>
+<strong>--certificate</strong>=FILE
+</dt>
+<dd>
+<p>
+  Use the client certificate in FILE.
+  The certificate must be in PEM format.
+  You may use <strong>--private-key</strong> option to specify the private key.
+</p>
+</dd>
+<dt>
+<strong>--check-certificate</strong>[=<em>true</em>|<em>false</em>]
+</dt>
+<dd>
+<p>
+  Verify the peer using certificates specified in <strong>--ca-certificate</strong> option.
+</p>
+</dd>
+<dt>
 <strong>--http-auth-scheme</strong>=SCHEME
 </dt>
 <dd>
@ -647,37 +707,33 @@ aria2c -o myfile.zip <a href="http://mirror1/file.zip">http://mirror1/file.zip</
 </p>
 </dd>
 <dt>
-<strong>--http-proxy</strong>=HOST:PORT
+<strong>--http-proxy</strong>=PROXY
 </dt>
 <dd>
 <p>
-  Use HTTP proxy server. This affects all URLs.
+  Use this proxy server for HTTP. See also <strong>--all-proxy</strong> option.
+  This affects all URLs.
+  The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]
 </p>
 </dd>
 <dt>
-<strong>--http-proxy-user</strong>=USER
+<strong>--https-proxy</strong>=PROXY
 </dt>
 <dd>
 <p>
-  Set HTTP proxy user. This affects all URLs.
+  Use this proxy server for HTTPS. See also <strong>--all-proxy</strong> option.
+  This affects all URLs.
+  The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]
 </p>
 </dd>
 <dt>
-<strong>--http-proxy-passwd</strong>=PASSWD
+<strong>--private-key</strong>=FILE
 </dt>
 <dd>
 <p>
-  Set HTTP proxy password. This affects all URLs.
-</p>
-</dd>
-<dt>
-<strong>--http-proxy-method</strong>=METHOD
-</dt>
-<dd>
-<p>
-  Set the method to use in proxy request.
-  <em>METHOD</em> is either <em>get</em> or <em>tunnel</em>.
-  Default: <em>tunnel</em>
+  Use the private key in FILE.
+  The private key must be decrypted and in PEM format.
+  See also <strong>--certificate</strong> option.
 </p>
 </dd>
 <dt>
@ -773,6 +829,16 @@ aria2c -o myfile.zip <a href="http://mirror1/file.zip">http://mirror1/file.zip</
 </p>
 </dd>
 <dt>
+<strong>--ftp-proxy</strong>=PROXY
+</dt>
+<dd>
+<p>
+  Use this proxy server for FTP. See also <strong>--all-proxy</strong> option.
+  This affects all URLs.
+  The format of PROXY is [http://][USER:PASSWORD@]HOST[:PORT]
+</p>
+</dd>
+<dt>
 <strong>--ftp-type</strong>=TYPE
 </dt>
 <dd>
@ -791,15 +857,6 @@ aria2c -o myfile.zip <a href="http://mirror1/file.zip">http://mirror1/file.zip</
 </p>
 </dd>
 <dt>
-<strong>--ftp-via-http-proxy</strong>=METHOD
-</dt>
-<dd>
-<p>
-  Use HTTP proxy in FTP. METHOD is either <em>get</em> or <em>tunnel</em>.
-  Default: <em>tunnel</em>
-</p>
-</dd>
-<dt>
 <strong>-n</strong>, <strong>--no-netrc</strong>
 </dt>
 <dd>
@ -1787,6 +1844,62 @@ ftp-pasv=true</tt></pre>
 <h3 id="_dht_dat">dht.dat</h3><div style="clear:left"></div>
 <div class="para"><p>By default, the routing table of DHT is saved to the path $HOME/.aria2/dht.dat.</p></div>
 </div>
+<h2 id="_environment">ENVIRONMENT</h2>
+<div class="sectionbody">
+<div class="para"><p>aria2 recognizes the following environment variables.</p></div>
+<div class="vlist"><dl>
+<dt>
+http_proxy [http://][USER:PASSWORD@]HOST[:PORT]
+</dt>
+<dd>
+<p>
+  Specify proxy server for use in HTTP.
+  Overrides http-proxy value in configuration file.
+  The command-line option <strong>--http-proxy</strong> overrides this value.
+</p>
+</dd>
+<dt>
+https_proxy [http://][USER:PASSWORD@]HOST[:PORT]
+</dt>
+<dd>
+<p>
+  Specify proxy server for use in HTTPS.
+  Overrides https-proxy value in configuration file.
+  The command-line option <strong>--https-proxy</strong> overrides this value.
+</p>
+</dd>
+<dt>
+ftp_proxy [http://][USER:PASSWORD@]HOST[:PORT]
+</dt>
+<dd>
+<p>
+  Specify proxy server for use in FTP.
+  Overrides ftp-proxy value in configuration file.
+  The command-line option <strong>--ftp-proxy</strong> overrides this value.
+</p>
+</dd>
+<dt>
+all_proxy [http://][USER:PASSWORD@]HOST[:PORT]
+</dt>
+<dd>
+<p>
+  Specify proxy server for use if no protocol-specific proxy is specified.
+  Overrides all-proxy value in configuration file.
+  The command-line option <strong>--all-proxy</strong> overrides this value.
+</p>
+</dd>
+<dt>
+no_proxy [DOMAIN,&#8230;]
+</dt>
+<dd>
+<p>
+  Specify comma-separated hostname or domains to which proxy should not be used.
+  Overrides no-proxy value in configuration file.
+  The command-line option <strong>--no-proxy</strong> overrides this value.
+</p>
+</dd>
+</dl></div>
+</div>
 <h2 id="_resources">RESOURCES</h2>
 <div class="sectionbody">
 <div class="para"><p>Project web site: <a href="http://aria2.sourceforge.net/">http://aria2.sourceforge.net/</a></p></div>
@ -1829,7 +1942,7 @@ files in the program, then also delete it here.</p></div>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2008-10-14 22:14:48 JST
+Last updated 2008-11-09 17:57:01 JST
 </div>
 </div>
 </body>
--- a/doc/aria2c.1.txt
+++ b/doc/aria2c.1.txt
@ -61,6 +61,13 @@ Basic Options

 HTTP/FTP Options
 ~~~~~~~~~~~~~~~~
+*--all-proxy*=PROXY::
+  Use this proxy server in the all protocols.
+  You can override this setting and specify a proxy server for particular
+  proctol using *--http-proxy*, *--https-proxy* and *--ftp-proxy* options.
+  This affects all URLs.
+  The format of PROXY is [\\http://][USER:PASSWORD@]HOST[:PORT]
+
 *--connect-timeout*=SEC::
  Set the connect timeout in seconds to establish connection to
  HTTP/FTP/proxy server. After the connection is established, this
@ -86,9 +93,18 @@ HTTP/FTP Options
  Set number of tries. '0' means unlimited.
  Default: '5'

+*--no-proxy*=DOMAINS::
+  Specify comma separated hostnames or domains to which proxy should not be
+  used.
+
 *-o*, *--out*=FILE::
  The file name of the downloaded file.

+*--proxy-method*=METHOD::
+  Set the method to use in proxy request.
+  'METHOD' is either 'get' or 'tunnel'.
+  Default: 'tunnel'
+
 [NOTE]
 In Metalink, BitTorrent download you cannot specify file name.
 The file name specified here is only used when the URLs fed to aria2
@ -147,6 +163,20 @@ aria2c -o myfile.zip http://mirror1/file.zip http://mirror2/file.zip

 HTTP Specific Options
 ~~~~~~~~~~~~~~~~~~~~~
+*--ca-certificate*=FILE::
+  Use the certificate authorities in FILE to verify the peers.
+  The certificate file must be in PEM format and can contain multiple CA
+  certificates.
+  Use *--check-certificate* option to enable verification.
+
+*--certificate*=FILE::
+  Use the client certificate in FILE.
+  The certificate must be in PEM format.
+  You may use *--private-key* option to specify the private key.
+
+*--check-certificate*[='true'|'false']::
+  Verify the peer using certificates specified in *--ca-certificate* option.
+
 *--http-auth-scheme*=SCHEME::
  Set HTTP authentication scheme.
  Currently, 'basic' is the only supported scheme.
@ -158,19 +188,20 @@ HTTP Specific Options
 *--http-passwd*=PASSWD::
  Set HTTP password. This affects all URLs.

-*--http-proxy*=HOST:PORT::
-  Use HTTP proxy server. This affects all URLs.
+*--http-proxy*=PROXY::
+  Use this proxy server for HTTP. See also *--all-proxy* option.
+  This affects all URLs.
+  The format of PROXY is [\\http://][USER:PASSWORD@]HOST[:PORT]

-*--http-proxy-user*=USER::
-  Set HTTP proxy user. This affects all URLs.
+*--https-proxy*=PROXY::
+  Use this proxy server for HTTPS. See also *--all-proxy* option.
+  This affects all URLs.
+  The format of PROXY is [\\http://][USER:PASSWORD@]HOST[:PORT]

-*--http-proxy-passwd*=PASSWD::
-  Set HTTP proxy password. This affects all URLs.
-
-*--http-proxy-method*=METHOD::
-  Set the method to use in proxy request.
-  'METHOD' is either 'get' or 'tunnel'.
-  Default: 'tunnel'
+*--private-key*=FILE::
+  Use the private key in FILE.
+  The private key must be decrypted and in PEM format.
+  See also *--certificate* option.

 *--referer*=REFERER::
  Set Referer. This affects all URLs.
@ -211,6 +242,11 @@ FTP Specific Options
 *-p*, *--ftp-pasv*::
  Use passive mode in FTP.

+*--ftp-proxy*=PROXY::
+  Use this proxy server for FTP. See also *--all-proxy* option.
+  This affects all URLs.
+  The format of PROXY is [\\http://][USER:PASSWORD@]HOST[:PORT]
+
 *--ftp-type*=TYPE::
  Set FTP transfer type. TYPE is either 'binary' or 'ascii'.
  Default: 'binary'
@ -219,10 +255,6 @@ FTP Specific Options
  Reuse connection in FTP.
  Default: 'true'

-*--ftp-via-http-proxy*=METHOD::
-  Use HTTP proxy in FTP. METHOD is either 'get' or 'tunnel'.
-  Default: 'tunnel'
-
 *-n*, *--no-netrc*::
  Disables netrc support. netrc support is enabled by default.

@ -851,6 +883,35 @@ dht.dat
 ~~~~~~~~
 By default, the routing table of DHT is saved to the path $HOME/.aria2/dht.dat.

+ENVIRONMENT
+-----------
+aria2 recognizes the following environment variables.
+
+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]::
+  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]::
+  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]::
+  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.
+
+no_proxy [DOMAIN,...]::
+  Specify comma-separated hostname or domains to which proxy should not be used.
+  Overrides no-proxy value in configuration file.
+  The command-line option *--no-proxy* overrides this value.
+
 RESOURCES
 ---------
 Project web site: http://aria2.sourceforge.net/[]