=encoding utf8

=head1 NAME

transmission-remote-cli - Transmission remote client

=head1 SYNOPSIS

transmission-remote-cli [--options] [commands]

=head1 DESCRIPTION

A console client for the BitTorrent client.The default configuration file path for it is "~/.config/transmission-remote-cli/setting.cfg" and if you need to change it: "transmission-remote-cli.py -f ~/.trclirc --create-config

=head1 OPTIONS

B<-h   --help>

Displays general help on options.

B<-a   --add>

Add torrent files by filename or URL.

B<-c   --connect=CONNECTION>

Points to server using the pattern [username:password@]host[:port].

B<-f   --config=CONFIGRATION>

Path to configration file.

B<-as  --alt-speed>

Use the alternate Limits.

B<-AS  --no-alt-speed>

Don't use the alternate Limits.

B<-asd  --alt-speed-downlimit>

Max alternate download speed (in KB/s)

B<-asu  --al-speed-uplimit>

Max alternate upload speed (in KB/s)

B<-asc  --alt-speed-scheduler>

Use the scheduled on/off times.

B<-ASC  --no-alt-speed-time-begin/end> or B<-ASC  --alt-speed-days>

Time to start/stop the alt speed limits (in hhmm).Numbers for any/all days of the week - eg. "1-7".

B<-ASC  --blocklist-update>

Blocklist update.

B<-c  --incomplete-dir>

Where to store new torrents untill they're complete.

B<-C  --no-incomplete-dir>

Don't store incomplete torrents in a different location.

B<-b  --debug>

Print debugging information.

B<-d  --downlimit>

Set the maximum global download speed in KB/s.

B<-D  --no-downlimit>

Don't limit the global download speed.

B<-er  --encryption-required>

Encrypt all peer connections.

B<-ep  --encryption-preferred>

Prefer encrypted peer connections.

B<-et  --encryption-tolerated>

Prefer unencrypted peer connections.

B<-f   --files>

List the current torrent(s)' files.

B<-g   --get>

Mark files for download.

B<-G   --no-get>

Mark files for not downloading.

B<--info>

Show the current torrent(s)' details.

B<-si  --session-info>

Show the session's details.

B<-st  --session-stats>

Show the session's statistics.

B<-l   --list, --move, --find>

List all torrents, Move current torrent's data to a new folder, Tell Transmission where to find a torrent's data.

B<-m   --portmap>

Enable portmapping via NAT-PMP or UPnP.

B<-M   --no-portmap>

Disable portmapping.

B<-n   --auth                   username:password>

Set authentication info.

B<-N   --netrc>

Set authentication info from a .netrc file.

B<-o   --dht>

Enable distributed hash tables (DHT).

B<-O   --no-dht>

Disable distributed hash tables (DHT).

B<-p   --port>

Port for incoming peers (Default: 51413).

B<-pt  --port-test>

Port testing.

B<-P   --random-port>

Random port for incomping peers.

B<-ph  --priority-high,  -pn  --priority-normal,  -pl  --priority-low>

Set the files' priorities as high, normal, low.

B<-r   --remove>

Remove the current torrent(s).

B<-pr  --peers>

Set the current torrent(s)' maximum number of peers each.

B<-gpr --global-peers,  --remove-and-delete>

Set the global maximum number of peers, Remove the current torrent(s) and delete local data.

B<-sr  --seedratio>

Let the current torrent(s) seed until a specific ratio.

B<-srd --seedratio-default>

Let the current torrent(s) use the global seedratio settings.

B<-SR  --no-seedratio>

Let the current torrent(s) seed regardless of ratio.

B<-gsr --global-seedratio>

All torrents, unless overridden by a per-torrent setting, should seed until a specific ratio.

B<-GSR --no-global-seedratio>

All torrents, unless overridden by a per-torrent setting, should seed regardless of ratio.

B<-s   --start>

Start the current torrent(s).

B<-S   --stop>

Stop the current torrent(s).

B<-t   --torrent>

Set the current torrent(s).

B<-td  --torrent-downlimit>

Set the maximum download speed for the current torrent(s) in KB/s.

B<-TD  --no-torrent-downlimit>

Don't limit the download speed for the current torrent(s).

B<-tu  --torrent-uplimit>

Set the maximum upload speed for the current torrent(s) in KB/s.

B<-TU  --no-torrent-uplimit>

Don't limit the upload speed for the current torrent(s).

B<-hl  --honor-session>

Make the current torrent(s) honor the session limits.

B<-HL  --no-honor-session>

Make the current torrent(s) not honor the session limits.

B<-u   --uplimit>

Set the maximum global upload speed in KB/s.

B<-U   --no-uplimit>

Don't limit the global upload speed.

B<-v   --verify>

Verify the current torrent(s).

B<-V   --version>

Show version number and exit.

B<-w   --download-dir>

Set the default download folder.

B<-x   --pex>

Enable peer exchange (PEX).

B<-X   --no-pex>

Disable peer exchange (PEX).

B<-pi  --peer-info>

List the current torrent(s)' peers.

=head1 EXAMPLES

Authentication and host/port can be set via command line with one of these patterns:
$ transmission-remote-cli.py -c homeserver
$ transmission-remote-cli.py -c homeserver:1234
$ transmission-remote-cli.py -c johndoe:secretbirthday@homeserver
$ transmission-remote-cli.py -c johndoe:secretbirthday@homeserver:1234

--create-config

Create configration file CONFIGFILE with default values.

$ transmission-remote-cli.py -c johndoe:secretbirthday@homeserver:1234 --create-config

No configuration file is created automatically, you have to do this somehow. However, if the file exists, it is re-written when trcli exits to remember some settings. This means you shouldn't have trcli running when editing your configuration file.

If you don't like the default configuration file path ~/.config/transmission-remote-cli/settings.cfg, change it:
$ transmission-remote-cli.py -f ~/.trclirc --create-config

Add torrents

If you provide only one command line argument and it dosen't start with'-', it's treated like a torrent file/URl and submitted to the daemon via transmission-remote.This is useful because you can instruct Firefox to open torrents files with transmission-remote-cli.

transmission-remote-cli.py http://link/to/file.torrent
transmission-remote-cli.py path/to/some/torrent-file

Calling transmission-remote

transmission-remote-cli forwards all arguments after '--' to transmission-remote. This is useful if your daemon requires authentication and/or doesn't listen on the default localhost:9091 for instructions. transmission-remote-cli reads HOST:PORT and authentication from the config file and forwards them on to transmission-remote, along with your arguments.

$ transmission-remote-cli.py -- -l
$ transmission-remote-cli.py -- -t 2 -i
$ transmission-remote-cli.py -- -as

=head1 AUTHOR

Harsh Verma (yevlempy@gmail.com) wrote the man page for Fedora Project

=head1 FILES

/etc/sysconfig/transmission-daemon

=head1 SEE ALSO

L<transmissioncli(1)>,
L<transmission-daemon(1)>,
L<transmission-remote(1)>
L</etc/sysconfig/transmission-daemon>
L<http://www.transmissionbt.com/>
L<http://github.com/fagga/transmission-remote-cli>

=head1 CONTACT

Feel free to request new features or provide bug report.You can contact Benjamin (fagga@gmx.de)

