scale-catalog/jailman/blueprints/transmission/readme.md

# Transmission

## Original README from the transmission github:

https://github.com/transmission/transmission

# Transmission

## 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
Wiki replacement and CI update (#86) * dhcp uses on, not true (because iocage syntax) * Documentation updates * Add gh-pages wiki generator using mkdocs * Update shellcheck.yml * Update wiki.yml * Add filecheck * readme case correction1 * readme case correction2 * Update filecheck.yml 2020-04-26 14:00:47 +00:00			`# Transmission`

			`## Original README from the transmission github:`
Jailman v1.1.0 (#24) * set branch (+2 squashed commit) Squashed commit: [e322f24] remove placeholder [8647131] palceholder * Code cleanup and (primarily) consolidation (#21) * set branch * Exit 1 on iocage create failure * - Move jailcreate to global function - Remove Jailcreate.sh * Add dataset creation function * - add test script to test new global changes - also create folder in jail with createmount * fix * make test executable * more verbosity, fixing folder creation * moving global dataset create * move jails to new dataset-mount creation function * remove test jail and test branch-ref * Add Nextcloud (#22) * Basic working nextcloud integration * Enable persistent reinstall of Nextcloud * prepare for dev merge * Licence alert * Add external database and integrated jail * small improvements and update script * Add mariadb to dev (#31) * Working MariaDB config * - Set ZFS settings for DB on Nextcloud and MariaDB - Cleanup MariaDB * prepare for dev merge * Niceify Readme (#34) * put content from master into it * Some readme itteration * more niceification * [WIP} Wiki workflow test (#37) introduce automatic wiki generation * Add Bitwarden support (#35) * Nextcloud-Cleanup for v1.1.0 (#40) * Nextcloud cleanup - add db-type sanity check - remove some integrated db checks - Move ssl to /config/ssl - remove integrated databases * slight default tweaking * fix mariadb install bug * QA cycle 2020-03-13 22:59:05 +00:00
			`https://github.com/transmission/transmission`

			`# Transmission`

			`## 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`