From fe9c638735ff74dc5edffeac0f4f4af704331880 Mon Sep 17 00:00:00 2001 From: Tatsuhiro Tsujikawa Date: Wed, 28 Mar 2007 16:13:36 +0000 Subject: [PATCH] Update doc about configuration file. --- README | 11 +++++------ doc/aria2c.1 | 27 ++++++++++++++++++++++++--- doc/aria2c.1.txt | 15 ++++++++++++++- 3 files changed, 43 insertions(+), 10 deletions(-) diff --git a/README b/README index 448b290d..f15c77f9 100644 --- a/README +++ b/README @@ -112,13 +112,12 @@ Your .netrc file should have correct permissions(600). 8. Configuration file --------------------- -Configuration file must be placed under ~/.aria2 and must be named as -aria2.conf. Options in a file are one option per line. -The syntax is name=value, where name is the long option name without '--' -prefix. -The line beginning '#' are treated as comments. +Configuration file must be placed under ~/.aria2 and must be named as aria2.conf. +In each line, there is 1 parameter whose syntax is name=value pair, +where name is the long command-line option name without '--' prefix. +The lines beginning '#' are treated as comments. -Examples: +Example: # sample configuration file for aria2c file-allocation=prealloc diff --git a/doc/aria2c.1 b/doc/aria2c.1 index 29c230b8..1a4c6d75 100644 --- a/doc/aria2c.1 +++ b/doc/aria2c.1 @@ -1,11 +1,11 @@ .\" Title: aria2c .\" Author: .\" Generator: DocBook XSL Stylesheets v1.71.0 -.\" Date: 03/28/2007 +.\" Date: 03/29/2007 .\" Manual: .\" Source: .\" -.TH "ARIA2C" "1" "03/28/2007" "" "" +.TH "ARIA2C" "1" "03/29/2007" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -442,7 +442,28 @@ aria2c \-M test.metalink \-\-metalink\-version=1.1.1 \-\-metalink\-language=en\- .PP aria2.conf .RS 3n -User configuration file. Must be placed under ~/.aria2 directory. +User configuration file. It must be placed under ~/.aria2 and must be named as aria2.conf. In each line, there is 1 parameter whose syntax is name=value pair, where name is the long command\-line option name without +\fI\-\-\fR +prefix. The lines beginning +\fI#\fR +are treated as comments. +.sp +.RS 3n +.nf +Examples: +.fi +.RE +.sp +.RS 3n +.nf +# sample configuration file for aria2c +file\-allocation=prealloc +listen\-port=60000 +seed\-ratio=1.0 +max\-upload\-limit=40K +ftp\-pasv=true +.fi +.RE .RE .SH "REPORTING BUGS" Report bugs to Tatsuhiro Tsujikawa diff --git a/doc/aria2c.1.txt b/doc/aria2c.1.txt index 0ffe941a..5c2827a4 100644 --- a/doc/aria2c.1.txt +++ b/doc/aria2c.1.txt @@ -287,7 +287,20 @@ EXAMPLES FILES ----- aria2.conf:: - User configuration file. Must be placed under ~/.aria2 directory. + User configuration file. + It must be placed under ~/.aria2 and must be named as aria2.conf. + In each line, there is 1 parameter whose syntax is name=value pair, + where name is the long command-line option name without '--' prefix. + The lines beginning '#' are treated as comments. + + Example: + + # sample configuration file for aria2c + file-allocation=prealloc + listen-port=60000 + seed-ratio=1.0 + max-upload-limit=40K + ftp-pasv=true REPORTING BUGS --------------