| 1 | .Dd May 20, 2008 |
|---|
| 2 | .Dt TRANSMISSION-REMOTE 1 |
|---|
| 3 | .Os |
|---|
| 4 | .Sh NAME |
|---|
| 5 | .Nm transmission-remote |
|---|
| 6 | .Nd a remote control utility for |
|---|
| 7 | .Xr transmission-daemon 1 |
|---|
| 8 | and |
|---|
| 9 | .Xr transmission 1 |
|---|
| 10 | .Sh SYNOPSIS |
|---|
| 11 | .Bk -words |
|---|
| 12 | .Nm transmission-remote |
|---|
| 13 | .Fl h |
|---|
| 14 | .Nm |
|---|
| 15 | .Op Ar host:port | host | port |
|---|
| 16 | .Op Fl a Ar torrent-file |
|---|
| 17 | .Op Fl d Ar download-rate |
|---|
| 18 | .Op Fl D |
|---|
| 19 | .Op Fl e |
|---|
| 20 | .Op Fl E |
|---|
| 21 | .Op Fl f Ar directory |
|---|
| 22 | .Op Fl i |
|---|
| 23 | .Op Fl l |
|---|
| 24 | .Op Fl m |
|---|
| 25 | .Op Fl M |
|---|
| 26 | .Op Fl p Ar port |
|---|
| 27 | .Op Fl q |
|---|
| 28 | .Oo |
|---|
| 29 | .Fl r Ar all | Ar id | Ar hash |
|---|
| 30 | .Oc |
|---|
| 31 | .Oo |
|---|
| 32 | .Fl s Ar all | Ar id | Ar hash |
|---|
| 33 | .Oc |
|---|
| 34 | .Oo |
|---|
| 35 | .Fl S Ar all | Ar id | Ar hash |
|---|
| 36 | .Oc |
|---|
| 37 | .Op Fl u Ar upload-rate |
|---|
| 38 | .Op Fl U |
|---|
| 39 | .Oo |
|---|
| 40 | .Fl v Ar all | Ar id | Ar hash |
|---|
| 41 | .Oc |
|---|
| 42 | .Ek |
|---|
| 43 | .Sh DESCRIPTION |
|---|
| 44 | .Nm |
|---|
| 45 | is a remote control utility for |
|---|
| 46 | .Xr transmission 1 |
|---|
| 47 | and |
|---|
| 48 | .Xr transmission-daemon 1 . |
|---|
| 49 | .Pp |
|---|
| 50 | By default, |
|---|
| 51 | .Nm |
|---|
| 52 | connects to the transmission session at localhost:9091. |
|---|
| 53 | Other sessions can be controlled by specifying a different host and/or port. |
|---|
| 54 | .Pp |
|---|
| 55 | The options are as follows: |
|---|
| 56 | .Bl -tag -width Ds |
|---|
| 57 | .It Fl a Fl -add Ar torrent-file |
|---|
| 58 | Add the torrent metainfo file |
|---|
| 59 | .Ar torrent-file . |
|---|
| 60 | .It Fl d Fl -download-limit Ar download-rate |
|---|
| 61 | Set maximum download rate to |
|---|
| 62 | .Ar download-rate |
|---|
| 63 | in kilobytes per second. |
|---|
| 64 | .It Fl D Fl -download-unlimited |
|---|
| 65 | Remove the download limit. |
|---|
| 66 | .It Fl e |
|---|
| 67 | Enable peer exchange. |
|---|
| 68 | .It Fl E |
|---|
| 69 | Disable peer exchange. |
|---|
| 70 | .It Fl f Fl -folder Ar directory |
|---|
| 71 | Use |
|---|
| 72 | .Ar directory |
|---|
| 73 | as the default location for newly added torrents to download files to. |
|---|
| 74 | .It Fl h Fl -help |
|---|
| 75 | Print command-line option descriptions. |
|---|
| 76 | .It Fl l Fl -list |
|---|
| 77 | Print a listing of all torrents, their Id numbers, and current status. |
|---|
| 78 | .It Fl m Fl -port-mapping |
|---|
| 79 | Enable automatic port mapping via NAT-PMP or UPnP IGD. |
|---|
| 80 | .It Fl M Fl -no-port-mapping |
|---|
| 81 | Disable automatic port mapping. |
|---|
| 82 | .It Fl p Fl -port Ar port |
|---|
| 83 | Attempt to bind to |
|---|
| 84 | .Ar port |
|---|
| 85 | for use as a listening port to accept incoming peer connections. |
|---|
| 86 | |
|---|
| 87 | .It Fl r Fl -remove Ar all | id | torrent-hash |
|---|
| 88 | Remove all torrents, or the torrent matching the specified |
|---|
| 89 | .Ar id |
|---|
| 90 | or |
|---|
| 91 | .Ar hash . |
|---|
| 92 | This does not delete the downloaded data. |
|---|
| 93 | |
|---|
| 94 | .It Fl S Fl -stop Ar all | id | torrent-hash |
|---|
| 95 | Stop all torrents from downloading or seeding, or the torrent matching the specified |
|---|
| 96 | .Ar id |
|---|
| 97 | or |
|---|
| 98 | .Ar hash . |
|---|
| 99 | |
|---|
| 100 | .It Fl s Fl -start Ar all | id | torrent-hash |
|---|
| 101 | Start all torrents downloading or seeding, or the torrent matching the specified |
|---|
| 102 | .Ar id |
|---|
| 103 | or |
|---|
| 104 | .Ar hash . |
|---|
| 105 | |
|---|
| 106 | .It Fl u Fl -upload-limit Ar upload-rate |
|---|
| 107 | Set maximum upload rate to |
|---|
| 108 | .Ar upload-rate |
|---|
| 109 | in kilobytes per second. |
|---|
| 110 | |
|---|
| 111 | .It Fl U Fl -upload-unlimited |
|---|
| 112 | Remove the upload limit. |
|---|
| 113 | |
|---|
| 114 | .It Fl v Fl -verify Ar all | id | torrent-hash |
|---|
| 115 | Queue all the torrents for verification, or the torrent matching the specified |
|---|
| 116 | .Ar id |
|---|
| 117 | or |
|---|
| 118 | .Ar hash . |
|---|
| 119 | |
|---|
| 120 | .El |
|---|
| 121 | .Sh EXAMPLES |
|---|
| 122 | Show all torrents, their ID numbers, and their status: |
|---|
| 123 | .Pp |
|---|
| 124 | .Dl transmission-remote -l |
|---|
| 125 | .Pp |
|---|
| 126 | Pause torrent #12: |
|---|
| 127 | .Pp |
|---|
| 128 | .Dl transmission-remote -S 12 |
|---|
| 129 | .Pp |
|---|
| 130 | Set download and upload limits to 100 KiB/sec and 20 KiB/sec: |
|---|
| 131 | .Pp |
|---|
| 132 | .Dl transmission-remote -d 100 -u 20 |
|---|
| 133 | .Pp |
|---|
| 134 | Add two torrents: |
|---|
| 135 | .Pp |
|---|
| 136 | .Dl transmission-remote -a foo.torrent -a bar.torrent |
|---|
| 137 | |
|---|
| 138 | .Sh AUTHORS |
|---|
| 139 | .An -nosplit |
|---|
| 140 | .An Charles Kerr , |
|---|
| 141 | .An Josh Elsasser , |
|---|
| 142 | .An Eric Petit , |
|---|
| 143 | and |
|---|
| 144 | .An Mitchell Livingston . |
|---|
| 145 | |
|---|
| 146 | .Sh SEE ALSO |
|---|
| 147 | .Xr transmissioncli 1 , |
|---|
| 148 | .Xr transmission-daemon 1 , |
|---|
| 149 | .Xr transmission 1 |
|---|
| 150 | |
|---|
| 151 | .Pp |
|---|
| 152 | http://www.transmissionbt.com/ |
|---|
