Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Add documentation for 'btpd --numwant' and 'btcli rate'

  • Loading branch information...
commit c550cbb4353bc653a916be3beb19853bc650e56b 1 parent a632807
@queueRAM queueRAM authored
Showing with 19 additions and 1 deletion.
  1. +4 −0 README
  2. +8 −0 doc/btcli.1
  3. +7 −1 doc/btpd.1
View
4 README
@@ -50,6 +50,7 @@ Contents
* del - Remove torrents from btpd.
* kill - Shut down btpd.
* list - List torrents.
+ * rate - Set the global up and download rates in KB/s.
* start - Activate torrents.
* stat - Display stats for active torrents.
* stop - Deactivate torrents.
@@ -160,6 +161,9 @@ Contents
Same as above, but also display individual stats for each active torrent.
# btcli stat -w 5 -i
+ Set the global upload rate to 20KB/s and download rate to 1MB/s.
+ # btcli rate 20K 1M
+
Shut down btpd.
# btcli kill
View
8 doc/btcli.1
@@ -27,6 +27,8 @@ One of the following operations must be specified when running btcli:
.TP
\fBlist\fR \- List torrents.
.TP
+\fBrate\fR \- Set the global up and download rates in KB/s.
+.TP
\fBstart\fR \- Activate torrents.
.TP
\fBstat\fR \- Display stats for active torrents.
@@ -225,6 +227,12 @@ Same as above, but also display individual stats for each active torrent.
.B $ btcli stat \-w 5 \-i
.RE
.PP
+Set the global upload rate to 20KB/s and download rate to 1MB/s.
+.br
+.RS 4
+.B $ btcli rate 20K 1M
+.RE
+.PP
Shut down btpd.
.br
.RS 4
View
8 doc/btpd.1
@@ -63,10 +63,13 @@ Set the protection mode of the command socket. The mode is specified by an octa
.B \-\-logfile \fIfile\fR
Where to put the logfile. By default it's put in the btpd dir.
.TP
+.B \-\-logmask \fImask\fR
+Bitfield to specify which data to record in the btpd log (dev info).
+.TP
.B \-\-max\-peers \fIn\fR
Limit the amount of peers to \fIn\fR.
.TP
-.B \-\-max\-uploads n
+.B \-\-max\-uploads \fIn\fR
Controls the number of simultaneous uploads. The possible values are:
.RS
\fIn\fR < \-1 : Choose \fIn\fR >= 2 based on \fB\-\-bw\-out\fR (default).
@@ -83,6 +86,9 @@ Keep the btpd process in the foregorund and log to std{out,err}. This option is
.TP
.B \-\-prealloc \fIn\fR
Preallocate disk space in chunks of \fIn\fR kB. Default is 2048. Note that \fIn\fR will be rounded up to the closest multiple of the torrent piece size. If \fIn\fR is zero no preallocation will be done.
+.TP
+.B \-\-numwant \fIn\fR
+Specify the number of wanted peers 'numwant' tracker request parameter. Default is 50.
.SH "STARTING BTPD"
To start btpd with default settings you only need to run it. However, there are many useful options you may want to use. To see a full list run \fBbtpd \-\-help\fR. If you didn't specify otherwise, btpd starts with the same set of active torrents as it had the last time it was shut down.
.PP
Please sign in to comment.
Something went wrong with that request. Please try again.