From 7567ff8188947eff7f9e9c52c956a5a43d15d367 Mon Sep 17 00:00:00 2001 From: Tatsuhiro Tsujikawa Date: Fri, 22 May 2009 15:03:45 +0000 Subject: [PATCH] 2009-05-23 Tatsuhiro Tsujikawa Documented --on-download-* option and --save-cookies option in man page. * doc/aria2c.1.txt --- ChangeLog | 6 +++++ doc/aria2c.1 | 47 ++++++++++++++++++++++++++++++++++++-- doc/aria2c.1.html | 58 ++++++++++++++++++++++++++++++++++++++++++++++- doc/aria2c.1.txt | 36 +++++++++++++++++++++++++++++ 4 files changed, 144 insertions(+), 3 deletions(-) diff --git a/ChangeLog b/ChangeLog index 433bebbe..89a38121 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,9 @@ +2009-05-23 Tatsuhiro Tsujikawa + + Documented --on-download-* option and --save-cookies option in man + page. + * doc/aria2c.1.txt + 2009-05-23 Tatsuhiro Tsujikawa Set possible values for --load-cookie option to "/path/to/file". diff --git a/doc/aria2c.1 b/doc/aria2c.1 index 2a470889..34fd3402 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.74.3 -.\" Date: 05/15/2009 +.\" Date: 05/23/2009 .\" Manual: [FIXME: manual] .\" Source: [FIXME: source] .\" Language: English .\" -.TH "ARIA2C" "1" "05/15/2009" "[FIXME: source]" "[FIXME: manual]" +.TH "ARIA2C" "1" "05/23/2009" "[FIXME: source]" "[FIXME: manual]" .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- @@ -383,6 +383,12 @@ If aria2 is built without libsqlite3, then it doesn\(cqt support Firefox3 cookie .sp .5v .RE .PP +\fB\-\-save\-cookies\fR=FILE +.RS 4 +Save Cookies to FILE in Mozilla/Firefox(1\&.x/2\&.x)/ Netscape format\&. If FILE already exists, it is overwritten\&. Session Cookies are also saved and their expiry values are treated as 0\&. Possible Values: +\fI/path/to/file\fR +.RE +.PP \fB\-\-use\-head\fR[=\fItrue\fR|\fIfalse\fR] .RS 4 Use HEAD method for the first request to the HTTP server\&. Default: @@ -902,6 +908,43 @@ or \fIdebug\fR .RE .PP +\fB\-\-on\-download\-complete\fR=COMMAND +.RS 4 +Set the command to be executed when download completes\&. See +\fB\-\-on\-download\-start\fR +option for the requirement of COMMAND\&. See also +\fB\-\-on\-download\-stop\fR +option\&. Possible Values: +\fI/path/to/command\fR +.RE +.PP +\fB\-\-on\-download\-error\fR=COMMAND +.RS 4 +Set the command to be executed when download aborts due to error\&. See +\fB\-\-on\-download\-start\fR +option for the requirement of COMMAND\&. See also +\fB\-\-on\-download\-stop\fR +option\&. Possible Values: +\fI/path/to/command\fR +.RE +.PP +\fB\-\-on\-download\-start\fR=COMMAND +.RS 4 +Set the command to be executed when download starts up\&. COMMAND must take just one argument and GID is passed to COMMAND as a first argument\&. Possible Values: +\fI/path/to/command\fR +.RE +.PP +\fB\-\-on\-download\-stop\fR=COMMAND +.RS 4 +Set the command to be executed when download stops\&. You can override the command to be executed for particular download result using +\fB\-\-on\-download\-complete\fR +and +\fB\-\-on\-download\-error\fR\&. If they are specified, command specified in this option is not executed\&. See +\fB\-\-on\-download\-start\fR +option for the requirement of COMMAND\&. Possible Values: +\fI/path/to/command\fR +.RE +.PP \fB\-\-summary\-interval\fR=SEC .RS 4 Set interval in seconds to output download progress summary\&. Setting diff --git a/doc/aria2c.1.html b/doc/aria2c.1.html index 0bbd44d8..f8ac7106 100644 --- a/doc/aria2c.1.html +++ b/doc/aria2c.1.html @@ -884,6 +884,17 @@ aria2c -o myfile.zip "http://mirror1/file.zip" "http://mirror2/file.zip"
+--save-cookies=FILE +
+
+

+ Save Cookies to FILE in Mozilla/Firefox(1.x/2.x)/ Netscape + format. If FILE already exists, it is overwritten. Session Cookies + are also saved and their expiry values are treated as 0. Possible + Values: /path/to/file +

+
+
--use-head[=true|false]
@@ -1537,6 +1548,51 @@ writes the piece to the appropriate files.

+--on-download-complete=COMMAND +
+
+

+ Set the command to be executed when download completes. See + --on-download-start option for the requirement of COMMAND. See + also --on-download-stop option. Possible Values: + /path/to/command +

+
+
+--on-download-error=COMMAND +
+
+

+ Set the command to be executed when download aborts due to error. + See --on-download-start option for the requirement of COMMAND. + See also --on-download-stop option. Possible Values: + /path/to/command +

+
+
+--on-download-start=COMMAND +
+
+

+ Set the command to be executed when download starts up. COMMAND must + take just one argument and GID is passed to COMMAND as a first + argument. Possible Values: /path/to/command +

+
+
+--on-download-stop=COMMAND +
+
+

+ Set the command to be executed when download stops. You can override + the command to be executed for particular download result using + --on-download-complete and --on-download-error. If they are + specified, command specified in this option is not executed. See + --on-download-start option for the requirement of COMMAND. + Possible Values: /path/to/command +

+
+
--summary-interval=SEC
@@ -2724,7 +2780,7 @@ files in the program, then also delete it here.

diff --git a/doc/aria2c.1.txt b/doc/aria2c.1.txt index 14274e12..1b96b61b 100644 --- a/doc/aria2c.1.txt +++ b/doc/aria2c.1.txt @@ -263,6 +263,13 @@ HTTP Specific Options [NOTE] If aria2 is built without libsqlite3, then it doesn't support Firefox3 cookie format. +*--save-cookies*=FILE:: + + Save Cookies to FILE in Mozilla/Firefox(1.x/2.x)/ Netscape + format. If FILE already exists, it is overwritten. Session Cookies + are also saved and their expiry values are treated as 0. Possible + Values: '/path/to/file' + *--use-head*[='true'|'false']:: Use HEAD method for the first request to the HTTP server. Default: 'true' @@ -607,6 +614,35 @@ Advanced Options LEVEL is either 'debug', 'info', 'notice', 'warn' or 'error'. Default: 'debug' +*--on-download-complete*=COMMAND:: + + Set the command to be executed when download completes. See + *--on-download-start* option for the requirement of COMMAND. See + also *--on-download-stop* option. Possible Values: + '/path/to/command' + +*--on-download-error*=COMMAND:: + + Set the command to be executed when download aborts due to error. + See *--on-download-start* option for the requirement of COMMAND. + See also *--on-download-stop* option. Possible Values: + '/path/to/command' + +*--on-download-start*=COMMAND:: + + Set the command to be executed when download starts up. COMMAND must + take just one argument and GID is passed to COMMAND as a first + argument. Possible Values: '/path/to/command' + +*--on-download-stop*=COMMAND:: + + Set the command to be executed when download stops. You can override + the command to be executed for particular download result using + *--on-download-complete* and *--on-download-error*. If they are + specified, command specified in this option is not executed. See + *--on-download-start* option for the requirement of COMMAND. + Possible Values: '/path/to/command' + *--summary-interval*=SEC:: Set interval in seconds to output download progress summary. Setting '0' suppresses the output.