source: xsoft/other/transmission.xml@ 805d241

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY transmission-download-http "https://raw.githubusercontent.com/transmission/transmission-releases/master/transmission-&transmission-version;.tar.xz">
  <!ENTITY transmission-download-ftp  " ">
  <!ENTITY transmission-md5sum        "a23a32672b83c89b9b61e90408f53d98">
  <!ENTITY transmission-size          "3.2 MB">
  <!ENTITY transmission-buildsize     "228 MB">
  <!ENTITY transmission-time          "0.5 SBU (with Qt and GTK gui interfaces; using parallelism=4)">
]>

<sect1 id="transmission" xreflabel="Transmission-&transmission-version;">
  <?dbhtml filename="transmission.html"?>


  <title>Transmission-&transmission-version;</title>

  <indexterm zone="transmission">
    <primary sortas="a-Transmission">Transmission</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Transmission</title>

    <para>
      <application>Transmission</application> is a cross-platform, open source
      BitTorrent client. This is useful for downloading large files (such as
      Linux ISOs) and reduces the need for the distributors to provide server
      bandwidth.
    </para>

    <note><para>
      The download speed of the client defaults to 50 KB/s which is quite slow.
      It can be raised, but even on a fast internet connection, the highest
      speeds seen were about 500 KB/s. For those that have internet capabilities
      faster than about 1 MB/s, direct downloads (if available) will be much faster.
    </para></note>

    &lfs112_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&transmission-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&transmission-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &transmission-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &transmission-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &transmission-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &transmission-time;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Optional patch:
          <ulink url="&patch-root;/transmission-&transmission-version;-pidfile_doc-1.patch"/>
        </para>
      </listitem>
    </itemizedlist>


    <bridgehead renderas="sect3">Transmission Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="curl"/>, and
      <xref linkend="libevent"/>
    </para>

    <bridgehead renderas="sect4">Recommended (to build a GUI)</bridgehead>
    <para role="recommended">
      <xref linkend="gtk3"/> and
      <xref linkend="qt5"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="doxygen"/> and
      <xref linkend="gdb"/>
    </para>

    <para condition="html" role="usernotes">
      User Notes: <ulink url="&blfs-wiki;/transmission"/>
    </para>
  </sect2>

  <sect2 role="installation">
    <title>Installation of Transmission</title>

    <para>
      Apply an optional patch to document the pid-file option
      on the man-page of <command>transmission-daemon</command>:
    </para>

<screen><userinput remap="pre">patch -Np1 -i ../transmission-&transmission-version;-pidfile_doc-1.patch</userinput></screen>


    <para>
      Install <application>Transmission</application> by running the
      following commands:
    </para>

<screen><userinput>./configure --prefix=/usr --enable-cli &amp;&amp;
make</userinput></screen>

    <para>
      Compile the Qt GUI with the following commands:
    </para>

<screen><userinput>pushd qt        &amp;&amp;
  qmake qtr.pro &amp;&amp;
  make          &amp;&amp;
popd</userinput></screen>

    <para>
      This package does not come with a test suite.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>make install</userinput></screen>

    <para>
      If you compiled the Qt GUI, install it by running the following commands
      as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>make INSTALL_ROOT=/usr -C qt install &amp;&amp;

install -m644 qt/transmission-qt.desktop /usr/share/applications/transmission-qt.desktop &amp;&amp;
install -m644 qt/icons/transmission.png  /usr/share/pixmaps/transmission-qt.png</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para>
      <option>--enable-cli</option>: This switch enables building the cli client.
    </para>

    <!-- with-gtk is auto detected if gtk3 is present -->
    <para>
      <option>--without-gtk</option>: This switch disables building of the
      <application>GTK+</application> interface if
      <application>GTK+</application> is present on the system (useful for
      <application>Qt5</application> or cli only builds).
    </para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>
          transmission-cli, transmission-create, transmission-daemon,
          transmission-edit, transmission-gtk, transmission-qt,
          transmission-remote and transmission-show
        </seg>
        <seg>
          None
        </seg>
        <seg>
          /usr/share/transmission
        </seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="transmission-cli">
        <term><command>transmission-cli</command></term>
        <listitem>
          <para>
            is a lightweight, command-line BitTorrent client with scripting
            capabilities
          </para>
          <indexterm zone="transmission transmission-cli">
            <primary sortas="b-transmission-cli">transmission-cli</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="transmission-create">
        <term><command>transmission-create</command></term>
        <listitem>
          <para>
            is a command line tool used to create .torrent files
          </para>
          <indexterm zone="transmission transmission-create">
            <primary sortas="b-transmission-create">transmission-create</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="transmission-daemon">
        <term><command>transmission-daemon</command></term>
        <listitem>
          <para>
            is a daemon-based Transmission session that can be controlled via
            RPC commands from transmission's web interface or
            <command>transmission-remote</command>
          </para>
          <indexterm zone="transmission transmission-daemon">
            <primary sortas="b-transmission-daemon">transmission-daemon</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="transmission-edit">
        <term><command>transmission-edit</command></term>
        <listitem>
          <para>
            is a command-line utility to modify .torrent files' announce URLs
          </para>
          <indexterm zone="transmission transmission-edit">
            <primary sortas="b-transmission-edit">transmission-edit</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="transmission-gtk">
        <term><command>transmission-gtk</command></term>
        <listitem>
          <para>
            is a GTK+ bittorrent client
          </para>
          <indexterm zone="transmission transmission-gtk">
            <primary sortas="b-transmission-gtk">transmission-gtk</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="transmission-qt">
        <term><command>transmission-qt</command></term>
        <listitem>
          <para>
            is a Qt bittorrent client
          </para>
          <indexterm zone="transmission transmission-qt">
            <primary sortas="b-transmission-qt">transmission-qt</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="transmission-remote">
        <term><command>transmission-remote</command></term>
        <listitem>
          <para>
            is a remote control utility for transmission-daemon and transmission
          </para>
          <indexterm zone="transmission transmission-remote">
            <primary sortas="b-transmission-remote">transmission-remote</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="transmission-show">
        <term><command>transmission-show</command></term>
        <listitem>
          <para>
            is a command line tool to display bittorrent .torrent file metadata
          </para>
          <indexterm zone="transmission transmission-show">
            <primary sortas="b-transmission-show">transmission-show</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>