« back to all changes in this revision
Viewing changes to doc/en/index.docbook
- browse files at revision 1
- compare with another revision
- download diff
- download tarball
- view history from revision 1
- Committer: Bazaar Package Importer
- Author(s): Anthony Mercatante
- Date: 2006-01-20 11:26:41 UTC
- Revision ID: james.westby@ubuntu.com-20060120112641-xd1rmv568k0vvz3u
Tags: upstream-0.2.5
Import upstream version 0.2.5
- files added:
- admin
- doc
- doc/en
- icons
- po
- src
added
removed
doc/en/index.docbook
1
<?xml version="1.0" ?>
2
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.1.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
3
<!ENTITY ksweeper "<application>KSweeper 0.1.9</application>">
4
<!ENTITY kappname "&ksweeper;"><!-- Do *not* replace kappname-->
5
<!ENTITY package "kde-module"><!-- kdebase, kdeadmin, etc -->
6
<!ENTITY % addindex "IGNORE">
7
<!ENTITY % English "INCLUDE"><!-- change language only here -->
8
9
10
<!-- Do not define any other entities; instead, use the entities
11
from kde-genent.entities and $LANG/user.entities. -->
12
]>
13
<!-- kdoctemplate v0.8 October 1 1999
14
Minor update to "Credits and Licenses" section on August 24, 2000
15
Removed "Revision history" section on 22 January 2001
16
Changed to Installation/Help menu entities 18 October 2001
17
Other minor cleanup and changes 18 October 2001 -->
18
19
20
<!--
21
This template was designed by: David Rugge davidrugge@mindspring.com
22
with lots of help from: Eric Bischoff ebisch@cybercable.tm.fr
23
and Frederik Fouvry fouvry@sfs.nphil.uni-tuebingen.de
24
of the KDE DocBook team.
25
26
You may freely use this template for writing any sort of KDE documentation.
27
If you have any changes or improvements, please let us know.
28
29
Remember:
30
- in XML, the case of the <tags> and attributes is relevant ;
31
- also, quote all attributes.
32
33
Please don't forget to remove all these comments in your final documentation,
34
thanks ;-).
35
-->
36
37
<!-- ................................................................ -->
38
39
<!-- The language must NOT be changed here. -->
40
41
<book lang="&language;">
42
43
<!-- This header contains all of the meta-information for the document such
44
as Authors, publish date, the abstract, and Keywords -->
45
46
<bookinfo>
47
<title>The &ksweeper; Handbook</title>
48
49
<authorgroup>
50
<author>
51
<firstname>Pawel</firstname>
52
<othername></othername>
53
<surname>Stolowski</surname>
54
<affiliation>
55
<address><email>pawel.stolowski@wp.pl</email></address>
56
</affiliation>
57
</author>
58
</authorgroup>
59
60
<!-- TRANS:ROLES_OF_TRANSLATORS -->
61
62
<copyright>
63
<year>2005</year>
64
<holder>Pawel Stolowski</holder>
65
</copyright>
66
<!-- Translators: put here the copyright notice of the translation -->
67
<!-- Put here the FDL notice. Read the explanation in fdl-notice.docbook
68
and in the FDL itself on how to use it. -->
69
<legalnotice>&FDLNotice;</legalnotice>
70
71
<!-- Date and version information of the documentation
72
Don't forget to include this last date and this last revision number, we
73
need them for translation coordination !
74
Please respect the format of the date (YYYY-MM-DD) and of the version
75
(V.MM.LL), it could be used by automation scripts.
76
Do NOT change these in the translation. -->
77
78
<date>2001-10-18</date>
79
<releaseinfo>0.1</releaseinfo>
80
81
<!-- Abstract about this handbook -->
82
83
<abstract>
84
<para>
85
&ksweeper; allows you to reclaim disk space by finding unneeded files using various search criterias.
86
</para>
87
</abstract>
88
89
<keywordset>
90
<keyword>KDE</keyword>
91
<keyword>KSweeper</keyword>
92
<keyword>system</keyword>
93
<keyword>disk</keyword>
94
</keywordset>
95
96
</bookinfo>
97
98
<!-- The contents of the documentation begin here. Label
99
each chapter so with the id attribute. This is necessary for two reasons: it
100
allows you to easily reference the chapter from other chapters of your
101
document, and if there is no ID, the name of the generated HTML files will vary
102
from time to time making it hard to manage for maintainers and for the CVS
103
system. Any chapter labelled (OPTIONAL) may be left out at the author's
104
discretion. Other chapters should not be left out in order to maintain a
105
consistent documentation style across all KDE apps. -->
106
107
<chapter id="introduction">
108
<title>Introduction</title>
109
110
<!-- The introduction chapter contains a brief introduction for the
111
application that explains what it does and where to report
112
problems. Basically a long version of the abstract. Don't include a
113
revision history. (see installation appendix comment) -->
114
115
<para>
116
&ksweeper; allows you to reclaim disk space by finding unneeded files. It can
117
search for files basing on several criterias; you can seek for:
118
119
<itemizedlist>
120
<listitem><para>empty files</para></listitem>
121
<listitem><para>backup files</para></listitem>
122
<listitem><para>broken symbolic links</para></listitem>
123
<listitem><para>dead menu entries (.desktop files pointing to non-existing executables)</para></listitem>
124
<listitem><para>duplicated files</para></listitem>
125
<listitem><para>orphaned files (files not found in RPM database)</para></listitem>
126
<listitem><para>obsolete thumbnails (thumbnails conforming to freedesktop.org standard, pointing to
127
non-existing pictures) - requires 'identify' from ImageMagick</para></listitem>
128
</itemizedlist>
129
130
</para>
131
</chapter>
132
133
<chapter id="using-ksweeper">
134
<title>Using &ksweeper;</title>
135
136
<!-- This chapter should tell the user how to use your app. You should use as
137
many sections (Chapter, Sect1, Sect3, etc...) as is necessary to fully document
138
your application. -->
139
140
<para>
141
142
<screenshot>
143
<screeninfo>Here's a screenshot of &ksweeper;</screeninfo>
144
<mediaobject>
145
<imageobject>
146
<imagedata fileref="screenshot.png" format="PNG"/>
147
</imageobject>
148
<textobject>
149
<phrase>Screenshot</phrase>
150
</textobject>
151
</mediaobject>
152
</screenshot>
153
</para>
154
155
156
<sect1 id="ksweeper-features">
157
<title>More &ksweeper; features</title>
158
159
<para>It slices! It dices! and it comes with a free toaster!</para>
160
<para>
161
The Squiggle Tool <guiicon><inlinemediaobject>
162
<imageobject>
163
<imagedata fileref="squiggle.png" format="PNG"/>
164
</imageobject>
165
<textobject>
166
<phrase>Squiggle</phrase>
167
</textobject>
168
</inlinemediaobject></guiicon> is used to draw squiggly lines all over
169
the &ksweeper; main window. It's not a bug, it's a feature!
170
</para>
171
</sect1>
172
173
<sect1 id="ksweeper-start">
174
<title>Choosing what files to find</title>
175
<para>
176
</para>
177
</sect1>
178
179
<sect1 id="ksweeper-results">
180
<title>Browsing the results</title>
181
<para>
182
</para>
183
</sect1>
184
185
<sect1 id="ksweeper-archiving">
186
<title>Archiving and deleting files</title>
187
<para>
188
</para>
189
</sect1>
190
</chapter>
191
192
<chapter id="commands">
193
<title>Command Reference</title>
194
195
<!-- (OPTIONAL, BUT RECOMMENDED) This chapter should list all of the
196
application windows and their menubar and toolbar commands for easy reference.
197
Also include any keys that have a special function but have no equivalent in the
198
menus or toolbars. This may not be necessary for small apps or apps with no tool
199
or menu bars. -->
200
201
<sect1 id="ksweeper-mainwindow">
202
<title>The main &ksweeper; window</title>
203
204
<sect2>
205
<title>The File Menu</title>
206
<para>
207
<variablelist>
208
<varlistentry>
209
<term><menuchoice>
210
<shortcut>
211
<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
212
</shortcut>
213
<guimenu>File</guimenu>
214
<guimenuitem>New</guimenuitem>
215
</menuchoice></term>
216
<listitem><para><action>Creates a new document</action></para></listitem>
217
</varlistentry>
218
<varlistentry>
219
<term><menuchoice>
220
<shortcut>
221
<keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo>
222
</shortcut>
223
<guimenu>File</guimenu>
224
<guimenuitem>Save</guimenuitem>
225
</menuchoice></term>
226
<listitem><para><action>Saves the document</action></para></listitem>
227
</varlistentry>
228
<varlistentry>
229
<term><menuchoice>
230
<shortcut>
231
<keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
232
</shortcut>
233
<guimenu>File</guimenu>
234
<guimenuitem>Quit</guimenuitem>
235
</menuchoice></term>
236
<listitem><para><action>Quits</action> &ksweeper;</para></listitem>
237
</varlistentry>
238
</variablelist>
239
</para>
240
241
</sect2>
242
243
<sect2>
244
<title>The <guimenu>Help</guimenu> Menu</title>
245
246
<!-- Assuming you have a standard help menu (help, what's this, about -->
247
<!-- &ksweeper;, about KDE) then the documentation is already written. -->
248
<!-- The following entity is valid anywhere that a variablelist is -->
249
<!-- valid. -->
250
251
&help.menu.documentation;
252
253
</sect2>
254
255
</sect1>
256
</chapter>
257
258
<chapter id="faq">
259
<title>Questions and Answers</title>
260
261
&reporting.bugs;
262
&updating.documentation;
263
264
<qandaset id="faqlist">
265
<qandaentry>
266
<question>
267
<para>My Mouse doesn't work. How do I quit &ksweeper;?</para>
268
</question>
269
<answer>
270
<para>You silly goose! Check out the <link linkend="commands">Commands
271
Section</link> for the answer.</para>
272
</answer>
273
</qandaentry>
274
<qandaentry>
275
<question>
276
<para>Why can't I twiddle my documents?</para>
277
</question>
278
<answer>
279
<para>You can only twiddle your documents if you have the foobar.lib
280
installed.</para>
281
</answer>
282
</qandaentry>
283
</qandaset>
284
</chapter>
285
286
<chapter id="credits">
287
288
<!-- Include credits for the programmers, documentation writers, and
289
contributors here. The license for your software should then be included below
290
the credits with a reference to the appropriate license file included in the KDE
291
distribution. -->
292
293
<title>Credits and License</title>
294
295
<para>
296
&ksweeper;
297
</para>
298
<para>
299
Program copyright 2005 Pawel Stolowski <email>pawel.stolowski@wp.pl</email>
300
</para>
301
<para>
302
Contributors:
303
<itemizedlist>
304
<listitem><para>Konqui the KDE Dragon <email>konqui@kde.org</email></para>
305
</listitem>
306
<listitem><para>Tux the Linux Penguin <email>tux@linux.org</email></para>
307
</listitem>
308
</itemizedlist>
309
</para>
310
311
<para>
312
Documentation copyright 2005 Pawel Stolowski <email>pawel.stolowski@wp.pl</email>
313
</para>
314
315
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
316
317
&underFDL; <!-- FDL: do not remove -->
318
319
<!-- Determine which license your application is licensed under,
320
and delete all the remaining licenses below:
321
322
(NOTE: All documentation are licensed under the FDL,
323
regardless of what license the application uses) -->
324
325
&underGPL; <!-- GPL License -->
326
&underBSDLicense; <!-- BSD License -->
327
&underArtisticLicense; <!-- BSD Artistic License -->
328
&underX11License; <!-- X11 License -->
329
330
</chapter>
331
332
<appendix id="installation">
333
<title>Installation</title>
334
335
<sect1 id="getting-ksweeper">
336
<title>How to obtain &ksweeper;</title>
337
338
<!-- This first entity contains boiler plate for applications that are
339
part of KDE CVS. You should remove it if you are releasing your
340
application -->
341
342
&install.intro.documentation;
343
344
</sect1>
345
346
<sect1 id="requirements">
347
<title>Requirements</title>
348
349
<!--
350
List any special requirements for your application here. This should include:
351
.Libraries or other software that is not included in kdesupport,
352
kdelibs, or kdebase.
353
.Hardware requirements like amount of RAM, disk space, graphics card
354
capabilities, screen resolution, special expansion cards, etc.
355
.Operating systems the app will run on. If your app is designed only for a
356
specific OS, (you wrote a graphical LILO configurator for example) put this
357
information here.
358
-->
359
360
<para>
361
In order to successfully use &ksweeper;, you need &kde; 1.1. Foobar.lib is
362
required in order to support the advanced &ksweeper; features. &ksweeper; uses
363
about 5 megs of memory to run, but this may vary depending on your
364
platform and configuration.
365
</para>
366
367
<para>
368
All required libraries as well as &ksweeper; itself can be found
369
on <ulink url="ftp://ftp.ksweeper.org">The &ksweeper; home page</ulink>.
370
</para>
371
372
<!-- For a list of updates, you may refer to the application web site
373
or the ChangeLog file, or ... -->
374
<para>
375
You can find a list of changes at <ulink
376
url="http://apps.kde.org/ksweeper">http://apps.kde.org/ksweeper</ulink>.
377
</para>
378
</sect1>
379
380
<sect1 id="compilation">
381
<title>Compilation and Installation</title>
382
383
<!-- This entity contains the boilerplate text for standard -->
384
<!-- compilation instructions. If your application requires any -->
385
<!-- special handling, remove it, and replace with your own text. -->
386
387
&install.compile.documentation;
388
389
</sect1>
390
391
<sect1 id="configuration">
392
<title>Configuration</title>
393
394
<para>Don't forget to tell your system to start the <filename>dtd</filename>
395
dicer-toaster daemon first, or &ksweeper; won't work !</para>
396
397
</sect1>
398
399
</appendix>
400
401
&documentation.index;
402
</book>
403
404
<!--
405
Local Variables:
406
mode: sgml
407
sgml-minimize-attributes:nil
408
sgml-general-insert-case:lower
409
sgml-indent-step:0
410
sgml-indent-data:nil
411
End:
412
413
vim:tabstop=2:shiftwidth=2:expandtab
414
-->
415
Loggerhead is a web-based interface for Breezy
Version: 2.0.1