Go to file
Charles Kerr 745adf8332
Update libutp to 3.4+ (TRAC-5888) (#3416)
Co-authored-by: Mike Gelfand <mikedld@mikedld.com>
2022-07-08 10:13:22 -05:00
.github/workflows build: re-fix the naming of workflow triggers (#3374) 2022-06-29 00:36:42 -05:00
.tx Add Mac client translations to and downsync from Transifex 2017-01-28 13:44:15 +03:00
Transmission.xcodeproj Update libutp to 3.4+ (TRAC-5888) (#3416) 2022-07-08 10:13:22 -05:00
cli refactor: add pathbuf and std::string-friendly helpers to tr_sys file and path funcs (#3118) 2022-05-21 20:17:00 -05:00
cmake Update libutp to 3.4+ (TRAC-5888) (#3416) 2022-07-08 10:13:22 -05:00
daemon daemon: deprecated --log-error -> --log-level=error (#3201) 2022-06-05 01:13:11 -05:00
dist/msi fixup! feat: use jimmac ratio icon in qt client (#3399) 2022-07-03 13:34:01 -05:00
docs Rename Mac OS X to macOS (#3362) 2022-06-27 15:28:37 -05:00
extras docs: fix various typos and misspellings (#2955) 2022-04-21 09:28:38 -05:00
gtk refactor: use svg icons in GTK client (#3395) 2022-07-03 17:14:13 -05:00
libtransmission Update libutp to 3.4+ (TRAC-5888) (#3416) 2022-07-08 10:13:22 -05:00
licenses chore: update copyright years, make notices consistent (#2463) 2022-01-20 12:27:56 -06:00
macosx [macOS] Use NSAlert APIs to show alert suppression checkbox (#3360) 2022-07-02 16:38:27 -05:00
news docs: move news to news/ directory; add 4.0.0-beta.1 release notes (#3272) 2022-07-01 17:47:53 -05:00
po Sync translations (#3389) 2022-07-02 04:10:12 +01:00
qt refactor: use svg icons in GTK client (#3395) 2022-07-03 17:14:13 -05:00
release/windows Include SVG support in Windows builds 2021-12-07 08:39:12 +00:00
tests fix: minor warnings (#3413) 2022-07-05 18:32:30 -05:00
third-party Update libutp to 3.4+ (TRAC-5888) (#3416) 2022-07-08 10:13:22 -05:00
utils Add basic support for v2 hashes in transmission-show (#3380) 2022-07-01 09:49:33 -05:00
web Web client: fix broken state and labels filter. (#3311) 2022-06-16 17:09:47 -05:00
.clang-format Switch to clang-format for code formatting, include Mac client 2021-08-16 00:38:29 +03:00
.clang-format-ignore refactor: modernize cache.cc (#3108) 2022-06-11 19:46:30 -05:00
.clang-format-include Adopting .clang-format-include and .clang-format-ignore (#3047) 2022-05-13 18:48:33 -05:00
.gitignore refactor: modernize cache.cc (#3108) 2022-06-11 19:46:30 -05:00
.gitmodules Update libutp to 3.4+ (TRAC-5888) (#3416) 2022-07-08 10:13:22 -05:00
AUTHORS Rename Mac OS X to macOS (#3362) 2022-06-27 15:28:37 -05:00
CMakeLists.txt Update libutp to 3.4+ (TRAC-5888) (#3416) 2022-07-08 10:13:22 -05:00
CONTRIBUTING.md docs: fix various typos and misspellings (#2955) 2022-04-21 09:28:38 -05:00
COPYING Update Copyright Year to 2022. (#3352) 2022-06-28 09:07:12 -05:00
README.md build: use GitHub actions to check code-style (#3138) 2022-05-26 07:38:20 -05:00
appveyor.yml Switch to Strawberry Perl for AppVeyor Windows builds (#2763) 2022-03-12 18:49:39 +03:00
code_style.sh Adopting .clang-format-include and .clang-format-ignore (#3047) 2022-05-13 18:48:33 -05:00
icon.png Adding icon.png for Sourcetree (#3250) 2022-06-10 12:34:46 -05: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 can use: ./code_style.sh

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