tags 578598 patch retitle 578598 Properly document the ratio.*= options thanks
Here's a patch that corrects the man page and fixes the example configuration file, using the correct syntax reported by Tomas Vondra. Cheers, -- Benoît Knecht --- diff --git a/doc/rtorrent.1 b/doc/rtorrent.1 index fa5477f..423d2ad 100644 --- a/doc/rtorrent.1 +++ b/doc/rtorrent.1 @@ -3,7 +3,7 @@ .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng <[email protected]>. -.TH "RTORRENT" "1" "14 May 2009" "BitTorrent client for ncurses" "" +.TH "RTORRENT" "1" "07 December 2010" "BitTorrent client for ncurses" "" .SH NAME rtorrent \- a BitTorrent client for ncurses @@ -280,11 +280,16 @@ to the filename provided. Load a resource file. \fBtry_import\fR does not throw torrent::input_error exception on bad input. .TP -\fBstop_on_ratio = \fImin_ratio\fB\fR +\fBratio.enable =\fR .TP -\fBstop_on_ratio = \fImin_ratio\fB,\fImin_upload\fB\fR +\fBratio.disable =\fR +Enable or disable ratio settings, respectively (see below). .TP -\fBstop_on_ratio = \fImin_ratio\fB,\fImin_upload\fB,\fImax_ratio\fB\fR +\fBratio.min.set = \fImin_ratio\fB\fR +.TP +\fBratio.max.set = \fImax_ratio\fB\fR +.TP +\fBratio.upload.set = \fImin_upload\fB\fR Stop torrents when they reach the given upload ratio \fBmin_ratio\fR in percent. If the optional \fBmin_upload\fR is given, require a total diff --git a/doc/rtorrent.1.xml b/doc/rtorrent.1.xml index 9c45585..8fc3da2 100644 --- a/doc/rtorrent.1.xml +++ b/doc/rtorrent.1.xml @@ -581,9 +581,17 @@ torrent::input_error exception on bad input. </varlistentry> <varlistentry> - <term>stop_on_ratio = <replaceable>min_ratio</replaceable></term> - <term>stop_on_ratio = <replaceable>min_ratio</replaceable>,<replaceable>min_upload</replaceable></term> - <term>stop_on_ratio = <replaceable>min_ratio</replaceable>,<replaceable>min_upload</replaceable>,<replaceable>max_ratio</replaceable></term> + <term>ratio.enable =</term> + <term>ratio.disable =</term> + <listitem><para> +Enable or disable ratio settings, respectively (see below). + </para></listitem> + </varlistentry> + + <varlistentry> + <term>ratio.min.set = <replaceable>min_ratio</replaceable></term> + <term>ratio.max.set = <replaceable>max_ratio</replaceable></term> + <term>ratio.upload.set = <replaceable>min_upload</replaceable></term> <listitem><para> Stop torrents when they reach the given upload ratio <emphasis>min_ratio</emphasis> in percent. If the optional diff --git a/doc/rtorrent.rc b/doc/rtorrent.rc index bc567f0..0932cc8 100644 --- a/doc/rtorrent.rc +++ b/doc/rtorrent.rc @@ -37,7 +37,10 @@ # when also reaching total upload in bytes, or when # reaching final upload ratio in percent. # example: stop at ratio 2.0 with at least 200 MB uploaded, or else ratio 20.0 -#schedule = ratio,60,60,"stop_on_ratio=200,200M,2000" +#ratio.enable= +#ratio.min.set=200 +#ratio.max.set=2000 +#ratio.upload.set=200M # The ip address reported to the tracker. #ip = 127.0.0.1 -- To UNSUBSCRIBE, email to [email protected] with a subject of "unsubscribe". Trouble? Contact [email protected]
