~ubuntu-branches/ubuntu/saucy/aptoncd/saucy-proposed

« back to all changes in this revision

Viewing changes to help/C/features.xml

  • Committer: Bazaar Package Importer
  • Author(s): Fabrice Coutadeur
  • Date: 2009-08-17 22:04:26 UTC
  • mfrom: (1.1.1 upstream) (0.1.11 jaunty)
  • Revision ID: james.westby@ubuntu.com-20090817220426-bhxr3a21ff6y8edm
Tags: 0.1.98+bzr109-0.1
* Non-maintainer upload
* New upstream release (Closes: #452205, #423480, #433915, #541047, #427003,
  #493647, #484636)
* debian/control: 
  - Changed python build dependencies to Build-Depends-Indep
  - Moved url from Description to Homepage
  - Changed Standards-Version to 3.8.2
  - Changed Maintainer to myself
  - Deleted dependency on deprecated mkisofs 
  - Deleted recommend of nautilus-cd-burner
* debian/copyright: Changed (C) to © to make lintian happy
* debian/rules: 
  - deleted deprecated dh_desktop
  - added get-orig-source target to get the latest source from lp
* data/aptoncd.desktop.in: Fixed error and deprecated values in Desktop file

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<section id="features">
 
2
<title>Features</title>
 
3
<para>&aoc; features can be divided into two main categories. Basically, the <emphasis>Create</emphasis> category is used to create 
 
4
a CD/DVD repository with packages previously downloaded with apt-get tools while the <emphasis>Restore</emphasis> category has functions related 
 
5
to restoring packages using the previously created &aoc; media (as a local repository).</para>
 
6
 
 
7
<itemizedlist>
 
8
        <listitem><para>Create</para>
 
9
                <itemizedlist>
 
10
                <listitem><para><link linkend="create">Create &aoc;</link></para></listitem>
 
11
                <listitem><para><link linkend="download">Download repositories</link></para></listitem>
 
12
                </itemizedlist>
 
13
        </listitem>
 
14
        
 
15
        <listitem><para>Restore</para>
 
16
                <itemizedlist>
 
17
                <listitem><para><link linkend="restore-aoc">Restore from APTonCD</link></para></listitem>
 
18
                <listitem><para><link linkend="restore-iso">Restore .iso image</link></para></listitem>
 
19
                <listitem><para><link linkend="restore-repo">Add CD/DVD</link></para></listitem>
 
20
                </itemizedlist>
 
21
        </listitem>
 
22
 
 
23
</itemizedlist>
 
24
 
 
25
 
 
26
<!-- -->
 
27
        <section id="create">
 
28
                <title>Create &aoc;</title>
 
29
                
 
30
                <sec2>
 
31
                        <title>Action</title>
 
32
                        <para>Create a removable repository with all packages downloaded with Synaptic, apt-get or aptitude.</para>
 
33
                </sec2>
 
34
                
 
35
                <sec2>
 
36
                <title>Features</title>
 
37
                <para>
 
38
                        
 
39
                        <varlistentry>
 
40
                                <term><guimenuitem>Select packages</guimenuitem></term>
 
41
                                <listitem><para>By default, all packages saved in the /var/cache/apt/archives/ directory are listed and the latest versions are checked. 
 
42
                                You can choose which packages won't be saved on the &aoc; media by just un-checking them from this list. 
 
43
                                When you remove a package the total file size is automatically updated.</para>
 
44
                                
 
45
                                <para> When in the package list screen, a right mouse click will bring up options for quick manipulation of the selections.
 
46
                                All of the packages may be selected or deselected and the current selection list can be inverted.
 
47
                                'Remove package' tidies up the list by no longer displaying that package.
 
48
                                Control-click and shift click are not supported. </para>
 
49
                                <para>To find a package, to save having to scroll through a long list of packages, a search box is provided.  This will
 
50
                                pop-up when you start typing in the package list window and will show the first partial match.  To find
 
51
                                the next matching occurence press the down arrow.</para>
 
52
                                <para> </para>
 
53
                                </listitem>
 
54
                        </varlistentry>
 
55
                        
 
56
                        <varlistentry>
 
57
                                <term><guimenuitem>Add packages</guimenuitem></term>
 
58
                                <listitem><para>It's possible to add other deb packages inside the &aoc; media, even those that weren't installed using 
 
59
                                the apt-get tools. There are two ways to do this: </para>
 
60
                                <para>You can use the <guibutton>Add Package...</guibutton> button,  
 
61
                                then find and open the deb package you want to add.  Within the 'Add package' window, you can use Ctrl-click and Shift-click
 
62
                                to select multiple packages.</para>
 
63
                                <para>The other way to add packages is to simply drag-and-drop the package from <application>Nautilus</application> to the &aoc; window.  
 
64
                      It's possible to add multiple packages at same time using either method.
 
65
                                </para>
 
66
                                <para> </para>
 
67
                                </listitem>
 
68
                        </varlistentry>
 
69
                
 
70
                        <varlistentry>
 
71
                                <term><guimenuitem>Destination folder</guimenuitem></term>
 
72
                                <listitem><para>The image generated by &aoc; is saved in the /home/USER directory by default. You can change 
 
73
                                this using the 'destination folder' option to select another place to save the files. 
 
74
APTonCD doesn't allow you to select a directory where you have not permission to write.</para>
 
75
                                <para> </para>
 
76
                                </listitem>
 
77
                        </varlistentry>
 
78
                
 
79
                        <varlistentry>
 
80
                                <term><guimenuitem>Burn image</guimenuitem></term>
 
81
                                <listitem><para>When an &aoc; image is successfully created, an option is displayed to burn this image onto the previously 
 
82
                                selected media. If you prefer, you can burn it later using your favorite program.</para></listitem>
 
83
                        </varlistentry>
 
84
                                
 
85
                </para>
 
86
                </sec2> 
 
87
                
 
88
                <sec2>
 
89
                <title>Options</title>
 
90
                <para>
 
91
                                                
 
92
                        <varlistentry>
 
93
                                <term><guimenuitem>Media Type</guimenuitem></term>
 
94
                                <listitem><para>You can choose what type of media is created. The options are CD (690 MB) and DVD (4500MB). 
 
95
                                If the total size of the packages is bigger than the media capacity, 
 
96
                                &aoc; will automatically split it up into the necessary number of files (you can see this number above 
 
97
                                the package box, along with the total number of files and total file size).</para>
 
98
                                <para>The required number of CDs (or DVDs) is shown below the package list screen. This switches between CD 
 
99
                                or DVD count based on the option selected.
 
100
                                </para>
 
101
                        
 
102
                        <!-- Insert file  screenshot-create_APTonCD.png  here 
 
103
                                <mediaobject>
 
104
                                        <imageobject>
 
105
                                        <imagedata fileref="images/screenshot-create_APTonCD.png" format="PNG"/>
 
106
                                        </imageobject>
 
107
                                        <textobject>Creating package screen</textobject>
 
108
                                        </mediaobject> -->
 
109
 
 
110
                                        <para> </para>  
 
111
                                </listitem>
 
112
                        </varlistentry>
 
113
                         
 
114
                        <varlistentry>
 
115
                                <term><guimenuitem>Filename</guimenuitem></term>
 
116
                                <listitem><para>If the filename is left blank, by default &aoc; images are named using the the follow format: 'aptoncd-yyyymmdd-MMX.iso' where (yyyy)
 
117
                                is the year, (mm) the month and (dd) the day. (MM) denotes the chosen media, which can be 'CD' or 'DVD' and X stands for
 
118
                                the number of the image if more than one media is created. For example: aptoncd-20061030-CD1.
 
119
                                You can choose a different filename for the image(s) using the file box - this replaces the 
 
120
                                'aptoncd' part of the name.</para>
 
121
                                <para></para>
 
122
                                <para> </para>
 
123
                                </listitem>
 
124
                        </varlistentry>
 
125
                
 
126
                        <varlistentry>
 
127
                                <term><guimenuitem>Metapackage</guimenuitem></term>
 
128
                                <listitem><para>The Metapackage option creates a package named 'aptoncd-metapackage' that includes all of the other packages on 
 
129
                                the APTonCD media as dependencies. It's useful for easily restoring all packages along with their dependencies, 
 
130
                                so you can just install the metapackage instead of installing
 
131
                                each package by hand. The default is to have this selected.</para>
 
132
                        <para> </para>
 
133
                        </listitem>
 
134
                        </varlistentry>
 
135
                        
 
136
                        <varlistentry id="autodependencies">
 
137
                                <term><guimenuitem>Auto-select dependencies</guimenuitem></term>
 
138
                                <listitem><para>This option guarantees that all dependencies of a package are selected. 
 
139
                                The default is selected.</para>
 
140
                                <para> </para>
 
141
                                </listitem>
 
142
                        </varlistentry>
 
143
                        
 
144
                        <varlistentry id="oldversions">
 
145
                                <term><guimenuitem>Insert old versions of the same same package</guimenuitem></term>
 
146
                                <listitem><para>This option enables &aoc; to include several versions of same package on the media. 
 
147
                                If it is selected together with the 'Metapackage' option, just the newer version of each 
 
148
                                package is included in the metapackage.</para>
 
149
                                <para> </para>
 
150
                                </listitem>
 
151
                        </varlistentry>
 
152
                </para>
 
153
                </sec2> 
 
154
                <para>(<link linkend="features">back to top</link>)</para>
 
155
        </section>
 
156
        
 
157
        <!-- -->
 
158
        
 
159
        <!-- -->
 
160
        <section id="download">
 
161
                <title>Download repositories (Unstable!)</title>
 
162
                <emphasis>The Download Repository module is a little unstable in this release. It was 
 
163
disabled in the APTonCD GUI and only can be called by command line (--download). Use with your own risk.</emphasis>
 
164
                <sec2>
 
165
                        <title>Action</title>
 
166
                        <para>This downloads complete Ubuntu repositories from the internet,
 
167
                         creating locally stored versions on CD, DVD or iso image files.</para>
 
168
                        <para>Given the size of some of the repositories this may take 
 
169
                        a long time, even with a fast internet connection.  It is not recommended from a dial-up modem connection.</para>
 
170
                        <para>Any of the standard Ubuntu repositories may be downloaded - Main, Restricted, Universe or Multiverse. 
 
171
                        At the moment, &aoc; does not support downloading unofficial repositories</para>
 
172
                </sec2>
 
173
                
 
174
                <sec2 id="download-features">
 
175
                <title>Features</title>
 
176
                <para>
 
177
                                
 
178
                        <varlistentry>
 
179
                                <term><guimenuitem>Autodetection</guimenuitem></term>
 
180
                                <listitem><para> &aoc; detects automatically the distribution and version of your operational system
 
181
                                and also the architecture of your computer. This information will be used as option defaults, 
 
182
                                but you can easily change them if you want to.</para><para> </para></listitem>
 
183
                        </varlistentry>
 
184
                        
 
185
                                <varlistentry>
 
186
                                <term><guimenuitem>Download resume</guimenuitem></term>
 
187
                                <listitem><para> If the repository download is interrupted for whatever reason, 
 
188
                                if you run it again, the download will resume from where it left off.  
 
189
                                Packages that were successfully downloaded before the interruption won't be downloaded again.</para><para> </para></listitem>
 
190
                        </varlistentry>
 
191
                        
 
192
                        <varlistentry>
 
193
                                <term><guimenuitem>Download progress</guimenuitem></term>
 
194
                                <listitem><para> During the download a progress window is displayed 
 
195
                                showing the total file size of the download, the number of files downloaded (including the file currently being
 
196
                                downloaded, total number of files in the download and the estimated time remaining.  The progress of individual 
 
197
                                files can also be shown.</para></listitem>
 
198
                        </varlistentry>
 
199
                
 
200
                
 
201
                
 
202
                </para>
 
203
                </sec2> 
 
204
                
 
205
                <sec2>
 
206
                <title>Options</title>
 
207
                <para>
 
208
                        
 
209
                        
 
210
                        <varlistentry>
 
211
                                <term><guimenuitem>Distribution</guimenuitem></term>
 
212
                                <listitem><para> &aoc; can download Ubuntu or Debian repositories 
 
213
                                (the default option is the system you're using).</para>
 
214
                                <para> </para>
 
215
                                </listitem>
 
216
                        </varlistentry>
 
217
                
 
218
                        <varlistentry>
 
219
                                <term><guimenuitem>Version</guimenuitem></term>
 
220
                                <listitem><para>You can select the Ubuntu (or Debian) version you want to download. 
 
221
                                All Ubuntu versions that are officially supported are listed.</para>
 
222
                                <para> </para>
 
223
                                </listitem>
 
224
                        </varlistentry>
 
225
                        
 
226
                        <varlistentry>
 
227
                                <term><guimenuitem>Architecture</guimenuitem></term>
 
228
                                <listitem><para> &aoc; allows you to download repositories available for 
 
229
                                several architectures: i386, amd64, powerpc and sparc. 
 
230
                                You don't need to change any of the selections, unless you know exactly what you're doing :-).</para> 
 
231
                                <para> </para>
 
232
                                </listitem>
 
233
                        </varlistentry>
 
234
                        
 
235
                        <varlistentry>
 
236
                                <term><guimenuitem>Sections</guimenuitem></term>
 
237
                                <listitem><para>You can choose multiples repositories to download. If you're using Ubuntu 
 
238
                                the options are: main, restricted, universe and multiverse.</para><para> </para></listitem>
 
239
 
 
240
                        </varlistentry>
 
241
                        
 
242
                        <varlistentry>
 
243
                                <term><guimenuitem>Advanced options - Method</guimenuitem></term>
 
244
                                <listitem><para>&aoc; can download repositories using two methods: http or ftp. Http is the default 
 
245
                                and unless you experience some connection problems you don't need to change this option.</para><para> </para></listitem>
 
246
 
 
247
                        </varlistentry>
 
248
                        
 
249
                        <varlistentry>
 
250
                                <term><guimenuitem>Advanced options - Mirror</guimenuitem></term>
 
251
                                <listitem><para>Ubuntu and Debian repositories are distributed among several mirrors. 
 
252
                                By default Universal is selected but you can choose a closer mirror (and the download will probably
 
253
                                be faster). Once you select a different mirror &aoc; stores your preference for
 
254
                                future downloads.</para> <para> </para></listitem>
 
255
                                        
 
256
                        </varlistentry>
 
257
                        
 
258
                        <varlistentry>
 
259
                                <term><guimenuitem>Advanced options - Media Type</guimenuitem></term>
 
260
                                <listitem><para>You can choose what type of media is created. 
 
261
                                The options are CD (690 MB) and DVD (4500MB). If the total size of the packages 
 
262
                                is bigger than the media capacity, APTonCD will automatically split it up into 
 
263
                                the necessary number of files.</para>
 
264
                                <para>As the package sizes are in the Gigabytes, it's recommended that you use DVD's.</para>                            
 
265
                                        <para> </para>
 
266
                                </listitem>
 
267
 
 
268
                        </varlistentry>
 
269
 
 
270
                        <varlistentry>
 
271
                                <term><guimenuitem>Advanced options - Temp directory</guimenuitem></term>
 
272
                                <listitem><para>The temp directory is used by &aoc; to store the downloaded files.
 
273
                                 </para>                        
 
274
                                        <para> </para>  
 
275
                                </listitem>
 
276
 
 
277
                        </varlistentry>
 
278
                        
 
279
                </para>
 
280
                </sec2> 
 
281
                <para>(<link linkend="features">back to top</link>)</para>
 
282
        </section>
 
283
        
 
284
        <!-- -->
 
285
        <section id="restore-aoc">
 
286
                <title>Restore APTonCD</title>
 
287
                <sec2>
 
288
                        <title>Action</title>
 
289
                        <para>Restore from media (CD or DVD) created by &aoc;</para>
 
290
                        <para>
 
291
                        <para><emphasis>Notes:</emphasis></para>
 
292
                        <itemizedlist>
 
293
                                <listitem><para>This action requires administrative privileges.</para></listitem>
 
294
                                <listitem><para>It's not possible to restore from an &aoc; media created using a different distribution/version 
 
295
                                                from the one you're using now.  If the media is a downloaded repository, the version downloaded must match the operating system version
 
296
                                                you are using.</para></listitem>
 
297
                        </itemizedlist>
 
298
                        </para>
 
299
                </sec2>
 
300
                
 
301
                <sec2>
 
302
                <title>Features</title>
 
303
                <para>
 
304
                        <varlistentry>
 
305
                                <term><guimenuitem>Open media</guimenuitem></term>
 
306
                                <listitem><para>The first step is to put the CD/DVD created by &aoc; in the drive.</para>
 
307
                                <para> </para></listitem>
 
308
                        </varlistentry>
 
309
                
 
310
                        <varlistentry>
 
311
                                <term><guimenuitem>Select packages</guimenuitem></term>
 
312
                                <listitem><para>When the media is read, a list showing all available packages that can be restored is displayed. 
 
313
                                By default all packages are selected, but you can just un-check the packages you don't want to restore.  If you just 
 
314
                                wish to restore one package, right click in the package window and select uncheck all, then select the package you want.</para>
 
315
                                <para>To find a particular package, to save having to scroll through a long list of packages, a search box is provided.  This will
 
316
                                pop-up when you start typing in the package list window and will show the first partial match.  To find
 
317
                                the next matching occurence press the down arrow.</para>
 
318
                                <para> </para>
 
319
                                </listitem>
 
320
                        </varlistentry>
 
321
                
 
322
                        <varlistentry>
 
323
                                <term><guimenuitem>Copy files</guimenuitem></term>
 
324
                                <listitem><para>The selected packages are copied from the &aoc; media to the /var/cache/apt/archives/ directory. 
 
325
                                This way the packages are available and can be installed using apt-get, aptitude or synaptic without needing to download them.</para>
 
326
                                <para> </para>
 
327
                                </listitem>
 
328
                        </varlistentry>
 
329
                </para>
 
330
                </sec2>
 
331
                        
 
332
                <sec2>
 
333
                <title>Options</title>
 
334
                <para>  
 
335
                        <varlistentry>
 
336
                                <term><guimenuitem>Insert old versions of the same same package</guimenuitem></term>
 
337
                                <listitem><para>By default just the newer versions of packages are restored. If you want to include old versions, just check
 
338
                                the option below the packages' list. 
 
339
                                <para>Refer to how to put old versions on an &aoc; media <link linkend="oldversions">here</link>.</para>
 
340
                                </para>
 
341
                                <para> </para>
 
342
                                </listitem>
 
343
                        </varlistentry>
 
344
                        
 
345
                        <varlistentry>
 
346
                                <term><guimenuitem>Auto-select dependencies</guimenuitem></term>
 
347
                                <listitem><para>This option guarantees that all dependencies of the selected packages are also selected to be restored.
 
348
                                <para>To see how to auto-select dependencies when creating an &aoc; media, refer <link linkend="autodependencies">here</link>.</para>
 
349
                                </para>
 
350
                                </listitem>
 
351
                        </varlistentry>
 
352
                
 
353
                </para>
 
354
                </sec2>
 
355
                <para>(<link linkend="features">back to top</link>)</para>
 
356
        </section>
 
357
        
 
358
        
 
359
        <!-- -->
 
360
        <section id="restore-iso">
 
361
                <title>Restore .iso image</title>
 
362
                <sec2>
 
363
                        <title>Action</title>
 
364
                        <para>Restore an ISO image created by &aoc;, similar to <link linkend="restore-aoc">Restore APTonCD</link> option.</para>
 
365
                        <para>
 
366
                        <para><emphasis>Notes:</emphasis></para>
 
367
                        <itemizedlist>
 
368
                                <listitem><para>This action requires administrative privileges.</para></listitem>
 
369
                                <listitem><para>It's not possible to restore from an &aoc; image created using a different distribution/version 
 
370
                                                from the one you're using now.  If the image is a downloaded repository, the version downloaded must match the operating system version
 
371
                                                you are using.</para></listitem>
 
372
                        </itemizedlist>
 
373
                        </para>
 
374
                </sec2>
 
375
                
 
376
                <sec2>
 
377
                <title>Features</title>
 
378
                        <para>
 
379
                                <varlistentry>
 
380
                                        <term><guimenuitem>Open image</guimenuitem></term>
 
381
                                        <listitem><para>The first step is to find and select the .iso file you want to restore.</para>
 
382
                                        <para> </para>
 
383
                                        </listitem>
 
384
                                </varlistentry>
 
385
                        
 
386
                                <varlistentry>
 
387
                                        <term><guimenuitem>Select packages</guimenuitem></term>
 
388
                                        <listitem><para>When you select and open an image it's shown as a list of all packages available to restore. 
 
389
                                        By default all packages are selected, but you can just un-check the packages you don't want to restore.
 
390
                                        If you just wish to restore one package, right click in the package window and select uncheck all, then select the package you want.</para>
 
391
                                <para> </para></listitem>
 
392
                                </varlistentry>
 
393
                        
 
394
                                <varlistentry>
 
395
                                        <term><guimenuitem>Copy files</guimenuitem></term>
 
396
                                        <listitem><para>When you restore an ISO image created by &aoc; the image is mounted and then all the selected packages 
 
397
                                        are copied back to the /var/cache/apt/archives/ directory. This way the packages are available and you can install 
 
398
                                        them using apt-get, aptitude or synaptic without needing to     download them.</para></listitem>
 
399
                                </varlistentry>
 
400
                        </para>
 
401
                </sec2>
 
402
                
 
403
                <sec2>
 
404
                <title>Options</title>  
 
405
                        <para>
 
406
                                <varlistentry>
 
407
                                        <term><guimenuitem>Insert old versions of the same same package</guimenuitem></term>
 
408
                                        <listitem><para>By default just the newer versions of packages are restored. If you want to include old versions just check
 
409
                                        the option above the packages' list. 
 
410
                                        <para>See also how to put old versions inside an &aoc; media <link linkend="oldversions">here</link>.</para>
 
411
                                        </para>
 
412
                                        <para> </para></listitem>
 
413
                                </varlistentry>
 
414
                                
 
415
                                <varlistentry>
 
416
                                        <term><guimenuitem>Auto-select dependencies</guimenuitem></term>
 
417
                                        <listitem><para>This option guarantees that all dependencies of the selected packages are also selected for restoration.
 
418
                                        <para>Also see how to auto-select dependencies when creating an &aoc; media <link linkend="autodependencies">here</link>.</para>
 
419
                                        </para>
 
420
                                        </listitem>
 
421
                                </varlistentry> 
 
422
                        
 
423
                        </para>
 
424
                </sec2> 
 
425
                <para>(<link linkend="features">back to top</link>)</para>
 
426
        </section>
 
427
        
 
428
        <!-- -->
 
429
        <section id="restore-repo">
 
430
                <title>Add CD/DVD</title>
 
431
                <sec2>
 
432
                        <title>Action</title>
 
433
                        <para>Add a CD/DVD created by &aoc; as a repository for apt-get tools.  This adds the CD/DVD so that it can
 
434
                        subsequently be used as an off-line software source.
 
435
                        <para></para>
 
436
                        <para><emphasis>Note:</emphasis> This action requires administrative privileges.</para>
 
437
                        </para>
 
438
                </sec2>
 
439
                
 
440
                <sec2>
 
441
                <title>Features</title>
 
442
                <para>
 
443
                        <varlistentry>
 
444
                                <term><guimenuitem>Add as repository v's Restore &aoc; or .iso image</guimenuitem></term>
 
445
                                <listitem><para>The main difference between "Add a CD/DVD as repository" and <link linkend="restore-aoc">restore &aoc; 
 
446
                                </link> (or<link linkend="restore-iso"> restore .iso image</link>) is that using either of the restore options, all packages are copied back to 
 
447
                                the hard disk while, in the first case (Add CD/DVD), the packages are read directly from the CD/DVD when you use an apt-tool to install 
 
448
                                packages.
 
449
                                </para>
 
450
                                <para> </para>
 
451
                                </listitem>
 
452
                        </varlistentry>
 
453
                
 
454
                        <varlistentry>
 
455
                                <term><guimenuitem>Open media</guimenuitem></term>
 
456
                                <listitem><para>The first step is to put the CD/DVD created by &aoc; in the drive.</para>
 
457
                                <para> </para></listitem>
 
458
                        </varlistentry>
 
459
                
 
460
                </para>
 
461
                </sec2>
 
462
                
 
463
                <para>(<link linkend="features">back to top</link>)</para>      
 
464
        </section>
 
465
 
 
466
 
 
467
 
 
468
<!-- -->
 
469
<!-- 
 
470
 -->
 
471
</section>