From dd0d462afae75ff243f8cd1528963f9ad489706d Mon Sep 17 00:00:00 2001 From: Richard Nyberg Date: Fri, 24 Jun 2005 09:51:38 +0000 Subject: Import btpd-0.1. git-svn-id: file:///home/rnyberg/svngit/btpd/releases/0.1@1 76a1f634-46fa-0310-9943-bd1476092a85 --- README | 59 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) create mode 100644 README (limited to 'README') diff --git a/README b/README new file mode 100644 index 0000000..2cc1a60 --- /dev/null +++ b/README @@ -0,0 +1,59 @@ ++ PROGRAMS + +btpd consists of the following programs: +* btpd - The BitTorrent client. +* btcli - Command line interface to btpd. +* btinfo - Shows information from a torrent file. + +All programs takes the "--help" option. + ++ DIRECTORY STRUCTURE + +foo.torrent + The torrent metainfo file. + +foo.torrent.d + Content will be downloaded to, and uploaded from, this dir. + It and its subdirectories and files will be created by + btpd as it downloads them. + +foo.torrent.i + Created by 'btcli add'. Contains info on downloaded pieces. + ++ SAMPLE USAGE + +NOTE: Don't start one instance of btpd per torrent. You should only +need one instance regardless of how many torrents you want to share. + +Start btpd: +# btpd + +Start downloading or seeding bar.torrent: +# btcli add /path/to/bar.torrent + +List active torrents (only bar.torrent atm): +# btcli list + +Show some stats: +# btcli stat + +Stop downloading/seeding bar.torrent: +# btcli del /path/to/bar.torrent + +Shut down btpd (Why would you do such a thing?): +# btcli die + ++ BUILDING + +Make sure you have recent versions of the following software: +* curl - Get at +* openssl - Get at +* libevent - Get at + +You also need a c99 compiler. A non antique GCC should do. + +# ./configure +# make +# make install + +See ./configure --help for options if it fails. -- cgit 1.4.1