glfs/xsoft/other/transmission.xml
Douglas R. Reno e7c4a7f280 Tags
2024-02-20 22:43:37 -06:00

314 lines
10 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!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://github.com/transmission/transmission/releases/download/&transmission-version;/transmission-&transmission-version;.tar.xz">
<!ENTITY transmission-download-ftp " ">
<!ENTITY transmission-md5sum "d3cda868215246644c429b18a30f7e47">
<!ENTITY transmission-size "9.2 MB">
<!ENTITY transmission-buildsize "229 MB (with both GUI interfaces)">
<!ENTITY transmission-time "2.3 SBU (with both 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>
&lfs121_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">Transmission Dependencies</bridgehead>
<bridgehead renderas="sect4">Required</bridgehead>
<para role="required">
<xref linkend="curl"/>
</para>
<bridgehead renderas="sect4">Recommended</bridgehead>
<para role="recommended">
<xref linkend="libevent"/> and
<xref linkend="libpsl"/>
(to use system libraries instead of bundled ones)
</para>
<bridgehead renderas="sect4">Recommended (to build a GUI)</bridgehead>
<para role="recommended">
<xref linkend="gtkmm3"/> or
&qt5-deps; or
<xref linkend="qt6" role="nodep"/>
</para>
<bridgehead renderas="sect4">Optional</bridgehead>
<para role="optional">
<xref linkend="nodejs"/> (for building the web client, not needed at run time),
<ulink url="https://github.com/ubuntu/gnome-shell-extension-appindicator">appindicator</ulink>,
<ulink url="https://github.com/jech/dht">dht</ulink>,
<ulink url="https://github.com/libb64/libb64">libb64</ulink>,
<ulink url="https://github.com/ebiggers/libdeflate">libdeflate</ulink>,
<ulink url="https://github.com/miniupnp/libnatpmp">libnatpmp</ulink>,
<ulink url="https://github.com/bittorrent/libutp">libutp</ulink>, and
<ulink url="https://github.com/miniupnp/miniupnp">miniupnp</ulink>
</para>
<para condition="html" role="usernotes">
Editor Notes: <ulink url="&blfs-wiki;/transmission"/>
</para>
</sect2>
<sect2 role="installation">
<title>Installation of Transmission</title>
<para>
Install <application>Transmission</application> by running the
following commands:
</para>
<screen><userinput>mkdir build &amp;&amp;
cd build &amp;&amp;
cmake -DCMAKE_INSTALL_PREFIX=/usr \
-DCMAKE_BUILD_TYPE=Release \
-DCMAKE_INSTALL_DOCDIR=/usr/share/doc/transmission-&transmission-version; \
.. &amp;&amp;
make</userinput></screen>
<para>
Now, as the <systemitem class="username">root</systemitem> user:
</para>
<screen role="root"><userinput>make install</userinput></screen>
<para>
Next, create transmission.png from the SVG file:
</para>
<screen role="root"><userinput>rsvg-convert \
/usr/share/icons/hicolor/scalable/apps/transmission.svg \
-o /usr/share/pixmaps/transmission.png</userinput></screen>
</sect2>
<sect2 role="commands">
<title>Command Explanations</title>
<para>
<option>-DENABLE_QT=OFF</option>: This switch disables building
the <application>Qt</application> interface. The default is to build it
if &qt5-deps; or <xref linkend="qt6"/> is installed.
</para>
<para>
<option>-DENABLE_GTK=OFF</option>: This switch disables building
the GTK+-3 interface. The default is to build it if
<xref linkend="gtkmm3"/> is installed.
</para>
<para>
<option>-DENABLE_WEB=OFF</option>: This switch disables building
the web client. The default is to build it if <xref linkend="nodejs"/>
is installed.
</para>
<para>
<option>-DREBUILD_WEB=ON</option>: This switch forces rebuilding
the web client. This option needs <xref linkend="nodejs"/> to be
installed as well as an internet connection. The default is to not
rebuild the client.
</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 (contains the web client) and
/usr/share/doc/transmission-&transmission-version;
</seg>
</seglistitem>
</segmentedlist>
<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>
<?dbhtml list-presentation="table"?>
<!-- Not seen in 4.0.4 or 4.0.5
<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 tool 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-based 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>