Go to file
Charles Kerr a4b1c2cadc
deps: update dht to 0.27 (#3015)
2022-04-29 14:40:52 -05:00
.tx Add Mac client translations to and downsync from Transifex 2017-01-28 13:44:15 +03:00
Transmission.xcodeproj refactor: replace tr_fdlimit with tr_open_files (#3016) 2022-04-28 21:35:47 -05:00
cli update documentation links (#2985) 2022-04-25 18:18:35 -05:00
cmake deps: update libdeflate to v1.10 (#3014) 2022-04-28 12:51:18 -05:00
daemon update documentation links (#2985) 2022-04-25 18:18:35 -05: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
docs Specify the umask and IPC socket permission as strings. (#2984) 2022-04-28 09:16:19 -05:00
extras docs: fix various typos and misspellings (#2955) 2022-04-21 09:28:38 -05:00
gtk refactor: use smaller integral types in some structs (#3005) 2022-04-27 20:06:51 -05:00
libtransmission fix: invalid tr_peerMsgsImpl::prefetchCount value (#3024) 2022-04-29 12:44:22 -05:00
licenses chore: update copyright years, make notices consistent (#2463) 2022-01-20 12:27:56 -06:00
macosx OS X → macOS (#2986) 2022-04-26 09:11:44 -05:00
po docs: fix various typos and misspellings (#2955) 2022-04-21 09:28:38 -05:00
qt OS X → macOS (#2986) 2022-04-26 09:11:44 -05:00
release/windows Include SVG support in Windows builds 2021-12-07 08:39:12 +00:00
tests refactor: replace tr_fdlimit with tr_open_files (#3016) 2022-04-28 21:35:47 -05:00
third-party deps: update dht to 0.27 (#3015) 2022-04-29 14:40:52 -05:00
utils build: re-enable cert-err33-c clang-tidy warning (#2968) 2022-04-22 14:56:54 -05:00
web build(deps): bump minimist from 1.2.5 to 1.2.6 in /web (#2831) 2022-03-28 08:10:46 -05:00
.clang-format Switch to clang-format for code formatting, include Mac client 2021-08-16 00:38:29 +03:00
.gitignore Add ability to change piece size during torrent creation in MacOS GUI… (#2805) 2022-03-24 22:26:21 -05:00
.gitmodules deps: update dht to 0.27 (#3015) 2022-04-29 14:40:52 -05:00
AUTHORS macOS icon redesigned for Big Sur 2021-03-29 18:05:30 -04:00
CMakeLists.txt deps: update libdeflate to v1.10 (#3014) 2022-04-28 12:51:18 -05:00
CONTRIBUTING.md docs: fix various typos and misspellings (#2955) 2022-04-21 09:28:38 -05:00
COPYING Bump copyright to 2020 (some more places) (#1206) 2020-05-02 12:26:42 -05:00
NEWS.md docs: fix various typos and misspellings (#2955) 2022-04-21 09:28:38 -05:00
README.md update documentation links (#2985) 2022-04-25 18:18:35 -05:00
appveyor.yml Switch to Strawberry Perl for AppVeyor Windows builds (#2763) 2022-03-12 18:49:39 +03:00
code_style.sh build: try clang-format-12 in code_style (#2935) 2022-04-16 22:23:20 -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.

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