<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
<!--ArborText, Inc., 1988-1999, v.4002-->
<!ENTITY cmd "transmission">
%commonents;
%booktitles;
<!ENTITY suncopy "Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.">
]>
<?Pub UDT _bookmark _target>
<?Pub Inc>
<refentry id="transmission-1">
<!-- %Z%%M% %I% %E% SMI; -->
<refmeta><refentrytitle>&cmd;</refentrytitle><manvolnum>1</manvolnum>
<refmiscinfo class="date">17 Jul 2008</refmiscinfo>
<refmiscinfo class="sectdesc">&man1;</refmiscinfo>
<refmiscinfo class="software">&release;</refmiscinfo>
<refmiscinfo class="arch">generic</refmiscinfo>
<refmiscinfo class="copyright">&suncopy;</refmiscinfo>
</refmeta>
<indexterm><primary>&cmd;</primary></indexterm><indexterm><primary>a GTK+-based BitTorrent client</primary></indexterm>
<refnamediv id="transmission-1-name"><refname>&cmd;</refname><refpurpose>a GTK+-based BitTorrent client</refpurpose></refnamediv>
<refsynopsisdiv id="tranmission-1-synp"><title>&synp-tt;</title>
<cmdsynopsis><command>&cmd;</command>
<arg choice="opt"><option>-help</option></arg>
</cmdsynopsis>
<cmdsynopsis><command>&cmd;</command>
<arg choice="opt"><option>-paused</option></arg>
<arg choice="opt"><option>-minimized</option></arg>
<arg choice="opt"><option>-config-dir <replaceable>directory</replaceable></option></arg>
<arg rep="repeat"><option role="nodash"><replaceable>torrent-file</replaceable></option></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="transmission-1-desc"><title>&desc-tt;</title>
<para><command>&cmd;</command> is a fast and easy BitTorrent client.
BitTorrent is a peer-to-peer file transfer protocol which uses a metainfo
file (usually with the .torrent file extension) and a central <replacebale>tracker</replaceable> to distribute file data amongst a group of peers. For more information on the
BitTorrent protocol see http://www.bittorrent.org/
</para></refsect1>
<refsect1 id="transmission-1-exde"><title>&exde-tt;</title>
<refsect2 id="transmission-1-exde-seeder">
<title>Seeder</title>
<para>A seeder is a peer that has a complete copy of the <replaceable>torrent</replaceable> and still offers it for upload. The more seeders there are, the better the chances are for completion of the file.</para>
</refsect2>
<refsect2 id="transmission-1-exde-leecher">
<title>Leecher</title>
<para>A leecher is usually a peer who has a negative effect on the swarm by having a very poor share ratio - in other words, downloading much more than they upload. Most leechers are users on asymmetric internet connections and do not leave their BitTorrent client open to seed the file after their download has completed. However, some leechers intentionally avoid uploading by using modified clients or excessively limiting their upload speed. The term leecher, however, can be used simply to describe a peer - or any client that does not have 100% of the data.</para>
</refsect2>
<refsect2 id="transmission-1-exde-swarm">
<title>Swarm</title>
<para>Together, all peers (including seeders) sharing a torrent are called a swarm. For example, six ordinary peers and two seeders make a swarm of eight.</para>
</refsect2>
<refsect2 id="transmission-1-exde-torrent">
<title>Torrent</title>
<para>A torrent can mean either a .torrent metadata file or all files described by it, depending on context. The torrent file contains metadata about all the files it makes downloadable, including their names and sizes and checksums of all pieces in the torrent. It also contains the address of a <replaceable>tracker</replaceable> that coordinates communication between the peers in the swarm.<para>
</refsect2>
<refsect2 id="transmission-1-exde-tracker">
<title>Tracker</title>
<para>A tracker is a server that keeps track of which seeds and peers are in the swarm. Clients report information to the tracker periodically and in exchange receive information about other clients to which they can connect. The tracker is not directly involved in the data transfer and does not have a copy of the file.</para>
</refsect2>
</refsect1>
<refsect1 id="transmission-1-opts"><title>&opts-tt;</title>
<para>The following options are supported:</para>
<variablelist termlength="wholeline">
<varlistentry><term><option role="nodash">-?</option>, <option>-help</option></term>
<listitem><para>Show help options.</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">-p</option>, <option>-paused</option></term><listitem>
<para>Start with all torrents paused.</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">-m</option>, <option>-minimized</option></term><listitem>
<para>Start minimized in system tray.</para>
</listitem></varlistentry>
<varlistentry><term><option role="nodash">-g</option>, <option>-config-dir <replaceable>directory</replaceable></option></term><listitem>
<para>Where to look for configuration files.</para>
</listitem></varlistentry>
</variablelist>
<para>Multiple .torrent files may be added at startup by appending them on the command line. If &cmd; is already running, the torrents will be added to the running instance. </para>
</refsect1>
<refsect1 id="transmission-1-oper"><title>&oper-tt;</title>
<para>The following operands are supported:</para>
<variablelist termlength="narrow">
<varlistentry><term><option role="nodash"><replaceable>torrent-file</replaceable></option></term>
<listitem><para>The name of the torrent file.</para>
</listitem></varlistentry>
</variablelist></refsect1>
<refsect1 id="transmission-1-envr"><title>&envr-tt;</title>
<para><command>&cmd;</command> uses the following environment variables:</para>
<variablelist><varlistentry><term>TRANSMISSION_HOME</term><listitem><para>Sets the default conf-dir.</para>
</listitem></varlistentry></variablelist></refsect1>
<refsect1 id="transmission-1-file"><title>&file-tt;</title>
<para>The following files are used by this application:</para>
<variablelist termlength="wholeline">
</term><listitem><para>
The executable for <application>&cmd;</application>
</para></listitem></varlistentry>
</term><listitem><para>
The conf-dir used when neither TRANSMISSION_HOME nor -g is specified.
</para></listitem></varlistentry>
</variablelist>
</refsect1>
<refsect1 id="transmission-1-exit"><title>&exit-tt;</title>
<para>The following exit values are returned:</para>
<variablelist termlength="xtranarrow">
<varlistentry><term><returnvalue>0</returnvalue></term><listitem><para>Application
exited successfully.</para>
</listitem></varlistentry>
<varlistentry><term><returnvalue>>0</returnvalue></term><listitem><para>Application
exited with failure.</para>
</listitem></varlistentry>
</variablelist></refsect1>
<refsect1 id="transmission-1-attr"><title>&attr-tt;</title>
<para>See <olink targetdocent="REFMAN5" localinfo="attributes-5"><citerefentry>
<refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink>
for descriptions of the following attributes:</para>
<informaltable frame="all">
<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*">
<colspec colname="COLSPEC1" colwidth="1*">
<thead>
<row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center"
valign="middle">ATTRIBUTE VALUE</entry></row>
</thead>
<tbody>
<row><entry><para>Availability</para></entry><entry><para>SUNWtransmission</para></entry>
</row>
<row><entry colname="COLSPEC0"><para>Interface stability</para></entry><entry
colname="COLSPEC1"><para>Volatile</para></entry></row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="transmission-1-also"><title>&also-tt;</title>
<!--Reference to another man page-->
<!--Reference to a Help manual-->
<!--Reference to a book.-->
<para>
<citerefentry><refentrytitle>transmissioncli</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>transmission-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>transmission-remote</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>
</para>
</refsect1>
<refsect1 id="tranmission-1-note"><title>¬e-tt;</title>
<parm><command>&cmd;</command> program was written by Charles Kerr
��charles@rebelbase.com��, Josh Elsasser ��josh@elsasser.org��, Eric Petit
��titer@m0k.org��, and Mitchell Livingston ��livings124@gmail.com��.<para>
<para>The man page updated by Elaine Xiong, Sun Microsystems Inc., 2008.</para>
</refsect1>
</refentry>