Difference between revisions of "Btpd"

From ArchWiki
Jump to: navigation, search
m (Installing)
(Installation: stay aur helper generic)
(18 intermediate revisions by 8 users not shown)
Line 1: Line 1:
[[Category:Utilities (English)]]
+
[[Category:Internet Applications]]
[[Category:HOWTOs (English)]]
+
[[Category:Networking]]
 
+
 
[http://github.com/btpd/btpd/wiki/Using-btpd btpd] is a BitTorrent client daemon.
 
[http://github.com/btpd/btpd/wiki/Using-btpd btpd] is a BitTorrent client daemon.
  
== Installing ==
+
== Installation ==
  
It's in [[AUR]], get/installit it with your AUR helper or manually.
+
You can install {{AUR|btpd}} from the [[AUR]].
  
$ cower -d btpd && makepkg && su -c "pacman -U *.pkg"
+
== Configuration ==
  
== Configuring ==
+
Btpd does not have a configuration file. Options can be applied using flags (see {{Ic|man btpd}}).
 
+
The configuration lies in /etc/conf.d/btpd. Actually in the file there's just a definition for $BTPD_ARGS, which is included in /etc/rc.d/btpd. The configuration file could look something like this:
+
 
+
<pre>
+
#
+
# Arguments to be passed to the BitTorrent Protocol Daemon
+
#
+
 
+
btpdUSER="zie"  # See the note, for this option to work.
+
DIR="/home/zie/down/.torrents" # It'll create a directory 'torrents' in there, and sock, pid, log. No content here.
+
PORT="6881"
+
 
+
OUTLIMIT="0"    # Measured in kB/s, 0 means unlimited.
+
INLIMIT="0"    # Measured in kB/s, 0 means unlimited.
+
# See other options in `man btpd`
+
 
+
BTPD_ARGS="-d $DIR -p $PORT --bw-out $OUTLIMIT --bw-in $INLIMIT"
+
</pre>
+
 
+
'''NOTE''': It's meant to be used from userland, although you could run it from your user, but that requires a tweak in the default deamon. Change line 11 to: "su $btpdUSER -c "/usr/bin/btpd $BTPD_ARGS" &> /dev/null".
+
  
 
== Interaction ==
 
== Interaction ==
  
Through '''btcli''': (don't forget to configure working directory with -d)
+
To interact with '''btpd''' use the command-line interface '''btcli'''.
 
+
* Add foo.torrent, with content dir /home/user/foo.torrent.d/, and start it: $ btcli add -d /home/user/foo.torrent.d foo.torrent
+
* Same as above without starting it: $ btcli add -N -d /home/user/foo.torrent.d foo.torrent
+
* Display a list btpd’s torrents and their number, size, status, etc: $ btcli list
+
* Same as above, but only for torrent 12 and my.little.torrent: $ btcli list 12 my.little.torrent
+
* Same as above but only for active torrents: $ btcli list -a
+
* Use a custom list forma: $btcli list -f "btcli list -f "%n\t%#\t%p%s\t%r\n"
+
* Start bar.torrent and torrent number 7: $ btcli start bar.torrent 7
+
* Stop torrent number 7: $ btcli stop 7
+
* Stop all active torrents: $ btcli stop -a
+
* Remove bar.torrent and it’s associated information from btpd: $ btcli del bar.torrent
+
* Display a summary of up/download stats for the active torrents: $ btcli stat
+
* Display the summary once every five seconds: $ btcli stat -w 5
+
* Same as above, but also display individual stats for each active torrent: $ btcli stat -w 5 -i
+
* Shut down btpd: $ btcli kill
+
 
+
Through '''btpd-webui''':
+
  
[to be written]
+
{{note|Don't forget to configure a working directory with -d if you do not want to use the default.}}
  
Resources:
+
Add foo.torrent, with content dir /home/user/foo.torrent.d/, and start it:  
* http://github.com/btpd/btpd
+
$ btcli add -d /home/user/foo.torrent.d foo.torrent
* http://github.com/btpd/btpd/wiki/Using-btpd
+
Same as above without starting it:
* man btpd
+
$ btcli add -N -d /home/user/foo.torrent.d foo.torrent
 +
Display a list btpd’s torrents and their number, size, status, etc:
 +
$ btcli list
 +
Same as above, but only for torrent 12 and my.little.torrent:
 +
$ btcli list 12 my.little.torrent
 +
Same as above but only for active torrents:
 +
$ btcli list -a
 +
Use a custom list forma:
 +
$btcli list -f "btcli list -f "%n\t%#\t%p%s\t%r\n"
 +
Start bar.torrent and torrent number 7:
 +
$ btcli start bar.torrent 7
 +
Stop torrent number 7:
 +
$ btcli stop 7
 +
Stop all active torrents:
 +
$ btcli stop -a
 +
Remove bar.torrent and it’s associated information from btpd:
 +
$ btcli del bar.torrent
 +
Display a summary of up/download stats for the active torrents:
 +
$ btcli stat
 +
Display the summary once every five seconds:
 +
$ btcli stat -w 5
 +
Same as above, but also display individual stats for each active torrent:
 +
$ btcli stat -w 5 -i
 +
Shut down btpd:
 +
$ btcli kill
  
''--zie:'' This is my first wiki page, I hope it's not too horrible.
+
== External Links ==
 +
*[http://github.com/btpd/btpd GitHub] Project Page
 +
*[http://github.com/btpd/btpd/wiki/Using-btpd GitHub Wiki]
 +
*[https://aur.archlinux.org/packages.php?ID=18293 Btpd Webui] in AUR
 +
*[https://aur.archlinux.org/packages.php?ID=39443 GTK+ Btpd frontend] in AUR

Revision as of 07:22, 24 July 2012

btpd is a BitTorrent client daemon.

Installation

You can install btpdAUR from the AUR.

Configuration

Btpd does not have a configuration file. Options can be applied using flags (see man btpd).

Interaction

To interact with btpd use the command-line interface btcli.

Note: Don't forget to configure a working directory with -d if you do not want to use the default.

Add foo.torrent, with content dir /home/user/foo.torrent.d/, and start it:

$ btcli add -d /home/user/foo.torrent.d foo.torrent

Same as above without starting it:

$ btcli add -N -d /home/user/foo.torrent.d foo.torrent

Display a list btpd’s torrents and their number, size, status, etc:

$ btcli list

Same as above, but only for torrent 12 and my.little.torrent:

$ btcli list 12 my.little.torrent

Same as above but only for active torrents:

$ btcli list -a

Use a custom list forma:

$btcli list -f "btcli list -f "%n\t%#\t%p%s\t%r\n"

Start bar.torrent and torrent number 7:

$ btcli start bar.torrent 7

Stop torrent number 7:

$ btcli stop 7

Stop all active torrents:

$ btcli stop -a

Remove bar.torrent and it’s associated information from btpd:

$ btcli del bar.torrent

Display a summary of up/download stats for the active torrents:

$ btcli stat

Display the summary once every five seconds:

$ btcli stat -w 5

Same as above, but also display individual stats for each active torrent:

$ btcli stat -w 5 -i

Shut down btpd:

$ btcli kill

External Links