transmissioncli.1 revision 18861
18861N/A<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
18861N/A<indexterm><primary>&cmd;</primary></indexterm><indexterm><primary>a command-line BitTorrent client</primary></indexterm>
18861N/A<refnamediv id="transmissioncli-1-name"><refname>&cmd;</refname><refpurpose>a command-line BitTorrent client</refpurpose></refnamediv>
18861N/A<arg choice="plain"><option role="nodash"><replaceable>torrent-file</replaceable></option></arg>
18861N/A<arg choice="plain"><option role="nodash"><replaceable>torrent-file</replaceable></option></arg>
18861N/A<arg choice="plain"><option role="nodash"><replaceable>new-torrent-file</replaceable></option></arg>
18861N/A<arg choice="opt"><option>-downlimit </option><replaceable>speed</replaceable> | <option>-no-downlimit</options></arg>
18861N/A<arg choice="opt"><option>-encryption-required</option>|<option>-encryption-preferred</option>|<option>-encryption-tolerated</option></arg>
18861N/A<arg choice="opt"><option>-uplimit </option><replaceable>speed</replaceable>|<option>-no-uplimit</option></arg>
18861N/A<arg choice="plain"><option role="nodash"><replaceable>torrent-file</replaceable></option></arg>
18861N/A<para><command>&cmd;</command> is a lightweight, command-line BitTorrent client with scripting capabilities.
18861N/A<varlistentry><term><option role="nodash">-a</option>, <option>-announce <replaceable>url</replaceable></option></term>
18861N/A<listitem><para>When creating a new torrent, set its announce <replaceable>url</replaceable>.</para>
18861N/A<listitem><para>Enable peer blocklists. <command>&cmd;</command> understands the bluetack blocklist file format. Bluetack blocklists are text files that applications can load in order to block access. Bluetack blocklists are available on <literal>http://www.bluetack.co.uk/<literal>. New blocklists can be added by copying them into the config-dir's "blocklists" subdirectory.</para></listitem></varlistentry>
18861N/A<varlistentry><term><option role="nodash">-B</option>, <option>-no-blocklist</option></term>
18861N/A<varlistentry><term><option role="nodash">-c</option>, <option>-comment <replaceable>text</replaceable></option></term><listitem><para>When creating a new torrent, set its comment field.</para></listitem></varlistentry>
18861N/A<varlistentry><term><option role="nodash">-d</option>, <option>-downlimit <replaceable>speed</replaceable></option></term><listitem>
18861N/A<varlistentry><term><option role="nodash">-D</option>, <option>-no-downlimit</option></term><listitem><para>Do not limit the download speed.</para></listitem></varlistentry>
18861N/A<varlistentry><term><option role="nodash">-er</option>, <option>-encryption-required</option></term><listitem><para>Encrypt all peer connections.</para></listitem></varlistentry>
18861N/A<varlistentry><term><option role="nodash">-ep</option>, <option>-encryption-preferred</option></term><listitem><para>Prefer encrypted peer connections.</para></listitem></varlistentry>
18861N/A<varlistentry><term><option role="nodash">-et</option>, <option>-encryption-tolerated</option></term><listitem><para>Prefer unencrypted peer connections.</para></listitem></varlistentry>
18861N/A<varlistentry><term><option role="nodash">-f</option>, <option>-finish <replaceable>script</replaceable></option></term><listitem><para>Specify a script to run when the torrent finishes.</para></listitem></varlistentry>
18861N/A<varlistentry><term><option role="nodash">-g</option>, <option>-conf-dir <replaceable>directory</replaceable></option></term><listitem><para>Where to look for configuration files.</para></listitem></varlistentry>
18861N/A<varlistentry><term><option role="nodash">-h</option>, <option>-help</option></term><listitem><para>Print a short usage summary.</para></listitem></varlistentry>
18861N/A<varlistentry><term><option role="nodash">-i</option>, <option>-info</option></term><listitem><para>Show torrent details and exit.</para></listitem></varlistentry>
18861N/A<varlistentry><term><option role="nodash">-m</option>, <option>-portmap</option></term><listitem><para>Enable portmapping via NAT-PMP or uPnP.</para></listitem></varlistentry>
18861N/A<varlistentry><term><option role="nodash">-M</option>, <option>-no-portmap</option></term><listitem><para>Disable portmapping.</para></listitem></varlistentry>
18861N/A<varlistentry><term><option role="nodash">-n</option>, <option>-new <replaceable>sourcefile</replaceable></option></term><listitem><para>Create torrent from the specified file or directory.</para></listitem></varlistentry>
18861N/A<varlistentry><term><option role="nodash">-p</option>, <option>-port <replaceable>port</replaceable></option></term><listitem><para>Set the <replaceable>port</replaceable> to listen for incoming peers. The default <replaceable>port</replaceable> is 51413.</para></listitem></varlistentry>
18861N/A<varlistentry><term><option role="nodash">-r</option>, <option>-private</option></term><listitem><para>When creating a new torrent, set its "private" flag.</para></listitem></varlistentry>
18861N/A<varlistentry><term><option role="nodash">-s</option>, <option>-scrape</option></term><listitem><para>Print the current number of seeders and leechers for the specified torrent.</para></listitem></varlistentry>
18861N/A<varlistentry><term><option role="nodash">-t</option>, <option>-tos</option></term><listitem><para>Set the peer socket TOS for local router-based traffic shaping.</para></listitem></varlistentry>
18861N/A<varlistentry><term><option role="nodash">-u</option>, <option>-uplimit <replaceable>speed</replaceable></option></term><listitem><para>Set the maximum upload speed, Which defaults to 20KB/s.</para></listitem></varlistentry>
18861N/A<varlistentry><term><option role="nodash">-U</option>, <option>-no-uplimit</option></term><listitem><para>Do not limit the upload speed.</para></listitem></varlistentry>
18861N/A<varlistentry><term><option role="nodash">-v</option>, <option>-verify</option></term><listitem><para>Verify the torrent's downloaded data.</para></listitem></varlistentry>
18861N/A<varlistentry><term><option role="nodash">-w</option>, <option>-download-dir <replaceable>directory</replaceable></option></term><listitem><para>Where to save download data.</para></listitem></varlistentry>
18861N/A<para>In addition to these options, sending transmissioncli a SIGHUP signal will contact the tracker for more peers.</para>
18861N/A<listitem><para>The name of the file or directory to create the <replaceable>new-torrent-file</replaceable>.</para>
18861N/A<listitem><para>The name of the output file created from the <replaceable>sourcefile</replaceable>.</para>
18861N/ADirectory where <application>&cmd;</application> keeps torrent information for future seeding and resuming operations.
18861N/A<citerefentry><refentrytitle>transmission</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
18861N/A<citerefentry><refentrytitle>transmission-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
18861N/A<citerefentry><refentrytitle>transmission-remote</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
18861N/A<citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>
18861N/A<para>Transmission community site - <literal>http://www.transmissionbt.org/</literal></para>