transmission/README.md

79 lines
2.9 KiB
Markdown
Raw Normal View History

## About
2006-07-16 19:39:23 +00:00
Transmission is a fast, easy, and free BitTorrent client. It comes in several flavors:
2021-08-07 10:31:28 +00:00
* 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
2006-07-16 19:39:23 +00:00
2016-09-03 22:59:50 +00:00
Visit https://transmissionbt.com/ for more information.
2006-07-16 19:39:23 +00:00
## 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.
2016-09-03 22:59:50 +00:00
For a more detailed description, and dependencies, visit: https://github.com/transmission/transmission/wiki
### Building a Transmission release from the command line
2008-12-06 17:04:24 +00:00
2016-12-26 19:46:07 +00:00
$ 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
2009-06-20 01:31:34 +00:00
2016-12-26 19:46:07 +00:00
Download a tarball from https://build.transmissionbt.com/job/trunk-linux/ and follow the steps from the previous section.
2009-06-20 01:31:34 +00:00
2016-12-26 19:46:07 +00:00
If you're new to building programs from source code, this is typically easier than building from Git.
2009-06-20 01:31:34 +00:00
2016-12-26 19:46:07 +00:00
### Building Transmission from Git (first time)
2016-12-26 19:46:07 +00:00
$ git clone https://github.com/transmission/transmission Transmission
$ cd Transmission
2016-12-26 19:46:07 +00:00
$ 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
2007-08-17 02:50:55 +00:00
2016-12-26 19:46:07 +00:00
### Building Transmission from Git (updating)
2016-12-26 19:46:07 +00:00
$ cd Transmission/build
2008-12-06 17:04:24 +00:00
$ make clean
2016-12-26 19:46:07 +00:00
$ 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
2019-02-27 23:01:21 +00:00
## 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.
2019-02-27 23:01:21 +00:00
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