Go to file
Charles Kerr 3b72a1feea
refactor: use C++ inheritance for tr_peer, tr_peerMsgs, and tr_webseed (#1877)
* refactor: use C++ inheritance for tr_peer, tr_peerMsgs, and tr_webseed
2021-10-07 08:33:55 -05:00
.tx Add Mac client translations to and downsync from Transifex 2017-01-28 13:44:15 +03:00
Transmission.xcodeproj refactor: use C++ inheritance for tr_peer, tr_peerMsgs, and tr_webseed (#1877) 2021-10-07 08:33:55 -05:00
cli refactor: use nullptr instead of NULL (#1884) 2021-10-06 11:32:17 -05:00
cmake refactor: port libtransmission to C++ (#1787) 2021-09-12 12:41:49 -05:00
daemon refactor: use nullptr instead of NULL (#1884) 2021-10-06 11:32:17 -05:00
dist/msi Use PowerShell instead of ImageMagick for AppVeyor build 2021-08-24 08:55:53 +03:00
docker/code_style Switch to clang-format for code formatting, include Mac client 2021-08-16 00:38:29 +03:00
extras add authentication information to rpc-spec.txt (#1808) 2021-09-15 08:35:23 -05:00
gtk refactor: add [[fallthrough]] annotation (#1886) 2021-10-06 12:24:02 -05:00
libtransmission refactor: use C++ inheritance for tr_peer, tr_peerMsgs, and tr_webseed (#1877) 2021-10-07 08:33:55 -05:00
macosx Port macOS client to C++ (#1830) 2021-09-24 07:56:57 -05:00
po Sync existing translations with Transifex 2020-11-03 20:26:30 +03:00
qt refactor: add [[fallthrough]] annotation (#1886) 2021-10-06 12:24:02 -05:00
release/windows Switch from zip to 7z for PDBs archive on AppVeyor 2021-10-05 20:33:09 +03:00
tests refactor: use C++ inheritance for tr_peer, tr_peerMsgs, and tr_webseed (#1877) 2021-10-07 08:33:55 -05:00
third-party Switch to a standalone ARC4 implementation (#1788) 2021-09-12 06:47:29 +03:00
utils refactor: add [[fallthrough]] annotation (#1886) 2021-10-06 12:24:02 -05:00
web chore(deps): bump url-parse from 1.5.1 to 1.5.3 in /web (#1828) 2021-09-22 17:24:46 -05:00
.clang-format Switch to clang-format for code formatting, include Mac client 2021-08-16 00:38:29 +03:00
.gitignore feat: web client refresh (#1476) 2020-10-23 20:04:25 -05:00
.gitmodules Use default tracking branch for arc4 submodule 2021-09-21 17:12:49 +03:00
AUTHORS macOS icon redesigned for Big Sur 2021-03-29 18:05:30 -04:00
CMakeLists.txt build: skip clang-tidy on lgtm (#1792) 2021-09-12 14:36:51 -05: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 instruction in README.md to config a release build. (#1282) 2021-08-19 00:18:22 +03:00
appveyor.yml Switch from zip to 7z for PDBs archive on AppVeyor 2021-10-05 20:33:09 +03:00
code_style.sh refactor: port libtransmission to C++ (#1787) 2021-09-12 12:41:49 -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