161 lines
4.1 KiB
Groff
161 lines
4.1 KiB
Groff
.\"
|
|
.\" This file Copyright © Deanna Phillips <deanna@sdf.lonestar.org>
|
|
.\"
|
|
.\" Permission to use, copy, modify, and distribute this software for any
|
|
.\" purpose with or without fee is hereby granted, provided that the above
|
|
.\" copyright notice and this permission notice appear in all copies.
|
|
.\"
|
|
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
.\"
|
|
.Dd July 21, 2008
|
|
.Dt TRANSMISSION-CLI 1
|
|
.Os
|
|
.Sh NAME
|
|
.Nm transmission-cli
|
|
.Nd a bittorrent client
|
|
.Sh SYNOPSIS
|
|
.Nm transmission-cli
|
|
.Bk -words
|
|
.Fl h
|
|
.Nm
|
|
.Op Fl b | B
|
|
.Op Fl d Ar number | Fl D
|
|
.Op Fl er | ep | et
|
|
.Op Fl f Ar script
|
|
.Op Fl g Ar directory
|
|
.Op Fl h
|
|
.Op Fl m | M
|
|
.Op Fl p Ar port
|
|
.Op Fl -tos Ar tos
|
|
.Op Fl u Ar number | Fl U
|
|
.Op Fl v
|
|
.Op Fl w Ar directory
|
|
.Ar torrent-file
|
|
.Ek
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Nm
|
|
program is a lightweight, command-line BitTorrent client with
|
|
scripting capabilities.
|
|
.Pp
|
|
The options are as follows:
|
|
.Bl -tag -width Ds
|
|
.It Fl b Fl -blocklist
|
|
Enable peer blocklists. Transmission understands the bluetack blocklist file format.
|
|
New blocklists can be added by copying them into the config-dir's "blocklists" subdirectory.
|
|
.It Fl B Fl -no-blocklist
|
|
Disable blocklists.
|
|
.It Fl d -downlimit Ar number
|
|
Set the maximum download speed in KB/s
|
|
.It Fl D -no-downlimit
|
|
Don't limit the download speed
|
|
.It Fl er Fl -encryption-required
|
|
Encrypt all peer connections.
|
|
.It Fl ep Fl -encryption-preferred
|
|
Prefer encrypted peer connections.
|
|
.It Fl et Fl -encryption-tolerated
|
|
Prefer unencrypted peer connections.
|
|
.It Fl f -finish Ar script
|
|
Set a script to run when the torrent finishes
|
|
.It Fl g Fl -config-dir Ar directory
|
|
Where to look for configuration files. This can be used to swap between using the cli, daemon, gtk, and qt clients.
|
|
See https://github.com/transmission/transmission/blob/main/docs/Configuration-Files.md for more information.
|
|
.It Fl h Fl -help
|
|
Prints a short usage summary.
|
|
.It Fl m Fl -portmap
|
|
Enable portmapping via NAT-PMP or UPnP
|
|
.It Fl M Fl -no-portmap
|
|
Disable portmapping
|
|
.It Fl p -port Ar port
|
|
Set the port to listen for incoming peers. (Default: 51413)
|
|
.It Fl -tos Ar tos
|
|
.nf
|
|
Use a ToS or DSCP name to set the peer socket service type for
|
|
local router-based traffic shaping. Valid values are a decimal
|
|
value 0-255, or any of these DSCP strings:
|
|
.fi
|
|
.Pp
|
|
.Dq af11 ,
|
|
.Dq af12 ,
|
|
.Dq af13 ,
|
|
.Dq af21 ,
|
|
.Dq af22 ,
|
|
.Dq af23 ,
|
|
.Dq af31 ,
|
|
.Dq af32 ,
|
|
.Dq af33 ,
|
|
.Dq af41 ,
|
|
.Dq af42 ,
|
|
.Dq af43 ,
|
|
.Dq cs0 ,
|
|
.Dq cs1 ,
|
|
.Dq cs2 ,
|
|
.Dq cs3 ,
|
|
.Dq cs4 ,
|
|
.Dq cs5 ,
|
|
.Dq cs6 ,
|
|
.Dq cs7 ,
|
|
.Dq ef ,
|
|
.Dq le
|
|
These ToS keys are deprecated and will be removed in the future:
|
|
.Dq default ,
|
|
.Dq lowcost ,
|
|
.Dq lowdelay,
|
|
.Dq reliability ,
|
|
.Dq throughput
|
|
.Pp
|
|
.It Fl u -uplimit Ar number
|
|
Set the maximum upload speed in KB/s
|
|
.It Fl U -no-uplimit
|
|
Don't limit the upload speed
|
|
.It Fl v Fl -verify
|
|
Verify the torrent's downloaded data.
|
|
.It Fl w Fl -download-dir Ar directory
|
|
Where to save downloaded data.
|
|
.El
|
|
.Sh SIGNALS
|
|
In addition to these options, sending
|
|
.Nm
|
|
a SIGHUP signal will contact the tracker for more peers.
|
|
.Sh ENVIRONMENT
|
|
.Bl -tag -width Fl
|
|
.It Ev TRANSMISSION_HOME
|
|
Sets the default config-dir.
|
|
.It Ev http_proxy
|
|
libcurl uses this environment variable when performing tracker announces.
|
|
.El
|
|
.Sh FILES
|
|
.Bl -tag -width Ds -compact
|
|
.It ~/.config/transmission
|
|
Directory where
|
|
.Nm
|
|
keeps torrent information for future seeding and resume operations.
|
|
.El
|
|
.Sh AUTHORS
|
|
The
|
|
.Nm
|
|
program was written by
|
|
.An -nosplit
|
|
.An Eric Petit ,
|
|
.An Josh Elsasser ,
|
|
.An Charles Kerr ,
|
|
.An Mitchell Livingston ,
|
|
and
|
|
.An Mike Gelfand .
|
|
.Sh SEE ALSO
|
|
.Xr transmission-create 1 ,
|
|
.Xr transmission-daemon 1 ,
|
|
.Xr transmission-edit 1 ,
|
|
.Xr transmission-gtk 1 ,
|
|
.Xr transmission-qt 1 ,
|
|
.Xr transmission-remote 1 ,
|
|
.Xr transmission-show 1
|
|
.Pp
|
|
https://transmissionbt.com/
|