logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

transmission-remote.1 (12377B)


  1. .Dd July 21, 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
  13. .Op Ar host:port | host | port
  14. .Op Fl a Ar filenames-or-URLs
  15. .Op Fl as
  16. .Op Fl AS
  17. .Op Fl asd Ar number
  18. .Op Fl asu Ar number
  19. .Op Fl asc
  20. .Op Fl ASC
  21. .Op Fl b
  22. .Op Fl c Ar path | Fl C
  23. .Op Fl d Ar number | Fl D
  24. .Op Fl e Ar size
  25. .Op Fl er | ep | et
  26. .Op Fl -exit
  27. .Op Fl f
  28. .Op Fl g Ar files
  29. .Op Fl G Ar files
  30. .Op Fl gsr Ar ratio
  31. .Op Fl GSR
  32. .Op Fl h
  33. .Op Fl i
  34. .Op Fl ic
  35. .Op Fl if
  36. .Op Fl ip
  37. .Op Fl it
  38. .Op Fl l
  39. .Op Fl m | M
  40. .Op Fl n Ar user:pass
  41. .Op Fl ne
  42. .Op Fl N Ar netrc
  43. .Op Fl o | O
  44. .Op Fl p Ar port
  45. .Op Fl Bh
  46. .Op Fl Bn
  47. .Op Fl \&Bl
  48. .Op Fl ph Ar files
  49. .Op Fl pl Ar files
  50. .Op Fl pn Ar files
  51. .Op Fl pr Ar peers
  52. .Op Fl r
  53. .Op Fl rad
  54. .Op Fl s | S
  55. .Op Fl sr Ar ratio
  56. .Op Fl SR
  57. .Op Fl srd
  58. .Op Fl si
  59. .Op Fl st
  60. .Op Fl t Ar all | active | Ar id | Ar hash
  61. .Op Fl hl
  62. .Op Fl HL
  63. .Op Fl u Ar number | Fl U
  64. .Op Fl utp | no-utp
  65. .Op Fl v
  66. .Op Fl V
  67. .Op Fl w Ar download-dir
  68. .Op Fl x | X
  69. .Op Fl y | Y
  70. .Op Fl pi
  71. .Ek
  72. .Sh DESCRIPTION
  73. .Nm
  74. is a remote control utility for
  75. .Xr transmission 1
  76. and
  77. .Xr transmission-daemon 1 .
  78. .Pp
  79. By default,
  80. .Nm
  81. connects to the transmission session at localhost:9091.
  82. Other sessions can be controlled by specifying a different host and/or port.
  83. .Sh OPTIONS
  84. .Bl -tag -width Ds
  85. .It Fl a Fl -add Ar filenames-or-URLs
  86. Add torrents to transmission.
  87. .It Fl b Fl -debug
  88. Enable debugging mode.
  89. .It Fl as Fl -alt-speed
  90. Use the alternate Limits.
  91. .It Fl AS Fl -no-alt-speed
  92. Don't use the alternate Limits.
  93. .It Fl asd Fl -alt-speed-downlimit Ar limit
  94. Limit the alternate download speed to
  95. .Ar limit
  96. kilobytes per second.
  97. .It Fl asu Fl -alt-speed-uplimit Ar limit
  98. Limit the alternate upload speed to
  99. .Ar limit
  100. kilobytes per second.
  101. .It Fl asc Fl -alt-speed-scheduler
  102. Use the scheduled on/off times.
  103. .It Fl ASC Fl -no-alt-speed-scheduler
  104. Don't use the scheduled on/off days and times.
  105. .It Fl -alt-speed-time-begin Ar time
  106. .Ar Time
  107. to start using the alt speed limits (in hhmm).
  108. .It Fl -alt-speed-time-end Ar time
  109. .Ar Time
  110. to stop using the alt speed limits (in hhmm).
  111. .It Fl -alt-speed-days Ar days
  112. Set the number of
  113. .Ar days
  114. on which to enable the speed scheduler, using a list such as "2,4-6".
  115. .It Fl -torrent-done-script Ar filename
  116. Specify a
  117. .Ar file
  118. to run each time a torrent finishes
  119. .It Fl -no-torrent-done-script
  120. Don't run any script when a torrent finishes
  121. .It Fl c Fl -incomplete-dir Ar dir
  122. When adding new torrents, store their contents in
  123. .Ar directory
  124. until the torrent is done.
  125. .It Fl C Fl -no-incomplete-dir
  126. Don't store incomplete torrents in a different directory.
  127. .It Fl d Fl -downlimit Ar limit
  128. Limit the maximum download speed to
  129. .Ar limit
  130. kB/s.
  131. If current torrent(s) are selected this operates on them. Otherwise, it changes the global setting.
  132. .It Fl D Fl -no-downlimit
  133. Disable download speed limits.
  134. If current torrent(s) are selected this operates on them. Otherwise, it changes the global setting.
  135. .It Fl e Fl -cache Ar size
  136. Set the session's maximum memory cache size in MiB. This cache is used to reduce disk IO.
  137. .It Fl er Fl -encryption-required
  138. Encrypt all peer connections.
  139. .It Fl ep Fl -encryption-preferred
  140. Prefer encrypted peer connections.
  141. .It Fl et Fl -encryption-tolerated
  142. Prefer unencrypted peer connections.
  143. .It Fl -exit
  144. Tell the Transmission to initiate a shutdown.
  145. .It Fl f Fl -files
  146. Get a file list for the current torrent(s)
  147. .It Fl g Fl -get Ar all | file-index | files
  148. Mark file(s) for download.
  149. .Ar all
  150. marks all all of the torrent's files for downloading,
  151. .Ar file-index
  152. adds a single file to the download list, and
  153. .Ar files
  154. adds multiple files to the download list,
  155. such as "\-g1,3-5" to add files #1, #3, #4, and #5 to the download list.
  156. .It Fl G Fl -no-get Ar all | file-index | files
  157. Mark file(s) for not downloading.
  158. .It Fl gsr Fl -global-seedratio Ar ratio
  159. All torrents, unless overridden by a per-torrent setting, should seed until a specific
  160. .Ar ratio
  161. .It Fl GSR Fl -no-global-seedratio
  162. All torrents, unless overridden by a per-torrent setting, should seed regardless of ratio
  163. .It Fl h Fl -help
  164. Print command-line option descriptions.
  165. .It Fl i Fl -info
  166. Show details of the current torrent(s)
  167. .It Fl if Fl -info-files
  168. List the specified torrent's files
  169. .It Fl ip Fl -info-peers
  170. List the specified torrent's peers
  171. .It Fl ic Fl -info-pieces
  172. List the specified torrent's pieces
  173. .It Fl it Fl -info-trackers
  174. List the specified torrent's trackers
  175. .It Fl si Fl -session-info
  176. List session information from the server
  177. .It Fl st Fl -session-stats
  178. List statistical information from the server
  179. .It Fl l Fl -list
  180. List all torrents
  181. .It Fl L Fl -labels
  182. Set the specified torrent's labels
  183. .It Fl m Fl -portmap
  184. Enable portmapping via NAT-PMP or UPnP
  185. .It Fl M Fl -no-portmap
  186. Disable portmapping
  187. .It Fl n Fl -auth Ar username:password
  188. Set the
  189. .Ar username
  190. and
  191. .Ar password
  192. for authentication
  193. .It Fl ne Fl -authenv
  194. Set the authentication information from the
  195. .Ar TR_AUTH
  196. environment variable which must be formatted as
  197. .Ar username:password.
  198. .It Fl N Fl -netrc Ar filename
  199. Set the authentication information from a
  200. .Ar netrc file.
  201. See netrc(5) for more information.
  202. .It Fl o Fl -dht
  203. Enable distributed hash table (DHT).
  204. .It Fl O Fl -no-dht
  205. Disable distribued hash table (DHT).
  206. .It Fl p Fl -port Ar port
  207. Set the
  208. .Ar port
  209. for use when listening for incoming peer connections
  210. .It Fl Bh Fl -bandwidth-high
  211. Give this torrent first chance at available bandwidth
  212. .It Fl Bn Fl -bandwidth-normal
  213. Give this torrent the bandwidth left over by high priority torrents
  214. .It Fl \&Bl Fl -bandwidth-low
  215. Give this torrent the bandwidth left over by high and normal priority torrents
  216. .It Fl ph Fl -priority-high Ar all | file-index | files
  217. Try to download the specified file(s) first.
  218. .Ar all
  219. marks all of the torrent's files as normal priority,
  220. .Ar file-index
  221. sets a single file's priority as normal, and
  222. .Ar files
  223. sets multiple files' priorities as normal,
  224. such as "\-pn1,3-5" to normalize files #1, #3, #4, and #5.
  225. .It Fl pn Fl -priority-normal Ar all | file-index | files
  226. Try to download the specified files normally.
  227. .It Fl pl Fl -priority-low Ar all | file-index | files
  228. Try to download the specified files last
  229. .It Fl pr Fl -peers Ar number
  230. Set the maximum number of peers.
  231. If current torrent(s) are selected this operates on them. Otherwise, it changes the global setting.
  232. .It Fl r Fl -remove
  233. Remove the current torrent(s). This does not delete the downloaded data.
  234. .It Fl rad Fl -remove-and-delete
  235. Remove the current torrent(s) and delete their downloaded data.
  236. .It Fl -reannounce
  237. Reannounce the current torrent(s). This is the same as the GUI's "ask tracker for more peers" button.
  238. .It Fl -move
  239. Move the current torrents' data from their current locations to the specified directory.
  240. .It Fl -find
  241. Tell Transmission where to look for the current torrents' data.
  242. .It Fl sr Fl -seedratio Ar ratio
  243. Let the current torrent(s) seed until a specific
  244. .Ar ratio
  245. .It Fl SR Fl -no-seedratio
  246. Let the current torrent(s) seed regardless of ratio
  247. .It Fl srd Fl -seedratio-default
  248. Let the current torrent(s) use the global seedratio settings
  249. .It Fl td Fl -tracker-add Ar tracker
  250. Add a tracker to a torrent
  251. .It Fl tr Fl -tracker-remove Ar trackerId
  252. Remove a tracker from a torrent
  253. .It Fl s Fl -start
  254. Start the current torrent(s)
  255. .It Fl S Fl -stop
  256. Stop the current torrent(s) from downloading or seeding
  257. .It Fl -start-paused
  258. Start added torrents paused
  259. .It Fl -no-start-paused
  260. Start added torrents unpaused
  261. .It Fl t Fl -torrent Ar all | active | id | torrent-hash
  262. Set the current torrent(s) for use by subsequent options. The literal
  263. .Ar all
  264. will apply following requests to all torrents; the literal
  265. .Ar active
  266. will apply following requests to recently-active torrents; and specific torrents can be chosen by
  267. .Ar id
  268. or
  269. .Ar hash .
  270. To set more than one current torrent, join their ids together in a list, such as
  271. "\-t2,4,6-8" to operate on the torrents whose IDs are 2, 4, 6, 7, and 8.
  272. .It Fl -trash-torrent
  273. Delete torrents after adding
  274. .It Fl -no-trash-torrent
  275. Do not delete torrents after adding
  276. .It Fl hl Fl -honor-session
  277. Make the current torrent(s) honor the session limits.
  278. .It Fl HL Fl -no-honor-session
  279. Make the current torrent(s) not honor the session limits.
  280. .It Fl u Fl -uplimit Ar limit
  281. Limit the maximum upload speed to
  282. .Ar limit
  283. kB/s.
  284. If current torrent(s) are selected this operates on them. Otherwise, it changes the global setting.
  285. .It Fl U Fl -no-uplimit
  286. Disable upload speed limits.
  287. .It Fl -utp
  288. Enable uTP for peer connections.
  289. .It Fl -no-utp
  290. Disable uTP for peer connections.
  291. If current torrent(s) are selected this operates on them. Otherwise, it changes the global setting.
  292. .It Fl v Fl -verify
  293. Verify the current torrent(s)
  294. .It Fl V Fl -version
  295. Show version number and exit
  296. .It Fl w Fl -download-dir Ar directory
  297. When used in conjunction with --add, set the new torrent's download folder. Otherwise, set the default download folder.
  298. .It Fl x Fl -pex
  299. Enable peer exchange (PEX).
  300. .It Fl X Fl -no-pex
  301. Disable peer exchange (PEX).
  302. .It Fl y Fl -lds
  303. Enable local peer discovery (LPD).
  304. .It Fl Y Fl -no-lds
  305. Disable local peer discovery (LPD).
  306. .It Fl pi Fl -peer-info
  307. List the current torrent's connected peers.
  308. In the `status' section of the list, the following shorthand is used:
  309. .D1 D: Downloading from this peer
  310. .D1 d: We would download from this peer if they would let us
  311. .D1 E: Encrypted connection
  312. .D1 H: Peer was found through DHT
  313. .D1 I: Peer is an incoming connection
  314. .D1 K: Peer has unchoked us, but we're not interested
  315. .D1 O: Optimistic unchoked
  316. .D1 T: Peer is connected over uTP
  317. .D1 U: Uploading to peer
  318. .D1 u: We would upload to this peer if they asked
  319. .D1 X: Peer was discovered through Peer Exchange (PEX)
  320. .D1 ?: We unchoked this peer, but they're not interested
  321. .It Fl -blocklist-update
  322. Update blocklist from URL specified in remote client's settings with
  323. .Va "blocklist-url"
  324. key.
  325. .El
  326. .Sh EXAMPLES
  327. List all torrents:
  328. .Bd -literal -offset indent
  329. $ transmission-remote \-l
  330. .Ed
  331. List all active torrents:
  332. .Bd -literal -offset indent
  333. $ transmission-remote \-tactive \-l
  334. .Ed
  335. Set download and upload limits to 400 kB/sec and 60 kB/sec:
  336. .Bd -literal -offset indent
  337. $ transmission-remote \-d400 \-u60
  338. $ transmission-remote \-\-downlimit=400 \-\-uplimit=60
  339. .Ed
  340. Set alternate download and upload limits to 100 kB/sec and 20 kB/sec:
  341. .Bd -literal -offset indent
  342. $ transmission-remote \-asd100 \-asu20
  343. $ transmission-remote \-\-alt-speed-downlimit=100 \-\-alt-speed-uplimit=20
  344. .Ed
  345. Set the scheduler to use the alternate speed limits on weekdays between 10AM and 11PM
  346. .Bd -literal -offset indent
  347. $ transmission-remote \-\-alt-speed-time-begin=1000
  348. $ transmission-remote \-\-alt-speed-time-end=2300
  349. $ transmission-remote \-\-alt-speed-days=1-5
  350. $ transmission-remote \-\-alt-speed-scheduler
  351. .Ed
  352. List all torrents' IDs and states:
  353. .Bd -literal -offset indent
  354. $ transmission-remote \-l
  355. .Ed
  356. List all torrents from a remote session that requires authentication:
  357. .Bd -literal -offset indent
  358. $ transmission-remote host:9091 \-\-auth=username:password \-l
  359. .Ed
  360. Start all torrents:
  361. .Bd -literal -offset indent
  362. $ transmission-remote \-tall \-\-start
  363. .Ed
  364. Add two torrents:
  365. .Bd -literal -offset indent
  366. $ transmission-remote \-a one.torrent two.torrent
  367. .Ed
  368. Add all torrents in ~/Desktop:
  369. .Bd -literal -offset indent
  370. $ transmission-remote \-a ~/Desktop/*torrent
  371. .Ed
  372. Get detailed information on the torrent whose ID is '1':
  373. .Bd -literal -offset indent
  374. $ transmission-remote \-t1 \-i
  375. .Ed
  376. Get a list of a torrent's files:
  377. .Bd -literal -offset indent
  378. $ transmission-remote \-t1 \-f
  379. .Ed
  380. Download only its second and fourth files:
  381. .Bd -literal -offset indent
  382. $ transmission-remote \-t1 \-Gall \-g2,4
  383. .Ed
  384. Set all torrents' first two files' priorities to high:
  385. .Bd -literal -offset indent
  386. $ transmission-remote \-tall \-ph1,2
  387. .Ed
  388. Set all torrents' files' priorities to normal:
  389. .Bd -literal -offset indent
  390. $ transmission-remote \-tall \-pnall
  391. .Ed
  392. .Sh ENVIRONMENT
  393. .Bl -tag -width Fl
  394. .It Ev http_proxy
  395. Sets the proxy to use for http tracker announces.
  396. .El
  397. .Sh AUTHORS
  398. .An -nosplit
  399. .An Charles Kerr ,
  400. .An Josh Elsasser ,
  401. .An Eric Petit ,
  402. .An Mitchell Livingston ,
  403. and
  404. .An Mike Gelfand .
  405. .Sh SEE ALSO
  406. .Xr transmission-create 1 ,
  407. .Xr transmission-daemon 1 ,
  408. .Xr transmission-edit 1 ,
  409. .Xr transmission-gtk 1 ,
  410. .Xr transmission-qt 1 ,
  411. .Xr transmission-remote 1 ,
  412. .Xr transmission-show 1
  413. .Pp
  414. https://transmissionbt.com/