summaryrefslogtreecommitdiff
path: root/network/btpd/README
diff options
context:
space:
mode:
Diffstat (limited to 'network/btpd/README')
-rw-r--r--network/btpd/README35
1 files changed, 19 insertions, 16 deletions
diff --git a/network/btpd/README b/network/btpd/README
index 40dfc99531..a63b2bbd16 100644
--- a/network/btpd/README
+++ b/network/btpd/README
@@ -1,17 +1,20 @@
-BTPD is a bittorrent client consisting of a daemon and
-client commands, which can be used to read and/or
-manipulate the daemon state. The daemon is capable of
-running several torrents simultaneously and only uses one
-tcp port. It's fairly low on resource usage and should be
-perfect for file distribution sites. Efficient downloads and
-ease of use makes this client a good choice for the casual
-user as well.
+Btpd is a utility for sharing files over the BitTorrent network protocol.
+It runs in daemon mode, thus needing no controlling terminal or gui. Instead,
+the daemon is controlled by the btcli command line utility, or other programs
+capable of sending commands and queries on the btpd control socket.
-Features:
-* Runs multiple torrents simultaneously;
-* Only uses one tcp port;
-* Command line interface;
-* Runs as a daemon; no need for constant gui or terminal;
-* Bandwidth rate limiting for out- and inbound traffic;
-* Supports the multitracker extension;
-* Supports the key tracker extension.
+The goal is to provide a healthy alternative to the still prevailing ftp/http
+servers for file distribution sites and a good BitTorrent client for the
+casual user.
+
+Features of btpd include:
+ * Reasonable resource usage.
+ * Runs in daemon mode; no need for constant terminal or gui.
+ * Command line interface.
+ * Sharing of multiple torrents in one btpd process.
+ * Upload and download rate limiting.
+ * IPv6 support.
+ * Multitracker support.
+
+Btpd is very simple and easy to use. The official README (which is located in
+the standard documentation directory) is small and complete, so read it first.