source: xsoft/other/transmission.xml

trunk
Last change on this file was 5866da0, checked in by Bruce Dubbs <bdubbs@…>, 6 weeks ago

General cleanup.

Remove a bunch of unneeded xml comments.
Remove refereces to qt5 where qt6 can be used.

  • Property mode set to 100644
File size: 9.9 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY transmission-download-http "https://github.com/transmission/transmission/releases/download/&transmission-version;/transmission-&transmission-version;.tar.xz">
8 <!ENTITY transmission-download-ftp " ">
9 <!ENTITY transmission-md5sum "d3cda868215246644c429b18a30f7e47">
10 <!ENTITY transmission-size "9.2 MB">
11 <!ENTITY transmission-buildsize "229 MB (with both GUI interfaces)">
12 <!ENTITY transmission-time "2.3 SBU (with both GUI interfaces; using parallelism=4)">
13]>
14
15<sect1 id="transmission" xreflabel="Transmission-&transmission-version;">
16 <?dbhtml filename="transmission.html"?>
17
18
19 <title>Transmission-&transmission-version;</title>
20
21 <indexterm zone="transmission">
22 <primary sortas="a-Transmission">Transmission</primary>
23 </indexterm>
24
25 <sect2 role="package">
26 <title>Introduction to Transmission</title>
27
28 <para>
29 <application>Transmission</application> is a cross-platform, open source
30 BitTorrent client. This is useful for downloading large files (such as
31 Linux ISOs) and reduces the need for the distributors to provide server
32 bandwidth.
33 </para>
34
35 &lfs121_checked;
36
37 <bridgehead renderas="sect3">Package Information</bridgehead>
38 <itemizedlist spacing="compact">
39 <listitem>
40 <para>
41 Download (HTTP): <ulink url="&transmission-download-http;"/>
42 </para>
43 </listitem>
44 <listitem>
45 <para>
46 Download (FTP): <ulink url="&transmission-download-ftp;"/>
47 </para>
48 </listitem>
49 <listitem>
50 <para>
51 Download MD5 sum: &transmission-md5sum;
52 </para>
53 </listitem>
54 <listitem>
55 <para>
56 Download size: &transmission-size;
57 </para>
58 </listitem>
59 <listitem>
60 <para>
61 Estimated disk space required: &transmission-buildsize;
62 </para>
63 </listitem>
64 <listitem>
65 <para>
66 Estimated build time: &transmission-time;
67 </para>
68 </listitem>
69 </itemizedlist>
70
71
72 <bridgehead renderas="sect3">Transmission Dependencies</bridgehead>
73
74 <bridgehead renderas="sect4">Required</bridgehead>
75 <para role="required">
76 <xref linkend="curl"/>
77 </para>
78
79 <bridgehead renderas="sect4">Recommended</bridgehead>
80 <para role="recommended">
81 <xref linkend="libevent"/> and
82 <xref linkend="libpsl"/>
83 (to use system libraries instead of bundled ones)
84 </para>
85
86 <bridgehead renderas="sect4">Recommended (to build a GUI)</bridgehead>
87 <para role="recommended">
88 <xref linkend="gtkmm4"/> or
89 <xref linkend="qt6"/>
90 </para>
91
92 <bridgehead renderas="sect4">Optional</bridgehead>
93 <para role="optional">
94 <xref linkend="nodejs"/> (for building the web client, not needed at run time),
95 <ulink url="https://github.com/ubuntu/gnome-shell-extension-appindicator">appindicator</ulink>,
96 <ulink url="https://github.com/jech/dht">dht</ulink>,
97 <ulink url="https://github.com/libb64/libb64">libb64</ulink>,
98 <ulink url="https://github.com/ebiggers/libdeflate">libdeflate</ulink>,
99 <ulink url="https://github.com/miniupnp/libnatpmp">libnatpmp</ulink>,
100 <ulink url="https://github.com/bittorrent/libutp">libutp</ulink>, and
101 <ulink url="https://github.com/miniupnp/miniupnp">miniupnp</ulink>
102 </para>
103
104 <para condition="html" role="usernotes">
105 Editor Notes: <ulink url="&blfs-wiki;/transmission"/>
106 </para>
107 </sect2>
108
109 <sect2 role="installation">
110 <title>Installation of Transmission</title>
111
112 <para>
113 Install <application>Transmission</application> by running the
114 following commands:
115 </para>
116
117<screen><userinput>mkdir build &amp;&amp;
118cd build &amp;&amp;
119
120cmake -DCMAKE_INSTALL_PREFIX=/usr \
121 -DCMAKE_BUILD_TYPE=Release \
122 -DCMAKE_INSTALL_DOCDIR=/usr/share/doc/transmission-&transmission-version; \
123 .. &amp;&amp;
124
125make</userinput></screen>
126
127
128 <para>
129 Now, as the <systemitem class="username">root</systemitem> user:
130 </para>
131
132<screen role="root"><userinput>make install</userinput></screen>
133
134 <para>
135 Next, create transmission.png from the SVG file:
136 </para>
137
138<screen role="root"><userinput>rsvg-convert \
139 /usr/share/icons/hicolor/scalable/apps/transmission.svg \
140 -o /usr/share/pixmaps/transmission.png</userinput></screen>
141
142 </sect2>
143
144 <sect2 role="commands">
145 <title>Command Explanations</title>
146
147 <para>
148 <option>-DENABLE_QT=OFF</option>: This switch disables building
149 the <application>Qt</application> interface. The default is to build it
150 if &qt5-deps; or <xref linkend="qt6"/> is installed.
151 </para>
152
153 <para>
154 <option>-DENABLE_GTK=OFF</option>: This switch disables building
155 the GTK-4 interface. The default is to build it if
156 <xref linkend="gtkmm4"/> is installed.
157 </para>
158
159 <para>
160 <option>-DENABLE_WEB=OFF</option>: This switch disables building
161 the web client. The default is to build it if <xref linkend="nodejs"/>
162 is installed.
163 </para>
164
165 <para>
166 <option>-DREBUILD_WEB=ON</option>: This switch forces rebuilding
167 the web client. This option needs <xref linkend="nodejs"/> to be
168 installed as well as an internet connection. The default is to not
169 rebuild the client.
170 </para>
171 </sect2>
172
173 <sect2 role="content">
174 <title>Contents</title>
175
176 <segmentedlist>
177 <segtitle>Installed Programs</segtitle>
178 <segtitle>Installed Libraries</segtitle>
179 <segtitle>Installed Directory</segtitle>
180
181 <seglistitem>
182 <seg>
183 <!--transmission-cli,-->
184 transmission-create,
185 transmission-daemon,
186 transmission-edit,
187 transmission-gtk,
188 transmission-qt,
189 transmission-remote, and
190 transmission-show
191 </seg>
192 <seg>
193 None
194 </seg>
195 <seg>
196 /usr/share/transmission (contains the web client) and
197 /usr/share/doc/transmission-&transmission-version;
198 </seg>
199 </seglistitem>
200 </segmentedlist>
201
202 <variablelist>
203 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
204 <?dbfo list-presentation="list"?>
205 <?dbhtml list-presentation="table"?>
206
207<!-- Not seen in 4.0.4 or 4.0.5
208 <varlistentry id="transmission-cli">
209 <term><command>transmission-cli</command></term>
210 <listitem>
211 <para>
212 is a lightweight, command line BitTorrent client with scripting
213 capabilities
214 </para>
215 <indexterm zone="transmission transmission-cli">
216 <primary sortas="b-transmission-cli">transmission-cli</primary>
217 </indexterm>
218 </listitem>
219 </varlistentry>
220-->
221
222 <varlistentry id="transmission-create">
223 <term><command>transmission-create</command></term>
224 <listitem>
225 <para>
226 is a command line tool used to create .torrent files
227 </para>
228 <indexterm zone="transmission transmission-create">
229 <primary sortas="b-transmission-create">transmission-create</primary>
230 </indexterm>
231 </listitem>
232 </varlistentry>
233
234 <varlistentry id="transmission-daemon">
235 <term><command>transmission-daemon</command></term>
236 <listitem>
237 <para>
238 is a daemon-based Transmission session that can be controlled via
239 RPC commands from Transmission's web interface or
240 <command>transmission-remote</command>
241 </para>
242 <indexterm zone="transmission transmission-daemon">
243 <primary sortas="b-transmission-daemon">transmission-daemon</primary>
244 </indexterm>
245 </listitem>
246 </varlistentry>
247
248 <varlistentry id="transmission-edit">
249 <term><command>transmission-edit</command></term>
250 <listitem>
251 <para>
252 is a command line tool to modify .torrent files' announce URLs
253 </para>
254 <indexterm zone="transmission transmission-edit">
255 <primary sortas="b-transmission-edit">transmission-edit</primary>
256 </indexterm>
257 </listitem>
258 </varlistentry>
259
260 <varlistentry id="transmission-gtk">
261 <term><command>transmission-gtk</command></term>
262 <listitem>
263 <para>
264 is a GTK+ bittorrent client
265 </para>
266 <indexterm zone="transmission transmission-gtk">
267 <primary sortas="b-transmission-gtk">transmission-gtk</primary>
268 </indexterm>
269 </listitem>
270 </varlistentry>
271
272 <varlistentry id="transmission-qt">
273 <term><command>transmission-qt</command></term>
274 <listitem>
275 <para>
276 is a Qt-based bittorrent client
277 </para>
278 <indexterm zone="transmission transmission-qt">
279 <primary sortas="b-transmission-qt">transmission-qt</primary>
280 </indexterm>
281 </listitem>
282 </varlistentry>
283
284 <varlistentry id="transmission-remote">
285 <term><command>transmission-remote</command></term>
286 <listitem>
287 <para>
288 is a remote control utility for transmission-daemon and transmission
289 </para>
290 <indexterm zone="transmission transmission-remote">
291 <primary sortas="b-transmission-remote">transmission-remote</primary>
292 </indexterm>
293 </listitem>
294 </varlistentry>
295
296 <varlistentry id="transmission-show">
297 <term><command>transmission-show</command></term>
298 <listitem>
299 <para>
300 is a command line tool to display bittorrent .torrent file metadata
301 </para>
302 <indexterm zone="transmission transmission-show">
303 <primary sortas="b-transmission-show">transmission-show</primary>
304 </indexterm>
305 </listitem>
306 </varlistentry>
307
308 </variablelist>
309
310 </sect2>
311
312</sect1>
Note: See TracBrowser for help on using the repository browser.