Browse Source

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

	Added a section that explains how to pass argument to options
	that takes optional arguments with its short form.
	* doc/aria2c.1.txt
Tatsuhiro Tsujikawa 17 years ago
parent
commit
64a7770f53
4 changed files with 26 additions and 1 deletions
  1. 6 0
      ChangeLog
  2. 3 0
      doc/aria2c.1
  3. 8 1
      doc/aria2c.1.html
  4. 9 0
      doc/aria2c.1.txt

+ 6 - 0
ChangeLog

@@ -1,3 +1,9 @@
+2008-11-16  Tatsuhiro Tsujikawa  <t-tujikawa@users.sourceforge.net>
+
+	Added a section that explains how to pass argument to options that
+	takes optional arguments with its short form.
+	* doc/aria2c.1.txt
+	
 2008-11-16  Tatsuhiro Tsujikawa  <t-tujikawa@users.sourceforge.net>
 
 	Added -u for the short form of --max-upload-limit option.

+ 3 - 0
doc/aria2c.1

@@ -782,6 +782,9 @@ is given, this feature is disabled\&. Default:
 .RS 4
 Print the version number, copyright and the configuration information and exit\&.
 .RE
+.SS "OPTIONS THAT TAKES OPTIONAL ARGUMENTS"
+The options that has its arguments surrounded by square brackets([]) are optional\&. Usually ommiting the argument is evaluated to \fItrue\fR\&. If you use short form of these option(such as \fI\-V\fR) of these options and give arugment, then the option name and its argument should be concatenated like \fI\-Vfalse\fR)\&. If any spaces are inserted between the option name and argument, the argument treated as URI and usually this is not what you expect\&.
+.sp
 .SS "URL, TORRENT_FILE, METALINK_FILE"
 You can specify multiple URLs in command\-line\&. Unless you specify \fB\-Z\fR option, all URLs must point to the same file or downloading will fail\&.
 .sp

+ 8 - 1
doc/aria2c.1.html

@@ -1433,6 +1433,13 @@ are also allocated if they share a same piece.</td>
 </p>
 </dd>
 </dl></div>
+<h3 id="_options_that_takes_optional_arguments">OPTIONS THAT TAKES OPTIONAL ARGUMENTS</h3><div style="clear:left"></div>
+<div class="para"><p>The options that has its arguments surrounded by square brackets([])
+are optional. Usually ommiting the argument is evaluated to <em>true</em>.
+If you use short form of these option(such as <em>-V</em>) of these options and give
+arugment, then the option name and its argument should be concatenated like
+<em>-Vfalse</em>). If any spaces are inserted between the option name and argument, the
+argument treated as URI and usually this is not what you expect.</p></div>
 <h3 id="_url_torrent_file_metalink_file">URL, TORRENT_FILE, METALINK_FILE</h3><div style="clear:left"></div>
 <div class="para"><p>You can specify multiple URLs in command-line.
 Unless you specify <strong>-Z</strong> option, all URLs must point to the same file or downloading will fail.</p></div>
@@ -2021,7 +2028,7 @@ files in the program, then also delete it here.</p></div>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2008-11-16 17:09:18 JST
+Last updated 2008-11-16 17:34:48 JST
 </div>
 </div>
 </body>

+ 9 - 0
doc/aria2c.1.txt

@@ -556,6 +556,15 @@ are also allocated if they share a same piece.
   Print the version number, copyright and the configuration information and
   exit.
 
+OPTIONS THAT TAKES OPTIONAL ARGUMENTS
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The options that has its arguments surrounded by square brackets([])
+are optional. Usually ommiting the argument is evaluated to 'true'.
+If you use short form of these option(such as '-V') of these options and give
+arugment, then the option name and its argument should be concatenated like
+'-Vfalse'). If any spaces are inserted between the option name and argument, the
+argument treated as URI and usually this is not what you expect.
+
 URL, TORRENT_FILE, METALINK_FILE
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 You can specify multiple URLs in command-line.