source: trunk/daemon/transmission-remote.1 @ 10635

Last change on this file since 10635 was 10635, checked in by charles, 12 years ago

(trunk) #3060 "Local Peer Discovery" -- in the code, rename LDS as LPD for Local Peer Discovery

  • Property svn:keywords set to Date Rev Author Id
File size: 9.8 KB
1.Dd July 21, 2008
5.Nm transmission-remote
6.Nd a remote control utility for
7.Xr transmission-daemon 1
9.Xr transmission 1
11.Bk -words
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 er | ep | et
25.Op Fl f
26.Op Fl g Ar files
27.Op Fl G Ar files
28.Op Fl gsr Ar ratio
29.Op Fl GSR
30.Op Fl h
31.Op Fl i
32.Op Fl l
33.Op Fl m | M
34.Op Fl n Ar user:pass
35.Op Fl N Ar netrc
36.Op Fl o | O
37.Op Fl p Ar port
38.Op Fl ph Ar files
39.Op Fl pl Ar files
40.Op Fl pn Ar files
41.Op Fl pr Ar peers
42.Op Fl r
43.Op Fl R
44.Op Fl s | S
45.Op Fl sr Ar ratio
46.Op Fl SR
47.Op Fl srd
48.Op Fl si
49.Op Fl st
50.Op Fl t Ar all | Ar id | Ar hash
51.Op Fl hl
52.Op Fl HL
53.Op Fl u Ar number | Fl U
54.Op Fl v
55.Op Fl V
56.Op Fl w Ar download-dir
57.Op Fl x | X
58.Op Fl z | Z
59.Op Fl pi
63is a remote control utility for
64.Xr transmission 1
66.Xr transmission-daemon 1 .
68By default,
70connects to the transmission session at localhost:9091.
71Other sessions can be controlled by specifying a different host and/or port.
73.Bl -tag -width Ds
74.It Fl a Fl -add Ar filenames-or-URLs
75Add torrents to transmission.
76.It Fl b Fl -debug
77Enable debugging mode.
78.It Fl as Fl -alt-speed
79Use the alternate Limits.
80.It Fl AS Fl -no-alt-speed
81Don't use the alternate Limits.
82.It Fl asd Fl -alt-speed-downlimit Ar limit
83Limit the alternate download speed to
84.Ar limit
85kilobytes per second.
86.It Fl asu Fl -alt-speed-uplimit Ar limit
87Limit the alternate upload speed to
88.Ar limit
89kilobytes per second.
90.It Fl asc Fl -alt-speed-scheduler
91Use the scheduled on/off times.
92.It Fl ASC Fl -no-alt-speed-scheduler
93Don't use the scheduled on/off days and times.
94.It Fl -alt-speed-time-begin Ar time
95.Ar Time
96to start using the alt speed limits (in hhmm).
97.It Fl -alt-speed-time-end Ar time
98.Ar Time
99to stop using the alt speed limits (in hhmm).
100.It Fl -alt-speed-days Ar days
101Set the number of
102.Ar days
103on which to enable the speed scheduler, using a list such as "2,4-6".
104.It Fl c Fl -incomplete-dir Ar dir
105When adding new torrents, store their contents in
106.Ar directory
107until the torrent is done.
108.It Fl C Fl -no-incomplete-dir
109Don't store incomplete torrents in a different directory.
110.It Fl d Fl -downlimit Ar limit
111Limit the maximum download speed to
112.Ar limit
114If current torrent(s) are selected this operates on them.  Otherwise, it changes the global setting.
115.It Fl D Fl -no-downlimit
116Disable download speed limits.
117If current torrent(s) are selected this operates on them.  Otherwise, it changes the global setting.
118.It Fl er Fl -encryption-required
119Encrypt all peer connections.
120.It Fl ep Fl -encryption-preferred
121Prefer encrypted peer connections.
122.It Fl et Fl -encryption-tolerated
123Prefer unencrypted peer connections.
124.It Fl f Fl -files
125Get a file list for the current torrent(s)
126.It Fl g Fl -get Ar all | file-index | files
127Mark file(s) for download.
128.Ar all
129marks all all of the torrent's files for downloading,
130.Ar file-index
131adds a single file to the download list, and
132.Ar files
133adds multiple files to the download list,
134such as "\-g1,3-5" to add files #1, #3, #4, and #5 to the download list.
135.It Fl G Fl -no-get Ar all | file-index | files
136Mark file(s) for not downloading.
137.It Fl gsr Fl -global-seedratio Ar ratio
138All torrents, unless overridden by a per-torrent setting, should seed until a specific
139.Ar ratio
140.It Fl GSR Fl -no-global-seedratio
141All torrents, unless overridden by a per-torrent setting, should seed regardless of ratio
142.It Fl h Fl -help
143Print command-line option descriptions.
144.It Fl i Fl -info Ar id | torrent-hash
145Show details of the current torrent(s)
146.It Fl si Fl -session-info
147List session information from the server
148.It Fl st Fl -session-stats
149List statistical information from the server
150.It Fl l Fl -list
151List all torrents
152.It Fl m Fl -portmap
153Enable portmapping via NAT-PMP or UPnP
154.It Fl M Fl -no-portmap
155Disable portmapping
156.It Fl n Fl -auth Ar username:password
157Set the
158.Ar username
160.Ar password
161for authentication
162.It Fl N Fl -netrc Ar filename
163Set the authentication information from a
164.Ar netrc file.
165See netrc(5) for more information.
166.It Fl o Fl -dht
167Enable distributed hash table (DHT).
168.It Fl O Fl -no-dht
169Disable distribued hash table (DHT).
170.It Fl p Fl -port Ar port
171Set the
172.Ar port
173for use when listening for incoming peer connections
174.It Fl pn Fl -priority-normal Ar all | file-index | files
175Mark file(s) as normal priority.
176.Ar all
177marks all of the torrent's files as normal priority,
178.Ar file-index
179sets a single file's priority as normal, and
180.Ar files
181sets multiple files' priorities as normal,
182such as "\-pn1,3-5" to normalize files #1, #3, #4, and #5.
183.It Fl ph Fl -priority-high Ar all | file-index | files
184Mark file(s) as high priority.
185.It Fl pl Fl -priority-low Ar all | file-index | files
186Mark file(s) as low priority.
187.It Fl pr Fl -peers Ar number
188Set the maximum number of peers.
189If current torrent(s) are selected this operates on them.  Otherwise, it changes the global setting.
190.It Fl r Fl -remove
191Remove the current torrent(s).  This does not delete the downloaded data.
192.It Fl -remove-and-delete
193Remove the current torrent(s) and delete their downloaded data.
194.It Fl -move
195Move the current torrents' data from their current locations to the specified directory.
196.It Fl -find
197Tell Transmission where to look for the current torrents' data.
198.It Fl sr Fl -seedratio Ar ratio
199Let the current torrent(s) seed until a specific
200.Ar ratio
201.It Fl SR Fl -no-seedratio
202Let the current torrent(s) seed regardless of ratio
203.It Fl srd Fl -seedratio-default
204Let the current torrent(s) use the global seedratio settings
205.It Fl s Fl -start
206Start the current torrent(s)
207.It Fl S Fl -stop
208Stop the current torrent(s) from downloading or seeding
209.It Fl -start-paused
210Start added torrents paused
211.It fl -no-start-paused
212Start added torrents unpaused
213.It Fl t Fl -torrent Ar all | id | torrent-hash
214Set the current torrent(s) for use by subsequent options.
215.Ar all
216will apply following requests to all torrents, while specific torrents can be chosen by
217.Ar id
219.Ar hash .
220To set more than one current torrent, join their ids together in a list, such as
221"\-t2,4,6-8" to operate on the torrents whose IDs are 2, 4, 6, 7, and 8.
222.It Fl -trash-torrent
223Delete torrents after adding
224.It Fl -no-trash-torrent
225Do not delete torrents after adding
226.It Fl hl Fl -honor-session
227Make the current torrent(s) honor the session limits.
228.It Fl HL Fl -no-honor-session
229Make the current torrent(s) not honor the session limits.
230.It Fl u Fl -uplimit Ar limit
231Limit the maximum upload speed to
232.Ar limit
234If current torrent(s) are selected this operates on them.  Otherwise, it changes the global setting.
235.It Fl U Fl -no-uplimit
236Disable upload speed limits.
237If current torrent(s) are selected this operates on them.  Otherwise, it changes the global setting.
238.It Fl v Fl -verify
239Verify the current torrent(s)
240.It Fl V Fl -version
241Show version number and exit
242.It Fl w Fl -download-dir Ar directory
244.Ar directory
245as the default location for newly added torrents to download files to.
246.It Fl x Fl -pex
247Enable peer exchange (PEX).
248.It Fl X Fl -no-pex
249Disable peer exchange (PEX).
250.It Fl z Fl -lds
251Enable local peer discovery (LPD).
252.It Fl Z Fl -no-lds
253Disable local peer discovery (LPD).
254.It Fl pi Fl -peer-info
255List the current torrent's connected peers.
256In the `status' section of the list, the following shorthand is used:
257.D1 D: Downloading from this peer
258.D1 d: We would download from this peer if they would let us
259.D1 E: Encrypted connection
260.D1 I: Peer is an incoming connection
261.D1 K: Peer has unchoked us, but we're not interested
262.D1 O: Optimistic unchoked
263.D1 U: Uploading to peer
264.D1 u: We would upload to this peer if they asked
265.D1 X: Peer was discovered through Peer Exchange (PEX)
266.D1 ?: We unchoked this peer, but they're not interested
269Set download and upload limits to 400 KiB/sec and 60 KiB/sec:
270.Bd -literal -offset indent
271$ transmission-remote \-d400 \-u60
272$ transmission-remote \-\-downlimit=400 \-\-uplimit=60
274Set alternate download and upload limits to 100 KiB/sec and 20 KiB/sec:
275.Bd -literal -offset indent
276$ transmission-remote \-asd100 \-asu20
277$ transmission-remote \-\-alt-speed-downlimit=100 \-\-alt-speed-uplimit=20
279Set the scheduler to use the alternate speed limits on weekdays between 10AM and 11PM
280.Bd -literal -offset indent
281$ transmission-remote \-\-alt-speed-time-begin=1000
282$ transmission-remote \-\-alt-speed-time-end=2300
283$ transmission-remote \-\-alt-speed-days=1-5
284$ transmission-remote \-\-alt-speed-scheduler
286List all torrents' IDs and states:
287.Bd -literal -offset indent
288$ transmission-remote \-l
290List all torrents from a remote session that requires authentication:
291.Bd -literal -offset indent
292$ transmission-remote host:9091 \-\-auth=username:password \-l
294Start all torrents:
295.Bd -literal -offset indent
296$ transmission-remote \-tall \-\-start
298Add two torrents:
299.Bd -literal -offset indent
300$ transmission-remote \-a one.torrent two.torrent
302Add all torrents in ~/Desktop:
303.Bd -literal -offset indent
304$ transmission-remote \-a ~/Desktop/*torrent
306Get detailed information on the torrent whose ID is '1':
307.Bd -literal -offset indent
308$ transmission-remote \-t1 \-i
310Get a list of a torrent's files:
311.Bd -literal -offset indent
312$ transmission-remote \-t1 \-f
314Download only its second and fourth files:
315.Bd -literal -offset indent
316$ transmission-remote \-t1 \-Gall \-g2,4
318Set all torrents' first two files' priorities to high:
319.Bd -literal -offset indent
320$ transmission-remote \-tall \-ph1,2
322Set all torrents' files' priorities to normal:
323.Bd -literal -offset indent
324$ transmission-remote \-tall \-pnall
327.An -nosplit
328.An Charles Kerr ,
329.An Josh Elsasser ,
330.An Eric Petit ,
332.An Mitchell Livingston .
334.Xr transmissioncli 1 ,
335.Xr transmission-daemon 1 ,
336.Xr transmission 1
Note: See TracBrowser for help on using the repository browser.