Go to file
FX Coudert 9cadcbdb86
ci: update workflow to Qt 6 on macOS (#6206)
* Remove brew lines on Linux

* Switch to Qt 6 on macOS
2023-11-04 14:17:45 -05:00
.github ci: update workflow to Qt 6 on macOS (#6206) 2023-11-04 14:17:45 -05:00
.tx Sync translations (#3968) 2022-10-15 21:21:13 +03:00
Transmission.xcodeproj pbxproj refactor (#6184) 2023-11-03 17:38:09 -05:00
cli refactor: remove the tr_error** idiom (#6198) 2023-11-04 11:39:41 -05:00
cmake chore: removed copyright timespans in headers (#4850) 2023-11-01 16:11:11 -05:00
daemon refactor: remove the tr_error** idiom (#6198) 2023-11-04 11:39:41 -05:00
dist/msi Minor CMake maintainability improvements (#6186) 2023-10-30 20:44:34 +03:00
docs docs: link to open source reverse proxy guide on securing transmission (#5867) 2023-11-03 19:04:15 -05:00
extras fix: some typos (#3904) 2022-10-13 09:35:10 -05:00
gtk refactor: remove the tr_error** idiom (#6198) 2023-11-04 11:39:41 -05:00
libtransmission ci: bump macos-11 to macos-12 in github actions (#6203) 2023-11-04 12:33:25 -05:00
licenses refactor: aggregate arc4 into libtransmission (#3684) 2022-08-20 13:41:40 -05:00
macosx refactor: remove the tr_error** idiom (#6198) 2023-11-04 11:39:41 -05:00
news docs: update release notes for 4.0.4 (#5924) 2023-08-23 15:16:27 -05:00
po Sync translations (#5391) 2023-04-14 03:00:44 +01:00
qt fix: only append '.added' suffix to watchdir files (#5705) 2023-11-04 13:14:08 -05:00
release/windows Bump 3rd-party deps versions used on Windows (#6192) 2023-11-01 15:09:45 +03:00
tests refactor: remove the tr_error** idiom (#6198) 2023-11-04 11:39:41 -05:00
third-party Minor CMake maintainability improvements (#6186) 2023-10-30 20:44:34 +03:00
utils refactor: remove the tr_error** idiom (#6198) 2023-11-04 11:39:41 -05:00
web chore: update generated transmission-web files (#6200) 2023-11-03 11:29:36 -05:00
.clang-format Use clang-format for qualifier alignment (#5845) 2023-07-30 16:43:43 +01: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 Minor CMake maintainability improvements (#6186) 2023-10-30 20:44:34 +03:00
AUTHORS docs: add tearfur to AUTHORS (#5859) 2023-08-14 13:52:43 -05:00
CMakeLists.txt Minor CMake maintainability improvements (#6186) 2023-10-30 20:44:34 +03: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 chore: update build instructions (#6102) 2023-10-23 22:24:51 -04:00
appveyor.yml Build additional packages for Qt 5 on Appveyor (#4855) 2023-02-12 22:12:09 +00:00
code_style.sh Use clang-format for qualifier alignment (#5845) 2023-07-30 16:43:43 +01:00
icon.png chore: improve lossless compression of png files (#5586) 2023-06-05 17:03:11 -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-4.0.4.tar.xz
$ cd transmission-4.0.4
# Use -DCMAKE_BUILD_TYPE=RelWithDebInfo to build optimized binary with debug information. (preferred)
# Use -DCMAKE_BUILD_TYPE=Release to build full optimized binary.
$ cmake -B build -DCMAKE_BUILD_TYPE=RelWithDebInfo
$ cd build
$ cmake --build .
$ sudo cmake --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 --recurse-submodules https://github.com/transmission/transmission Transmission
$ cd Transmission
# Use -DCMAKE_BUILD_TYPE=RelWithDebInfo to build optimized binary with debug information. (preferred)
# Use -DCMAKE_BUILD_TYPE=Release to build full optimized binary.
$ cmake -B build -DCMAKE_BUILD_TYPE=RelWithDebInfo
$ cd build
$ cmake --build .
$ sudo cmake --install .

Building Transmission from Git (updating)

$ cd Transmission/build
$ cmake --build . -t clean
$ git submodule foreach --recursive git clean -xfd
$ git pull --rebase --prune
$ git submodule update --init --recursive
$ cmake --build .
$ sudo cmake --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