Go to file
Mike Gelfand b7a8bd45b7 Reformat affected code after recent changes 2020-08-18 20:31:06 +03:00
.tx Add Mac client translations to and downsync from Transifex 2017-01-28 13:44:15 +03:00
Transmission.xcodeproj Merge branch 'master' into patch-1 2020-01-03 00:15:03 -05:00
cli Reformat affected code after recent changes 2020-08-18 20:31:06 +03:00
cmake Fix Ubuntu 18.04 Qt FTBFS (#1377) 2020-07-29 14:53:55 -05:00
daemon Reformat affected code after recent changes 2020-08-18 20:31:06 +03:00
dist/msi Only add revision to filename for nightly builds (MSI package) 2019-06-20 04:55:30 +03:00
docker/code_style Add code style script and Dockerfile 2019-02-28 03:19:24 +03:00
extras Fix typo in rpc-spec.txt (#1326) 2020-07-26 23:36:38 -05:00
gtk Reformat affected code after recent changes 2020-08-18 20:31:06 +03:00
libtransmission Reformat affected code after recent changes 2020-08-18 20:31:06 +03:00
m4 Work around "error: m4_copy: won't overwrite defined macro: glib_DEFUN" on 2017-03-12 06:20:14 +01:00
macosx Switch from UNUSED macro to TR_UNUSED macro 2020-08-18 14:19:55 +03:00
po refactor: use GTest for running tests (#1383) 2020-08-11 13:11:55 -05:00
qt fixup! refactor: remove exit-time destructors from transmission-qt (#1395) 2020-08-16 20:43:14 -05:00
release/windows Add AppVeyor configuration for Windows release builds 2020-05-05 13:56:48 +03:00
tests Make use of TR_UNUSED macro where cast-to-void was used before 2020-08-18 14:34:49 +03:00
third-party refactor: use GTest for running tests (#1383) 2020-08-11 13:11:55 -05:00
utils Switch from UNUSED macro to TR_UNUSED macro 2020-08-18 14:19:55 +03:00
web Remove unused html (#1313) 2020-06-14 16:04:26 -05:00
.gitignore Add AppVeyor configuration for Windows release builds 2020-05-05 13:56:48 +03:00
.gitmodules refactor: use GTest for running tests (#1383) 2020-08-11 13:11:55 -05:00
.jsbeautifyrc Fixup some formatting leftovers (JS) 2019-02-17 17:51:13 +03:00
AUTHORS Remove mention of Growl, which has been removed. 2020-05-25 09:37:19 -04:00
CMakeLists.txt Require C11, switch to standard static_assert 2020-08-18 14:19:55 +03:00
COPYING Bump copyright to 2020 (some more places) (#1206) 2020-05-02 12:26:42 -05:00
ChangeLog
Makefile.am refactor: use GTest for running tests (#1383) 2020-08-11 13:11:55 -05:00
NEWS.md docs: make 'news' a markdown file (#1208) 2020-05-03 18:33:57 -05:00
README.md Add code style script and Dockerfile 2019-02-28 03:19:24 +03:00
appveyor.yml Use release code signing certificate on Windows 2020-05-14 19:20:07 +03:00
autogen.sh Refactor shell scripts with syntax and styling fixes 2019-01-16 03:22:29 +08:00
code_style.sh refactor: use GTest for running tests (#1383) 2020-08-11 13:11:55 -05:00
configure.ac refactor: use GTest for running tests (#1383) 2020-08-11 13:11:55 -05:00
docker-compose.yml Add code style script and Dockerfile 2019-02-28 03:19:24 +03:00
transmission-gtk.spec.in docs: make 'news' a markdown file (#1208) 2020-05-03 18:33:57 -05:00
uncrustify.cfg Update Uncrustify config to 0.70.1 2020-01-03 03:21:50 +03:00
update-version-h.sh Refactor shell scripts with syntax and styling fixes 2019-01-16 03:22:29 +08:00

README.md

About

Transmission is a fast, easy, and free BitTorrent client. It comes in several flavors:

  • A native Mac OS X 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
$ cmake ..
$ 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
$ cmake ..
$ make
$ sudo make install

Building Transmission from Git (updating)

$ cd Transmission/build
$ make clean
$ git pull --rebase --prune
$ git submodule update
$ cmake ..
$ make
$ sudo make install

Contributing

Code Style

You would want to setup your editor to make use of uncrustify.cfg and .jsbeautifyrc configuration files located in the root of this repository.

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