Go to file
Charles Kerr 9fc0e4ff61
fix: disable-deprecated by default for end users (#5289)
deprecations can be turned on manually and are auto-enabled in CI
2023-03-24 13:34:30 -05:00
.github fix: 4.0.2 wishlist CPU perf regression pt. 1 (#5266) 2023-03-20 21:08:16 -05:00
.tx Sync translations (#3968) 2022-10-15 21:21:13 +03:00
Transmission.xcodeproj fix: crash when magnet dn isn't utf-8 (#5244) 2023-03-19 10:36:16 -05:00
cli docs: remove empty line in manpage (#5225) 2023-03-14 15:45:13 -05:00
cmake Fix libdeflate find module never finding anything (#4968) 2023-02-20 21:09:24 +00:00
daemon fix: make "unexpected argument" error message easier to read (#5029) 2023-02-24 15:47:51 -06:00
dist/msi Build additional packages for Qt 5 on Appveyor (#4855) 2023-02-12 22:12:09 +00:00
docs docs: add units to immutable properties in RPC doc (#5278) 2023-03-23 15:34:16 -05:00
extras fix: some typos (#3904) 2022-10-13 09:35:10 -05:00
gtk fix: disable-deprecated by default for end users (#5289) 2023-03-24 13:34:30 -05:00
libtransmission Use locale-dependent decimal separators for user-visible numbers (#5288) 2023-03-23 19:48:45 -05:00
licenses refactor: aggregate arc4 into libtransmission (#3684) 2022-08-20 13:41:40 -05:00
macosx fix: crash on launch from tapping on a notification (#5280) 2023-03-24 08:04:30 -05:00
news docs: add 4.0.2 release notes (#5230) 2023-03-15 12:13:55 -05:00
po chore: sync translations (#5182) 2023-03-08 23:29:22 -06:00
qt fix: wrong tier value in torrent get tracker stat response (#5274) 2023-03-21 20:23:08 -05:00
release/windows Build additional packages for Qt 5 on Appveyor (#4855) 2023-02-12 22:12:09 +00:00
tests perf: fix wishlist cpu load regression, pt. 2 (#5273) 2023-03-22 10:24:10 -05:00
third-party Bump bundled libutp to rollback anonymous unions fix (#4877) 2023-02-18 02:59:15 +00:00
utils fix: 'downloaded' field (#5265) 2023-03-20 16:42:32 -05:00
web chore: update generated transmission-web files (#5254) 2023-03-21 17:36:07 -05:00
.clang-format Switch to clang-format for code formatting, include Mac client 2021-08-16 00:38:29 +03:00
.clang-format-ignore Move jsonsl and wildmat to third-party (#4402) 2022-12-18 19:19:07 +00:00
.clang-format-include Adopting .clang-format-include and .clang-format-ignore (#3047) 2022-05-13 18:48:33 -05:00
.gitignore Fix WebUtilsTest.urlParse and psl_builtin for Xcode (#4642) 2023-01-31 23:51:04 -06:00
.gitmodules build: bump libdeflate snapshot to 1.17 (#4596) 2023-01-15 09:55:16 -06:00
AUTHORS fix: some typos (#3904) 2022-10-13 09:35:10 -05:00
CMakeLists.txt fix: disable-deprecated by default for end users (#5289) 2023-03-24 13:34:30 -05:00
CONTRIBUTING.md docs: fix various typos and misspellings (#2955) 2022-04-21 09:28:38 -05:00
COPYING chore: update copyrights to 2023 (#4834) 2023-02-11 14:49:42 -06:00
README.md docs: improve build instructions (#4980) 2023-03-06 12:11:13 -06:00
appveyor.yml Build additional packages for Qt 5 on Appveyor (#4855) 2023-02-12 22:12:09 +00:00
code_style.sh build: minor ci cleanup (#4652) 2023-01-24 01:02:48 -06:00
icon.png Adding icon.png for Sourcetree (#3250) 2022-06-10 12:34:46 -05:00
update-version-h.sh build: support semver versioning (#3867) 2022-10-05 16:53:10 -05:00

README.md

About

Transmission is a fast, easy, and free BitTorrent client. It comes in several flavors:

  • A native macOS GUI application
  • GTK+ and Qt GUI applications for Linux, BSD, etc.
  • A Qt-based Windows-compatible GUI application
  • A headless daemon for servers and routers
  • A web UI for remote controlling any of the above

Visit https://transmissionbt.com/ for more information.

Documentation

Transmission's documentation is currently out-of-date, but the team has recently begun a new project to update it and is looking for volunteers. If you're interested, please feel free to submit pull requests!

Command line interface notes

Transmission is fully supported in transmission-remote, the preferred cli client.

Three standalone tools to examine, create, and edit .torrent files exist: transmission-show, transmission-create, and transmission-edit, respectively.

Prior to development of transmission-remote, the standalone client transmission-cli was created. Limited to a single torrent at a time, transmission-cli is deprecated and exists primarily to support older hardware dependent upon it. In almost all instances, transmission-remote should be used instead.

Different distributions may choose to package any or all of these tools in one or more separate packages.

Building

Transmission has an Xcode project file (Transmission.xcodeproj) for building in Xcode.

For a more detailed description, and dependencies, visit How to Build Transmission in docs

Building a Transmission release from the command line

$ tar xf transmission-3.00.tar.xz
$ cd transmission-3.00
$ mkdir build
$ cd build
# Use -DCMAKE_BUILD_TYPE=RelWithDebInfo to build optimzed binary with debug information. (preferred)
# Use -DCMAKE_BUILD_TYPE=Release to build full optimized binary.
$ cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo ..
$ make
$ sudo make install

Building Transmission from the nightly builds

Download a tarball from https://build.transmissionbt.com/job/trunk-linux/ and follow the steps from the previous section.

If you're new to building programs from source code, this is typically easier than building from Git.

Building Transmission from Git (first time)

$ git clone https://github.com/transmission/transmission Transmission
$ cd Transmission
$ git submodule update --init --recursive
$ mkdir build
$ cd build
# Use -DCMAKE_BUILD_TYPE=RelWithDebInfo to build optimzed binary with debug information. (preferred)
# Use -DCMAKE_BUILD_TYPE=Release to build full optimized binary.
$ cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo ..
$ make
$ sudo make install

Building Transmission from Git (updating)

$ cd Transmission/build
$ make clean
$ git submodule foreach --recursive git clean -xfd
$ git pull --rebase --prune
$ git submodule update --recursive
# Use -DCMAKE_BUILD_TYPE=RelWithDebInfo to build optimzed binary with debug information. (preferred)
# Use -DCMAKE_BUILD_TYPE=Release to build full optimized binary.
$ cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo ..
$ make
$ sudo make install

Contributing

Code Style

You would want to setup your editor to make use of the .clang-format file located in the root of this repository and the eslint/prettier rules in web/package.json.

If for some reason you are unwilling or unable to do so, there is a shell script which you can use: ./code_style.sh

Translations

See language translations.

Sponsors

[MacStadium] macOS CI builds are running on a M1 Mac Mini provided by MacStadium
[SignPath] Free code signing on Windows provided by SignPath.io, certificate by SignPath Foundation