1
0
Fork 0
mirror of https://github.com/transmission/transmission synced 2024-12-27 01:57:52 +00:00
No description
Find a file
Mike Gelfand 62e4e4a373
Merge pull request #850 from transmission/code-style-script
Add code style script and Dockerfile
2019-03-03 01:13:20 +03:00
.tx Add Mac client translations to and downsync from Transifex 2017-01-28 13:44:15 +03:00
cli Update to Uncrustify 0.68.1 2019-02-15 09:21:48 +03:00
cmake Updated copyright strings to 2019 2019-01-11 19:36:19 +01:00
daemon Update to Uncrustify 0.68.1 2019-02-15 09:21:48 +03:00
dist/msi Use magick convert instead of convert 2018-01-26 07:56:11 +03:00
docker/code_style Add code style script and Dockerfile 2019-02-28 03:19:24 +03:00
extras Add labels feature (#822) 2019-02-17 04:33:57 -05:00
gtk Update to Uncrustify 0.68.1 2019-02-15 09:21:48 +03:00
libtransmission fix: Coverity warnings (#842) 2019-02-18 22:38:24 +00:00
m4 Work around "error: m4_copy: won't overwrite defined macro: glib_DEFUN" on 2017-03-12 06:20:14 +01:00
macosx Fixup some formatting leftovers 2019-02-16 10:50:37 +03:00
po gtk: move Tamil translation to the correct language code 2017-05-20 00:55:49 +03:00
qt Update to Uncrustify 0.68.1 2019-02-15 09:21:48 +03:00
third-party Update DHT library to 0.25 2018-02-10 11:35:14 +03:00
Transmission.xcodeproj Fix QuickLookPlugin reference path to be relative to group 2019-02-03 10:49:06 +08:00
utils widen the torrent-id column for cleaner formatting (#840) 2019-02-18 22:39:02 +00:00
web Fixup some formatting leftovers (JS) 2019-02-17 17:51:13 +03:00
.gitignore #5934: Generate REVISION file and use it in case of missing reliable source 2015-04-24 19:14:56 +00:00
.gitmodules Update DHT library to 0.25 2018-02-10 11:35:14 +03:00
.jsbeautifyrc Fixup some formatting leftovers (JS) 2019-02-17 17:51:13 +03:00
AUTHORS Add myself to the list of Transmission authors 2017-01-15 01:38:45 +03:00
autogen.sh Refactor shell scripts with syntax and styling fixes 2019-01-16 03:22:29 +08:00
ChangeLog
CMakeLists.txt Merge branch '2.9x' 2018-05-01 22:44:51 +03:00
code_style.sh Add code style script and Dockerfile 2019-02-28 03:19:24 +03:00
configure.ac Merge branch '2.9x' 2018-05-01 22:44:51 +03:00
COPYING Updated copyright strings to 2019 2019-01-11 19:36:19 +01:00
docker-compose.yml Add code style script and Dockerfile 2019-02-28 03:19:24 +03:00
Makefile.am Adjust autotools files to use submodules 2017-01-02 02:26:02 +03:00
NEWS add Sparkle update to NEWS 2018-12-24 19:00:29 -05:00
README.md Add code style script and Dockerfile 2019-02-28 03:19:24 +03:00
transmission-gtk.spec.in Update all website links to canonical HTTPS version. 2016-10-31 10:00:11 +01:00
uncrustify.cfg Update to Uncrustify 0.68.1 2019-02-15 09:21:48 +03:00
update-version-h.sh Refactor shell scripts with syntax and styling fixes 2019-01-16 03:22:29 +08:00

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