blob: 2e3ed21279ac6ea03516f90d012db01b0914fa95 (
plain)
1 .Dd July 12, 2006
2 .Dt BTPD 1
3 .Os
4 .Sh NAME
5 .Nm btpd
6 .Nd BitTorrent protocol daemon
7 .Sh SYNOPSIS
8 .Nm btpd
9 .Op Fl c
10 .Op Fl d Ar dir
11 .Op Fl p Ar port
12 .Op Ar more options ...
13 .Sh DESCRIPTION
14 .Nm
15 is the torrent download daemon of this package. Most of the interaction will
16 be with the
17 .Nm btcli
18 tool.
19 .Pp
20 The options are as follows:
21 .Bl -tag -width Ds
22 .It Fl -bw-in Ar n
23 Limit incoming BitTorrent traffix to
24 .Ar n
25 kB/s. Default is 0 which means unlimited.
26 .It Fl -bw-out Ar n
27 Limit outgoing BitTorrent traffic to
28 .Ar n
29 kB/s. Default is 0 which means unlimited.
30 .It Fl c , Fl -collective-mode
31 Enables collective mode. Collective mode allows the control socket to
32 be written to by all members of the login group
33 .Nm
34 runs as.
35 .Pp
36 .Em WARNING :
37 If enabled, the control socket will have permissions 0640 which mean that ANY
38 user of the login group of the user
39 .Nm
40 is running as can send ANY command to btpd. Use with care.
41 .It Fl d Ar dir
42 The directory in which to run btpd. Default is $HOME/.btpd.
43 .It Fl -help
44 Show the help text.
45 .It Fl -logfile Ar file
46 Where to put the logfile. By default it's put in the btpd dir.
47 .It Fl -max-peers Ar n
48 Limit the amount of peers to
49 .Ar n .
50 .It Fl -max-uploads Ar n
51 Control the number of simultaneous uploads.
52 The possible values are:
53 .Pp
54 .Bl -inset -compact
55 .It Ar n No \&< \-1 :
56 Choose n \&>\&= 2 based on
57 .Fl -bw-out
58 (default).
59 .It Ar n No \&= \-1 :
60 Upload to every interested peer.
61 .It Ar n No \&= \ 0 :
62 Don't upload to anyone.
63 .It Ar n No \&> \ 0 :
64 Upload to at most
65 .Ar n
66 peers simultaneously.
67 .El
68 .It Fl -no-daemon
69 Keep the
70 .Nm
71 process in the foreground and log to std{out, err}.
72 This option is intended for debugging purposes.
73 .It Fl p Ar n , Fl -port Ar n
74 Listen at port
75 .Ar n .
76 Default is 6881.
77 .It Fl -prealloc Ar n
78 Preallocate disk space in chunks of
79 .Ar n
80 kB. Default is 2048. Note that
81 .Ar n
82 will be rounded up to he closest multiple of the torrent piece size. If
83 .Ar n
84 is zero no preallocation will be done.
85 .El
86 .Pp
87 By default,
88 .Nm btpd
89 will store its information and and logfile in $HOME/.btpd. Only one instance
90 of this daemon should be running at a time.
91 .\" There are no references in the code to this but there are in the
92 .\" README. I say: trust the code.
93 .\" .Sh ENVIRONMENT
94 .\" .Bl -tag -width BTPD_HOME
95 .\" .It Ev BTPD_HOME
96 .\" Sets the directory in which to store information and the logfile if
97 .\" present. Overridden by the command-line option.
98 .\" .El
99 .Sh FILES
100 .Bl -tag -width $HOME/.btpd/
101 .It $HOME/.btpd/
102 Default diretory to store information files, the control socket, and the
103 log file.
104 .\" .Sh EXAMPLES
105 .Sh DIAGNOSTICS
106 If the daemon exits quickly for no apparent reason, check the logfile for
107 possible causes. If the logfile indicates something about bind and the adress
108 being in use, check that no other process is using the TCP port 6881
109 (the default) or the one you specified with the -p option.
110 .Sh SEE ALSO
111 .Xr btcli 1 ,
112 .Xr btinfo 1 .
113 .Sh AUTHORS
114 .An Richard Nyberg Aq rnyberg@murmeldjur.se
115 .Sh CAVEATS
116 When using colletive mode, be sure that you trust the members of the login
117 group of the user of
118 .Nm ,
119 otherwise you may end up with nasty suprises.
|
