Browse Source

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

	Added INPUT FILE section to man page.
	Escaped fake URLs.
	* doc/aria2c.1.txt
Tatsuhiro Tsujikawa 17 years ago
parent
commit
073d6ca265
4 changed files with 87 additions and 8 deletions
  1. 6 0
      ChangeLog
  2. 24 3
      doc/aria2c.1
  3. 28 3
      doc/aria2c.1.html
  4. 29 2
      doc/aria2c.1.txt

+ 6 - 0
ChangeLog

@@ -1,3 +1,9 @@
+2008-11-14  Tatsuhiro Tsujikawa  <t-tujikawa@users.sourceforge.net>
+
+	Added INPUT FILE section to man page.
+	Escaped fake URLs.
+	* doc/aria2c.1.txt
+
 2008-11-14  Tatsuhiro Tsujikawa  <t-tujikawa@users.sourceforge.net>
 2008-11-14  Tatsuhiro Tsujikawa  <t-tujikawa@users.sourceforge.net>
 
 
 	Fixed wrong note position for -o option.
 	Fixed wrong note position for -o option.

+ 24 - 3
doc/aria2c.1

@@ -30,7 +30,11 @@ The directory to store the downloaded file\&.
 .RS 4
 .RS 4
 Downloads URIs found in FILE\&. You can specify multiple URIs for a single entity: separate URIs on a single line using the TAB character\&. Reads input from stdin when
 Downloads URIs found in FILE\&. You can specify multiple URIs for a single entity: separate URIs on a single line using the TAB character\&. Reads input from stdin when
 \fI\-\fR
 \fI\-\fR
-is specified\&.
+is specified\&. The additional
+\fBout\fR
+and
+\fBdir\fR
+options can be specified after each line of URIs\&. This optional line must start with white space(s)\&. See INPUT FILE section for details\&.
 .RE
 .RE
 .PP
 .PP
 \fB\-l\fR, \fB\-\-log\fR=LOG
 \fB\-l\fR, \fB\-\-log\fR=LOG
@@ -304,8 +308,7 @@ Enable HTTP/1\&.1 pipelining\&. Default:
 .RS 4
 .RS 4
 Append HEADER to HTTP request header\&. You can use this option repeatedly to specify more than one header: aria2c
 Append HEADER to HTTP request header\&. You can use this option repeatedly to specify more than one header: aria2c
 \fB\-\-header\fR="X\-A: b78"
 \fB\-\-header\fR="X\-A: b78"
-\fB\-\-header\fR="X\-B: 9J1"
-http://host/file
+\fB\-\-header\fR="X\-B: 9J1" http://host/file
 .RE
 .RE
 .PP
 .PP
 \fB\-\-load\-cookies\fR=FILE
 \fB\-\-load\-cookies\fR=FILE
@@ -1427,6 +1430,24 @@ You can seed downloaded file using \-\-check\-integrity=true option\&.
 aria2c \-\-check\-integrity=true file\&.torrent
 aria2c \-\-check\-integrity=true file\&.torrent
 .fi
 .fi
 .RE
 .RE
+.SH "INPUT FILE"
+The input file can contain list of URIs to feed them into aria2\&. You can specify multiple URIs for a single entity: separate URIs on a single line using the TAB character\&.
+.sp
+Each line is treated as if it is provided in command\-line argument\&. Therefore they are affected by \fB\-Z\fR and \fB\-P\fR options\&. The additional \fBout\fR and \fBdir\fR options can be specified after each line of URIs\&. This optional line must start with white space(s)\&.
+.sp
+For example, the content of uri\&.txt is:
+.sp
+.sp
+.RS 4
+.nf
+http://server/file\&.iso http://mirror/file\&.iso
+  dir=/iso_images
+  out=file\&.img
+http://foo/bar
+.fi
+.RE
+and if aria2 is executed with \-i uri\&.txt \-d /tmp options, then file\&.iso is saved as /iso_images/file\&.img and it is downloaded from http://server/file\&.iso and http://mirror/file\&.iso\&. The file bar is downloaded from http://foo/bar and saved as /tmp/bar\&.
+.sp
 .SH "SERVER PERFORMANCE PROFILE"
 .SH "SERVER PERFORMANCE PROFILE"
 This section describes the format of server performance profile\&. The file is plain text and each line has several NAME=VALUE pair, delimited by comma\&. Currently following NAMEs are recognized:
 This section describes the format of server performance profile\&. The file is plain text and each line has several NAME=VALUE pair, delimited by comma\&. Currently following NAMEs are recognized:
 .PP
 .PP

+ 28 - 3
doc/aria2c.1.html

@@ -399,6 +399,9 @@ ARIA2C(1) Manual Page
   Downloads URIs found in FILE. You can specify multiple URIs for a single
   Downloads URIs found in FILE. You can specify multiple URIs for a single
   entity: separate URIs on a single line using the TAB character.
   entity: separate URIs on a single line using the TAB character.
   Reads input from stdin when <em>-</em> is specified.
   Reads input from stdin when <em>-</em> is specified.
+  The additional <strong>out</strong> and <strong>dir</strong> options can be specified after each line of
+  URIs. This optional line must start with white space(s).
+  See INPUT FILE section for details.
 </p>
 </p>
 </dd>
 </dd>
 <dt>
 <dt>
@@ -544,7 +547,7 @@ ARIA2C(1) Manual Page
 <td class="content">In Metalink, BitTorrent download you cannot specify file name.
 <td class="content">In Metalink, BitTorrent download you cannot specify file name.
 The file name specified here is only used when the URLs fed to aria2
 The file name specified here is only used when the URLs fed to aria2
 is done by command line without <strong>-i</strong>, <strong>-Z</strong> option. For example:
 is done by command line without <strong>-i</strong>, <strong>-Z</strong> option. For example:
-aria2c -o myfile.zip <a href="http://mirror1/file.zip">http://mirror1/file.zip</a> <a href="http://mirror2/file.zip">http://mirror2/file.zip</a></td>
+aria2c -o myfile.zip http://mirror1/file.zip http://mirror2/file.zip</td>
 </tr></table>
 </tr></table>
 </div>
 </div>
 <div class="vlist"><dl>
 <div class="vlist"><dl>
@@ -772,7 +775,7 @@ aria2c -o myfile.zip <a href="http://mirror1/file.zip">http://mirror1/file.zip</
 <p>
 <p>
   Append HEADER to HTTP request header.
   Append HEADER to HTTP request header.
   You can use this option repeatedly to specify more than one header:
   You can use this option repeatedly to specify more than one header:
-  aria2c <strong>--header</strong>="X-A: b78" <strong>--header</strong>="X-B: 9J1" <a href="http://host/file">http://host/file</a>
+  aria2c <strong>--header</strong>="X-A: b78" <strong>--header</strong>="X-B: 9J1" http://host/file
 </p>
 </p>
 </dd>
 </dd>
 <dt>
 <dt>
@@ -1817,6 +1820,28 @@ you can resume the download without a control file by giving
 <pre><tt>aria2c --check-integrity=true file.torrent</tt></pre>
 <pre><tt>aria2c --check-integrity=true file.torrent</tt></pre>
 </div></div>
 </div></div>
 </div>
 </div>
+<h2 id="_input_file">INPUT FILE</h2>
+<div class="sectionbody">
+<div class="para"><p>The input file can contain list of URIs to feed them into aria2.
+You can specify multiple URIs for a single entity:
+separate URIs on a single line using the TAB character.</p></div>
+<div class="para"><p>Each line is treated as if it is provided in command-line argument.
+Therefore they are affected by <strong>-Z</strong> and <strong>-P</strong> options.
+The additional <strong>out</strong> and <strong>dir</strong> options can be specified after each line of
+URIs. This optional line must start with white space(s).</p></div>
+<div class="para"><p>For example, the content of uri.txt is:</p></div>
+<div class="listingblock">
+<div class="content">
+<pre><tt>http://server/file.iso http://mirror/file.iso
+  dir=/iso_images
+  out=file.img
+http://foo/bar</tt></pre>
+</div></div>
+<div class="para"><p>and if aria2 is executed with -i uri.txt -d /tmp options,
+then file.iso is saved as /iso_images/file.img and it is downloaded from
+http://server/file.iso and http://mirror/file.iso.
+The file bar is downloaded from http://foo/bar and saved as /tmp/bar.</p></div>
+</div>
 <h2 id="_server_performance_profile">SERVER PERFORMANCE PROFILE</h2>
 <h2 id="_server_performance_profile">SERVER PERFORMANCE PROFILE</h2>
 <div class="sectionbody">
 <div class="sectionbody">
 <div class="para"><p>This section describes the format of server performance profile.
 <div class="para"><p>This section describes the format of server performance profile.
@@ -1994,7 +2019,7 @@ files in the program, then also delete it here.</p></div>
 </div>
 </div>
 <div id="footer">
 <div id="footer">
 <div id="footer-text">
 <div id="footer-text">
-Last updated 2008-11-14 00:10:16 JST
+Last updated 2008-11-14 00:31:03 JST
 </div>
 </div>
 </div>
 </div>
 </body>
 </body>

+ 29 - 2
doc/aria2c.1.txt

@@ -26,6 +26,9 @@ Basic Options
   Downloads URIs found in FILE. You can specify multiple URIs for a single
   Downloads URIs found in FILE. You can specify multiple URIs for a single
   entity: separate URIs on a single line using the TAB character.
   entity: separate URIs on a single line using the TAB character.
   Reads input from stdin when '-' is specified.
   Reads input from stdin when '-' is specified.
+  The additional *out* and *dir* options can be specified after each line of
+  URIs. This optional line must start with white space(s).
+  See INPUT FILE section for details.
 
 
 *-l*, *--log*=LOG::
 *-l*, *--log*=LOG::
   The file name of the log file. If '-' is specified, log is written to
   The file name of the log file. If '-' is specified, log is written to
@@ -104,7 +107,7 @@ HTTP/FTP Options
 In Metalink, BitTorrent download you cannot specify file name.
 In Metalink, BitTorrent download you cannot specify file name.
 The file name specified here is only used when the URLs fed to aria2
 The file name specified here is only used when the URLs fed to aria2
 is done by command line without *-i*, *-Z* option. For example:
 is done by command line without *-i*, *-Z* option. For example:
-aria2c -o myfile.zip http://mirror1/file.zip http://mirror2/file.zip
+aria2c -o myfile.zip \http://mirror1/file.zip \http://mirror2/file.zip
 
 
 *--proxy-method*=METHOD::
 *--proxy-method*=METHOD::
   Set the method to use in proxy request.
   Set the method to use in proxy request.
@@ -220,7 +223,7 @@ HTTP Specific Options
 *--header*=HEADER::
 *--header*=HEADER::
   Append HEADER to HTTP request header.
   Append HEADER to HTTP request header.
   You can use this option repeatedly to specify more than one header:
   You can use this option repeatedly to specify more than one header:
-  aria2c *--header*="X-A: b78" *--header*="X-B: 9J1" http://host/file
+  aria2c *--header*="X-A: b78" *--header*="X-B: 9J1" \http://host/file
 
 
 *--load-cookies*=FILE::
 *--load-cookies*=FILE::
   Load Cookies from FILE using the Firefox3 format(SQLite3) and the
   Load Cookies from FILE using the Firefox3 format(SQLite3) and the
@@ -871,6 +874,30 @@ You can seed downloaded file using --check-integrity=true option.
 aria2c --check-integrity=true file.torrent
 aria2c --check-integrity=true file.torrent
 ---------------------------------------------
 ---------------------------------------------
 
 
+INPUT FILE
+----------
+The input file can contain list of URIs to feed them into aria2.
+You can specify multiple URIs for a single entity:
+separate URIs on a single line using the TAB character.
+
+Each line is treated as if it is provided in command-line argument.
+Therefore they are affected by *-Z* and *-P* options.
+The additional *out* and *dir* options can be specified after each line of
+URIs. This optional line must start with white space(s).
+
+For example, the content of uri.txt is:
+---------------------------------------------
+http://server/file.iso http://mirror/file.iso
+  dir=/iso_images
+  out=file.img
+http://foo/bar
+---------------------------------------------
+
+and if aria2 is executed with -i uri.txt -d /tmp options,
+then file.iso is saved as /iso_images/file.img and it is downloaded from
+\http://server/file.iso and \http://mirror/file.iso.
+The file bar is downloaded from \http://foo/bar and saved as /tmp/bar.
+
 SERVER PERFORMANCE PROFILE
 SERVER PERFORMANCE PROFILE
 --------------------------
 --------------------------
 This section describes the format of server performance profile.
 This section describes the format of server performance profile.