~ubuntu-branches/ubuntu/gutsy/kid3/gutsy

<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>The Kid3 Handbook</title><meta name="generator" content="DocBook XSL Stylesheets V1.48"><meta name="keywords" content="KDE, kdemultimedia, MP3, ID3, ID3v1, ID3v2, Ogg, Vorbis, FLAC"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book"><div class="titlepage"><div><h1 class="title"><a name="id2385546"></a>The Kid3 Handbook</h1></div><div><h3 class="author">Urs Fleisch</h3><div class="affiliation"><div class="address"><p><tt><<a href="mailto:ufleisch at users.sourceforge.net">ufleisch at users.sourceforge.net</a>></tt></p></div></div></div><div><p class="releaseinfo">0.6</p></div><div><p class="copyright">Copyright � 2005 Urs Fleisch</p></div><div><div class="legalnotice"><p>Permission is granted to copy, distribute and/or modify this

Kid3 is an application to edit the ID3v1 and ID3v2 tags in MP3 files in

an efficient way. Also tags in Ogg/Vorbis and FLAC files are supported.

It is easy to set tags of multiple files to the same

values (e.g. album, artist, year and genre in all files of the same album) and

generate the tags from the file name or vice versa.

"><meta name="keywords" content="KDE, kdemultimedia, MP3, ID3, ID3v1, ID3v2, Ogg, Vorbis, FLAC"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book" lang="en"><div class="titlepage"><div><div><h1 class="title"><a name="id2452574"></a>The Kid3 Handbook</h1></div><div><div class="authorgroup"><div class="author"><h3 class="author"><span class="firstname">Urs</span> <span class="surname">Fleisch</span></h3><div class="affiliation"><div class="address"><p><code class="email"><<a href="mailto:ufleisch at users.sourceforge.net">ufleisch at users.sourceforge.net</a>></code></p></div></div></div></div></div><div><p class="releaseinfo">0.7</p></div><div><p class="copyright">Copyright � 2006 Urs Fleisch</p></div><div><div class="legalnotice"><a name="id2458463"></a><p>Permission is granted to copy, distribute and/or modify this

document under the terms of the GNU Free Documentation License,

Version 1.1 or any later version published by the Free Software

Foundation; with no Invariant Sections, with no Front-Cover Texts, and

with no Back-Cover Texts. A copy of the license is included in <a href="#gnu-fdl">the section entitled "GNU Free Documentation License"</a>.</p></div></div><div><div class="abstract"><p><b>Abstract</b></p><p>

Kid3 is an application to edit the ID3v1 and ID3v2 tags in MP3 files in

<span class="application">Kid3</span> is an application to edit the ID3v1 and ID3v2 tags in MP3 files in

an efficient way. Also tags in Ogg/Vorbis and FLAC files are supported.

It is easy to set tags of multiple files to the same

values (e.g. album, artist, year and genre in all files of the same album) and

generate the tags from the file name or vice versa.

</p></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt>1. <a href="#introduction">Introduction</a></dt><dt>2. <a href="#using-kid3">Using Kid3</a></dt><dd><dl><dt><a href="#kid3-features">Kid3 features</a></dt><dt><a href="#example-usage">Example Usage</a></dt></dl></dd><dt>3. <a href="#commands">Command Reference</a></dt><dd><dl><dt><a href="#kid3-window">The Kid3 Window</a></dt><dd><dl><dt><a href="#id2448050">The GUI Elements</a></dt><dt><a href="#id2387342">The File Menu</a></dt><dt><a href="#id2447531">The Tools Menu</a></dt><dt><a href="#id2447699">The Settings Menu</a></dt><dt><a href="#id2448757">The Help Menu</a></dt></dl></dd></dl></dd><dt>4. <a href="#credits">Credits and License</a></dt><dt>A. <a href="#installation">Installation</a></dt><dd><dl><dt><a href="#getting-kid3">How to obtain Kid3</a></dt><dt><a href="#requirements">Requirements</a></dt><dt><a href="#compilation">Compilation and Installation</a></dt><dt><a href="#configuration">Configuration</a></dt></dl></dd></dl></div><div class="chapter"><div class="titlepage"><div><h2 class="title"><a name="introduction"></a>Chapter 1. Introduction</h2></div></div><p>

Kid3 is an application to edit the ID3v1 and ID3v2 tags in MP3 files in

</p></div></div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="#introduction">1. Introduction</a></span></dt><dt><span class="chapter"><a href="#using-kid3">2. Using Kid3</a></span></dt><dd><dl><dt><span class="sect1"><a href="#kid3-features">Kid3 features</a></span></dt><dt><span class="sect1"><a href="#example-usage">Example Usage</a></span></dt></dl></dd><dt><span class="chapter"><a href="#commands">3. Command Reference</a></span></dt><dd><dl><dt><span class="sect1"><a href="#kid3-window">The Kid3 Window</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id2500686">The GUI Elements</a></span></dt><dt><span class="sect2"><a href="#id2453190">The File Menu</a></span></dt><dt><span class="sect2"><a href="#id2501275">The Tools Menu</a></span></dt><dt><span class="sect2"><a href="#id2501508">The Settings Menu</a></span></dt><dt><span class="sect2"><a href="#id2501828">The Help Menu</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="#credits">4. Credits and License</a></span></dt><dt><span class="appendix"><a href="#installation">A. Installation</a></span></dt><dd><dl><dt><span class="sect1"><a href="#getting-kid3">How to obtain Kid3</a></span></dt><dt><span class="sect1"><a href="#requirements">Requirements</a></span></dt><dt><span class="sect1"><a href="#compilation">Compilation and Installation</a></span></dt><dt><span class="sect1"><a href="#configuration">Configuration</a></span></dt></dl></dd></dl></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="introduction"></a>Chapter�1.�Introduction</h2></div></div></div><p>

<span class="application">Kid3</span> is an application to edit the ID3v1 and ID3v2 tags in MP3 files in

an efficient way. These tags can be edited by most MP3 players, but not in

a very comfortable and efficient way. Moreover the tags in Ogg/Vorbis and FLAC

files are supported too.

</p><p>

Kid3 does not grab, encode nor play

<span class="application">Kid3</span> does not grab, encode nor play

MP3 files, but it is targeted to edit the ID3 tags of all files of an album

in an efficient way, i.e. with as few mouse clicks and key strokes as

possible. Where most other programs can edit either ID3v1 or ID3v2 tags,

Kid3 has full control over both versions, can convert tags between the

<span class="application">Kid3</span> has full control over both versions, can convert tags between the

two formats and has access to all ID3v2 tags. Tags of multiple files can be

set to the same value, e.g. the artist, album, year and genre of all files

of an album typically have the same values and can be set together. If the

track lists. The import format is freely configurable by regular expressions.

</p><p>

Please report any problems or feature requests to the author.

</p></div><div class="chapter"><div class="titlepage"><div><h2 class="title"><a name="using-kid3"></a>Chapter 2. Using Kid3</h2></div></div><div class="sect1"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="kid3-features"></a>Kid3 features</h2></div></div><div class="itemizedlist"><ul type="disc"><li><p>Edit ID3v1.1 tags</p></li><li><p>Edit all ID3v2.3 frames</p></li><li><p>Edit tags of multiple files</p></li><li><p>Convert between ID3v1.1 and ID3v2.3 tags</p></li><li><p>Edit Ogg/Vorbis tags</p></li><li><p>Edit FLAC tags</p></li><li><p>Generate tags from filename</p></li><li><p>Generate filename from tags</p></li><li><p>Generate and change directory names from tags</p></li><li><p>Generate playlist file</p></li><li><p>Automatic case conversion and string translation</p></li><li><p>Import from <a href="http://freedb.org" target="_top">freedb.org</a>,

</p></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="using-kid3"></a>Chapter�2.�Using Kid3</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#kid3-features">Kid3 features</a></span></dt><dt><span class="sect1"><a href="#example-usage">Example Usage</a></span></dt></dl></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="kid3-features"></a>Kid3 features</h2></div></div></div><div class="itemizedlist"><ul type="disc"><li><p>Edit ID3v1.1 tags</p></li><li><p>Edit all ID3v2.3 frames</p></li><li><p>Edit tags of multiple files</p></li><li><p>Convert between ID3v1.1 and ID3v2.3 tags</p></li><li><p>Edit Ogg/Vorbis tags</p></li><li><p>Edit FLAC tags</p></li><li><p>Generate tags from filename</p></li><li><p>Generate filename from tags</p></li><li><p>Generate and change directory names from tags</p></li><li><p>Generate playlist file</p></li><li><p>Automatic case conversion and string translation</p></li><li><p>Import from <a href="http://freedb.org" target="_top">freedb.org</a>,

<a href="http://musicbrainz.org" target="_top">MusicBrainz</a>

and other data sources</p></li></ul></div></div><div class="sect1"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="example-usage"></a>Example Usage</h2></div></div><p>

This section describes a typical session with Kid3.

and other data sources</p></li><li><p>Export as CSV, HTML, playlist, Kover XML and other

formats. Exported CSV files can be imported again.</p></li></ul></div></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="example-usage"></a>Example Usage</h2></div></div></div><p>

This section describes a typical session with <span class="application">Kid3</span>.

Let's assume we have a directory containing MP3 files with the tracks from

the album "Let's Tag" from the band "One Hit Wonder". The directory is

named in the "artist - album" format, in our case <tt>One Hit Wonder - Let's

Tag</tt>. The directory contains the tracks in the "track title.mp3"

named in the "artist - album" format, in our case <code class="filename">One Hit Wonder - Let's

Tag</code>. The directory contains the tracks in the "track title.mp3"

format, which I think is useful because the filenames are short

(important when using mobile MP3 players with small displays) and in the

correct order when sorted alphabetically (important when using hardware MP3

players which play the tracks in alphabetical order or in the order in

which they are burnt on CD and that order is alphabetical when using

<b>mkisofs</b>). Besides this, the artist and album information

<span><strong class="command">mkisofs</strong></span>). Besides this, the artist and album information

is already in the directory name and does not have to be repeated in the filename.

But back to our example, the directory listing looks like this:

</p><p><tt>01 Intro.mp3</tt></p><p><tt>02 We Only Got This One.mp3</tt></p><p><tt>03 Outro.mp3</tt></p><p>

These files have no tags yet and we want to generate them using Kid3. We use

Open (File menu or toolbar) and

</p><p><code class="filename">01 Intro.mp3</code></p><p><code class="filename">02 We Only Got This One.mp3</code></p><p><code class="filename">03 Outro.mp3</code></p><p>

These files have no tags yet and we want to generate them using <span class="application">Kid3</span>. We use

<span class="guimenuitem">Open</span> (<span class="guimenu">File</span> menu or toolbar) and

select one of the files in this directory. All files will be displayed in the

file listbox. Lazy as we are, we want to use the information in the directory

and file names to generate tags. Therefore we select all files, then click the

From Filename button in the ID3v1.1

<span class="guibutton">From Filename</span> button in the <span class="guilabel">ID3v1.1</span>

section. This will set the title, artist, album and track values in all files.

To set the year and genre values of all files, we keep all files selected and

type in "2002" for the Year and select "Pop" from the

Genre combobox. To set only these two values, we check their

type in "2002" for the <span class="guilabel">Year</span> and select "Pop" from the

<span class="guilabel">Genre</span> combobox. To set only these two values, we check their

checkboxes and leave all other checkboxes unchecked. Now we change the

selection by only selecting the first file and we see that all tags contain

the correct values. The tags of the other files can be verified too by

selecting them one by one. When we are satisfied with the tags, we use

Save (File menu or toolbar).

Selecting Create Playlist from the

File menu will generate a file

<tt>One Hit Wonder - Let's Tag.m3u</tt> in the directory.

</p></div></div><div class="chapter"><div class="titlepage"><div><h2 class="title"><a name="commands"></a>Chapter 3. Command Reference</h2></div></div><div class="sect1"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="kid3-window"></a>The Kid3 Window</h2></div></div><div class="sect2"><div class="titlepage"><div><h3 class="title"><a name="id2448050"></a>The GUI Elements</h3></div></div><p>

The Kid3 GUI is separated in five sections: At the left are the file

and directory listboxes, the right side contains the Filename,

ID3v1.1 and ID3v2.3 sections.

<span class="guimenuitem">Save</span> (<span class="guimenu">File</span> menu or toolbar).

Selecting <span class="guimenuitem">Create Playlist</span> from the

<span class="guimenu">File</span> menu will generate a file

<code class="filename">One Hit Wonder - Let's Tag.m3u</code> in the directory.

</p></div></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="commands"></a>Chapter�3.�Command Reference</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#kid3-window">The Kid3 Window</a></span></dt><dd><dl><dt><span class="sect2"><a href="#id2500686">The GUI Elements</a></span></dt><dt><span class="sect2"><a href="#id2453190">The File Menu</a></span></dt><dt><span class="sect2"><a href="#id2501275">The Tools Menu</a></span></dt><dt><span class="sect2"><a href="#id2501508">The Settings Menu</a></span></dt><dt><span class="sect2"><a href="#id2501828">The Help Menu</a></span></dt></dl></dd></dl></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="kid3-window"></a>The Kid3 Window</h2></div></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2500686"></a>The GUI Elements</h3></div></div></div><p>

The <span class="application">Kid3</span> GUI is separated in five sections: At the left are the file

and directory listboxes, the right side contains the <span class="guilabel">Filename</span>,

<span class="guilabel">ID3v1.1</span> and <span class="guilabel">ID3v2.3</span> sections.

</p><div class="variablelist"><dl><dt><span class="term">Filelist</span></dt><dd><p>

The file list contains the names of all the files in the opened

directory which match the selected file name filter (typically

<tt>*.mp3 *.ogg *.flac</tt>). A single or multiple files can be selected. To

<code class="filename">*.mp3 *.ogg *.flac</code>). A single or multiple files can be selected. To

select no file, click into the empty area after the listbox entries. The

selection determines the files which are affected by the operations which

are available by using the buttons described below.

V1V2 or NO TAG, no icon is displayed if the file has not been read in yet).

</p></dd><dt><span class="term">Directory List</span></dt><dd><p>

The directory list contains the names of the directories in the opened

directory, as well as the current (<tt>.</tt>) and the parent

(<tt>..</tt>) directory. It allows to quickly change the directory

without using the Open... command or drag and drop.

</p></dd><dt><span class="term">Filename</span></dt><dd><p>The Name line edit contains the name of the file

directory, as well as the current (<code class="filename">.</code>) and the parent

(<code class="filename">..</code>) directory. It allows to quickly change the directory

100

without using the <span class="guimenuitem">Open...</span> command or drag and drop.

101

</p></dd><dt><span class="term"><span class="guilabel">Filename</span></span></dt><dd><p>The <span class="guilabel">Name</span> line edit contains the name of the file

102

(if only a single file is selected). If this name is changed, the file will

103

be renamed when the Save command is used.

104

</p><p>

The Format combo box and line edit contains the format

105

The <span class="guilabel">Format</span> combo box and line edit contains the format

106

to be used when the filename is generated from the ID3v1.1 or ID3v2.3 tags.

100

107

The filename can contain arbitrary characters, even a directory part separated

101

108

by a slash from the file name, but that directory must already exist for the

109

116

Some commonly used filename formats are already available in the combo box,

110

117

but it is also possible to type in some special format into the line edit.

111

118

</p><p>

112

From ID3v1: Sets the filename using the selected format

119

<span class="guibutton">From ID3v1</span>: Sets the filename using the selected format

113

120

and the ID3v1.1

114

121

tags.

115

122

</p><p>

116

From ID3v2: Sets the filename using the selected format

123

<span class="guibutton">From ID3v2</span>: Sets the filename using the selected format

117

124

and the ID3v2.3

118

125

tags.

119

126

</p><p>

120

Info: Shows information about the encoding (MP3, Ogg, FLAC),

127

<span class="guibutton">Info</span>: Shows information about the encoding (MP3, Ogg, FLAC),

121

128

bitrate, sample rate, channels and the length of the file.

122

</p></dd><dt><span class="term">ID3v1.1</span></dt><dd><p>

123

The line edit widgets for Title,

124

Artist,

125

Album, Comment,

126

Year, Track and

127

Genre are used to edit the corresponding value in the

129

</p></dd><dt><span class="term"><span class="guilabel">ID3v1.1</span></span></dt><dd><p>

130

The line edit widgets for <span class="guilabel">Title</span>,

131

<span class="guilabel">Artist</span>,

132

<span class="guilabel">Album</span>, <span class="guilabel">Comment</span>,

133

<span class="guilabel">Year</span>, <span class="guilabel">Track</span> and

134

<span class="guilabel">Genre</span> are used to edit the corresponding value in the

128

135

ID3v1.1 tags of the selected files. The value will be changed when the file

129

selection is altered or before operations like Save

130

and Quit and when the corresponding

136

selection is altered or before operations like <span class="guimenuitem">Save</span>

137

and <span class="guimenuitem">Quit</span> and when the corresponding

131

138

check box at the left of the field name is checked. This is useful to

132

139

change only some values and leave the other values unchanged.

133

140

</p><p>

134

141

If a single file is selected, all check boxes are checked and the line edit

135

142

widgets contain the values found in the tags of this file. If a tag is not

136

143

found in the file, the corresponding empty value is displayed, which is an

137

empty string for the Title, Artist,

138

Album and Comment line edits, 0 for the

139

numerical Year and Track edits and

140

an empty selected value for the Genre

144

empty string for the <span class="guilabel">Title</span>, <span class="guilabel">Artist</span>,

145

<span class="guilabel">Album</span> and <span class="guilabel">Comment</span> line edits, 0 for the

146

numerical <span class="guilabel">Year</span> and <span class="guilabel">Track</span> edits and

147

an empty selected value for the <span class="guilabel">Genre</span>

141

148

combo box. The values can be changed and if the corresponding check box is

142

149

checked, they will be set for the selected file after the selection is

143

150

changed. The file is then marked as modified by a disk symbol in the file

144

listbox but remains unchanged until the Save

151

listbox but remains unchanged until the <span class="guimenuitem">Save</span>

145

152

command is used.

146

153

</p><p>

147

154

If multiple files are selected, only the values which are identical in all

150

157

unwanted changes. If a value has to be set for all selected files, it can

151

158

be edited and the checkbox has to be set. The values will be set for all

152

159

selected files when the selection is changed and can be saved using the

153

Save command.

160

<span class="guimenuitem">Save</span> command.

154

161

</p><p>

155

162

The check boxes also control the operation of most commands affecting the

156

163

tags, such as copy, paste and transfer between V1 and V2 tags. To make it

158

165

commands behave in the same way when all check boxes are checked and when all

159

166

check boxes are unchecked.

160

167

</p><p>

161

From Filename: The tags are set from the filename.

162

First, the format specified in Format is used. If the

168

<span class="guibutton">From Filename</span>: The tags are set from the filename.

169

First, the format specified in <span class="guilabel">Format</span> is used. If the

163

170

existing filename does not match this format, the following formats

164

171

are tried:

165

<div class="itemizedlist"><ul type="disc"><li><p><tt>Artist - Album/Track Song</tt></p></li><li><p><tt>Album/Track - Artist - Song</tt></p></li><li><p><tt>/Artist - Album - Track - Song</tt></p></li><li><p><tt>Album/Artist - Track - Song</tt></p></li><li><p><tt>Album/Artist - Song</tt></p></li><li><p><tt>Artist/Album/Track Song</tt></p></li></ul></div>

172

</p><div class="itemizedlist"><ul type="disc"><li><p><code class="filename">Artist - Album/Track Song</code></p></li><li><p><code class="filename">Album/Track - Artist - Song</code></p></li><li><p><code class="filename">/Artist - Album - Track - Song</code></p></li><li><p><code class="filename">Album/Artist - Track - Song</code></p></li><li><p><code class="filename">Album/Artist - Song</code></p></li><li><p><code class="filename">Artist/Album/Track Song</code></p></li></ul></div><p>

166

173

If a single file is selected, the GUI controls are filled with the values

167

174

extracted from the filename. If multiple files are selected, the tags of the

168

175

files are directly set according to the filenames.

169

176

</p><p>

170

From ID3v2: The ID3v1.1 tags are set from the

177

<span class="guibutton">From ID3v2</span>: The ID3v1.1 tags are set from the

171

178

corresponding values in the ID3v2.3 tags.

172

179

If a single file is selected, the GUI controls are filled with the values

173

180

from the ID3v2.3 tags. If multiple files are selected, the tags of the

174

181

files are directly set.

175

182

</p><p>

176

Copy: The copy buffer is filled with the ID3v1.1 values.

183

<span class="guibutton">Copy</span>: The copy buffer is filled with the ID3v1.1 values.

177

184

Only values with checked checkbox will be used in subsequent Paste commands.

178

185

</p><p>

179

Paste: Pastes the values from the copy buffer into the

186

<span class="guibutton">Paste</span>: Pastes the values from the copy buffer into the

180

187

GUI controls.

181

188

</p><p>

182

Remove: This will set all GUI controls to their empty

189

<span class="guibutton">Remove</span>: This will set all GUI controls to their empty

183

190

values which results in removing all values. The saved file will then contain

184

191

no ID3v1.1 tags.

185

</p></dd><dt><span class="term">ID3v2.3</span></dt><dd><p>

192

</p></dd><dt><span class="term"><span class="guilabel">ID3v2.3</span></span></dt><dd><p>

186

193

The GUI controls function in the same way as described for the

187

ID3v1.1 section, but the size of the strings is not limited.

188

</p><p>

189

Frames: The ID3v2.3 tags can not only contain the same values

194

<span class="guilabel">ID3v1.1</span> section, but the size of the strings is not limited.

195

</p><p>

196

For the ID3v2.3 <span class="guilabel">Genre</span> you can also use your own names

197

besides the genres listed in the combo box, just type the name into the line

198

edit. If such a custom genre shall be present in the combo box list in the

199

future, type <span><strong class="keycap">Enter</strong></span>.

200

</p><p>

201

<span class="guilabel">Frames</span>: The ID3v2.3 tags can not only contain the same values

190

202

as the ID3v1.1 tags, the format is built in a flexible way from several frames

191

203

which are themselves composed of several fields. The frames list box shows

192

204

all the frames which are available in the selected file.

193

205

</p><p>

194

Edit: This will open a window which allows to edit all fields

206

<span class="guibutton">Edit</span>: This will open a window which allows to edit all fields

195

207

of the selected frame. This is equivalent to double clicking on the selected frame.

196

208

</p><p>

197

Add: A requester to select the frame type will appear

198

and a frame of the selected type is added to the file.

209

<span class="guibutton">Add</span>: A requester to select the frame type will appear

210

and a frame of the selected type can be edited and added to the file. This

211

works also to add a frame to multiple selected files.

199

212

</p><p>

200

Delete: Deletes the selected frame.

201

</p></dd></dl></div></div><div class="sect2"><div class="titlepage"><div><h3 class="title"><a name="id2387342"></a>The File Menu</h3></div></div><p>

202

<div class="variablelist"><dl><dt><span class="term">File->Open... (<b><b>Ctrl</b>-<b>O</b></b>)</span></dt><dd><p>Opens a directory. All files matching the selected

203

file name filter will be displayed in the file listbox.</p></dd><dt><span class="term">File->Open Recent</span></dt><dd><p>Opens a recently opened directory.</p></dd><dt><span class="term">File->Save (<b><b>Ctrl</b>-<b>S</b></b>)</span></dt><dd><p>Saves all changed files in the directory. The

204

changed files are marked with an asterisk in the file listbox. If any file

205

names have been changed, those files will be renamed.</p></dd><dt><span class="term">File->Revert</span></dt><dd><p>Reverts the changes of one or multiple files. If no

213

<span class="guibutton">Delete</span>: Deletes the selected frame.

214

</p></dd></dl></div></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2453190"></a>The File Menu</h3></div></div></div><p>

215

</p><div class="variablelist"><dl><dt><span class="term"><span class="guimenu">File</span>-><span class="guimenuitem">Open...</span> (<span><strong class="shortcut"><span><strong class="keycap">Ctrl</strong></span>-<span><strong class="keycap">O</strong></span></strong></span>)</span></dt><dd><p><span class="action">Opens a directory.</span> All files matching the selected

216

file name filter will be displayed in the file listbox.</p></dd><dt><span class="term"><span class="guimenu">File</span>-><span class="guimenuitem">Open Recent</span></span></dt><dd><p><span class="action">Opens a recently opened directory.</span></p></dd><dt><span class="term"><span class="guimenu">File</span>-><span class="guimenuitem">Save</span> (<span><strong class="shortcut"><span><strong class="keycap">Ctrl</strong></span>-<span><strong class="keycap">S</strong></span></strong></span>)</span></dt><dd><p><span class="action">Saves all changed files in the directory.</span> The

217

changed files are marked with a disk symbol in the file listbox. If any file

218

names have been changed, those files will be renamed.</p></dd><dt><span class="term"><span class="guimenu">File</span>-><span class="guimenuitem">Revert</span></span></dt><dd><p><span class="action">Reverts the changes of one or multiple files.</span> If no

206

219

files are selected in the file listbox, the changes of all files will be

207

220

reverted, else only the changes of the selected files are reverted.

208

</p></dd><dt><span class="term">File->Import...</span></dt><dd><p>The Import dialog can be used to import data

221

</p></dd><dt><span class="term"><span class="guimenu">File</span>-><span class="guimenuitem">Import...</span></span></dt><dd><p>The <span class="action">Import dialog</span> can be used to import data

209

222

directly from a freedb.org server, from the Web-interface of <a href="http://freedb.org" target="_top">freedb.org</a>, from a MusicBrainz server or other

210

223

sources of album track lists in textual format.

211

224

</p><p>

212

225

Import from a freedb.org server is possible using a dialog which appears when

213

From freedb.org is selected. The words to search for

226

<span class="guibutton">From freedb.org</span> is selected. The words to search for

214

227

(e.g. artist and album name) can be entered there, the albums which match the

215

query will be displayed when Find is clicked and the

228

query will be displayed when <span class="guibutton">Find</span> is clicked and the

216

229

results from <a href="http://www.freedb.org" target="_top">www.freedb.org</a> are

217

230

received. If multiple entries for one album are found, the second entry is

218

231

displayed as 2, then 3 and so on. Importing the track data for an album is

220

233

can be selected as well as the CGI path and a proxy, if necessary. The

221

234

imported data is displayed in the preview table of the import dialog. To work

222

235

in that dialog again, the freedb.org dialog has to be closed - it can be

223

reopened later by clicking From freedb.org again and

236

reopened later by clicking <span class="guibutton">From freedb.org</span> again and

224

237

its contents will be restored. When satisfied with the displayed tracks, they

225

238

can be imported by terminating the import dialog with

226

OK.

239

<span class="guibutton">OK</span>.

227

240

</p><p>

228

241

Import from a MusicBrainz server is possible using the dialog which appears when

229

From MusicBrainz is selected. Server and proxy can be

242

<span class="guibutton">From MusicBrainz</span> is selected. Server and proxy can be

230

243

selected as in the freedb import dialog. Below is a table displaying the

231

244

imported track data. The right column shows the state of the MusicBrainz

232

245

query, which starts with "Pending" when the dialog is opened. Then the TRM

236

249

tags before the import. If a result was found, the search ends in the state

237

250

"Recognized", otherwise nothing was found or multiple ambiguous results and one

238

251

of them has to be selected by the user.

239

OK and Apply use the imported

240

data, Cancel closes the dialog. The closing can take a

252

<span class="guibutton">OK</span> and <span class="guibutton">Apply</span> use the imported

253

data, <span class="guibutton">Cancel</span> closes the dialog. The closing can take a

241

254

while since the whole MusicBrainz machinery has to be shut down.

242

255

</p><p>

243

256

For the import of textual data, several preconfigured import formats are

244

available. The first, "freedb HTML

257

available. The first two, "CSV unquoted" and "CSV quoted" can be used to

258

import data which was exported by the Export dialog. The CSV data can be

259

edited with a spreadsheet, and shall be written using tabs as

260

delimiters. Import should then be possible using "CSV quoted", which is more

261

flexible than "CSV unquoted". However, its fields cannot contain any double

262

quotes. If you only export from <span class="application">Kid3</span> and import later, "CSV unquoted" can be

263

used as a simple format for this purpose.

264

</p><p>

265

The next format, "freedb HTML

245

266

text", can be used to copy information from an HTML page of

246

267

<a href="http://freedb.org" target="_top">freedb.org</a>. Search an album in freedb

247

268

and if the desired information is displayed in the web browser, copy the

248

contents to the clipboard. Then click the From

249

Clipboard button and the imported tracks will be displayed in the

269

contents to the clipboard. Then click the <span class="guibutton">From

270

Clipboard</span> button and the imported tracks will be displayed in the

250

271

preview table at the top of the dialog. If you are satisfied with the imported

251

data, terminate the dialog with OK, which will insert

272

data, terminate the dialog with <span class="guibutton">OK</span>, which will insert

252

273

the data into the tags of the current directory. The destination

253

(ID3v1 or ID3v2) can be selected

274

(<span class="guilabel">ID3v1</span> or <span class="guilabel">ID3v2</span>) can be selected

254

275

with a combo box. The files in the current directory should be in the correct

255

276

track order to get their tags assigned. This is the case if they are numbered.

256

277

</p><p>

257

The second preconfigured import format, "freedb HTML source", can be used, if

278

The next preconfigured import format, "freedb HTML source", can be used, if

258

279

the data is available as an HTML document. Import is possible using the

259

From File button, which opens a file selector, or

280

<span class="guibutton">From File</span> button, which opens a file selector, or

260

281

copying its contents from an editor and then importing from clipboard. This

261

282

format can be useful for offline import, although the HTML document could also

262

283

be opened in a browser and then be imported in the first format via the clipboard.

269

290

from the start of the document to the end to get track data, usually number

270

291

and title. The regular expressions include all the features offered by Qt,

271

292

which is most of the what Perl offers. Bracketing constructs "(..)" create

272

capture buffers for the fields to import and are preceded by Kid3 specific

293

capture buffers for the fields to import and are preceded by <span class="application">Kid3</span> specific

273

294

codes to specify which field to capture. The codes are the same as used for

274

295

the filename format:

275

296

276

297

For example, a track regular expression (second line) to import from an

277

298

.m3u playlist could be "%t(\d+)\s+%s(\S[^\r\n]*)\.mp3[\r\n]". All formats can

278

299

be changed by editing the regular expressions and the name and then clicking

279

OK. They will be stored in the

280

<tt>kid3rc</tt> file in the configuration directory. This file can

300

<span class="guibutton">OK</span>. They will be stored in the

301

<code class="filename">kid3rc</code> file in the configuration directory. This file can

281

302

be directly edited to have more import formats or it can be deleted to revert

282

303

to the default formats.

283

304

</p><p>

284

305

To check whether the imported tracks match the current set of files, the

285

306

duration of the imported tracks can be compared with the duration of the

286

files. This option can be enabled with the checkbox Check maximum

287

allowable time difference and the maximum tolerated difference in

307

files. This option can be enabled with the checkbox <span class="guibutton">Check maximum

308

allowable time difference</span> and the maximum tolerated difference in

288

309

time can be set in seconds. If a mismatch in a length is detected, the length

289

310

is displayed with a red background in the preview table.

290

</p></dd><dt><span class="term">File->Create Playlist</span></dt><dd><p>Creates an M3U playlist. The file will be stored in

311

</p><p>

312

It the files are ordered differently than the imported tracks, their assigned

313

tracks have to be changed. This task can be facilitated using

314

the <span class="guilabel">Match with</span>

315

buttons <span class="guibutton">Length</span>, <span class="guibutton">Track</span>,

316

and <span class="guibutton">Title</span>, which will reorder the tracks according to

317

the corresponding field. To correct the assignments manually, a track can be

318

dragged with the left mouse button and the <span><strong class="keycap">Ctrl</strong></span> key hold

319

down, and then dropped at the new location.

320

</p></dd><dt><span class="term"><span class="guimenu">File</span>-><span class="guimenuitem">Import from freedb.org...</span></span></dt><dd><p><span class="action">Import from a freedb.org server.</span> This menu

321

item opens the same import dialog as <span class="guimenuitem">Import...</span>, but

322

opens directly the <span class="guibutton">From freedb.org</span>

323

dialog.</p></dd><dt><span class="term"><span class="guimenu">File</span>-><span class="guimenuitem">Import from MusicBrainz...</span></span></dt><dd><p><span class="action">Import from a MusicBrainz server.</span> This menu

324

item opens the same import dialog as <span class="guimenuitem">Import...</span>, but

325

opens directly the <span class="guibutton">From MusicBrainz</span>

326

dialog.</p></dd><dt><span class="term"><span class="guimenu">File</span>-><span class="guimenuitem">Export...</span></span></dt><dd><p>

327

The <span class="action">Export Dialog</span> is used to store data from the tags in a

328

file or the clipboard. The editor at the top shows a preview of the data to

329

export. The data can be edited before exporting, as it is exactly the contents

330

of the editor which will be stored. The data will be generated from the tags

331

in the current directory according to the configured format.

332

</p><p>

333

The format settings are similar as in the Import dialog: The topmost field

334

contains the title (e.g. "CSV unquoted"), followed by the header, which will

335

be generated at the begin of the file. The track data follows; it is used for

336

every track. Finally, the trailer can be used to generate some finishing

337

text.

338

</p><p>

339

The format fields do not contain regular expressions as in the Import dialog,

340

but only output format expressions with special %-expressions, which will be

341

replaced by values from the tags. The whole thing works like the file name

342

format, and the same codes are used plus some additional codes.

343

</p><div class="itemizedlist"><ul type="disc"><li><p>%s Title (Song)</p></li><li><p>%a Artist</p></li><li><p>%l Album</p></li><li><p>%c Comment</p></li><li><p>%y Year</p></li><li><p>%t Track</p></li><li><p>%T Track, without leading zeroes</p></li><li><p>%g Genre</p></li><li><p>%f File name</p></li><li><p>%p Path</p></li><li><p>%u URL</p></li><li><p>%d Duration in minutes:seconds</p></li><li><p>%D Duration in seconds</p></li><li><p>%n Number of tracks of the album</p></li></ul></div><p>

344

A few formats are predefined. "CSV unquoted" separates the fields by

345

tabs. Data in this format can be imported again into <span class="application">Kid3</span> using the import

346

format with the same name. "CSV quoted" additionally encloses the fields by

347

double quotes, which eases the import into spreadsheet applications. However,

348

the fields shall not contain any double quotes when this format is used.

349

"Extended M3U" and "Extended PLS" generate playlists with extended attributes

350

and absolute path names. "HTML" can be used to generate an HTML page with

351

hyperlinks to the tracks. "Kover XML" creates a file which can be imported by

352

the cover printing program Kover. Finally, "Custom Format" is left empty for

353

definition of a custom format. You can define more formats of your own by

354

adding lines in the file <code class="filename">kid3rc</code> in the configuration

355

directory. The other formats can be adapted to your needs.

356

</p><p>

357

The source of the tags to generate the export data (<span class="guilabel">ID3v1</span>

358

or <span class="guilabel">ID3v2</span>) can be selected with a combo

359

box. Pushing <span class="guibutton">To File</span> or

360

<span class="guibutton">To Clipboard</span> stores the data in a file or on the

361

clipboard. <span class="guibutton">OK</span> and <span class="guibutton">Cancel</span> close

362

the dialog, whereat <span class="guibutton">OK</span> accepts the current dialog

363

settings.

364

</p></dd><dt><span class="term"><span class="guimenu">File</span>-><span class="guimenuitem">Create Playlist</span></span></dt><dd><p><span class="action">Creates an M3U playlist.</span> The file will be stored in

291

365

the opened directory and have the same name as the directory, followed by

292

366

an .m3u extension. The file simply contains the names of the files displayed

293

367

in the file listbox, no special EXTM3U or EXTINFO lines are generated.

294

368

If all files of an album are stored in a separate directory, this function

295

can be used to generate a playlist for an album.</p></dd><dt><span class="term">File->Quit (<b><b>Ctrl</b>-<b>Q</b></b>)</span></dt><dd><p>Quits the application.</p></dd></dl></div>

296

</p></div><div class="sect2"><div class="titlepage"><div><h3 class="title"><a name="id2447531"></a>The Tools Menu</h3></div></div><p>

297

<div class="variablelist"><dl><dt><span class="term">Tools->Apply Format</span></dt><dd><p>When Format while editing is switched off

298

in the configuration dialog, this menu item can be used to apply

299

the configured format to the selected files. This can also be used

300

to check whether the file and tag names conform with the configured format

301

by applying the format to all saved files and then checking if any files were

302

changed (and therefore marked with an asterisk in the file listbox).

303

</p></dd><dt><span class="term">Tools->Rename Directory...</span></dt><dd><p>This dialog offers the possibility to automatically rename the

369

can be used to generate a playlist for an album.</p></dd><dt><span class="term"><span class="guimenu">File</span>-><span class="guimenuitem">Quit</span> (<span><strong class="shortcut"><span><strong class="keycap">Ctrl</strong></span>-<span><strong class="keycap">Q</strong></span></strong></span>)</span></dt><dd><p><span class="action">Quits the application.</span></p></dd></dl></div><p>

370

</p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2501275"></a>The Tools Menu</h3></div></div></div><p>

371

</p><div class="variablelist"><dl><dt><span class="term"><span class="guimenu">Tools</span>-><span class="guimenuitem">Apply Filename Format</span></span></dt><dd><p>When <span class="guilabel">Format while editing</span> is switched off

372

for the filename format in the configuration dialog, this menu item can be used to <span class="action">apply

373

the configured format to the names of the selected files</span>. This can also be used

374

to check whether the file names conform with the configured format

375

by applying the format to all saved files and then checking if any files were

376

changed (and therefore marked with a disk symbol in the file listbox).

377

</p></dd><dt><span class="term"><span class="guimenu">Tools</span>-><span class="guimenuitem">Apply ID3 Format</span></span></dt><dd><p>When <span class="guilabel">Format while editing</span> is switched off

378

for the ID3 format in the configuration dialog, this menu item can be used to <span class="action">apply

379

the configured format to the tags of the selected files</span>. This can also be used

380

to check whether the tags conform with the configured format

381

by applying the format to all saved files and then checking if any files were

382

changed (and therefore marked with a disk symbol in the file listbox).

383

</p></dd><dt><span class="term"><span class="guimenu">Tools</span>-><span class="guimenuitem">Rename Directory...</span></span></dt><dd><p>This dialog offers the possibility to automatically rename the

304

384

currently open directory according to the tags in the files. Several formats

305

385

are preconfigured to include information about artist, album and year in the

306

386

directory name. It is also possible to set a custom format, the following

308

388

309

389

If a directory separator "/" is found in the format, multiple directories are

310

390

created. If you want to create a new directory instead of renaming the current

311

directory, select Create Directory instead of

312

Rename Directory. The source of the tag information can

313

be chosen between From ID3v1 and From

314

ID3v2. A preview for the rename operation performed on the first

315

file can be seen in the From and To

391

directory, select <span class="guilabel">Create Directory</span> instead of

392

<span class="guilabel">Rename Directory</span>. The source of the tag information can

393

be chosen between <span class="guilabel">From ID3v1</span> and <span class="guilabel">From

394

ID3v2</span>. A preview for the rename operation performed on the first

395

file can be seen in the <span class="guilabel">From</span> and <span class="guilabel">To</span>

316

396

sections of the dialog.

317

</p></dd></dl></div>

318

</p></div><div class="sect2"><div class="titlepage"><div><h3 class="title"><a name="id2447699"></a>The Settings Menu</h3></div></div><p>

319

<div class="variablelist"><dl><dt><span class="term">Settings->Show Toolbar</span></dt><dd><p>Toggles displaying of the toolbar, which contains

320

icons to open and save a directory.</p></dd><dt><span class="term">Settings->Show Statusbar</span></dt><dd><p>Toggles displaying of the statusbar, which displays

321

longer actions such as opening or saving a directory.</p></dd><dt><span class="term">Settings->Configure Kid3...</span></dt><dd><p>Opens the configuration dialog, which

397

</p></dd><dt><span class="term"><span class="guimenu">Tools</span>-><span class="guimenuitem">Number Tracks...</span></span></dt><dd><p>

398

If the track numbers in the tags are not set or have the wrong values, this

399

function can <span class="action">number the tracks automatically in ascending

400

order</span>. The start number can be set in the dialog. If only part of the

401

tracks have to be numbered, they must be selected.

402

</p></dd></dl></div><p>

403

</p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2501508"></a>The Settings Menu</h3></div></div></div><p>

404

</p><div class="variablelist"><dl><dt><span class="term"><span class="guimenu">Settings</span>-><span class="guimenuitem">Hide ID3v1.1</span></span></dt><dd><p><span class="action">Toggles displaying of the ID3v1.1 section.</span>

405

</p></dd><dt><span class="term"><span class="guimenu">Settings</span>-><span class="guimenuitem">Hide ID3v2.3</span></span></dt><dd><p><span class="action">Toggles displaying of the ID3v2.3 section.</span>

406

</p></dd><dt><span class="term"><span class="guimenu">Settings</span>-><span class="guimenuitem">Show Toolbar</span></span></dt><dd><p><span class="action">Toggles displaying of the toolbar</span>, which contains

407

icons to open and save a directory.</p></dd><dt><span class="term"><span class="guimenu">Settings</span>-><span class="guimenuitem">Show Statusbar</span></span></dt><dd><p><span class="action">Toggles displaying of the statusbar</span>, which displays

408

longer actions such as opening or saving a directory.</p></dd><dt><span class="term"><span class="guimenu">Settings</span>-><span class="guimenuitem">Configure Kid3...</span></span></dt><dd><p>Opens the <span class="action">configuration dialog</span>, which

322

409

consists of two pages, one for general settings and one, which is used

323

410

to set the format for the strings in the tag fields and the filename.

324

411

</p><p>

325

On the page General the check box Preserve file

326

timestamp can be marked to preserve the file modification time

327

stamp. The check box Use track/total number of tracks

328

format controls whether the track number field of ID3v2 tags

412

On the page <span class="guilabel">General</span> the check box <span class="guilabel">Preserve file

413

timestamp</span> can be marked to preserve the file modification time

414

stamp. The check box <span class="guilabel">Use track/total number of tracks

415

format</span> controls whether the track number field of ID3v2 tags

329

416

contains simply the track number or additionally the total number of tracks in

330

the directory. The combo box Comment Field Name is only

417

the directory. The combo box <span class="guilabel">Comment Field Name</span> is only

331

418

relevant for Ogg/Vorbis and FLAC files and sets the name of the field used for

332

419

comments. Different applications seem to use different names, "COMMENT" for

333

420

instance is used by xmms, whereas amaroK uses "DESCRIPTION".

334

The Context Menu Commands table contains the commands

421

The <span class="guilabel">Context Menu Commands</span> table contains the commands

335

422

which can be used from the context menu of the file list. For critical

336

423

operations such as deleting files, it is advisable to mark

337

Confirm to pop up a confirmation dialog before executing

424

<span class="guilabel">Confirm</span> to pop up a confirmation dialog before executing

338

425

the command. To add and delete entries in this table, a context menu can be

339

426

used.

340

427

</p><p>

341

The page Format contains options for the format of

428

The page <span class="guilabel">Format</span> contains options for the format of

342

429

filenames and tags.

343

When Format while editing is checked, the format

344

configuration is automatically used while editing text in the line edits. The

345

format can be set separately for filenames and ID3 tags.

346

The Case Conversion can be set to No

347

changes, All lowercase, All

348

uppercase, First letter uppercase or

349

All first letters uppercase.

430

The format can be set separately for filenames and ID3 tags.

431

When <span class="guilabel">Format while editing</span> is checked, the format

432

configuration is automatically used while editing text in the line edits.

433

The <span class="guilabel">Case Conversion</span> can be set to <span class="guilabel">No

434

changes</span>, <span class="guilabel">All lowercase</span>, <span class="guilabel">All

435

uppercase</span>, <span class="guilabel">First letter uppercase</span> or

436

<span class="guilabel">All first letters uppercase</span>.

350

437

The string replacement list can be set to arbitrary string mappings. To add a

351

new mapping, select the From cell of a row and insert the

352

text to replace, then go to the To column and enter the

353

replacement text. To remove a mapping set the From cell

438

new mapping, select the <span class="guilabel">From</span> cell of a row and insert the

439

text to replace, then go to the <span class="guilabel">To</span> column and enter the

440

replacement text. To remove a mapping set the <span class="guilabel">From</span> cell

354

441

to an empty value (e.g. by first typing space and then backspace). Inserting

355

442

and deleting rows is also possible using a context menu which appears when the

356

443

right mouse button is clicked. Replacement is only active, if the

357

String Replacement checkbox is checked.

358

</p></dd><dt><span class="term">Settings->Configure Shortcuts...</span></dt><dd><p>Opens a dialog to assign keyboard shortcuts for most of the

444

<span class="guilabel">String Replacement</span> checkbox is checked.

445

</p></dd><dt><span class="term"><span class="guimenu">Settings</span>-><span class="guimenuitem">Configure Shortcuts...</span></span></dt><dd><p>Opens a dialog to assign keyboard shortcuts for most of the

359

446

program functions. There are even functions without corresponding menu or

360

447

button available, e.g. next file, previous file, select all.

361

448

</p><p>

362

</p></dd></dl></div>

363

</p></div><div class="sect2"><div class="titlepage"><div><h3 class="title"><a name="id2448757"></a>The Help Menu</h3></div></div><p>

364

<div class="variablelist"><dl><dt><span class="term">Help->Kid3 Handbook</span></dt><dd><p>Opens this handbook.</p></dd><dt><span class="term">Help->About Kid3</span></dt><dd><p>Displays a short information about Kid3.

365

</p></dd></dl></div>

366

</p></div></div></div><div class="chapter"><div class="titlepage"><div><h2 class="title"><a name="credits"></a>Chapter 4. Credits and License</h2></div></div><p>

367

Kid3

449

</p></dd></dl></div><p>

450

</p></div><div class="sect2" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2501828"></a>The Help Menu</h3></div></div></div><p>

451

</p><div class="variablelist"><dl><dt><span class="term"><span class="guimenu">Help</span>-><span class="guimenuitem">Kid3 Handbook</span></span></dt><dd><p><span class="action">Opens this handbook.</span></p></dd><dt><span class="term"><span class="guimenu">Help</span>-><span class="guimenuitem">About Kid3</span></span></dt><dd><p><span class="action">Displays a short information about Kid3;.

452

</span></p></dd></dl></div><p>

453

</p></div></div></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="credits"></a>Chapter�4.�Credits and License</h2></div></div></div><p>

454

368

455

</p><p>

369

Program written by Urs Fleisch <tt><<a href="mailto:ufleisch at users.sourceforge.net">ufleisch at users.sourceforge.net</a>></tt>

456

Program written by Urs Fleisch <code class="email"><<a href="mailto:ufleisch at users.sourceforge.net">ufleisch at users.sourceforge.net</a>></code>

370

457

</p><p><a name="gnu-fdl"></a>This documentation is licensed under the terms of the <a href="http://www.gnu.org/licenses/licenses.html#FDL" target="_top">GNU Free Documentation

371

372

Kid3 can be found at

458

License</a>.</p><p>This program is licensed under the terms of the <a href="http://www.gnu.org/licenses/licenses.html#GPL" target="_top">GNU General Public License</a>.</p></div><div class="appendix" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="installation"></a>Appendix�A.�Installation</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="sect1"><a href="#getting-kid3">How to obtain Kid3</a></span></dt><dt><span class="sect1"><a href="#requirements">Requirements</a></span></dt><dt><span class="sect1"><a href="#compilation">Compilation and Installation</a></span></dt><dt><span class="sect1"><a href="#configuration">Configuration</a></span></dt></dl></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="getting-kid3"></a>How to obtain Kid3</h2></div></div></div><p>

459

<span class="application">Kid3</span> can be found at

373

460

<a href="http://kid3.sourceforge.net" target="_top">http://kid3.sourceforge.net</a>.

374

</p></div><div class="sect1"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="requirements"></a>Requirements</h2></div></div><p>

375

Kid3 needs <a href="http://id3lib.sourceforge.net" target="_top">id3lib</a> and

461

</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="requirements"></a>Requirements</h2></div></div></div><p>

462

<span class="application">Kid3</span> needs <a href="http://id3lib.sourceforge.net" target="_top">id3lib</a> and

376

463

<a href="http://www.trolltech.com/qt/" target="_top">Qt</a>. <a href="http://www.kde.org" target="_top">KDE</a> is recommended but not necessary, as

377

Kid3 can also be compiled as a Qt application. Kid3 can be compiled for

464

<span class="application">Kid3</span> can also be compiled as a Qt application. <span class="application">Kid3</span> can be compiled for

378

465

systems where these libraries are available, e.g. for GNU/Linux and Windows.

379

466

To tag Ogg/Vorbis files, libogg, libvorbis and libvorbisfile are

380

467

required, for FLAC files libFLAC++ and libFLAC. For MusicBrainz support,

381

468

libtunepimp is used. As there does not exist a tunepimp SDK for Windows at the

382

469

moment, the Windows version is compiled without MusicBrainz import.

383

470

</p><p>

384

Kid3 was tested with

471

<span class="application">Kid3</span> was tested with

385

472

</p><p>

386

473

SuSE Linux 7.3: id3lib 3.8.0pre1, id3lib 3.8.0, id3lib 3.8.2, KDE 2.2.2,

387

474

KDE 3.0.4, Qt 2.3.2, Qt 3.0.5

398

485

Ubuntu 5.10: id3lib 3.8.3, KDE 3.4.3, Qt 3.3.4, libvorbis 1.1.0,

399

486

libogg 1.1.2, libflac++ 1.1.2, libtunepimp 0.3.0

400

487

</p><p>

488

Ubuntu 6.06: id3lib 3.8.3, KDE 3.4.3, Qt 3.3.6, libvorbis 1.1.2,

489

libogg 1.1.3, libflac++ 1.1.2, libtunepimp 0.3.0 and 0.4.2

490

</p><p>

491

Note that the MP3 format is not supported in the MusicBrainz import on Ubuntu

492

as libtunepimp is built without libmad.

493

</p><p>

401

494

Windows NT 4.0: id3lib 3.8.0, id3lib 3.8.2, id3lib 3.8.3, non-commercial Qt version 2.3.0

402

495

</p><p>

403

496

Windows 2000, XP: id3lib 3.8.3, non-commercial Qt Version 2.3.0,

404

497

non-commercial Qt Version 3.2.1, libvorbis 1.1.0, libogg 1.1.2, FLAC 1.1.2

405

</p></div><div class="sect1"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="compilation"></a>Compilation and Installation</h2></div></div><p>

406

You can compile Kid3 with or without KDE. Without KDE, Kid3 is a

498

</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="compilation"></a>Compilation and Installation</h2></div></div></div><p>

499

You can compile <span class="application">Kid3</span> with or without KDE. Without KDE, <span class="application">Kid3</span> is a

407

500

simple Qt application and lacks some configuration and session features.

408

501

</p><p>

409

502

Go into the top directory and type

410

411

<tt>%</tt> <b><tt>./configure</tt></b>

412

413

<tt>%</tt> <b><tt>make install</tt></b>

414

</pre>

503

</p><pre class="screen">

504

<code class="prompt">%</code> <strong class="userinput"><code>./configure</code></strong>

505

506

<code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>

507

</pre><p>

415

508

</p><p>

416

509

To compile for different versions of Qt or KDE, set the corresponding

417

<b><tt>configure</tt></b> options.

510

<strong class="userinput"><code>configure</code></strong> options.

418

511

</p><p>

419

To speed up compilation, Kid3 can use precompiled headers with GCC

420

3.4. Start <b><tt>configure</tt></b> with the option

421

<b><tt>--enable-gcc-pch</tt></b> (and setting CC and CXX to gcc and g++

512

To speed up compilation, <span class="application">Kid3</span> can use precompiled headers with GCC

513

3.4. Start <strong class="userinput"><code>configure</code></strong> with the option

514

<strong class="userinput"><code>--enable-gcc-pch</code></strong> (and setting CC and CXX to gcc and g++

422

515

of GCC 3.4 if it is not the default compiler). The create a precompiled system

423

include file with <b><tt>make pch</tt></b>.

516

include file with <strong class="userinput"><code>make pch</code></strong>.

517

</p><p>

518

Generation of RPM-Packages is supported by the

519

file <code class="filename">kid3.spec</code>, for Debian-Packages,

520

a <code class="filename">debian</code> directory is available.

424

521

</p><p>

425

522

The Qt application can also be compiled for Windows.

426

523

In the kid3 directory, type

427

428

<tt>></tt> <b><tt>nmake /f kid3.mak</tt></b>

429

</pre>

430

</p></div><div class="sect1"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="configuration"></a>Configuration</h2></div></div><p>With KDE, the file name filter and format, the import formats, the

524

</p><pre class="screen">

525

<code class="prompt">></code> <strong class="userinput"><code>nmake /f kid3.mak</code></strong>

526

</pre><p>

527

</p></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="configuration"></a>Configuration</h2></div></div></div><p>With KDE, the file name filter and format, the import formats, the

431

528

filename and ID3 formats, the toolbar and statusbar

432

529

settings as well as the window size will be be saved in the standard

433

location in file <tt>kid3rc</tt>.

434

As a Qt application, this file is in the <tt>.qt</tt> directory,

435

with older releases of Qt, a file <tt>kid3.cfg</tt> is created.

530

location in file <code class="filename">kid3rc</code>.

531

As a Qt application, this file is in the <code class="filename">.qt</code> directory,

532

with older releases of Qt, a file <code class="filename">kid3.cfg</code> is created.

436

533

</p></div></div></div></body></html>

Older »