Ignore:
Timestamp:
Jul 21, 2008, 4:11:47 PM (14 years ago)
Author:
charles
Message:

add more rpc unit tests. man page cleanups.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/daemon/transmission-remote.1

    r6324 r6376  
    1 .Dd May 20, 2008
     1.Dd July 21, 2008
    22.Dt TRANSMISSION-REMOTE 1
    33.Os
     
    1414.Op Fl a Ar torrent-files
    1515.Op Fl b
    16 .Op Fl d Ar number
    17 .Op Fl D
    18 .Op Fl er
    19 .Op Fl ep
    20 .Op Fl et
     16.Op Fl d Ar number | Fl D
     17.Op Fl er | ep | et
    2118.Op Fl f
    2219.Op Fl g Ar files
     
    2522.Op Fl i
    2623.Op Fl l
    27 .Op Fl m
    28 .Op Fl M
     24.Op Fl m | M
    2925.Op Fl n Ar user:pass
    3026.Op Fl p Ar port
     
    3329.Op Fl pn Ar files
    3430.Op Fl r
    35 .Op Fl s
    36 .Op Fl S
     31.Op Fl s | S
    3732.Op Fl t Ar all | Ar id | Ar hash
    38 .Op Fl u Ar number
    39 .Op Fl U
     33.Op Fl u Ar number | Fl U
    4034.Op Fl v
    4135.Op Fl w Ar download-dir
    42 .Op Fl x
    43 .Op Fl X
     36.Op Fl x | X
    4437.Ek
    4538.Sh DESCRIPTION
     
    5447connects to the transmission session at localhost:9091.
    5548Other sessions can be controlled by specifying a different host and/or port.
    56 .Pp
    57 The options are as follows:
     49
     50.Sh OPTIONS
    5851.Bl -tag -width Ds
    59 .It Fl a Fl -add Ar torrent-file
    60 Add metainfo
    61 .Ar torrent-file(s) .
     52.It Fl a Fl -add Ar torrent-file(s)
     53Add
     54.Ar torrent-file(s)
     55into transmission.
    6256
    6357.It Fl b Fl -debug
     
    8276Get a file list for the current torrent(s)
    8377
    84 .It Fl g Fl -get Ar files
     78.It Fl g Fl -get Ar all | file-index | files
    8579Mark file(s) for download.
     80.Ar all
     81marks all all of the torrent's files for downloading,
     82.Ar file-index
     83adds a single file to the download list, and
    8684.Ar files
    87 can be a file index, or a comma-separated list of file indices, or the literal
    88 .Ar all
    89 for all files in the torrent.
    90 
    91 .It Fl g Fl -no-get Ar files
    92 Mark file(s) for not downloading
     85adds multiple files to the download list,
     86such as "-g1,3-5" to add files #1, #3, #4, and #5 to the download list.
     87
     88.It Fl G Fl -no-get Ar all | file-index | files
     89Mark file(s) for not downloading.
    9390
    9491.It Fl h Fl -help
     
    118115for use when listening for incoming peer connections
    119116
    120 .It Fl ph Fl -priority-high Ar files
    121 Mark
     117.It Fl pn Fl -priority-normal Ar all | file-index | files
     118Mark file(s) as normal priority.
     119.Ar all
     120marks all of the torrent's files as normal priority,
     121.Ar file-index
     122sets a single file's priority as normal, and
    122123.Ar files
    123 as high priority.
    124 .Ar files
    125 can be a file index, or a comma-separated list of file indices, or the literal
    126 .Ar all
    127 for all files in the torrent.
    128 
    129 .It Fl pl Fl -priority-low Ar files
    130 Mark
    131 .Ar files
    132 as low priority
    133 
    134 .It Fl pn Fl -priority-normal Ar files
    135 Mark
    136 .Ar files
    137 as normal priority
     124sets multiple files' priorities as normal,
     125such as "-pn1,3-5" to normalize files #1, #3, #4, and #5.
     126
     127.It Fl ph Fl -priority-high Ar all | file-index | files
     128Mark file(s) as high priority.
     129
     130.It Fl pl Fl -priority-low Ar all | file-index | files
     131Mark file(s) as low priority.
    138132
    139133.It Fl r Fl -remove
     
    153147or
    154148.Ar hash .
    155 To set more than one current torrent, joined their ids or hashes together in a comma-delimited list,
    156 such as "-t1,2,3"
     149To set more than one current torrent, join their ids or hashes together in a list,
     150such as "-t2,4,6-8" to operate on the torrents whose IDs are 2, 4, 6, 7, and 8.
    157151
    158152.It Fl u Fl -uplimit Ar limit
     
    179173.Sh EXAMPLES
    180174
    181 List all torrents' IDs and states:
    182 .Bd -literal -offset indent
    183 $ transmission-remote -l
    184 .Ed
    185 
    186 List all torrents from a remote session that requires authentication:
    187 .Bd -literal -offset indent
    188 $ transmission-remote host:9091 --auth=username:password -l
    189 .Ed
    190 
    191 Start all torrents:
    192 .Bd -literal -offset indent
    193 $ transmission-remote -tall --start
    194 .Ed
    195 
    196 Add two torrents:
    197 .Bd -literal -offset indent
    198 $ transmission-remote -a one.torrent two.torrent
    199 .Ed
    200 
    201 Add all torrents in ~/Desktop:
    202 .Bd -literal -offset indent
    203 $ transmission-remote -a ~/Desktop/*torrent
    204 .Ed
    205 
    206 Get detailed information on the torrent whose ID is '1':
    207 .Bd -literal -offset indent
    208 $ transmission-remote -t1 -i"
    209 .Ed
    210 
    211 Download only its second and fourth files:
    212 .Bd -literal -offset indent
    213 $ transmission-remote -t1 -Gall -g2,4"
    214 .Ed
    215 
    216 Set all torrents' first two files' priorities to high:
    217 .Bd -literal -offset indent
    218 $ transmission-remote -tall -ph1,2"
    219 .Ed
    220 
    221 Set all torrents' files' priorities to normal:
    222 .Bd -literal -offset indent
    223 $ transmission-remote -tall -pnall"
    224 .Ed
    225 
    226175Set download and upload limits to 100 KiB/sec and 20 KiB/sec:
    227176.Bd -literal -offset indent
    228177$ transmission-remote -d100 -u20
    229178$ transmission-remote --downlimit=100 --uplimit=20
    230 .Bd -literal -offset indent
     179.Ed
     180
     181List all torrents' IDs and states:
     182.Bd -literal -offset indent
     183$ transmission-remote -l
     184.Ed
     185
     186List all torrents from a remote session that requires authentication:
     187.Bd -literal -offset indent
     188$ transmission-remote host:9091 --auth=username:password -l
     189.Ed
     190
     191Start all torrents:
     192.Bd -literal -offset indent
     193$ transmission-remote -tall --start
     194.Ed
     195
     196Add two torrents:
     197.Bd -literal -offset indent
     198$ transmission-remote -a one.torrent two.torrent
     199.Ed
     200
     201Add all torrents in ~/Desktop:
     202.Bd -literal -offset indent
     203$ transmission-remote -a ~/Desktop/*torrent
     204.Ed
     205
     206Get detailed information on the torrent whose ID is '1':
     207.Bd -literal -offset indent
     208$ transmission-remote -t1 -i"
     209.Ed
     210
     211Get a list of a torrent's files:
     212.Bd -literal -offset indent
     213$ transmission-remote -t1 -l"
     214.Ed
     215
     216Download only its second and fourth files:
     217.Bd -literal -offset indent
     218$ transmission-remote -t1 -Gall -g2,4"
     219.Ed
     220
     221Set all torrents' first two files' priorities to high:
     222.Bd -literal -offset indent
     223$ transmission-remote -tall -ph1,2"
     224.Ed
     225
     226Set all torrents' files' priorities to normal:
     227.Bd -literal -offset indent
     228$ transmission-remote -tall -pnall"
     229.Ed
    231230
    232231.Sh AUTHORS
Note: See TracChangeset for help on using the changeset viewer.