~ubuntu-core-dev/update-manager/main

« back to all changes in this revision

Viewing changes to help/C/update-manager.xml

  • Committer: Michael Vogt
  • Date: 2005-11-15 13:18:07 UTC
  • Revision ID: egon@top-20051115131807-12fada324eb74180
* initial revision (after accidently killing it)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0"?>
 
2
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
 
3
    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
 
4
  <!ENTITY legal SYSTEM "legal.xml">
 
5
  <!ENTITY GFDL SYSTEM "fdl-appendix.xml">
 
6
]>
 
7
<?yelp:chunk-depth 4?>
 
8
<!--
 
9
      (Do not remove this comment block.)
 
10
  Version: 0.0.3
 
11
  Last modified: March 26, 2005
 
12
  Maintainers:
 
13
               Sean Wheller  <sean@inwords.co.za>
 
14
               Jeff Schering <jeffschering@gmail.com>
 
15
               
 
16
  Translators:
 
17
               (translators put your name and email here)
 
18
-->
 
19
<!-- =============Document Header ============================= -->
 
20
<article id="index" lang="en">
 
21
  <!-- please do not change the id; for translations, change lang to -->
 
22
  <!-- appropriate code -->
 
23
  <articleinfo>
 
24
    <title>Update Manager Manual</title>
 
25
    <copyright>
 
26
      <year>2005</year>
 
27
      <holder>In Words</holder>
 
28
    </copyright>
 
29
    <!-- translators: uncomment this:
 
30
 
 
31
  <copyright>
 
32
   <year>2000</year>
 
33
   <holder>ME-THE-TRANSLATOR (Latin translation)</holder>
 
34
  </copyright>
 
35
 
 
36
  -->
 
37
    <!-- An address can be added to the publisher information.  If a role is
 
38
     not specified, the publisher/author is the same for all versions of the
 
39
     document.  -->
 
40
    <publisher>
 
41
      <!--<publishername> GNOME Documentation Project </publishername>-->
 
42
      <publishername>
 
43
        <ulink url="http://www.inwords.co.za">In Words Techdoc Solutions</ulink>
 
44
      </publishername>
 
45
    </publisher> &legal;
 
46
    <!-- This file  contains link to license for the documentation (GNU FDL), and
 
47
        other legal stuff such as "NO WARRANTY" statement. Please do not change
 
48
        any of this. -->
 
49
    <authorgroup>
 
50
      <author>
 
51
        <firstname>Sean</firstname>
 
52
        <surname>Wheller</surname>
 
53
        <affiliation>
 
54
          <orgname>In Words</orgname>
 
55
          <address>
 
56
            <email>sean@inwords.co.za</email>
 
57
          </address>
 
58
        </affiliation>
 
59
      </author>
 
60
      <othercredit role="editor">
 
61
        <firstname>Jeff</firstname>
 
62
        <surname>Schering</surname>
 
63
        <contrib>Editor</contrib>
 
64
      </othercredit>
 
65
      <!-- This is appropriate place for other contributors: translators,
 
66
      maintainers,  etc. Commented out by default.
 
67
       <othercredit role="translator">
 
68
        <firstname>Latin</firstname>
 
69
        <surname>Translator 1</surname>
 
70
        <affiliation>
 
71
          <orgname>Latin Translation Team</orgname>
 
72
          <address> <email>translator@gnome.org</email> </address>
 
73
        </affiliation>
 
74
        <contrib>Latin translation</contrib>
 
75
      </othercredit>
 
76
-->
 
77
    </authorgroup>
 
78
    <!-- According to GNU FDL, revision history is mandatory if you are -->
 
79
    <!-- modifying/reusing someone else's document.  If not, you can omit it. -->
 
80
    <!-- Remember to remove the &manrevision; entity from the revision entries other
 
81
-->
 
82
    <!-- than the current revision. -->
 
83
    <!-- The revision numbering system for GNOME manuals is as follows: -->
 
84
    <!-- * the revision number consists of two components -->
 
85
    <!-- * the first component of the revision number reflects the release version of the GNOME desktop. -->
 
86
    <!-- * the second component of the revision number is a decimal unit that is incremented with each revision of the manual. -->
 
87
    <!-- For example, if the GNOME desktop release is V2.x, the first version of the manual that -->
 
88
    <!-- is written in that desktop timeframe is V2.0, the second version of the manual is V2.1, etc. -->
 
89
    <!-- When the desktop release version changes to V3.x, the revision number of the manual changes -->
 
90
    <!-- to V3.0, and so on. -->
 
91
    <revhistory>
 
92
      <revision>
 
93
        <revnumber>V0.0.1</revnumber>
 
94
        <date>06/03/2005</date>
 
95
        <revdescription>
 
96
          <para role="author">First version of the manual created in accordance
 
97
            with Update Manager V0.37.1+svn20050301. Documentation Writer
 
98
              <email>sean@inwords.co.za</email>
 
99
          </para>
 
100
          <para role="publisher">
 
101
            <ulink url="http://www.inwords.co.za">InWords Techdoc
 
102
            Solutions</ulink>
 
103
          </para>
 
104
        </revdescription>
 
105
      </revision>
 
106
      <revision>
 
107
        <revnumber>V0.0.2</revnumber>
 
108
        <date>26/03/2005</date>
 
109
        <revdescription>
 
110
          <para role="author">Edit of V0.0.1 to make some nodes shorter.
 
111
            Editor <email>jeffschering@gmail.com</email>
 
112
          </para>
 
113
          <para role="publisher">
 
114
            <ulink url="http://www.inwords.co.za">InWords Techdoc
 
115
              Solutions</ulink>
 
116
          </para>
 
117
        </revdescription>
 
118
      </revision>
 
119
      <revision>
 
120
        <revnumber>V0.0.3</revnumber>
 
121
        <date>26/03/2005</date>
 
122
        <revdescription>
 
123
          <para role="author">Added Help, Add CD, Settings options.
 
124
            <email>sean@inwords.co.za</email>
 
125
          </para>
 
126
          <para role="publisher">
 
127
            <ulink url="http://www.inwords.co.za">InWords Techdoc
 
128
              Solutions</ulink>
 
129
          </para>
 
130
        </revdescription>
 
131
      </revision>
 
132
    </revhistory>
 
133
    <releaseinfo>This manual explains how to use Update Manager an apt update
 
134
      management application for the GNOME desktop created by the Ubuntu Linux
 
135
      project.</releaseinfo>
 
136
    <legalnotice>
 
137
      <title>Feedback</title>
 
138
      <!--<para>To report a bug or make a suggestion regarding this package or this
 
139
        manual, follow the directions in the <ulink url="ghelp:gnome-feedback"
 
140
          type="help">GNOME Feedback Page</ulink>. </para>-->
 
141
      <para>To report a bug or make a suggestion regarding this package or this
 
142
        manual, send mail to <email>ubuntu-users@lists.ubuntu.com</email>.</para>
 
143
      <!-- Translators may also add here feedback address for translations -->
 
144
    </legalnotice>
 
145
  </articleinfo>
 
146
  <!-- ============= Document Body ============================= -->
 
147
  <!-- ============= Introduction ============================== -->
 
148
  <sect1 id="intro">
 
149
    <title>Introduction</title>
 
150
    <para>
 
151
      <application>Update Manager</application> is a graphical interface to the
 
152
      software update features of <application>Advanced Packaging
 
153
      Tool</application> (<acronym>APT</acronym>). <acronym>APT</acronym> is a
 
154
      command line tool for installing, updating, and removing software.</para>
 
155
    <para>
 
156
      <application>Update Manager</application> makes the task of checking for
 
157
      and installing software updates as effortless as possible.
 
158
        <application>Update Manager</application> keeps your system up-to-date
 
159
      by checking Ubuntu's software repositories for new versions of installed
 
160
      software. The new versions usually contain bug fixes and new features, but
 
161
      may also contain security updates. Use Update Manager on a regular basis
 
162
      to ensure that your system is as up-to-date and secure as possible.</para>
 
163
    <para>
 
164
      <application>Update Manager</application> decides which software needs to
 
165
      be updated by comparing the version numbers of individual software files
 
166
      on your computer with the software in one or more software repositories.
 
167
      The software repositories are usually on remote network servers, but may
 
168
      also be on a CD-ROM. Whenever <application>Update Manager</application>
 
169
      notifies you that an update is available, you may choose to install the
 
170
      update immediately, or to ignore the update.</para>
 
171
    <para>
 
172
      <application>Update Manager</application> has settings and preferences
 
173
      which allow you to: set how often it checks for updates, add and remove
 
174
      software repositories, and manage repository authentication keys. </para>
 
175
  </sect1>
 
176
  <sect1 id="getting-started">
 
177
    <title>Getting Started</title>
 
178
    <sect2 id="installation">
 
179
      <title>Installation</title>
 
180
      <para>
 
181
        <application>Update Manager</application> is installed as part of the
 
182
        Ubuntu standard installation, and should already be on your system. The
 
183
        application is known as <application>Ubuntu Update
 
184
        Manager</application>. If you need to install <application>Update
 
185
          Manager</application>, you can use <application>Synaptic Package
 
186
          Manager</application>. Choose <menuchoice>
 
187
          <guimenu>System</guimenu>
 
188
          <guisubmenu>Administration</guisubmenu>
 
189
          <guimenuitem>Synaptic Package Manager</guimenuitem>
 
190
        </menuchoice> to start <application>Synaptic</application>. The package
 
191
        you need to install is <command>update-manager</command>.</para>
 
192
      <para>You may also install Update Manager from the command line using
 
193
          <command>apt-get</command>. To install <application>Update
 
194
        Manager</application> from the command line:</para>
 
195
<programlisting>
 
196
sudo apt-get update-manager
 
197
</programlisting>
 
198
      <para>
 
199
        <application>Update Manager</application> is dependent on the following
 
200
        packages: &apos;python,&apos; &apos;python-gnome2,&apos;
 
201
        &apos;python-apt,&apos; &apos;synaptic,&apos; and
 
202
        &apos;lsb-release.&apos;</para>
 
203
    </sect2>
 
204
    <sect2 id="starting-update-manager">
 
205
      <title>Starting Update Manager</title>
 
206
      <para>Choose <menuchoice>
 
207
          <guimenu>System</guimenu>
 
208
          <guisubmenu>Administration</guisubmenu>
 
209
          <guimenuitem>Ubuntu Update Manager</guimenuitem>
 
210
        </menuchoice> to start the application. Enter your password when
 
211
        prompted.</para>
 
212
      <para>You may also start <application>Update Manager</application> from
 
213
        the command line:</para>
 
214
<programlisting>
 
215
sudo update-manager
 
216
</programlisting>
 
217
    </sect2>
 
218
    <sect2 id="main-window">
 
219
      <title>Main Window</title>
 
220
      <para>The <application>Update Manager</application> main window is used for
 
221
        managing the update process and setting preferences.</para>
 
222
      <para>When you open <application>Update Manager</application>, the main
 
223
        window displays the list of packages that need to be installed to update
 
224
        your computer. If your computer is up-to-date, the main window contains
 
225
        only the message &quot;Your system is up-to-date!&quot; </para>
 
226
      <screenshot>
 
227
        <mediaobject>
 
228
          <imageobject>
 
229
            <imagedata fileref="figures/main-system-updates-available.png"
 
230
              format="PNG"/>
 
231
          </imageobject>
 
232
          <caption>
 
233
            <para>Available Updates</para>
 
234
          </caption>
 
235
        </mediaobject>
 
236
      </screenshot>
 
237
    </sect2>
 
238
  </sect1>
 
239
  <sect1 id="performing-updates">
 
240
    <title>Performing Updates</title>
 
241
    <sect2 id="updating">
 
242
      <title>Updating Your Computer</title>
 
243
      <para>When you open <application>Update Manager</application>, the main
 
244
        window displays the list of packages that need to be installed to update
 
245
        your computer. If your computer is up-to-date, the main window contains
 
246
        only the message &quot;Your system is up-to-date!&quot; </para>
 
247
      <screenshot>
 
248
        <mediaobject>
 
249
          <imageobject>
 
250
            <imagedata fileref="figures/main-system-updates-available.png"
 
251
              format="PNG"/>
 
252
          </imageobject>
 
253
          <caption>
 
254
            <para>Available Updates</para>
 
255
          </caption>
 
256
        </mediaobject>
 
257
      </screenshot>
 
258
      <para>By default, all packages are marked for installation. In most
 
259
        cases you will install all of the packages right away. However, if there 
 
260
        are a large number of updates you may want to do only a few at a time.</para>
 
261
      <para>To deselect a package, <action>uncheck</action> the
 
262
          <guibutton>check box</guibutton> located on the left of each item
 
263
        description. </para>
 
264
      <para>To see additional information about a package, <action>click</action> on the 
 
265
          <guibutton>Details</guibutton> option 
 
266
          (see <xref linkend="expanding-update-info"/>)</para> 
 
267
      <para>When you are ready to install the selected packages, 
 
268
          <action>click</action> the <guibutton>Install</guibutton> button.</para>
 
269
      <para>If <application>Update Manager</application> detects 
 
270
        packages that do not contain a verification signature, the
 
271
          <interface>Summary</interface> dialog will be displayed.</para>
 
272
      <para>The <interface>Summary</interface> dialog lists three groups of update 
 
273
      categories:</para>
 
274
      <variablelist>
 
275
        <varlistentry>
 
276
          <term>
 
277
            <emphasis role="bold">NOT AUTHENTICATED</emphasis>
 
278
          </term>
 
279
          <listitem>
 
280
            <para>If a digital signature is not found for an update package, it is
 
281
              labeled &apos;NOT AUTHENTICATED.&apos;</para>
 
282
          </listitem>
 
283
        </varlistentry>
 
284
        <varlistentry>
 
285
          <term>
 
286
            <emphasis role="bold">To be upgraded</emphasis>
 
287
          </term>
 
288
          <listitem>
 
289
            <para>Packages that will be upgraded.</para>
 
290
          </listitem>
 
291
        </varlistentry>
 
292
        <varlistentry>
 
293
          <term>
 
294
            <emphasis role="bold">Unchanged</emphasis>
 
295
          </term>
 
296
          <listitem>
 
297
            <para>Packages that will not be upgraded due to dependency issues.
 
298
              The packages will be upgraded in a future <application>Update 
 
299
              Manager</application> session, once the developers have
 
300
              resolved the dependencies.</para>
 
301
          </listitem>
 
302
        </varlistentry>
 
303
      </variablelist>
 
304
      <para>This is the final point to check the upgrade before the installation
 
305
        starts. If you are not happy with the upgrade,
 
306
          <action>click</action>
 
307
        <guibutton>Cancel</guibutton> to return to the list and modify the
 
308
        upgrade. If you are happy with the upgrade, <action>click</action>
 
309
        <guibutton>Apply</guibutton>.</para>
 
310
      <note>
 
311
        <para>If a deselected package is required as a dependency for a selected
 
312
          package, <application>Update Manager</application> may install the
 
313
          deselected package to satisfy the dependency.</para>
 
314
      </note>
 
315
      <para>
 
316
        <application>Update Manager</application> will download all of the
 
317
        selected packages before installing them. The entire process may take a
 
318
        long time depending on the amount of data that needs to be downloaded, the
 
319
        speed of your network connection, and the number of packages that need to 
 
320
        be installed. </para>
 
321
      <para>Installation of the update packages will
 
322
        only start once all packages have been downloaded. The
 
323
        download progress can be monitored (see <xref
 
324
          linkend="monitoring-download"/>).</para>
 
325
    </sect2>
 
326
    <sect2 id="expanding-update-info">
 
327
      <title>Expanded Update Information</title>
 
328
      <para>When an item is selected, additional information about an update
 
329
        package and the enhancements it provides can be obtained by expanding
 
330
        the <guibutton>Details</guibutton> option, located at the bottom of the
 
331
        list.</para>
 
332
      <screenshot>
 
333
        <mediaobject>
 
334
          <imageobject>
 
335
            <imagedata fileref="figures/main-view-update-detail.png"/>
 
336
          </imageobject>
 
337
          <caption>
 
338
            <para>Update Item Details</para>
 
339
          </caption>
 
340
        </mediaobject>
 
341
      </screenshot>
 
342
      <para>For each update package the following information is available:</para>
 
343
      <variablelist>
 
344
        <varlistentry>
 
345
          <term>
 
346
            <emphasis role="bold">Changes</emphasis>
 
347
          </term>
 
348
          <listitem>
 
349
            <para>The <guibutton>Changes</guibutton> tab displays the contents
 
350
              of the packages <filename>ChangeLog</filename> file. This enables
 
351
              the user to read about the changes contained in the update
 
352
              package.</para>
 
353
          </listitem>
 
354
        </varlistentry>
 
355
        <varlistentry>
 
356
          <term>
 
357
            <emphasis role="bold">Description</emphasis>
 
358
          </term>
 
359
          <listitem>
 
360
            <para>A single update package may contain multiple programs. These
 
361
              programs are related in some way and are therefore bundled into a
 
362
              single package. The <guibutton>Description</guibutton> tab
 
363
              displays a short description for each program contained by the
 
364
              package.</para>
 
365
          </listitem>
 
366
        </varlistentry>
 
367
      </variablelist>
 
368
    </sect2>
 
369
    <sect2 id="monitoring-download">
 
370
      <title>Monitoring Download Progress</title>
 
371
      <para>When there are many packages in the update list, download can take a
 
372
        considerable amount of time. In this case it can be useful to be able to
 
373
        monitor the download progress.</para>
 
374
      <para>A progress bar is automatically displayed when updates need to be
 
375
        downloaded. <action>Click</action> the <guibutton>Show progress of
 
376
          single files</guibutton> option to display an expanded view of
 
377
        individual file download progress.</para>
 
378
      <screenshot>
 
379
        <mediaobject>
 
380
          <imageobject>
 
381
            <imagedata fileref="figures/download-progressbar.png" format="PNG"/>
 
382
          </imageobject>
 
383
          <caption>
 
384
            <para>Monitoring Download Progress Bar</para>
 
385
          </caption>
 
386
        </mediaobject>
 
387
      </screenshot>
 
388
      <para>Downloaded files are cached locally prior to installation. All files
 
389
        must be downloaded in order for the installation stage to commence. The
 
390
        cached files are automatically removed following successful installation
 
391
        when the <guibutton>Automatically clean temporary packages
 
392
        files</guibutton> option is checked (see <xref
 
393
          linkend="managing-settings"/>).</para>
 
394
      <note>
 
395
        <para>If for any reason the network connection fails or times out, the
 
396
          installation will not proceed. <application>Update
 
397
          Manager</application> will automatically resume the download, from the
 
398
          last successfully downloaded file, on the next attempt.</para>
 
399
      </note>
 
400
    </sect2>
 
401
    <sect2 id="monitoring-installation">
 
402
      <title>Monitoring Installation Progress</title>
 
403
      <para>It is common for software packages to use components belonging to
 
404
        other pieces of software. This creates a dependency in the software that
 
405
        uses external components. For this reason, installation of update
 
406
        packages will only commence once all packages have been successfully
 
407
        downloaded from the software repository (see <xref
 
408
          linkend="monitoring-download"/>). The <application>Update
 
409
        Manager</application> will take care to install packages in the required
 
410
        sequence in order to satisfy any dependencies.</para>
 
411
      <para>Once all update packages are downloaded installation will
 
412
        automatically begin. During installation a progress bar, similar to that
 
413
        of the download progress bar, is displayed.</para>
 
414
      <screenshot>
 
415
        <mediaobject>
 
416
          <imageobject>
 
417
            <imagedata fileref="figures/install-progress.png" format="PNG"/>
 
418
          </imageobject>
 
419
          <caption>
 
420
            <para>Monitoring Installation Progress Bar</para>
 
421
          </caption>
 
422
        </mediaobject>
 
423
      </screenshot>
 
424
      <para>During installation it is possible to view a verbose transcript of
 
425
        installation operations by <action>clicking</action> the
 
426
          <guibutton>Terminal</guibutton> option. This expands the dialog to
 
427
        show terminal view. It is also possible to configure installation
 
428
        progress to use Terminal Mode only, see <xref
 
429
          linkend="configure-terminal-only-view"/>.</para>
 
430
      <screenshot>
 
431
        <mediaobject>
 
432
          <imageobject>
 
433
            <imagedata fileref="figures/install-progress-terminal.png"
 
434
              format="PNG"/>
 
435
          </imageobject>
 
436
          <caption>
 
437
            <para>Monitoring Installation Progress Bar and Terminal View</para>
 
438
          </caption>
 
439
        </mediaobject>
 
440
      </screenshot>
 
441
      <caution>
 
442
        <para>Do not terminate the installation process. This may lead to
 
443
          corruption of installed programs and general system
 
444
        instability.</para>
 
445
      </caution>
 
446
    </sect2>
 
447
  </sect1>
 
448
  <sect1 id="setting-preferences">
 
449
    <title>Setting Preferences</title>
 
450
    <para>The <application>Update Manager</application>
 
451
      <guibutton>Preferences</guibutton> button displays the <interface>Software
 
452
        Preferences</interface> dialog. From this dialog users can perform the
 
453
      following tasks:</para>
 
454
    <itemizedlist>
 
455
      <listitem>
 
456
        <para>Manage software sources (see <xref linkend="managing-sources"
 
457
        />).</para>
 
458
      </listitem>
 
459
      <listitem>
 
460
        <para>Manage authentication keys (see <xref
 
461
            linkend="managing-authentication"/>).</para>
 
462
      </listitem>
 
463
      <listitem>
 
464
        <para>Manage settings (see <xref linkend="managing-settings"/>).</para>
 
465
      </listitem>
 
466
    </itemizedlist>
 
467
    <sect2 id="managing-sources">
 
468
      <title>Managing Software Sources</title>
 
469
      <para>During installation of a distro, software repositories are
 
470
        automatically added to the list of &apos;software sources.&apos;
 
471
        Typical sources added by the distro installation include the
 
472
        installation source, update, and security repositories. Sources can be
 
473
        added to and removed from the list and existing sources can be edited.</para>
 
474
      <note>
 
475
        <para>The operations described here modify <filename class="devicefile"
 
476
            >/etc/apt/sources.list</filename> using the <application>Update
 
477
            Manager</application> graphical user interface. Software sources can
 
478
          also be managed by making direct modifications in <filename
 
479
            class="devicefile">/etc/apt/sources.list</filename>. This is only
 
480
          advised for advanced users.</para>
 
481
      </note>
 
482
      <sect3 id="adding-sources">
 
483
        <title>Adding Software Sources</title>
 
484
        <para>Software may be installed using various access methods:</para>
 
485
        <itemizedlist>
 
486
          <listitem>
 
487
            <para>
 
488
              <emphasis>CD-ROM</emphasis> - Compact Disk Read Only Memory,
 
489
              normally directly connected to the computer system and mounted
 
490
              locally by the operating system.</para>
 
491
          </listitem>
 
492
          <!-- Currently unsupported see http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=60910 -->
 
493
          <!-- mvo: is handled with cdrom URIs -->
 
494
          <!--<listitem>
 
495
            <para>
 
496
              <emphasis>DVD</emphasis> - Digital Video Disk, normally directly
 
497
              connected to the computer system and mounted locally by the
 
498
              operating system.</para>
 
499
          </listitem>-->
 
500
          <listitem>
 
501
            <para>
 
502
              <emphasis>FTP</emphasis> - File Transfer Protocol, a secure and
 
503
              reliable protocol designed specifically for the purpose of
 
504
              transferring large files across the Internet.</para>
 
505
          </listitem>
 
506
          <listitem>
 
507
            <para>
 
508
              <emphasis>HTTP</emphasis> - HyperText Transfer Protocol, commonly
 
509
              used to request and receive Web pages, but can also be used for
 
510
              file transfer.</para>
 
511
          </listitem>
 
512
          <listitem>
 
513
            <para>
 
514
              <emphasis>SMB</emphasis> - Server Management Block is used to
 
515
              access shared resources on computers running Microsoft
 
516
                <trademark>Windows</trademark> or <application>Samba
 
517
              Server</application>.</para>
 
518
          </listitem>
 
519
          <listitem>
 
520
            <para>
 
521
              <emphasis>NFS</emphasis> - Network File System is used to access
 
522
              shared resources on Linux/UNIX computers.</para>
 
523
          </listitem>
 
524
        </itemizedlist>
 
525
        <note>
 
526
          <para>Before software sources residing on SMB or NFS shares can be
 
527
            defined, the share must be mounted by the local system. Access can
 
528
            then be made via the local filesystem. For more information see
 
529
              <xref linkend="editing-sources"/>.</para>
 
530
        </note>
 
531
        <para>A new software source can be defined by <action>clicking</action>
 
532
          the <guibutton>Add</guibutton> button located on the
 
533
            <interface>Software Preferences</interface> dialog. This will
 
534
          display the <interface>Edit Repository</interface> dialog.</para>
 
535
        <screenshot>
 
536
          <mediaobject>
 
537
            <imageobject>
 
538
              <imagedata fileref="figures/preferences-add.png" format="PNG"/>
 
539
            </imageobject>
 
540
            <caption>
 
541
              <para>Adding Software Sources</para>
 
542
            </caption>
 
543
          </mediaobject>
 
544
        </screenshot>
 
545
        <para>Complete the <interface>Edit Repository</interface> dialog to add
 
546
          a new Software source.</para>
 
547
        <variablelist>
 
548
          <varlistentry>
 
549
            <term>
 
550
              <emphasis role="bold">Repository</emphasis>
 
551
            </term>
 
552
            <listitem>
 
553
              <para>A drop-list containing known software sources.</para>
 
554
            </listitem>
 
555
          </varlistentry>
 
556
          <varlistentry>
 
557
            <term>
 
558
              <emphasis role="bold">Components</emphasis>
 
559
            </term>
 
560
            <listitem>
 
561
              <para>The Ubuntu software repository contains thousands of
 
562
                software packages organized into four
 
563
                &apos;components,&apos; on the basis of the level of
 
564
                support we can offer them, and whether or not they comply with
 
565
                Free Software Philosophy. The components are called
 
566
                &apos;main,&apos; &apos;restricted,&apos;
 
567
                &apos;universe,&apos; and
 
568
                &apos;multiverse.&apos;</para>
 
569
              <para>Check the components you wish to include in the update list.</para>
 
570
              <itemizedlist>
 
571
                <listitem>
 
572
                  <para>
 
573
                    <emphasis role="bold">Officially supported (main)</emphasis>
 
574
                    - The main distribution component contains applications that
 
575
                    are free software, can freely be redistributed and are fully
 
576
                    supported by the Ubuntu team. This includes the most popular
 
577
                    and most reliable open source applications available, much
 
578
                    of which is installed by default when you install Ubuntu.
 
579
                    Software in main includes a hand-selected list of
 
580
                    applications that the Ubuntu developers, community, and
 
581
                    users feel are important and that the Ubuntu security and
 
582
                    distribution team are willing to support. When you install
 
583
                    software from the main component you are assured that the
 
584
                    software will come with security updates and technical
 
585
                    support. We believe that the software in main includes
 
586
                    everything most people will need for a fully functional
 
587
                    desktop or Internet server running only open source
 
588
                    software. The licenses for software applications in main
 
589
                    must be free, but main may also may contain binary firmware
 
590
                    and selected fonts that cannot be modified without
 
591
                    permission from their authors. In all cases redistribution
 
592
                    is unencumbered.</para>
 
593
                </listitem>
 
594
                <listitem>
 
595
                  <para>
 
596
                    <emphasis role="bold">Restricted Copyright</emphasis> - The
 
597
                    restricted component is reserved for software that is very
 
598
                    commonly used, and which is supported by the Ubuntu team
 
599
                    even though it is not available under a completely free
 
600
                    license. Please note that it may not be possible to provide
 
601
                    complete support for this software since we are unable to
 
602
                    fix the software ourselves, but can only forward problem
 
603
                    reports to the actual authors. Some software from restricted
 
604
                    will be installed on Ubuntu CDs but is clearly separated to
 
605
                    ensure that it is easy to remove. We include this software
 
606
                    because it is essential in order for Ubuntu to run on
 
607
                    certain machines - typical examples are the binary drivers
 
608
                    that some video card vendors publish, which are the only way
 
609
                    for Ubuntu to run on those machines. By default, we will
 
610
                    only use open source software unless there is simply no
 
611
                    other way to install Ubuntu. The Ubuntu team works with such
 
612
                    vendors to accelerate the open-sourcing of their software to
 
613
                    ensure that as much software as possible is available under
 
614
                    a Free license.</para>
 
615
                </listitem>
 
616
                <listitem>
 
617
                  <para>
 
618
                    <emphasis role="bold">Community maintained
 
619
                    (Universe)</emphasis> - The universe component is a snapshot
 
620
                    of the free, open source, and Linux world. In universe you
 
621
                    can find almost every piece of open source software, and
 
622
                    software available under a variety of less open licenses,
 
623
                    all built automatically from a variety of public sources.
 
624
                    All of this software is compiled against the libraries and
 
625
                    using the tools that form part of main, so it should install
 
626
                    and work well with the software in main, but it comes with
 
627
                    no guarantee of security fixes and support. The universe
 
628
                    component includes thousands of pieces of software. Through
 
629
                    universe, users are able to have the diversity and
 
630
                    flexibility offered by the vast open source world on top of
 
631
                    a stable Ubuntu core.</para>
 
632
                </listitem>
 
633
                <listitem>
 
634
                  <para>
 
635
                    <emphasis role="bold">Non Free (Multiverse)</emphasis> - The
 
636
                    &apos;multiverse&apos; component contains software
 
637
                    that is <emphasis>not free</emphasis>, which means the
 
638
                    licensing requirements of this software do not meet the
 
639
                    Ubuntu &apos;main&apos; Component license Policy.
 
640
                    The onus is on you to verify your rights to use this
 
641
                    software and comply with the licensing terms of the
 
642
                    copyright holder. This software is not supported and usually
 
643
                    cannot be fixed or updated. Use it at your own risk.</para>
 
644
                </listitem>
 
645
              </itemizedlist>
 
646
            </listitem>
 
647
          </varlistentry>
 
648
        </variablelist>
 
649
      </sect3>
 
650
      <sect3 id="create-custom-sources">
 
651
        <title>Creating Custom Software Sources</title>
 
652
        <para>It is also possible to define custom software sources.</para>
 
653
        <para>To define a custom software source <action>click</action> the
 
654
            <guibutton>Custom</guibutton> button located on the <interface>Edit
 
655
            Repository</interface> dialog. This will display a dialog in which
 
656
          the custom repository can be defined using
 
657
          <application>apt</application> command syntax.
 
658
          <application>Apt</application> is an Advanced Packaging Tool and
 
659
          front-end to <application>dpkg</application> the Debian Package
 
660
          Management System. Once the <guilabel>apt line</guilabel> is entered
 
661
            <action>click</action> the <guibutton>Add repository</guibutton>
 
662
          button.</para>
 
663
        <screenshot>
 
664
          <mediaobject>
 
665
            <imageobject>
 
666
              <imagedata fileref="figures/preferences-add-custom.png"
 
667
                format="PNG"/>
 
668
            </imageobject>
 
669
            <caption>
 
670
              <para>Creating Custom Software Sources</para>
 
671
            </caption>
 
672
          </mediaobject>
 
673
        </screenshot>
 
674
        <para>The <application>apt</application> command syntax defines the
 
675
          &apos;type,&apos; &apos;location,&apos; and
 
676
          &apos;content&apos; of the repository. Example of the command
 
677
          syntax could look like this.</para>
 
678
        <programlisting>
 
679
<command>deb ftp://archive.ubuntu.com/ubuntu/ hoary main restricted universe multiverse</command>
 
680
        </programlisting>
 
681
        <para>This example would define the software sources as a Debian source
 
682
          at ubuntu.com containing the hoary release and using all components.
 
683
          For definition of the components, see <xref linkend="managing-sources"
 
684
          />.</para>
 
685
      </sect3>
 
686
      <sect3 id="remove-sources">
 
687
        <title>Removing Software Sources</title>
 
688
        <para>Software sources can be removed from the sources list by selecting
 
689
          the software source then <action>clicking</action> the
 
690
            <guibutton>Remove</guibutton> button located on the
 
691
            <interface>Software Preferences</interface> dialog.</para>
 
692
        <para>Removal of a software source requires that the
 
693
          <application>apt</application> file (<filename class="devicefile"
 
694
            >/etc/apt/sources.list</filename>) that contains the a list of
 
695
          software sources is updated. Before modifying this file
 
696
            <application>Update Manager</application> prompts to confirm the
 
697
          operation. If the operation is confirmed a backup copy is create in
 
698
            <filename class="devicefile"
 
699
        >/etc/apt/sources.list.save</filename>.</para>
 
700
      </sect3>
 
701
      <sect3 id="editing-sources">
 
702
        <title>Editing Software Sources</title>
 
703
        <para>To change the values defining a software source, select the source
 
704
          record then <action>click</action> the edit button. This will display
 
705
          the <interface>Edit Repository</interface> dialog.</para>
 
706
        <screenshot>
 
707
          <mediaobject>
 
708
            <imageobject>
 
709
              <imagedata fileref="figures/preferences-edit.png" format="PNG"/>
 
710
            </imageobject>
 
711
            <caption>
 
712
              <para>Editing Software Sources</para>
 
713
            </caption>
 
714
          </mediaobject>
 
715
        </screenshot>
 
716
        <variablelist>
 
717
          <varlistentry>
 
718
            <term>
 
719
              <emphasis role="bold">Type</emphasis>
 
720
            </term>
 
721
            <listitem>
 
722
              <para>Software sources may contain software in
 
723
                &apos;Binary&apos; or &apos;Source Code&apos;
 
724
                format. Select the option correlating to the repository
 
725
              format.</para>
 
726
            </listitem>
 
727
          </varlistentry>
 
728
          <varlistentry>
 
729
            <term>
 
730
              <emphasis role="bold">URI</emphasis>
 
731
            </term>
 
732
            <listitem>
 
733
              <para>Enter a valid Uniform Resource Indicator
 
734
                (<acronym>URI</acronym>). Following is a list of examples for
 
735
                each of the possible access methods:</para>
 
736
              <itemizedlist>
 
737
                <listitem>
 
738
                  <para>
 
739
                    <!-- mvo: we don't want users to add the cd manually
 
740
                              new CDs with ubuntu will be detected 
 
741
                              automatically when inserted and it will prompt 
 
742
                              for action (start package manager, 
 
743
                              upgrade from it)
 
744
                    *mvo* either the sources edit window needs a "add-cdrom" butotn or the user needs to run synaptic
 
745
                    *froud* I would say add a "Add CDROM"
 
746
                    *mvo* yeah
 
747
                    *mvo* I'll file a wishlist bug to myself
 
748
                    *mvo* update-manger should have "add-cdrom" is bug #7315
 
749
                    -->
 
750
                    <emphasis>CD-ROM</emphasis> -
 
751
                      <command>cdrom:[description_of_cd]/</command>
 
752
                  </para>
 
753
                </listitem>
 
754
                <!-- Currently unsupported see http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=60910 -->
 
755
                <!-- mvo: is handled with cdrom URIs -->
 
756
                <!--<listitem>
 
757
                  <para>
 
758
                    <emphasis>DVD</emphasis> -
 
759
                      <command>dvd:[description_of_dvd]/</command>
 
760
                  </para>
 
761
                </listitem>-->
 
762
                <listitem>
 
763
                  <para>
 
764
                    <emphasis>FTP</emphasis> -
 
765
                      <command>ftp://ftp.domain.ext/path/to/repository</command>
 
766
                  </para>
 
767
                </listitem>
 
768
                <listitem>
 
769
                  <para>
 
770
                    <emphasis>HTTP</emphasis> -
 
771
                      <command>http://www.domain.ext/path/to/repository</command>
 
772
                  </para>
 
773
                </listitem>
 
774
                <listitem>
 
775
                  <para>
 
776
                    <emphasis>SMB</emphasis> - Works only when the computer is
 
777
                    already connected to an SMB share. To connect to SMB share
 
778
                    use the following command syntax from the shell
 
779
                      <command>smbclient //hostname/sharename -U
 
780
                    username</command>. </para>
 
781
                  <para>The SMB share is accessed from the local file system
 
782
                    once the local system is connected.
 
783
                      <command>file://path/to/sharefile</command>
 
784
                  </para>
 
785
                </listitem>
 
786
                <listitem>
 
787
                  <para>
 
788
                    <emphasis>NFS</emphasis> - Works only when the computer is
 
789
                    already connected to a NFS share. To connect the NFS share
 
790
                    must be mounted. NFS shares are mounted on the client side
 
791
                    using the mount command. The format of the command is as
 
792
                    follows: <command>mount -o [options] [host]:[/remote/export]
 
793
                      [/local/directory]</command>
 
794
                  </para>
 
795
                  <para>Once mounted <application>Update Manager</application>
 
796
                    can access the share using the following command
 
797
                      <command>file://path/to/local/directory</command>
 
798
                  </para>
 
799
                </listitem>
 
800
              </itemizedlist>
 
801
              <note>
 
802
                <para>If accessing a SMB or NFS shares by manually issuing the
 
803
                    <command>mount</command> commands, the file system must be
 
804
                  remounted manually after the system is rebooted. Failing to
 
805
                  remount will result in <application>Update
 
806
                  Manager</application> not being able to access the
 
807
                resource.</para>
 
808
              </note>
 
809
            </listitem>
 
810
          </varlistentry>
 
811
          <varlistentry>
 
812
            <term>
 
813
              <emphasis role="bold">Distribution</emphasis>
 
814
            </term>
 
815
            <listitem>
 
816
              <para>The name of the distribution or name of the distribution
 
817
                version.</para>
 
818
            </listitem>
 
819
          </varlistentry>
 
820
          <varlistentry>
 
821
            <term>
 
822
              <emphasis role="bold">Sections</emphasis>
 
823
            </term>
 
824
            <listitem>
 
825
              <para>The section of the distribution repository to access.</para>
 
826
            </listitem>
 
827
          </varlistentry>
 
828
          <varlistentry>
 
829
            <term>
 
830
              <emphasis role="bold">Comment</emphasis>
 
831
            </term>
 
832
            <listitem>
 
833
              <para>Add a comment to describe the repository.</para>
 
834
            </listitem>
 
835
          </varlistentry>
 
836
        </variablelist>
 
837
        <note>
 
838
          <para>Repositories defined using <application>Synaptic</application>,
 
839
            another package management tool, are automatically displayed in the
 
840
              <application>Update Manager</application> Software Sources
 
841
          list.</para>
 
842
        </note>
 
843
      </sect3>
 
844
    </sect2>
 
845
    <sect2 id="managing-authentication">
 
846
      <title>Managing Authentication Keys</title>
 
847
      <para>Authentication keys make it possible to verify the integrity of
 
848
        update software. From the <interface>Authentication Keys</interface>
 
849
        dialog it is possible to view and manage the list authentication keys.
 
850
        Each key corresponds to a Software Source defined in the
 
851
          <interface>Software Preference</interface> dialog (see <xref
 
852
          linkend="managing-sources"/>). Keys can be added and removed. In the
 
853
        event of an error it is also possible to restore the default
 
854
        authentication keys provided by the defined update repositories.</para>
 
855
      <!-- I am not sure how the keys are obtained -->
 
856
      <screenshot>
 
857
        <mediaobject>
 
858
          <imageobject>
 
859
            <imagedata fileref="figures/authentication.png" format="PNG"/>
 
860
          </imageobject>
 
861
          <caption>
 
862
            <para>Managing Authentication Keys</para>
 
863
          </caption>
 
864
        </mediaobject>
 
865
      </screenshot>
 
866
      <sect3 id="adding-auth-keys">
 
867
        <title>Adding Authentication Keys</title>
 
868
        <para>Authentication keys are usually obtained from the software vendor
 
869
          running the repository. Often the vendor will place a copy of the
 
870
          authentication key on a key server, for example <ulink
 
871
            url="http://www.keyserver.net">www.keyserver.net</ulink>. The key
 
872
          can then be retrieved using the command <command>gpg
 
873
          -recv-key</command>. When the key resides on a key server the option
 
874
            <option>--keyserver</option> must be used to give the name of this
 
875
          key server.</para>
 
876
        <programlisting>
 
877
gpg -recv-key --keyserver www.keyserver.net
 
878
        </programlisting>
 
879
        <note>
 
880
          <para>If the key is fetched over a untrusted medium, like the
 
881
            Internet, additional steps should be taken to verify the key. For
 
882
            example, getting the fingerprint with a secure method such as by
 
883
            phone, letter, or business card. Alternately you can check if the
 
884
            key is signed with a known-good key.</para>
 
885
        </note>
 
886
        <para>Once the key is downloaded, select it using the <interface>Choose
 
887
            a key-file</interface> dialog that is displayed when the
 
888
            <guibutton>Add</guibutton> button.</para>
 
889
        <screenshot>
 
890
          <mediaobject>
 
891
            <imageobject>
 
892
              <imagedata fileref="figures/authentication-add.png" format="PNG"/>
 
893
            </imageobject>
 
894
            <caption>
 
895
              <para>Adding Authentication Keys</para>
 
896
            </caption>
 
897
          </mediaobject>
 
898
        </screenshot>
 
899
      </sect3>
 
900
      <sect3 id="remove-auth-keys">
 
901
        <title>Removing Authentication Keys</title>
 
902
        <para>Authentication keys can be removed by selecting a record item then
 
903
            <action>clicking</action> the <guibutton>Remove</guibutton>
 
904
        button.</para>
 
905
      </sect3>
 
906
      <sect3 id="restore-auth-keys">
 
907
        <title>Restoring Default Keys</title>
 
908
        <para>During installation the default Ubuntu Authentication keys are
 
909
          added to the <application>Ubuntu GPG Keyring</application> package. In
 
910
          the even of a key being accidentally deleted it can be restored by
 
911
          clicking the <guibutton>Restore default keys</guibutton>
 
912
        button.</para>
 
913
      </sect3>
 
914
    </sect2>
 
915
    <sect2 id="managing-settings">
 
916
      <title>Managing Settings</title>
 
917
      <para>The <guibutton>Settings</guibutton> button, located on the
 
918
          <interface>Software Preferences</interface> dialog, displays the
 
919
          <interface>Settings</interface> dialog. From this interface users can
 
920
        manage the behavior of the application and pre-update process.</para>
 
921
      <screenshot>
 
922
        <mediaobject>
 
923
          <imageobject>
 
924
            <imagedata fileref="figures/settings.png" format="PNG"/>
 
925
          </imageobject>
 
926
          <caption>
 
927
            <para>Managing Settings</para>
 
928
          </caption>
 
929
        </mediaobject>
 
930
      </screenshot>
 
931
      <para>The following options are available:</para>
 
932
      <itemizedlist>
 
933
        <title>User Interface</title>
 
934
        <listitem>
 
935
          <para>
 
936
            <emphasis>Show disabled software sources:</emphasis> - When checked
 
937
            software sources that are not checked in the <interface>Software
 
938
              Preferences</interface> dialog are displayed. When unchecked,
 
939
            these items are not displayed in the list.</para>
 
940
        </listitem>
 
941
      </itemizedlist>
 
942
      <itemizedlist>
 
943
        <title>Internet Updates</title>
 
944
        <listitem>
 
945
          <para>
 
946
            <itemizedlist>
 
947
              <listitem>
 
948
                <para>
 
949
                  <emphasis>Automatically check for software updates:</emphasis>
 
950
                  - When checked the <guilabel>Update interval in
 
951
                  days</guilabel> option is enabled. <application>Update
 
952
                  Manager</application> will poll all enabled software sources
 
953
                  for updates according to the value specified in the
 
954
                  scroll-box.</para>
 
955
              </listitem>
 
956
              <listitem>
 
957
                <para>
 
958
                  <emphasis>Download upgradable packages:</emphasis> - When
 
959
                  checked <application>Update Manager</application> will
 
960
                  automatically download any available software update packages.
 
961
                  It will not install them until the user has defined the
 
962
                  installation list (see <xref linkend="performing-updates"
 
963
                />).</para>
 
964
              </listitem>
 
965
            </itemizedlist>
 
966
          </para>
 
967
        </listitem>
 
968
      </itemizedlist>
 
969
      <itemizedlist>
 
970
        <title>Temporary files</title>
 
971
        <listitem>
 
972
          <para>
 
973
            <emphasis>Automatically clean temporary packages files:</emphasis> -
 
974
            When checked the <guilabel>Clean interval in days</guilabel> option
 
975
            is enabled. <application>Update Manager</application> automatically
 
976
            removes any temporary files created by the upgrade process according
 
977
            to the value specified in the scroll-box.</para>
 
978
        </listitem>
 
979
        <listitem>
 
980
          <para><emphasis>Set maximum size of the package cache:</emphasis> When checked the size of
 
981
          the package cache is limited to the value specified in the <guibutton>Maximum size in
 
982
            MB</guibutton> spin-box.</para>
 
983
        </listitem>
 
984
        <listitem>
 
985
          <para><emphasis>Delete old packages in the package cache:</emphasis> When checked cached
 
986
            packaged with a date older than the value specified in the <guibutton>Maximum age in
 
987
              days</guibutton> spin-box will be automatically purged from the cache.</para>
 
988
        </listitem>
 
989
      </itemizedlist>
 
990
    </sect2>
 
991
    <sect2 id="configure-terminal-only-view">
 
992
      <title>Install Progress for Terminal View Only</title>
 
993
      <para>It is also possible to configure the installation progress to use
 
994
        only a terminal view. That is to say, no progress bar is displayed, only
 
995
        a terminal view.</para>
 
996
      <screenshot>
 
997
        <mediaobject>
 
998
          <imageobject>
 
999
            <imagedata fileref="figures/main-view-monitor-update.png"
 
1000
              format="PNG"/>
 
1001
          </imageobject>
 
1002
          <caption>
 
1003
            <para>Monitoring Installation Progress</para>
 
1004
          </caption>
 
1005
        </mediaobject>
 
1006
      </screenshot>
 
1007
      <caution>
 
1008
        <para>Do not terminate the installation process. This may lead to
 
1009
          corruption of installed programs and general system
 
1010
        instability.</para>
 
1011
      </caution>
 
1012
      <para>Changing between &apos;Progress Bar&apos; and
 
1013
        &apos;Terminal View,&apos; modes is managed via
 
1014
          <application>Synaptic</application>. To change modes proceed as
 
1015
        follows:</para>
 
1016
      <procedure>
 
1017
        <step>
 
1018
          <para>Start <application>Synaptic</application> by selecting <menuchoice>
 
1019
              <guimenu>System</guimenu>
 
1020
              <guisubmenu>Administration</guisubmenu>
 
1021
              <guimenuitem>Synaptic Package Manager</guimenuitem>
 
1022
            </menuchoice> from the Desktop menu system. </para>
 
1023
        </step>
 
1024
        <step>
 
1025
          <para>When prompted, enter your password.</para>
 
1026
        </step>
 
1027
        <step>
 
1028
          <para>From the main menu, select <menuchoice>
 
1029
              <guimenu>Settings</guimenu>
 
1030
              <guimenuitem>Preferences</guimenuitem>
 
1031
            </menuchoice>. The <interface>Preferences</interface> dialog is
 
1032
            displayed.</para>
 
1033
        </step>
 
1034
        <step>
 
1035
          <para>From the <guibutton>General</guibutton> tab, <guilabel>Apply
 
1036
              Changes</guilabel> group, <action>check</action> or
 
1037
              <action>uncheck</action> the <guibutton>Apply changes in terminal
 
1038
              window</guibutton> checkbox.</para>
 
1039
          <screenshot>
 
1040
            <mediaobject>
 
1041
              <imageobject>
 
1042
                <imagedata fileref="figures/synaptic-toggle-install-view.png"
 
1043
                  format="PNG"/>
 
1044
              </imageobject>
 
1045
              <caption>
 
1046
                <para>Synaptic Preferences - General Tab</para>
 
1047
              </caption>
 
1048
            </mediaobject>
 
1049
          </screenshot>
 
1050
        </step>
 
1051
        <step>
 
1052
          <para>
 
1053
            <action>Click</action>
 
1054
            <guibutton>OK</guibutton> and exit
 
1055
            <application>Synaptic</application>.</para>
 
1056
        </step>
 
1057
      </procedure>
 
1058
    </sect2>
 
1059
  </sect1>
 
1060
  <sect1 id="about">
 
1061
    <title>About Update Manager</title>
 
1062
    <para>The <application>Update Manager</application> was written by Michiel
 
1063
      Sikkes <email>michiel@eyeopened.nl</email> and Michael Vogt
 
1064
        <email>michael.vogt@ubuntu.com</email> as an
 
1065
      <application>apt</application> update manager for the GNOME Desktop of the
 
1066
      Ubuntu Linux distribution. The user manual was written by Sean Wheller
 
1067
        <email>sean@inwords.co.za</email>.</para>
 
1068
    <para>To report a bug or make a suggestion regarding this package or this
 
1069
      manual, send mail to <email>ubuntu-users@lists.ubuntu.com</email>.</para>
 
1070
  </sect1> &GFDL; </article>