Go to file
tearfur 8b4d05d4e5
fixup! refactor: `tr_torrent.incompleteMetadata` from raw pointer to `std::optional` (#5837)
2023-07-29 08:49:52 -05:00
.github fix: CI: Do not use nproc on macOS hosts. (#5833) 2023-07-29 08:21:30 -05:00
.tx Sync translations (#3968) 2022-10-15 21:21:13 +03:00
Transmission.xcodeproj refactor: rename tr_dirSpace() to tr_sys_path_capacity() (#5689) 2023-06-29 10:23:00 -05:00
cli fix: conform to libcurl requirements to avoid memory leak (#5702) 2023-07-05 22:05:03 -05:00
cmake refactor: add libsmall dependency (#5649) 2023-06-20 22:50:36 -05:00
daemon chore: iwyu (#5746) 2023-07-08 10:24:03 -05:00
dist/msi Build additional packages for Qt 5 on Appveyor (#4855) 2023-02-12 22:12:09 +00:00
docs docs: document the `watch-dir-force-generic` setting (#5819) 2023-07-28 18:53:48 -05:00
extras fix: some typos (#3904) 2022-10-13 09:35:10 -05:00
gtk refactor: tr_compare_3way() (#5799) 2023-07-15 21:55:44 -05:00
libtransmission fixup! refactor: `tr_torrent.incompleteMetadata` from raw pointer to `std::optional` (#5837) 2023-07-29 08:49:52 -05:00
licenses refactor: aggregate arc4 into libtransmission (#3684) 2022-08-20 13:41:40 -05:00
macosx fix: conform to libcurl requirements to avoid memory leak (#5702) 2023-07-05 22:05:03 -05:00
news docs: add 4.0.3 release notes (#5389) 2023-04-13 15:24:22 -05:00
po Sync translations (#5391) 2023-04-14 03:00:44 +01:00
qt refactor: prefer direct-brace-initialization (#5803) 2023-07-18 10:20:17 -05:00
release/windows Build additional packages for Qt 5 on Appveyor (#4855) 2023-02-12 22:12:09 +00:00
tests refactor: avoid code duplication (#5793) 2023-07-17 08:56:57 -05:00
third-party chore: bump to head of small/devel (#5743) 2023-07-07 11:02:25 -05:00
utils chore: iwyu (#5746) 2023-07-08 10:24:03 -05:00
web chore: update generated transmission-web files (#5831) 2023-07-28 14:13:15 -05:00
.clang-format
.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 refactor: add libsmall dependency (#5649) 2023-06-20 22:50:36 -05:00
AUTHORS docs: update AUTHORS (#5286) 2023-03-24 13:51:32 -05:00
CMakeLists.txt refactor: add libsmall dependency (#5649) 2023-06-20 22:50:36 -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: `--init` added in `Building Transmission from Git (updating)` section (#5688) 2023-07-08 11:59:11 -05:00
appveyor.yml Build additional packages for Qt 5 on Appveyor (#4855) 2023-02-12 22:12:09 +00:00
code_style.sh fix: use both address + port together as a key for peer lookup (#5619) 2023-06-19 20:26:39 -05: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-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 --init --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