mirror
/
transmission
mirror of https://github.com/transmission/transmission
1
0
Fork 0
Code Issues Releases Wiki Activity
transmission/daemon/transmission-daemon.1

171 lines
5.1 KiB
Groff
Raw Normal View History

add more rpc unit tests. man page cleanups.
2008-07-21 16:11:47 +00:00
.Dd July 21, 2008
Merge daemon branch to trunk.
2007-04-18 16:39:10 +00:00
.Dt TRANSMISSION-DAEMON 1
.Sh NAME
.Nm transmission-daemon
.Nd a bittorrent client
.Sh SYNOPSIS
Add command-line option to use an alternate location for the socket file.
2007-05-24 03:59:53 +00:00
.Bk -words
Merge daemon branch to trunk.
2007-04-18 16:39:10 +00:00
.Nm transmission-daemon
.Fl h
.Nm
(trunk daemon) minor fixes to the daemon manpage
2008-12-23 23:54:53 +00:00
.Op Fl a Ar x.x.x.x,...
add more rpc unit tests. man page cleanups.
2008-07-21 16:11:47 +00:00
.Op Fl b | B
(trunk daemon) experimental commit for part of #1483: adding a WatchDir to transmission-daemon. I don't know if this will work out because of (1) any possible C/C++ issues, and (2) maybe some embedded systems don't have inotify and/or kqueue?
2009-02-27 21:49:31 +00:00
.Op Fl c Ar directory
.Op Fl C
add transmission-daemon's --dump option to the manpage.
2013-05-25 23:20:20 +00:00
.Op Fl d
#966: allow blocklist support in the daemon. add extra info in the man page explaining how to add blocklists.
2008-06-11 20:09:36 +00:00
.Op Fl f
updated daemon manpage
2008-05-19 15:50:30 +00:00
.Op Fl g Ar directory
#966: allow blocklist support in the daemon. add extra info in the man page explaining how to add blocklists.
2008-06-11 20:09:36 +00:00
.Op Fl h
updated daemon manpage
2008-05-19 15:50:30 +00:00
.Op Fl p Ar port
add more rpc unit tests. man page cleanups.
2008-07-21 16:11:47 +00:00
.Op Fl t | T
#966: allow blocklist support in the daemon. add extra info in the man page explaining how to add blocklists.
2008-06-11 20:09:36 +00:00
.Op Fl u Ar username
sync the man pages with the cli/daemon/remote changes
2008-07-08 17:44:33 +00:00
.Op Fl v Ar password
(trunk daemon) #1618: patch from er13 to make transmission-daemon's encryption, port, and peer limit command-line arguments similar to transmission-remote's
2008-12-30 18:18:34 +00:00
.Op Fl P Ar port
.Op Fl m | M
.Op Fl l Ar limit
.Op Fl L Ar limit
.Op Fl er | ep | et
(trunk daemon) #2338 "Add uTP support" -- added er13's patch from comment:115 to add uTP enable/disable commands to transmission-remote. Thanks er13!
2011-04-20 23:17:10 +00:00
.Op Fl utp | no-utp
(trunk libT) #1723: View version with / from transmission-remote
2009-01-23 19:36:34 +00:00
.Op Fl V
sync the man pages with the cli/daemon/remote changes
2008-07-08 17:44:33 +00:00
.Op Fl w Ar download-dir
(trunk daemon) #2890 "Add option to specify logfile in transmission-daemon" -- implemented for 1.90
2010-02-11 01:37:59 +00:00
.Op Fl e Ar logfile
(trunk daemon) #3511 "setting TR_DEBUG environment variable has no effect" -- rename --log-err as --log-error for consistency
2010-09-22 22:19:21 +00:00
.Op Fl log-error | log-info | log-debug
Add command-line option to use an alternate location for the socket file.
2007-05-24 03:59:53 +00:00
.Ek
Merge daemon branch to trunk.
2007-04-18 16:39:10 +00:00
.Sh DESCRIPTION
.Nm
minor tweaks.
2008-05-19 16:16:38 +00:00
is a daemon-based Transmission session that can be controlled
add more rpc unit tests. man page cleanups.
2008-07-21 16:11:47 +00:00
via RPC commands from transmission's web interface or
.Xr transmission-remote 1 .
.Sh OPTIONS
Merge daemon branch to trunk.
2007-04-18 16:39:10 +00:00
.Bl -tag -width Ds
#1309: Web/RPC interface ACL ignored
2008-10-01 20:23:57 +00:00
.It Fl a Fl -allowed Ar x.x.x.x,...
(trunk daemon) minor fixes to the daemon manpage
2008-12-23 23:54:53 +00:00
Allow RPC access to a comma-delimited whitelist of IP addresses.
update the daemon manpage to explain wildcarding in the ACL
2008-09-26 16:51:12 +00:00
Wildcards can be specified in an address by using '*'.
Allow the RPC server to listen on an IPv6 address
2017-01-28 20:18:38 +00:00
Default: "127.0.0.1,::1"
#1309: Web/RPC interface ACL ignored
2008-10-01 20:23:57 +00:00
Example: "127.0.0.*,192.168.1.*"
#966: allow blocklist support in the daemon. add extra info in the man page explaining how to add blocklists.
2008-06-11 20:09:36 +00:00
.It Fl b Fl -blocklist
(trunk) extremely minor manpage copyediting
2010-12-12 16:36:46 +00:00
Enable peer blocklists. Transmission understands the bluetack blocklist file format.
#966: allow blocklist support in the daemon. add extra info in the man page explaining how to add blocklists.
2008-06-11 20:09:36 +00:00
New blocklists can be added by copying them into the config-dir's "blocklists" subdirectory.
(trunk daemon) experimental commit for part of #1483: adding a WatchDir to transmission-daemon. I don't know if this will work out because of (1) any possible C/C++ issues, and (2) maybe some embedded systems don't have inotify and/or kqueue?
2009-02-27 21:49:31 +00:00
.It Fl c Ar directory
(trunk) extremely minor manpage copyediting
2010-12-12 16:36:46 +00:00
Directory to watch for new .torrent files to be added. As they are added to this directory,
(trunk daemon) experimental commit for part of #1483: adding a WatchDir to transmission-daemon. I don't know if this will work out because of (1) any possible C/C++ issues, and (2) maybe some embedded systems don't have inotify and/or kqueue?
2009-02-27 21:49:31 +00:00
the daemon will load them into Transmission.
.It Fl C
Do not watch for new .torrent files.
sync the man pages with the cli/daemon/remote changes
2008-07-08 17:44:33 +00:00
.It Fl B Fl -no-blocklist
#966: allow blocklist support in the daemon. add extra info in the man page explaining how to add blocklists.
2008-06-11 20:09:36 +00:00
Disble blocklists.
add transmission-daemon's --dump option to the manpage.
2013-05-25 23:20:20 +00:00
.It Fl d
Dump transmission-daemon's settings to stderr.
Merge daemon branch to trunk.
2007-04-18 16:39:10 +00:00
.It Fl f Fl -foreground
#966: allow blocklist support in the daemon. add extra info in the man page explaining how to add blocklists.
2008-06-11 20:09:36 +00:00
Run in the foreground and print errors to stderr.
updated daemon manpage
2008-05-19 15:50:30 +00:00
.It Fl g Fl -config-dir Ar directory
(trunk) extremely minor manpage copyediting
2010-12-12 16:36:46 +00:00
Where to look for configuration files. This can be used to swap between using the cli, daemon, gtk, and qt clients.
HTTPS links for trac, forum, portcheck, and build subdomains.
2016-11-02 19:45:13 +00:00
See https://trac.transmissionbt.com/wiki/ConfigFiles for more information.
(trunk daemon) #1618: patch from er13 to make transmission-daemon's encryption, port, and peer limit command-line arguments similar to transmission-remote's
2008-12-30 18:18:34 +00:00
.It Fl er Fl -encryption-required
Encrypt all peer connections.
.It Fl ep Fl -encryption-preferred
Prefer encrypted peer connections.
.It Fl et Fl -encryption-tolerated
Prefer unencrypted peer connections.
(trunk daemon) #2875 "add incomplete-dir, dht, and seedratio options to daemon" -- committed to trunk for 1.90
2010-02-07 19:20:00 +00:00
.It Fl gsr Fl -global-seedratio Ar ratio
All torrents, unless overridden by a per-torrent setting, should seed until a specific
.Ar ratio
.It Fl GSR Fl -no-global-seedratio
All torrents, unless overridden by a per-torrent setting, should seed regardless of ratio
Merge daemon branch to trunk.
2007-04-18 16:39:10 +00:00
.It Fl h Fl -help
Print command-line option descriptions.
(trunk daemon) #2875 "add incomplete-dir, dht, and seedratio options to daemon" -- committed to trunk for 1.90
2010-02-07 19:20:00 +00:00
.It Fl -incomplete-dir Ar dir
When adding new torrents, store their contents in
.Ar directory
until the torrent is done.
.It Fl -no-incomplete-dir
Don't store incomplete torrents in a different directory.
(trunk) #1497 Options to listen on specific network sockets
2009-04-15 21:05:58 +00:00
.It Fl i Fl -bind-address-ipv4
Listen for IPv4 BitTorrent connections on a specific address. Only one IPv4 listening address is allowed. Default: 0.0.0.0 (All addresses)
.It Fl I Fl -bind-address-ipv6
Listen for IPv6 BitTorrent connections on a specific address. Only one IPv6 listening address is allowed. Default: :: (All addresses)
.It Fl r Fl -rpc-bind-address
Allow the RPC server to listen on an IPv6 address
2017-01-28 20:18:38 +00:00
Listen for RPC connections on a specific address. This must be an IPv4 or IPv6 address. Only one RPC listening address is allowed. Default: 0.0.0.0 (All IPv4 addresses)
(trunk daemon) add --paused argument to pause all on startup
2009-05-13 19:58:04 +00:00
.It Fl -paused
Pause all torrents on startup
(trunk daemon) #1618: patch from er13 to make transmission-daemon's encryption, port, and peer limit command-line arguments similar to transmission-remote's
2008-12-30 18:18:34 +00:00
.It Fl L Fl -peerlimit-global Ar limit
Overall peer limit. Useful on embedded systems where the default might be unsuitable. Default: 240
.It Fl l Fl -peerlimit-torrent Ar limit
Peer limit per torrent. Useful on embedded systems where the default might be unsuitable. Default: 60
.It Fl m Fl -portmap
Enable portmapping via NAT-PMP or UPnP
.It Fl M Fl -no-portmap
Disable portmapping
(trunk daemon) #2875 "add incomplete-dir, dht, and seedratio options to daemon" -- committed to trunk for 1.90
2010-02-07 19:20:00 +00:00
.It Fl o Fl -dht
Enable distributed hash table (DHT).
.It Fl O Fl -no-dht
Disable distribued hash table (DHT).
updated daemon manpage
2008-05-19 15:50:30 +00:00
.It Fl p Fl -port Ar port
(trunk) extremely minor manpage copyediting
2010-12-12 16:36:46 +00:00
Port to open and listen for RPC requests on. Default: 9091
(trunk daemon) #1618: patch from er13 to make transmission-daemon's encryption, port, and peer limit command-line arguments similar to transmission-remote's
2008-12-30 18:18:34 +00:00
.It Fl P, -peerport Ar port
Port to listen for incoming peers on. Default: 51413
#966: allow blocklist support in the daemon. add extra info in the man page explaining how to add blocklists.
2008-06-11 20:09:36 +00:00
.It Fl t Fl -auth
Require clients to authenticate themselves.
This doesn't do much good unless
sync the man pages with the cli/daemon/remote changes
2008-07-08 17:44:33 +00:00
.Ar username
and
.Ar password
are also set.
.It Fl T Fl -no-auth
#966: allow blocklist support in the daemon. add extra info in the man page explaining how to add blocklists.
2008-06-11 20:09:36 +00:00
Don't require authentication from clients.
sync the man pages with the cli/daemon/remote changes
2008-07-08 17:44:33 +00:00
.It Fl u Fl -username Ar username
#966: allow blocklist support in the daemon. add extra info in the man page explaining how to add blocklists.
2008-06-11 20:09:36 +00:00
Used for client authentication.
sync the man pages with the cli/daemon/remote changes
2008-07-08 17:44:33 +00:00
.It Fl v Fl -password Ar password
#966: allow blocklist support in the daemon. add extra info in the man page explaining how to add blocklists.
2008-06-11 20:09:36 +00:00
Used for client authentication.
(trunk libT) #1723: View version with / from transmission-remote
2009-01-23 19:36:34 +00:00
.It Fl V Fl -version
Show version number and exit
(trunk daemon) #2338 "Add uTP support" -- added er13's patch from comment:115 to add uTP enable/disable commands to transmission-remote. Thanks er13!
2011-04-20 23:17:10 +00:00
.It Fl -utp
Enable uTP for peer connections.
.It Fl -no-utp
Disable uTP for peer connections.
sync the man pages with the cli/daemon/remote changes
2008-07-08 17:44:33 +00:00
.It Fl w Fl -download-dir
Where to store downloaded data.
(trunk daemon) #2890 "Add option to specify logfile in transmission-daemon" -- implemented for 1.90
2010-02-11 01:37:59 +00:00
.It Fl e Fl -logfile
Where to store transmission's log messages.
(trunk daemon) #3511 "setting TR_DEBUG environment variable has no effect" -- rename --log-err as --log-error for consistency
2010-09-22 22:19:21 +00:00
.It Fl -log-error
(trunk daemon) #3511 -- companion to r11249: document these three new arguments in the manpage
2010-09-22 15:23:44 +00:00
Show error messages
.It Fl -log-info
Show error and info messages
.It Fl -log-debug
Show error, info, and debug messages
Merge daemon branch to trunk.
2007-04-18 16:39:10 +00:00
.El
minor tweaks.
2008-05-19 16:16:38 +00:00
.Sh ENVIRONMENT
.Bl -tag -width Fl
(trunk daemon) add http_proxy info to the manpages for transmission-daemon and transmission-remote
2010-12-11 21:33:25 +00:00
.It Ev http_proxy
(trunk) clarify http_proxy in the manpages
2010-12-16 16:19:19 +00:00
libcurl uses this environment variable when performing tracker announces.
minor tweaks.
2008-05-19 16:16:38 +00:00
.It Ev TRANSMISSION_HOME
Sets the default config-dir.
.El
Merge daemon branch to trunk.
2007-04-18 16:39:10 +00:00
.Sh FILES
#1004: update man pages FILES section
2008-06-09 15:06:48 +00:00
.Bl -tag -width Ds -compact
.It ~/.config/transmission-daemon
The config-dir used when neither
.Op Ev TRANSMISSION_HOME
nor
.Op Fl g
is specified.
HTTPS links for trac, forum, portcheck, and build subdomains.
2016-11-02 19:45:13 +00:00
See https://trac.transmissionbt.com/wiki/ConfigFiles for more information.
#1004: update man pages FILES section
2008-06-09 15:06:48 +00:00
.El
Merge daemon branch to trunk.
2007-04-18 16:39:10 +00:00
.Sh AUTHORS
.An -nosplit
(trunk) update credits
2011-01-03 05:58:58 +00:00
.An Jordan Lee ,
RPC/IPC redesign
2008-05-18 16:44:30 +00:00
.An Josh Elsasser ,
.An Eric Petit ,
Add myself to the list of Transmission authors
2017-01-14 22:37:51 +00:00
.An Mitchell Livingston ,
Merge daemon branch to trunk.
2007-04-18 16:39:10 +00:00
and
Add myself to the list of Transmission authors
2017-01-14 22:37:51 +00:00
.An Mike Gelfand .
Merge daemon branch to trunk.
2007-04-18 16:39:10 +00:00
.Sh SEE ALSO
(trunk) synchronize the "see also" sections of the manpages
2010-08-04 23:17:49 +00:00
.Xr transmission-create 1 ,
.Xr transmission-daemon 1 ,
.Xr transmission-edit 1 ,
.Xr transmission-gtk 1 ,
.Xr transmission-qt 1 ,
.Xr transmission-remote 1 ,
.Xr transmission-show 1
Merge daemon branch to trunk.
2007-04-18 16:39:10 +00:00
.Pp
Update all website links to canonical HTTPS version.
2016-10-31 09:00:11 +00:00
https://transmissionbt.com/