Go to file
Charles Kerr df1cca9b57
chore: update copyright years, make notices consistent (#2463)
2022-01-20 12:27:56 -06:00
.tx Add Mac client translations to and downsync from Transifex 2017-01-28 13:44:15 +03:00
Transmission.xcodeproj refactor: use libdeflate instead of zlib's deflate() (#2405) 2022-01-17 10:20:12 -06:00
cli chore: update copyright years, make notices consistent (#2463) 2022-01-20 12:27:56 -06:00
cmake refactor: use libdeflate instead of zlib's deflate() (#2405) 2022-01-17 10:20:12 -06:00
daemon chore: update copyright years, make notices consistent (#2463) 2022-01-20 12:27:56 -06:00
dist/msi Include SVG support in Windows builds 2021-12-07 08:39:12 +00:00
docker/code_style Switch to clang-format for code formatting, include Mac client 2021-08-16 00:38:29 +03:00
extras Add total disk space to free-space RPC request (#1682) 2021-10-14 12:07:16 -05:00
gtk chore: update copyright years, make notices consistent (#2463) 2022-01-20 12:27:56 -06:00
libtransmission chore: update copyright years, make notices consistent (#2463) 2022-01-20 12:27:56 -06:00
licenses chore: update copyright years, make notices consistent (#2463) 2022-01-20 12:27:56 -06:00
macosx chore: update copyright years, make notices consistent (#2463) 2022-01-20 12:27:56 -06:00
po fix: macOS gui with Russian l10n does not fit lines of text. (Fixes #1963) (#1973) 2021-10-17 13:45:25 -05:00
qt chore: update copyright years, make notices consistent (#2463) 2022-01-20 12:27:56 -06:00
release/windows Include SVG support in Windows builds 2021-12-07 08:39:12 +00:00
tests chore: update copyright years, make notices consistent (#2463) 2022-01-20 12:27:56 -06:00
third-party refactor: use libdeflate instead of zlib's deflate() (#2405) 2022-01-17 10:20:12 -06:00
utils chore: update copyright years, make notices consistent (#2463) 2022-01-20 12:27:56 -06:00
web chore: update copyright years, make notices consistent (#2463) 2022-01-20 12:27:56 -06:00
.clang-format Switch to clang-format for code formatting, include Mac client 2021-08-16 00:38:29 +03:00
.gitignore Add VSCode configs to .gitignore (#2061) 2021-10-29 23:32:41 -05:00
.gitmodules refactor: use libdeflate instead of zlib's deflate() (#2405) 2022-01-17 10:20:12 -06:00
AUTHORS macOS icon redesigned for Big Sur 2021-03-29 18:05:30 -04:00
CMakeLists.txt refactor: use libdeflate instead of zlib's deflate() (#2405) 2022-01-17 10:20:12 -06:00
COPYING Bump copyright to 2020 (some more places) (#1206) 2020-05-02 12:26:42 -05:00
NEWS.md Update NEWS 2021-08-22 19:03:24 -04:00
README.md Add MacStadum and SignPath sponsor links to readme (#2105) 2021-11-06 01:16:51 -05:00
appveyor.yml build: refer to primary branch as main (#2394) 2022-01-13 16:03:59 -06:00
code_style.sh refactor: C++ify clients.cc (#1907) 2021-10-08 21:46:10 -05:00
docker-compose.yml Switch to clang-format for code formatting, include Mac client 2021-08-16 00:38:29 +03:00
update-version-h.sh Extract version from CMakeLists.txt in update-version-h.sh 2020-12-17 16:04:29 +03: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 headless daemon for servers and routers
  • A web UI for remote controlling any of the above

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

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: https://github.com/transmission/transmission/wiki

Building a Transmission release from the command line

$ tar xf transmission-2.92.tar.xz
$ cd transmission-2.92
$ mkdir build
$ cd build
$ # Use -DCMAKE_BUILD_TYPE=RelWithDebInfo to build 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
$ mkdir build
$ cd build
$ # Use -DCMAKE_BUILD_TYPE=RelWithDebInfo to build optimized binary.
$ cmake -DCMAKE_BUILD_TYPE=RelWithDebInfo ..
$ make
$ sudo make install

Building Transmission from Git (updating)

$ cd Transmission/build
$ make clean
$ git pull --rebase --prune
$ git submodule update
$ # Use -DCMAKE_BUILD_TYPE=RelWithDebInfo to build 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 could run either directly or via docker-compose:

$ ./code_style.sh
or
$ docker-compose build --pull
$ docker-compose run --rm code_style

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