~ubuntu-branches/ubuntu/hoary/kdemultimedia/hoary

« back to all changes in this revision

Viewing changes to doc/kscd/index.docbook

  • Committer: Bazaar Package Importer
  • Author(s): Martin Schulze
  • Date: 2003-01-22 15:00:51 UTC
  • Revision ID: james.westby@ubuntu.com-20030122150051-uihwkdoxf15mi1tn
Tags: upstream-2.2.2
ImportĀ upstreamĀ versionĀ 2.2.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0" ?>
 
2
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.1-Based Variant V1.0//EN" "dtd/kdex.dtd" [
 
3
  <!ENTITY kappname "&kscd;">
 
4
  <!ENTITY % English "INCLUDE" > <!-- change language only here -->
 
5
  <!ENTITY % addindex "IGNORE">
 
6
]>
 
7
 
 
8
<book lang="&language;">
 
9
 
 
10
<bookinfo>
 
11
<title>The &kscd; Handbook</title>
 
12
 
 
13
<authorgroup>
 
14
 
 
15
<author>
 
16
<firstname>Jonathan</firstname>
 
17
<surname>Singer</surname>
 
18
<affiliation><address><email>jsinger@leeta.net</email></address></affiliation>
 
19
</author>
 
20
 
 
21
<author>
 
22
<firstname>David</firstname>
 
23
<surname>White</surname>
 
24
<affiliation><address><email>a9403784@unet.univie.ac.at</email></address>
 
25
</affiliation>
 
26
</author>
 
27
 
 
28
<othercredit role="developer">
 
29
<firstname>Bernd</firstname>
 
30
<othername>Johannes</othername>
 
31
<surname>Wuebben</surname>
 
32
<affiliation><address><email>wuebben@kde.org</email></address></affiliation>
 
33
<contrib>Developer</contrib>
 
34
</othercredit>
 
35
 
 
36
<othercredit role="developer">
 
37
<firstname>Dirk</firstname>
 
38
<surname>Forsterling</surname>
 
39
<affiliation><address><email>milliByte@gmx.net</email></address></affiliation>
 
40
<contrib>Developer</contrib>
 
41
</othercredit>
 
42
 
 
43
<othercredit role="developer">
 
44
<firstname>Dirk</firstname>
 
45
<surname>Foersterling</surname>
 
46
<affiliation><address><email>milliByte@gmx.net</email></address></affiliation>
 
47
<contrib>Developer</contrib>
 
48
</othercredit>
 
49
 
 
50
<othercredit role="reviewer">
 
51
<firstname>Lauri</firstname>
 
52
<surname>Watts</surname>
 
53
<affiliation><address><email>vampyr@atconnex.net</email></address></affiliation>
 
54
<contrib>Reviewer</contrib>
 
55
</othercredit>
 
56
<!-- TRANS:ROLES_OF_TRANSLATORS -->
 
57
</authorgroup>
 
58
 
 
59
<copyright>
 
60
<year>2000-2001</year>
 
61
<holder>J Singer</holder>
 
62
</copyright>
 
63
 
 
64
<legalnotice>&FDLNotice;</legalnotice>
 
65
  
 
66
 
 
67
<date>2001-07-19</date>
 
68
<releaseinfo>1.03.02</releaseinfo>
 
69
 
 
70
<abstract>
 
71
<para>&kscd; is a small, fast, <abbrev>CDDB</abbrev> enabled audio
 
72
<abbrev>CD</abbrev> player for Unix platforms.</para>
 
73
</abstract>
 
74
 
 
75
<keywordset>
 
76
<keyword>KDE</keyword>
 
77
<keyword>kdemultimedia</keyword>
 
78
<keyword>kscd</keyword>
 
79
<keyword>music</keyword>
 
80
<keyword>CD</keyword>
 
81
<keyword>audio</keyword>
 
82
</keywordset>
 
83
 
 
84
</bookinfo>
 
85
 
 
86
<chapter id="introduction">
 
87
<title>Introduction</title>
 
88
 
 
89
<para>&kscd; is a fast, <acronym>CDDB</acronym>cddb enabled &CD; player for the Unix
 
90
platform. &kscd; stands for <quote>The KDE Project's small/simple &CD;
 
91
player</quote>.</para>
 
92
 
 
93
<para><emphasis>New</emphasis>: the <filename>workman2cddb.pl</filename> Perl
 
94
script provided in order to facilitate transition for users of workman.</para>
 
95
 
 
96
<para>I hope you will enjoy this &CD; player.</para>
 
97
 
 
98
<para>Bernd Johannes Wuebben</para>
 
99
 
 
100
<para><email>wuebben@kde.org</email></para>
 
101
 
 
102
<sect1 id="supported-platforms">
 
103
<title>Supported Platforms</title>
 
104
 
 
105
<para>&kscd; explicitly supports the following platforms:</para>
 
106
 
 
107
<itemizedlist>
 
108
<listitem><para>Linux</para></listitem>
 
109
<listitem><para>FreeBSD</para></listitem>
 
110
<listitem><para>NetBSD</para></listitem>
 
111
<listitem><para>BSD386</para></listitem>
 
112
<listitem><para>Sun</para></listitem>
 
113
<listitem><para>&Solaris; (including <acronym>cdda</acronym>
 
114
support)</para></listitem>
 
115
<listitem><para>&HP-UX;</para></listitem>
 
116
<listitem><para>&SGI; Irix (including <abbrev>cdda</abbrev>
 
117
support)</para></listitem>
 
118
<listitem><para>Sony NEWS</para></listitem>
 
119
<listitem><para>OSF/1</para></listitem>
 
120
<listitem><para>Ultrix</para></listitem>
 
121
</itemizedlist>
 
122
 
 
123
<para>and should compile on many others with few modifications.</para>
 
124
 
 
125
</sect1>
 
126
 
 
127
</chapter>
 
128
 
 
129
<chapter id="onscreen-fundamentals">
 
130
<title>Onscreen fundamentals</title>
 
131
 
 
132
<sect1 id="basic-operation">
 
133
<title>Basic Operation</title>
 
134
 
 
135
<screenshot>
 
136
<screeninfo>The &kscd; Interface</screeninfo>
 
137
<mediaobject>
 
138
<imageobject>
 
139
<imagedata fileref="kscd.png" format="PNG"/></imageobject>
 
140
<textobject><phrase>The &kscd; Interface</phrase></textobject>
 
141
</mediaobject>
 
142
</screenshot>
 
143
 
 
144
<para>This is the main window of &kscd;. You should see something like this when
 
145
you start &kscd;. The controls in this window are explained below, in no
 
146
particular order.</para>
 
147
 
 
148
<sect2 id="control-panel">
 
149
<title>The Control Panel</title>
 
150
 
 
151
<screenshot>
 
152
<screeninfo>The Control Panel</screeninfo>
 
153
<mediaobject>
 
154
<imageobject><imagedata fileref="kscd2.png" format="PNG"/></imageobject>
 
155
<textobject><phrase>The Control Panel</phrase></textobject>
 
156
</mediaobject>
 
157
</screenshot>
 
158
 
 
159
<para> This is the main control panel for &kscd;. The function of these buttons
 
160
should be familiar to anyone who has ever used a &CD; player.</para>
 
161
 
 
162
<para>The uppermost button in the above diagram toggles between playing and
 
163
pausing the &CD;. The left button in the second row stops playing the &CD;. The
 
164
right button in the second row toggles looping, so that the &CD; will start
 
165
playing again from the beginning when the end of the last audio track is
 
166
reached. The buttons in the third row advance the &CD; backward (left) or
 
167
forward (right) 30 seconds. The two buttons under the status display skip forward (right)
 
168
or backward (left) to the beginning of the next or previous track. </para>
 
169
</sect2>
 
170
 
 
171
<sect2 id="eject">
 
172
<title>The <guibutton>Eject</guibutton> button</title>
 
173
 
 
174
<screenshot>
 
175
<screeninfo>The <guibutton>Eject</guibutton> button</screeninfo>
 
176
<mediaobject>
 
177
<imageobject><imagedata fileref="kscd2a.png" format="PNG"/></imageobject>
 
178
<textobject><phrase>The Eject button</phrase></textobject>
 
179
</mediaobject>
 
180
</screenshot>
 
181
 
 
182
<para>This button ejects the &CD;. Note that the eject button on your &CD-ROM;
 
183
drive may not respond if an audio &CD; is in the drive and &kscd; is
 
184
started. Some very old &CD-ROM; drives may not support software eject. You may
 
185
also have to close the &CD-ROM; drive manually after inserting a new
 
186
disc.</para>
 
187
</sect2>
 
188
 
 
189
<sect2 id="status-display">
 
190
<title>The Status Display</title>
 
191
 
 
192
<screenshot>
 
193
<screeninfo>The Status Display</screeninfo>
 
194
<mediaobject>
 
195
<imageobject><imagedata fileref="kscd3.png" format="PNG"/></imageobject>
 
196
<textobject><phrase>The Status Display</phrase></textobject>
 
197
</mediaobject>
 
198
</screenshot>
 
199
 
 
200
<para>This is the status display. Starting at the top, from right to left, is
 
201
the main time display (see below for a discussion of the various possible time
 
202
display modes), the status of the &CD-ROM; drive, the total play time of the
 
203
audio &CD;, the current volume setting, and the current and maximum track
 
204
numbers (curr./max.). The bottommost two lines of text display the artist and
 
205
title of the &CD;, and then the title of the track, assuming that appropriate
 
206
entries exist in the local or network <acronym>CDDB</acronym> (&CD; Data
 
207
Base.)</para>
 
208
 
 
209
</sect2>
 
210
 
 
211
<sect2 id="time-display-modes">
 
212
<title>Time display modes</title>
 
213
 
 
214
<screenshot>
 
215
<screeninfo>The Time Display toggle</screeninfo>
 
216
<mediaobject>
 
217
<imageobject><imagedata fileref="kscd4.png" format="PNG"/></imageobject>
 
218
<textobject><phrase>The Time Display toggle</phrase></textobject>
 
219
</mediaobject>
 
220
</screenshot>
 
221
 
 
222
<para>This button toggles between the possible main time display modes. By
 
223
default, &kscd; displays the elapsed time of the current track, if the &CD; is
 
224
playing, or either &ndash;&ndash;:&ndash;&ndash; or 00:00 if the &CD; is not playing.
 
225
Pressing this button toggles in sequence between remaining track time, total
 
226
elapsed time, and total remaining time.</para>
 
227
</sect2>
 
228
 
 
229
<sect2 id="configuration-button">
 
230
<title>The <guibutton>Configuration</guibutton> button</title>
 
231
 
 
232
<screenshot>
 
233
<screeninfo>The Configuration button</screeninfo>
 
234
<mediaobject>
 
235
<imageobject><imagedata fileref="kscd5.png" format="PNG"/></imageobject>
 
236
<textobject><phrase>The Configuration button</phrase></textobject>
 
237
</mediaobject>
 
238
</screenshot>
 
239
 
 
240
<para>This button opens the &kscd; configuration panel. This allows you to
 
241
configure &kscd; to work on your machine. See <link linkend="configuring-kscd">the configuring &kscd;</link> section, for details
 
242
about configuring &kscd;</para>
 
243
</sect2>
 
244
 
 
245
<sect2 id="cddb-button">
 
246
<title>The <guibutton>CDDB</guibutton> button</title>
 
247
 
 
248
<screenshot>
 
249
<screeninfo>The <acronym>CDDB</acronym> button</screeninfo>
 
250
<mediaobject>
 
251
<imageobject><imagedata fileref="kscd6.png" format="PNG"/></imageobject>
 
252
<textobject><phrase>The <acronym>CDDB</acronym> button</phrase></textobject>
 
253
</mediaobject>
 
254
</screenshot>
 
255
 
 
256
<para> This button opens the <acronym>CDDB</acronym> (Compact Disc Data Base) entry
 
257
editor panel. </para>
 
258
 
 
259
<para>The <acronym>CDDB</acronym> can identify your &CD; and often download a
 
260
list of tracks for that &CD; or load it from the filesystem. See the <link
 
261
linkend="cddb-editor">&CD; Database Editor</link> section for more details about
 
262
using this tool.</para>
 
263
</sect2>
 
264
 
 
265
<sect2 id="information-button">
 
266
<title>The <guibutton>Information</guibutton> button</title>
 
267
 
 
268
<screenshot>
 
269
<screeninfo>The Information button</screeninfo>
 
270
<mediaobject>
 
271
<imageobject><imagedata fileref="kscd7.png" format="PNG"/></imageobject>
 
272
<textobject><phrase>The Information button</phrase></textobject>
 
273
</mediaobject>
 
274
</screenshot>
 
275
 
 
276
<para> This button will help you search for information about the artist on the
 
277
Internet. You can find out about performance dates, purchase information, and
 
278
other information by pressing this button and choosing the appropriate option in
 
279
the pop-up menu that appears.</para>
 
280
</sect2>
 
281
 
 
282
<sect2>
 
283
<title>The Exit button</title>
 
284
 
 
285
<screenshot>
 
286
<screeninfo>The Exit button</screeninfo>
 
287
<mediaobject>
 
288
<imageobject><imagedata fileref="kscd8.png" format="PNG"/></imageobject>
 
289
<textobject><phrase>The exit button</phrase></textobject>
 
290
</mediaobject>
 
291
</screenshot>
 
292
 
 
293
<para> This button closes &kscd;.</para>
 
294
</sect2>
 
295
 
 
296
<sect2>
 
297
<title>The Volume slider</title>
 
298
 
 
299
<screenshot>
 
300
<screeninfo>The Volume slider</screeninfo>
 
301
<mediaobject>
 
302
<imageobject><imagedata fileref="kscd9.png" format="PNG"/></imageobject>
 
303
<textobject><phrase>The Volume slider</phrase></textobject>
 
304
</mediaobject>
 
305
</screenshot>
 
306
 
 
307
<para> This slider controls the volume of the audio output of the &CD;. Right is
 
308
louder, left is quieter. If you are playing your &CD; through your sound card,
 
309
the sound card mixer will affect the playback volume as well.</para>
 
310
</sect2>
 
311
 
 
312
<sect2 id="randomize-button">
 
313
<title>The Randomize button</title>
 
314
 
 
315
<screenshot>
 
316
<screeninfo>The Randomize button</screeninfo>
 
317
<mediaobject>
 
318
<imageobject><imagedata fileref="kscd15.png" format="PNG"/></imageobject>
 
319
<textobject><phrase>The Randomize button</phrase></textobject>
 
320
</mediaobject>
 
321
</screenshot>
 
322
 
 
323
<para> This button causes the &CD; tracks to be played in random order. </para>
 
324
</sect2>
 
325
 
 
326
<sect2>
 
327
<title>The track selector</title>
 
328
 
 
329
<screenshot>
 
330
<screeninfo>The track selector</screeninfo>
 
331
<mediaobject>
 
332
<imageobject><imagedata fileref="kscd11.png" format="PNG"/></imageobject>
 
333
<textobject><phrase>The Track selector</phrase></textobject>
 
334
</mediaobject>
 
335
</screenshot>
 
336
            
 
337
<para>This combo box shows you the current track and lets you directly select
 
338
a track to play. </para>
 
339
</sect2>
 
340
 
 
341
</sect1>
 
342
</chapter>
 
343
 
 
344
<chapter id="configuring-kscd">
 
345
<title>Configuring &kscd;</title>
 
346
<sect1 id="configuration-intro">
 
347
<title>The primary configuration window</title>
 
348
 
 
349
<para>The primary configuration window for &kscd; is a tabbed dialog with four
 
350
major sections. </para>
 
351
 
 
352
<itemizedlist>
 
353
<listitem><para><link linkend="freedb-tab"><guilabel>freedb</guilabel></link></para></listitem>
 
354
<listitem><para><link linkend="smtp-options"><guilabel>SMTP Setup</guilabel>
 
355
</link></para></listitem>
 
356
<listitem><para><link linkend="kscd-options-tab"><guilabel>Kscd
 
357
Options</guilabel></link></para></listitem>
 
358
<listitem><para><link linkend="about"><guilabel>About</guilabel></link></para></listitem>
 
359
</itemizedlist>
 
360
</sect1>
 
361
 
 
362
<sect1 id="freedb-tab">
 
363
<title>The <guilabel>freedb</guilabel> tab</title>
 
364
<screenshot>
 
365
<screeninfo>The <guilabel>freedb</guilabel> tab of the configuration dialog</screeninfo>
 
366
<mediaobject>
 
367
<imageobject> <imagedata fileref="kscd14.png" format="PNG"/> </imageobject>
 
368
<textobject><phrase>The <guilabel>freedb</guilabel> tab of the configuration
 
369
dialog</phrase></textobject>
 
370
</mediaobject>
 
371
</screenshot>
 
372
 
 
373
<para> The <guilabel>freedb</guilabel> tab sets up the <acronym>CDDB</acronym> functions
 
374
of &kscd;.</para>
 
375
 
 
376
<para>The <guilabel>Enable Remote freedb</guilabel> checkbox turns on or off
 
377
<acronym>CDDB</acronym> lookups over the Internet.  The time allowed before the
 
378
lookup attempt times out can be set. To use an &HTTP; proxy, check the
 
379
<guilabel>Use HTTP proxy to access freedb</guilabel> and
 
380
enter the &URL; in the field below.</para>
 
381
 
 
382
<para>The <guilabel>freedb Base Directory</guilabel> text field lets you choose
 
383
the directory where you want <acronym>CDDB</acronym> entries to be stored
 
384
locally.</para>
 
385
 
 
386
<para>The <guilabel>freedb Server</guilabel> list box shows a list of known
 
387
freedb servers. Select an entry from this list and it will
 
388
appear in the text field above the selection box. Press the
 
389
<guibutton>Update</guibutton> button to update the list of servers in the list
 
390
box.  Press the <guibutton>Defaults</guibutton> button to enter the default
 
391
value, <userinput>freedb.freedb.org cddbp 888 -</userinput>, which will permit you to
 
392
update the list with a fresh list of freedb servers listed with
 
393
the master freedb site at <systemitem
 
394
class="systemname">freedb.freedb.org</systemitem>. Hit the
 
395
<guibutton>-</guibutton> button to delete the selected entry from the
 
396
list.</para>
 
397
 
 
398
<para>The <guilabel>Send freedb submissions to:</guilabel> field contains the
 
399
e-mail address to which to submit <abbrev>CDDB</abbrev> entries. The default address
 
400
is <email>freedb-submit@freedb.org</email>. As of version 0.8,
 
401
<acronym>CDDB</acronym> entries from &kscd; are accepted for inclusion in the
 
402
database. Hit the <guibutton>-</guibutton> button to delete the selected entry
 
403
from the list. The <guibutton>Defaults</guibutton> button restores all settings
 
404
to the default values.The <guibutton>Help</guibutton> button opens the &kscd;
 
405
help home page (this document).</para>
 
406
 
 
407
<para><guibutton>OK</guibutton> saves the current settings and exits;
 
408
<guibutton>Cancel</guibutton> exits without saving. </para>
 
409
</sect1>
 
410
 
 
411
<sect1 id="smtp-options">
 
412
<title>The <guilabel>SMTP Options</guilabel> tab</title> 
 
413
 
 
414
<screenshot>
 
415
<screeninfo>The SMTP Options tab</screeninfo>
 
416
<mediaobject>
 
417
<imageobject><imagedata fileref="kscd16.png" format="PNG"/></imageobject>
 
418
</mediaobject>
 
419
</screenshot>
 
420
 
 
421
<para> The <acronym>SMTP</acronym> options tab sets up connection to a mail
 
422
server to submit new <acronym>CDDB</acronym> entries. This is useful if you do
 
423
not have your own system configured as a server. Check <guilabel>Enable
 
424
submission via SMTP</guilabel> to use this feature. Enter the address of the
 
425
<acronym>SMTP</acronym> server in the upper left text field and the port number
 
426
(typically <userinput>25</userinput>) in the upper right field. Enter your own
 
427
email address in the lower text field. </para>
 
428
</sect1>
 
429
 
 
430
<sect1 id="kscd-options-tab">
 
431
<title>The <guilabel>KSCD Options</guilabel> tab</title> 
 
432
 
 
433
<screenshot>
 
434
<screeninfo>The <guilabel>KSCD Options</guilabel> tab</screeninfo>
 
435
<mediaobject>
 
436
<imageobject><imagedata fileref="kscd12.png" format="PNG"/></imageobject>
 
437
<textobject><phrase>The <guilabel>KSCD Options</guilabel> tab</phrase></textobject>
 
438
</mediaobject>
 
439
</screenshot>
 
440
 
 
441
<para>The <guilabel>LED Color:</guilabel> and <guilabel>Background
 
442
Color:</guilabel> fields show the color selected for the foreground and
 
443
background of the status display. Press the <guibutton>Change</guibutton> button
 
444
next to the color box to change these colors.</para>
 
445
 
 
446
<para>The <guilabel>CDROM Device</guilabel> field contains the name of the
 
447
&CD-ROM; device to be used to play audio &CD;s. The default value is
 
448
<filename>/dev/cdrom</filename>. The permissions on this device must be set to
 
449
allow opening this device read-only. Changing the permissions on this device
 
450
file will in almost all cases require superuser privileges and can be done from
 
451
the command line, or in the Super User Mode of &konqueror;.</para>
 
452
 
 
453
<para>The <guilabel>Unix mail command</guilabel> field shows the command used to
 
454
send new <acronym>CDDB</acronym> entries to the database. The default value is
 
455
<userinput><command>mail</command> <option>-s
 
456
<replaceable>%s</replaceable></option></userinput>. You will need to make sure
 
457
this command will actually send mail to non-local systems if you want to submit
 
458
<acronym>CDDB</acronym> entries, especially if you access the Internet through a
 
459
dial-up connection. Check the documentation for your Linux distribution for
 
460
details. Some Linux distributions that use sendmail to deliver e-mail require
 
461
only that you enter your mail host into the <guilabel>"Smart" relay
 
462
host</guilabel> field in <filename>/etc/sendmail.cf</filename>. In addition, the
 
463
<acronym>CDDB</acronym> site will want to be able to mail you back; it may
 
464
therefore also be necessary to edit <filename>/etc/sendmail.cf</filename> to
 
465
ensure that the return address on the submission is valid. Your mileage is
 
466
likely to vary. If all else fails, use <link linkend="smtp-options">SMTP</link>
 
467
instead.</para>
 
468
 
 
469
<para>The <guilabel>WWW-Browser</guilabel> section lets you choose which web
 
470
browser to use to access the web sites in the <link linkend="information-button">information button</link> menus.  You can choose
 
471
either &konqueror; or a custom browser with the radio buttons. By default, the
 
472
<guilabel>Use Custom Browser</guilabel> field contains
 
473
<userinput><command>kfmclient</command>
 
474
<option><replaceable>openURL %s</replaceable></option></userinput>.</para>
 
475
 
 
476
<para>The <guilabel>Show Tool Tips</guilabel> checkbox turns tooltips (tiny
 
477
windows that pop up when the mouse is <quote>parked</quote> briefly over a
 
478
control) on or off.</para>
 
479
 
 
480
<para><guilabel>Enable KPanel Docking</guilabel> causes a &kscd; control to
 
481
appear in the &kicker; panel.</para>
 
482
 
 
483
<para><guilabel>Play on Tray Close</guilabel> causes &CD; play to start when the
 
484
tray is closed, with no need to press the <guibutton>Play</guibutton>
 
485
button.</para>
 
486
 
 
487
<para><guilabel>Stop Playing on Exit</guilabel> causes &CD; playback to stop
 
488
when &kscd; is closed.</para>
 
489
 
 
490
<para><guilabel>Eject on Finish</guilabel> causes the &CD; to be ejected when
 
491
playback ends.</para>
 
492
 
 
493
<para><guilabel>Random is Shuffle</guilabel> means that when <link
 
494
linkend="randomize-button">random play</link> is used, each track is played only
 
495
once.</para>
 
496
 
 
497
<para>The <guibutton>Help</guibutton> button opens the &kscd; help contents
 
498
page.</para>
 
499
 
 
500
<para><guibutton>OK</guibutton> saves the current settings and exits;
 
501
<guibutton>Cancel</guibutton> exits without saving.</para>
 
502
 
 
503
</sect1>
 
504
 
 
505
<sect1 id="about">
 
506
<title>The <guilabel>About</guilabel> tab </title>
 
507
 
 
508
<para> The <guilabel>About</guilabel> tab displays information about the version
 
509
of &kscd; you are using and some copyright information. </para>
 
510
 
 
511
</sect1>
 
512
</chapter>
 
513
 
 
514
<chapter id="cddb-editor">
 
515
<title>The <guilabel>CD Database Editor</guilabel></title>
 
516
 
 
517
<screenshot>
 
518
<screeninfo>The CD Database Editor</screeninfo>
 
519
<mediaobject>
 
520
<imageobject><imagedata fileref="kscd13.png" format="PNG"/></imageobject>
 
521
<textobject><phrase>The CD Database Editor</phrase></textobject>
 
522
</mediaobject>
 
523
</screenshot>
 
524
 
 
525
<para>The &CD; Database Editor allows you to modify, download, save, annotate,
 
526
and upload <link linkend="cddb-support"><acronym>CDDB</acronym> (Compact Disc
 
527
Data Base)</link> entries.</para>
 
528
 
 
529
<para>If there is an entry in your local <acronym>CDDB</acronym> tree (see the
 
530
<link linkend="freedb-tab">CDDB subsection</link> in the Configuration chapter)
 
531
for the &CD; in your &CD-ROM; drive, or if the disc could be found in the
 
532
freedb, you will see the name of the artist and the title of
 
533
the &CD; in the <guilabel>Disc Artist / Title</guilabel> field and a list of
 
534
tracks with song titles in the <guilabel>Track / Time / Title</guilabel>
 
535
selection box. Otherwise, you will see a list of tracks and play times without
 
536
titles.</para>
 
537
 
 
538
<para>You can make an annotation for the entire disc with the <guibutton>Ext
 
539
Info</guibutton> button next to the <guilabel>Disc Artist / Title</guilabel>
 
540
field, or for a selected track in the <guilabel>Track / Time /Title</guilabel>
 
541
selection box with the adjacent <guibutton>Ext Info</guibutton> button. If you
 
542
select a track in the <guilabel>Track / Time / Title</guilabel> selection box,
 
543
the title, if present, will appear in the <guilabel>Edit Track Title</guilabel>
 
544
field below. You can type a title for the track in the box, or edit the entry to
 
545
suit your needs. Press the <keycap>Return</keycap> key on your keyboard, and the
 
546
text will appear in the proper line in the selection box.</para>
 
547
 
 
548
<para>Once all tracks have been given titles and the <guilabel>Disc Artist /
 
549
Title</guilabel> field has been filled out, you can press the
 
550
<guibutton>Submit</guibutton> button to send your submission by e-mail to freedb.</para>
 
551
 
 
552
<para>You will be prompted to select a category for the submission. The
 
553
<guilabel>Disc ID</guilabel> section displays the 32 bit <acronym>ID</acronym>
 
554
code used by freedb to identify a compact disc. Above the
 
555
<acronym>ID</acronym> code is the category of the <guilabel>CDDB</guilabel>
 
556
entry. These categories correspond to the subdirectories tree of the directory
 
557
chosen in the <guilabel>freedb Base Directory</guilabel> in the <link
 
558
linkend="freedb-tab"><abbrev>CDDB</abbrev> tab</link> of the &kscd; Configuration
 
559
window.</para>
 
560
 
 
561
<para>The <guilabel>Total Time:</guilabel> display shows the total play time of
 
562
the &CD;.</para>
 
563
 
 
564
<para>The <guilabel>Play List Editor</guilabel> lets you change the play order
 
565
of a disc. Enter a comma-separated list of track numbers to define a new play
 
566
order.</para>
 
567
 
 
568
<para>The <guibutton>Save</guibutton> button writes the displayed record to
 
569
disk. You will be prompted to select a category under which to save the
 
570
record. Select a directory and press <guibutton>Ok</guibutton> to finish
 
571
saving.</para>
 
572
 
 
573
<para>The <guibutton>Load</guibutton> button will prompt you for a location to
 
574
look for a <acronym>CDDB</acronym> entry other than a remote
 
575
freedb server or the local <abbrev>CDDB</abbrev> entries in the
 
576
file system. The <guibutton>Close</guibutton> button closes the &CD;
 
577
Database Editor without saving.</para>
 
578
 
 
579
</chapter>
 
580
 
 
581
<chapter id="using-kscd-in-the-panel">
 
582
<title>Using &kscd; in the &kde; Panel</title>
 
583
 
 
584
<screenshot>
 
585
<screeninfo>Using &kscd; in the &kde; Panel</screeninfo>
 
586
<mediaobject>
 
587
<imageobject><imagedata fileref="kscd18.png" format="PNG"/></imageobject>
 
588
<textobject><phrase>Using &kscd; in the &kde; Panel</phrase></textobject>
 
589
</mediaobject>
 
590
</screenshot>
 
591
 
 
592
<para>When the <guilabel>Enable KPanel Docking</guilabel> box is checked, a
 
593
small &kscd; applet is also displayed in the <application>KDE
 
594
panel</application>. Unlike the main &kscd; window, this applet is available on
 
595
any desktop. <mousebutton>Right</mousebutton> click on the applet to pop up a
 
596
menu to control &CD; playback. A <mousebutton>left</mousebutton> click on the
 
597
applet hides the main &kscd; window. If the main window is hidden, a second
 
598
<mousebutton>left</mousebutton> click on the applet restores it. </para>
 
599
 
 
600
<note><para>To be precise, the applet is displayed in the <application>system
 
601
tray</application> in the panel. If no applet appears when &kscd; is minimized,
 
602
you may have removed the tray. To add it, <mousebutton>right</mousebutton> click
 
603
on an empty spot on the panel and select <menuchoice><guisubmenu>Add</guisubmenu>
 
604
<guisubmenu>Applet</guisubmenu> <guimenuitem>System Tray</guimenuitem>
 
605
</menuchoice></para></note>
 
606
 
 
607
</chapter>
 
608
 
 
609
<chapter id="cddb-support">
 
610
<title><acronym>CDDB</acronym> Support</title>
 
611
 
 
612
<para>freedb is a distributed network database accessible
 
613
over the Internet that contains information about most audio &CD;s in
 
614
circulation. If you have Internet access, you will likely never have to manually
 
615
enter track information for your &CD;s if you have this set up properly. See
 
616
<link linkend="freedb-tab">The freedb Tab</link> subsection in the configuring
 
617
&kscd; chapter for detailed instructions on how to configure this service, and
 
618
the <link linkend="cddb-editor">The CD Database Editor</link> section for
 
619
instructions on how to edit <acronym>CDDB</acronym> entries.</para>
 
620
 
 
621
<para>Use of the <acronym>CDDB</acronym> is free. Submissions from users are
 
622
encouraged.</para>
 
623
 
 
624
<para>When preparing entries for the <acronym>CDDB</acronym>, please keep the
 
625
following points in mind:</para>
 
626
 
 
627
<itemizedlist>
 
628
<listitem><para>Use <quote>standard</quote> latin characters in the entries. Some
 
629
special characters are supported, but Cyrillic or Greek alphabet submissions,
 
630
for example, cannot be accepted.</para></listitem>
 
631
<listitem><para>Use only one <keysym>/</keysym> character in the
 
632
<guilabel>Disc Artist / Title</guilabel> field in the &CD; Database
 
633
Editor.</para>
 
634
<para>For classical &CD;s, it is standard practice to put the composer's name in
 
635
the Artist section (before the slash) and the performer's name in the Title
 
636
section (after the slash).</para></listitem> 
 
637
<listitem><para>If you send an entry that already exists in the database, any
 
638
additional information you provide may be added to the existing entry.</para>
 
639
</listitem>
 
640
</itemizedlist>
 
641
 
 
642
<para>By default, &kscd; installs the standard <acronym>CDDB</acronym>
 
643
categories in <filename class="directory">$KDEDIR/share/apps/kscd/cddb</filename>. You can create as
 
644
many category subdirectories as you like. However, when uploading, only the
 
645
offical <acronym>CDDB</acronym> categories are displayed. The default upload
 
646
address is <email>freedb-submit@freedb.org</email>. For more information about
 
647
<abbrev>freedb</abbrev> visit the <abbrev>freedb</abbrev> homepage.</para>
 
648
 
 
649
<para>The local <acronym>CDDB</acronym> entry for a particular &CD; is stored in
 
650
the file <filename><replaceable>category name</replaceable>/<replaceable>disc
 
651
ID</replaceable></filename> under the <acronym>CDDB</acronym> Base
 
652
Directory. These files can be edited with any text editor if you have nothing
 
653
better to do with your spare time.</para>
 
654
 
 
655
</chapter>
 
656
 
 
657
<chapter id="questions-and-answers">
 
658
<title>Questions and answers</title>
 
659
 
 
660
<qandaset>
 
661
<qandaentry>
 
662
<question><para>I see this dialog when I start &kscd;.  What's wrong?</para>
 
663
<screenshot>
 
664
<screeninfo>Error dialog</screeninfo>
 
665
<mediaobject>
 
666
<imageobject><imagedata fileref="kscd19.png" format ="PNG"/></imageobject>
 
667
<textobject><phrase>Error dialog</phrase></textobject>
 
668
</mediaobject>
 
669
</screenshot>
 
670
</question>
 
671
<answer><para>This means that &kscd; couldn't open your &CD-ROM; drive. The name of
 
672
the device in the <guilabel>CDROM Device</guilabel>cdrom field of the
 
673
<guilabel>Kscd Configuration</guilabel> must actually refer to the block device
 
674
associated with your &CD-ROM; drive. This will often be a hardlink to the
 
675
appropriate <acronym>IDE</acronym> (<filename>/dev/hdx</filename>) or
 
676
<acronym>SCSI</acronym> (<filename>/dev/sdx</filename>) device.</para>
 
677
 
 
678
<para> The device file normally belongs to user root in group root, and does not
 
679
allow normal users to open it for reading, writing, or execution directly. This
 
680
has <emphasis>nothing</emphasis> to do with the <application>SUID</application>
 
681
(Set User <acronym>ID</acronym> programs use the <function>setuid()</function>
 
682
function in the standard Un*x library to assume the identity of another user)
 
683
<command>mount</command> command, which has no problems with permissions; &kscd;
 
684
must be able to get a read-only file descriptor referring to the &CD; device to
 
685
control the &CD-ROM; drive and read raw data off the disk.</para>
 
686
 
 
687
<para> If you have the root password, you can fix this quickly and easily.
 
688
Become root and type <userinput><command>chmod</command> <option>a+r</option>
 
689
<filename><replaceable>/dev/cdrom</replaceable></filename></userinput> to allow
 
690
any user on your system to read from <filename>/dev/cdrom</filename>.  If your
 
691
&CD-ROM; device is called something else, change the permissions on that device
 
692
with the same procedure. If you don't have the root password, ask your system
 
693
administrator nicely to give you read permission for the &CD-ROM; device.</para>
 
694
 
 
695
<para>See also the chapter on <link linkend="configuring-kscd">configuring KSCD
 
696
</link></para></answer>
 
697
</qandaentry>
 
698
 
 
699
<qandaentry> 
 
700
<question><para>I can't get the <acronym>CDDB</acronym> to work. Can I get any
 
701
detailed information about what may be going wrong?</para></question> 
 
702
<answer><para>If you experience trouble with the <acronym>CDDB</acronym>
 
703
functionality try to starting &kscd; from the command line with the
 
704
<option>-d</option> switch and observe the debug output.</para></answer> 
 
705
</qandaentry>
 
706
</qandaset>
 
707
</chapter>
 
708
 
 
709
<chapter id="credits-and-license">
 
710
<title>Credits and licenses</title>
 
711
 
 
712
<para>&kscd; Copyright 1997,1998 Bernd Johannes Wuebben
 
713
<email>wuebben@kde.org</email>wuebben></para>
 
714
 
 
715
<para>&kscd; contains code from: </para>
 
716
<itemizedlist>
 
717
<listitem><para><application>workman</application> 1.4 beta 3 Copyright (c)
 
718
Steven Grimm <email>koreth@hyperion.com</email></para></listitem>
 
719
</itemizedlist>
 
720
 
 
721
<para>Special thanks to Ti Kan and Steve Scherf, the inventors of the
 
722
<acronym>CDDB</acronym> database concept. Visit <ulink
 
723
url="http://www.cddb.com/">http://ww.cddb.com</ulink> for more information on
 
724
<acronym>CDDB</acronym>.</para>
 
725
 
 
726
<para>A very special thank you also to David White who wrote the original &kscd;
 
727
help documention. Great Job David!</para>
 
728
 
 
729
<para>Documentation updated for KDE 2.0, and copyright by Jonathan Singer
 
730
<email>jsinger@leeta.net.</email></para>
 
731
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
 
732
 
 
733
&underFDL;
 
734
&underGPL;
 
735
 
 
736
</chapter>
 
737
 
 
738
<appendix id="installation">
 
739
<title>Installation</title>
 
740
 
 
741
<sect1 id="how-to-obtain-kscd">
 
742
<title>How to obtain &kscd;</title>
 
743
 
 
744
<para>&kscd; is part of the <ulink url="http://www.kde.org/">KDE
 
745
Project</ulink>. &kscd; can be found in the kdemultimedia package on <ulink
 
746
 url="ftp://ftp.kde.org/pub/kde/">ftp://ftp.kde.org/pub/kde/</ulink>, the main
 
747
ftp site of the KDE project. </para>
 
748
 
 
749
</sect1>
 
750
 
 
751
<sect1 id="requirements">
 
752
<title>Requirements</title>
 
753
 
 
754
<para>In order to successfully compile &kscd;, you need the latest versions of
 
755
the KDE libraries as well as the &Qt; C++ library.  All required libraries as
 
756
well as &kscd; itself can be found at the KDE &FTP; site, <ulink
 
757
url="ftp://ftp.kde.org/pub/kde/">ftp://ftp.kde.org/pub/kde/</ulink>.</para>
 
758
 
 
759
</sect1> 
 
760
 
 
761
<sect1 id="compilation-and-installation"> 
 
762
<title>Compilation and Installation</title> 
 
763
 
 
764
<para>In order to compile and install &kscd; on your system, type the following
 
765
in the base directory of the &kscd; distribution:</para>
 
766
        
 
767
<screen width="40">
 
768
<prompt>%</prompt> <userinput><command>./configure</command></userinput> 
 
769
<prompt>%</prompt> <userinput><command>make</command></userinput>
 
770
<lineannotation>Then as root: </lineannotation>
 
771
<prompt>%</prompt> <userinput><command>make</command> <option>install</option></userinput> 
 
772
</screen> 
 
773
        
 
774
<para>Please inform the current maintainer, Dirk Foersterling, at
 
775
<email>milliByte@gmlx.net</email> of any modification you had to undertake in
 
776
order to get &kscd; to compile on your platform.</para>
 
777
 
 
778
</sect1>
 
779
 
 
780
</appendix>
 
781
 
 
782
 
 
783
 
 
784
 
 
785
 
 
786
 
 
787
 
 
788
&documentation.index; 
 
789
</book>
 
790
<!--
 
791
Local Variables:
 
792
mode: sgml
 
793
sgml-minimize-attributes: nil
 
794
sgml-general-insert-case: lower
 
795
End:
 
796
-->