'\" t
.\"     Title: kid3
.\"    Author: Urs Fleisch <ufleisch at users.sourceforge.net>
.\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
.\"      Date: 2018-12-23
.\"    Manual: The Kid3 Handbook
.\"    Source: 3.7.0
.\"  Language: English
.\"
.TH "KID3" "1" "2018-12-23" "3.7.0" "The Kid3 Handbook"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
kid3, kid3-qt, kid3-cli \- Kid3 ID3 Tagger
.SH "SYNOPSIS"
.HP \w'\fBkid3\fR\ 'u
\fBkid3\fR [\fB\-\-help\fR | \fB\-\-author\fR | \fB\-\-version\fR | \fB\-\-license\fR | \fB\-\-desktopfile\ \fR\fBFILE\fR] [\fIFILE\fR...]
.HP \w'\fBkid3\-qt\fR\ 'u
\fBkid3\-qt\fR [\fB\-\-portable\fR] [\fBQt\-options\fR] [\fIFILE\fR...]
.HP \w'\fBkid3\-cli\fR\ 'u
\fBkid3\-cli\fR [\fB\-\-portable\fR] [\fB\-\-dbus\fR] [\fB\-h\fR | \fB\-\-help\fR] [\fB\-c\ COMMAND1\fR] [\fB\-c\ COMMAND2\fR...] [\fIFILE\fR...]
.SH "OPTIONS"
.PP
\fB\-\-portable\fR
.RS 4
Store configuration in file
kid3\&.ini
inside application directory\&.
.RE
.PP
\fIFILE\fR
.RS 4
If
\fIFILE\fR
is the path to a directory, it will be opened\&. If one or more file paths are given, their common directory is opened and the files are selected\&.
.RE
.SS "kid3"
.PP
\fB\-\-help\fR
.RS 4
Show help about options\&.
.RE
.PP
\fB\-\-author\fR
.RS 4
Show author information\&.
.RE
.PP
\fB\-\-version\fR
.RS 4
Show version information\&.
.RE
.PP
\fB\-\-license\fR
.RS 4
Show license information\&.
.RE
.PP
\fB\-\-desktopfile \fR\fBFILE\fR
.RS 4
The base file name of the desktop entry for this application\&.
.RE
.SS "kid3\-qt"
.PP
\fBQt\-options\fR
.RS 4
See
\fBqt5options\fR(7)\&.
.RE
.SS "kid3\-cli"
.PP
\fB\-\-dbus\fR
.RS 4
Activate the D\-Bus interface\&.
.RE
.PP
\fB\-c\fR
.RS 4
Execute a command\&. Multiple
\fB\-c\fR
options are possible, they are executed in sequence\&. See the section about
kid3\-cli
for a description of the available commands\&.
.RE
.PP
\fB\-h\fR|\fB\-\-help\fR
.RS 4
Show help about options and commands\&.
.RE
.SH "INTRODUCTION"
.PP
Kid3
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, Opus, DSF, FLAC, MPC, APE, MP4/AAC, MP2, Speex, TrueAudio, WavPack, WMA, WAV, AIFF files and tracker modules (MOD, S3M, IT, XM) are supported too\&.
.PP
Kid3
does not grab nor encode 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 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 information for the tags is contained in the file name, the tags can be automatically set from the file name\&. It is also possible to set the file name according to the tags found in the file in arbitrary formats\&.
.PP
The editing task is further supported by automatic replacement of characters or substrings, for instance to remove illegal characters from filenames\&. Automatic control of upper and lower case characters makes it easy to use a consistent naming scheme in all tags\&.
.PP
The tag information for full albums can be taken from
\m[blue]\fBgnudb\&.org\fR\m[]\&\s-2\u[1]\d\s+2,
\m[blue]\fBTrackType\&.org\fR\m[]\&\s-2\u[2]\d\s+2,
\m[blue]\fBMusicBrainz\fR\m[]\&\s-2\u[3]\d\s+2,
\m[blue]\fBDiscogs\fR\m[]\&\s-2\u[4]\d\s+2,
\m[blue]\fBAmazon\fR\m[]\&\s-2\u[5]\d\s+2
or other sources of track lists\&. The import format is freely configurable by regular expressions\&.
.PP
Please report any problems or feature requests to the author\&.
.SH "USING KID3"
.SS "Kid3 features"
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Edit ID3v1\&.1 tags
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Edit all ID3v2\&.3 and ID3v2\&.4 frames
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Edit tags of multiple files
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Convert between ID3v1 and ID3v2 tags
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Edit MP3, Ogg/Vorbis, Opus, DSF, FLAC, MPC, APE, MP4/AAC, MP2, Speex, TrueAudio, WavPack, WMA, WAV and AIFF tags
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Generate tags from filename
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Generate tags from the contents of tag fields
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Generate filename from tags
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Generate and change directory names from tags
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Generate playlist file
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Automatic case conversion and string translation
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Import from
\m[blue]\fBgnudb\&.org\fR\m[]\&\s-2\u[1]\d\s+2,
\m[blue]\fBTrackType\&.org\fR\m[]\&\s-2\u[2]\d\s+2,
\m[blue]\fBMusicBrainz\fR\m[]\&\s-2\u[3]\d\s+2,
\m[blue]\fBDiscogs\fR\m[]\&\s-2\u[4]\d\s+2,
\m[blue]\fBAmazon\fR\m[]\&\s-2\u[5]\d\s+2
and other data sources
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Export as CSV, HTML, playlist, Kover XML and other formats\&. Exported CSV files can be imported again\&.
.RE
.SS "Example Usage"
.PP
This section describes a typical session with
Kid3\&. Let\*(Aqs assume we have a directory containing MP3 files with the tracks from the album "Let\*(Aqs Tag" from the band "One Hit Wonder"\&. The directory is named in the "artist \- album" format, in our case
One Hit Wonder \- Let\*(Aqs Tag\&. 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
\fBmkisofs\fR)\&. 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:
.PP
01 Intro\&.mp3
.PP
02 We Only Got This One\&.mp3
.PP
03 Outro\&.mp3
.PP
These files have no tags yet and we want to generate them using
Kid3\&. We use
Open
(File
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
To:
Tag 1
button in the
File
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
Date
and select "Pop" from the
Genre
combobox\&. To set only these two values, their checkboxes are automatically checked and all other checkboxes are left 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
One Hit Wonder \- Let\*(Aqs Tag\&.m3u
in the directory\&.
.SH "COMMAND REFERENCE"
.SS "The GUI Elements"
.PP
The
Kid3
GUI is separated in six sections: At the left are the file and directory listboxes, the right side contains the
File,
Tag 1,
Tag 2
and
Tag 3
sections\&.
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBFile List\fR
.RS 4
.PP
The file list contains the names of all the files in the opened directory which match the selected file name filter (typically
*\&.mp3 *\&.ogg *\&.opus *\&.dsf *\&.flac *\&.mpc *\&.aac *\&.m4a *\&.m4b *\&.m4p *\&.mp4 *\&.mp2 *\&.spx *\&.tta *\&.wv *\&.wma *\&.wav *\&.aiff *\&.ape)\&. 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\&.
.PP
Besides
Name, also other columns
Size,
Type,
Date Modified
with file details can be displayed\&. Columns can be hidden by unchecking their name in the context menu of the list header\&. The order of the columns can be changed by drag and drop\&. The sort order can be toggled by clicking on the column header\&.
.PP
At the left of the names an icon can be displayed: a disc to show that the file has been modified or information about which tags are present (V1, V2, V1V2 or NO TAG, no icon is displayed if the file has not been read in yet)\&.
.PP
Directories are displayed with a folder icon\&. If a directory is opened, its files are displayed in a hierarchical tree\&. By selecting files from subdirectories, operations can be executed on files in different directories, which is useful if the music collection is organized with a folder for each artist containing folders for albums of this artist\&.
.PP
Clicking the right mouse button inside the file list opens a context menu with the following commands:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Expand all: Expands all folder trees (only the current tree if the shift key is pressed)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Collapse all: Collapses all folder trees
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Rename: Changes the name of a file
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Move to Trash: Moves a file to the trash
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Play: Plays a file, see
Play\&. If the selected file is a playlist, the files of the playlist will be played\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Edit: Edit a playlist, see
Edit Playlist\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
The subsequent entries are user commands, which can be defined in the
User Actions
tab of
Configure Kid3\&. The playback on double click can also be activated there\&.
.RE
.sp
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBEdit Playlist\fR
.RS 4
.PP
A playlist can be created empty or containing the tracks of a folder, see
Create Playlist\&. The playlist file created in such a way can be edited by double click or using
Edit
from the file list context menu\&. A dialog with the entries of the playlist is shown\&. It is possible to open multiple playlists simultaneously\&.
.PP
New entries can be added by drag and drop from the file list, a file manager or another playlist\&. If an entry is dragged from another playlist, it will be moved or copied depending on the system\&. To invoke the other operation, respectively, the
Shift,
Ctrl
or
Alt
(to copy instead of move on macOS) key has to be pressed\&. Reordering entries within the playlist is also possible via drag and drop\&. Alternatively, entries can be moved using the keyboard shortcuts
Ctrl+Shift+Up
and
Ctrl+Shift+Down
(on macOS
Command
has to be pressed instead of
Ctrl)\&. An entry can be removed using the
Delete
key\&.
.PP
Please note the following: To drag entries from the file list, they have to be held at the left side (near the icons), the same gesture at the right side will perform a multi selection, such an action is hereby still easily possible\&.
.PP
When a playlist has been modified, the changes can be stored using
Save
or discarded using
Cancel\&. When the window is closed, a confirmation prompt is shown if there are unsaved changes\&.
.PP
Tracks selected in a playlist will be automatically selected in the file list, thereby making it possible to edit their tags\&.
.PP
To execute actions on a playlist, its file must be selected in the file list\&.
Edit
from the context menu will lead to the dialog described in this section, and
Play
will start the media player with the tracks from the playlist\&. User actions can act on playlists, for
example
Export Playlist Folder, which copies the files from a playlist into a folder\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBDirectory List\fR
.RS 4
.PP
The directory list contains the names of the directories in the opened directory, as well as the current (\&.) and the parent (\&.\&.) directory\&. It allows one to quickly change the directory without using the
Open\&.\&.\&.
command or drag and drop\&.
.PP
Column visibility, order and sorting can be configured as described in the section about the
file list\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBFile\fR
.RS 4
.PP
Shows information about the encoding (MP3, Ogg, Opus, DSF, FLAC, MPC, APE, MP2, MP4, AAC, Speex, TrueAudio, WavPack, WMA, WAV, AIFF), bit rate, sample rate, channels and the length of the file\&.
.PP
The
Name
line edit contains the name of the file (if only a single file is selected)\&. If this name is changed, the file will be renamed when the Save command is used\&.
.PP
The
Format
combo box and line edit contains the format to be used when the filename is generated from the first or the second tag\&. The filename can contain arbitrary characters, even a directory part separated by a slash from the file name, but that directory must already exist for the renaming to succeed\&. The following special codes are used to insert tag values into the filename:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%s %{title} Title (Song)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%a %{artist} Artist
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%l %{album} Album
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%c %{comment} Comment
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%y %{year} Year
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%t %{track} Track (e\&.g\&. 01)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%t %{track\&.n} Track with field width n (e\&.g\&. 001 for %{track\&.3})
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%T %{tracknumber} Track (without leading zeros, e\&.g\&. 1)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%g %{genre} Genre
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%{ignore} Ignored when generating tags from the file name
.RE
.PP
The format codes are not restricted to the examples given above\&. Any frame name can be used, for instance unified frame names like
\fB%{albumartist}\fR,
\fB%{discnumber\&.1}\fR,
\fB%{bpm}\fR
or format specific names like
\fB%{popm}\fR\&.
.PP
It is possible to prepend and append strings to the replacement for a format code by adding them in double quotes inside the curly braces of a format code\&. These strings will only be put into the resulting string if the format code yields a nonempty value\&. For example, if the file name shall both contain the title and the subtitle, one could use
\fB%{title} [%{subtitle}]\fR
in the format string\&. But this would result in a string ending with
[]
if no subtitle frame exists for a file\&. In order to omit the brackets if no subtitle is present,
\fB%{title}%{" ["subtitle"]"}\fR
shall be used instead\&. This will omit the brackets, the leading space and the subtitle if not subtitle exists\&.
.PP
The list of available formats can be edited in the dialog which appears when clicking the
Filename from tag
button in the
File
tab of the
settings\&.
.PP
A second
Format
combo box (with arrow down) is used to generate the tags from the filename\&. If the format of the filename does not match this pattern, a few other commonly used formats are tried\&.
.PP
Some commonly used filename formats are already available in the combo box, but it is also possible to type in some special format into the line edit\&.
.PP
The list of available formats can be edited in the dialog which appears when clicking the
Tag from filename
button in the
File
tab of the
settings\&.
.PP
Internally, a regular expression is built from the format codes\&. If advanced regular expressions are required, the format to generate the tags from the filenames can be given as a complete regular expression with captures which are preceded by the format codes, e\&.g\&. to extract the track numbers without removal of leading zeros, a format like "/%{track}(\ed+) %{title}(\&.*)" could be used\&.
.PP
From:
Tag 1,
Tag 2: Sets the filename using the selected format and the first tag or the second tag, respectively\&.
.PP
To:
Tag 1,
Tag 2: The tags are set from the filename\&. First, the format specified in
Format
is used\&. If the existing filename does not match this format, the following formats are tried:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Artist \- Album/Track Song
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Album/Track \- Artist \- Song
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
/Artist \- Album \- Track \- Song
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Album/Artist \- Track \- Song
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Album/Artist \- Song
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Artist/Album/Track Song
.RE
.sp
If a single file is selected, the GUI controls are filled with the values extracted from the filename\&. If multiple files are selected, the tags of the files are directly set according to the filenames\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBTag 1\fR
.RS 4
.PP
The line edit widgets for
Title,
Artist,
Album,
Comment,
Date,
Track Number
and
Genre
are used to edit the corresponding value in the first tag of the selected files\&. The value will be changed when the file selection is altered or before operations like
Save
and
Quit
and when the corresponding check box at the left of the field name is checked\&. This is useful to change only some values and leave the other values unchanged\&.
.PP
If a single file is selected, all check boxes are checked and the line edit widgets contain the values found in the tags of this file\&. If a tag is not found in the file, the corresponding empty value is displayed, which is an empty string for the
Title,
Artist,
Album
and
Comment
line edits, 0 for the numerical
Date
and
Track Number
edits and an empty selected value for the
Genre
combo box\&. The values can be changed and if the corresponding check box is checked, they will be set for the selected file after the selection is changed\&. The file is then marked as modified by a disk symbol in the file listbox but remains unchanged until the
Save
command is used\&.
.PP
If multiple files are selected, only the values which are identical in all selected files are displayed\&. In all other controls, the empty values as described above are displayed\&. All check boxes are unchecked to avoid unwanted changes\&. If a value has to be set for all selected files, it can be edited and the checkbox has to be set\&. The values will be set for all selected files when the selection is changed and can be saved using the
Save
command\&.
.PP
The check boxes also control the operation of most commands affecting the tags, such as copy, paste and transfer between tags 1 and 2\&. To make it easier to use with multiple files where all check boxes are unchecked, these commands behave in the same way when all check boxes are checked and when all check boxes are unchecked\&.
.PP
From Tag 2: The tag 1 fields are set from the corresponding values in tag 2\&. If a single file is selected, the GUI controls are filled with the values from tag 2\&. If multiple files are selected, the tags of the files are directly set\&.
.PP
Copy: The copy buffer is filled with the Tag 1 values\&. Only values with checked checkbox will be used in subsequent Paste commands\&.
.PP
Paste: Pastes the values from the copy buffer into the GUI controls\&.
.PP
Remove: This will set all GUI controls to their empty values which results in removing all values\&. The saved file will then contain no tag 1\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBTag 2\fR
.RS 4
.PP
The GUI controls function in the same way as described for the
Tag 1
section, but the size of the strings is not limited\&.
.PP
For the tag 2
Genre
you can also use your own names besides the genres listed in the combo box, just type the name into the line edit\&.
.PP
The tag 2 can not only contain the same values as the tag 1, the format is built in a flexible way from several frames which are themselves composed of several fields\&. The tag 2 table shows all the frames which are available in the selected file\&.
.PP
Edit: This will open a window which allows one to edit all fields of the selected frame\&. If multiple files are selected, the edited fields are applied to all selected files which contain such a frame\&.
.PP
Add: A requester to select the frame type will appear and a frame of the selected type can be edited and added to the file\&. This works also to add a frame to multiple selected files\&.
.PP
Delete: Deletes the selected frame in the selected files\&.
.PP
Drag album artwork here
is shown if the file does not contain embedded cover art\&. A picture can be added using drag and drop from a browser or file manager and will be displayed here\&. Picture frames can be edited or added by double clicking on this control\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBTag 3\fR
.RS 4
.PP
Some files can have more than two tags, and a third tag section is visible\&. The following file types can have such a
Tag 3
section:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
MP3 files can have an ID3v1\&.1 tag, an ID3v2 (2\&.3\&.0 or 2\&.4\&.0) tag and in the third section an APE tag\&. Such APE tags are used for replay gain information\&. In the
Tag 3
section, this information is visible, and the APE tag can be removed with the
Remove
button\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
The RIFF INFO chunk of WAV files is available in the
Tag 3
section because the
Tag 1
section is dedicated to ID3v1\&.1 tags and handles their restrictions\&. The
Tag 2
is still used for ID3v2\&.4\&.0 tags, which are also supported for WAV files, but RIFF INFO chunks seem to be supported better\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
FLAC files normally use a Vorbis comment for their meta data\&. However, there are FLAC files which have IDv1 and ID3v2 tags, which can be found in the
Tag 1
and
Tag 3
sections\&. ID3 tags in FLAC files are only supported by TagLib, therefore the OggFlacMetadata plugin has to be disabled in the
Plugins
tab of the
settings\&.
.RE
.sp
The GUI controls work in the same way as in the
Tag 2
section\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBSynchronized Lyrics and Event Timing Codes\fR
.RS 4
.PP
For information synchronized with the audio data, a specific editor is available\&. These frames are supported for ID3v2\&.3\&.0 and ID3v2\&.4\&.0 tags\&. To add such a frame, the specific frame name has to be selected in the list which appears when the
Add
button is clicked \-
Synchronized Lyrics
or
Event Timing Codes, respectively\&. The editor is the same for both types, for the event timing codes, only a predefined set of events is available whereas for the synchronized lyrics, text has to be entered\&. In the following, editing synchronized lyrics is explained\&.
.PP
A file having an ID3v2 tag is selected, the lyrics editor is entered using
Add
and selecting
Synchronized Lyrics\&. For an existing Synchronized Lyrics frame, it is selected and
Edit
is clicked\&. The player is automatically opened with the current file so that the file can be played and paused to synchronize lyrics\&.
.PP
The settings at the top of the SYLT editor normally do not have to be changed\&. If the lyrics contains characters which are not present in the Latin 1 character set, changing the text encoding to UTF16 (or UTF8 for ID3v2\&.4\&.0) is advisable\&. For English lyrics and maximum compatibility, ISO\-8859\-1 should be used\&.
.PP
The
Lyrics
section has five buttons at the top\&.
Add
will add a new time event in the table\&. The time is taken from the position of the player, thus adding an entry while playing the track will add a line for the currently played position\&. The events in the table have to be chronologically ordered, therefore the row will be inserted accordingly\&. Entries with an invalid time are treated specially: If the currently selected row has an invalid time, its time stamp will be replaced by the current time instead of adding a new row\&. If the current time is not invalid, the first row with an invalid time will be used if present\&. This behavior should facilitate adding time stamps if the lyrics text is already in the table but the time stamps are missing (which is the case when importing unsynchronized lyrics)\&. Note that the invalid time is represented as 00:00\&.00, i\&.e\&. the same as the time at the absolute beginning of the track, which is not invalid\&. To make a time invalid, press the
Delete
key, or use
Clear
from the context menu\&. New rows inserted using
Insert row
from the context menu or created when importing unsynchronized lyrics with
From Clipboard
or
Import
also contain invalid time stamps\&. Rows in the table can be deleted by clicking the
Delete
button or using
Delete rows
from the context menu\&.
.PP
Synchronized lyrics can be imported from a file using
Import\&. The expected format is simple or enhanced LRC\&. If the selected file does not contain a square bracket in the first line, it is supposed to be a simple text file with unsynchronized lyrics\&. The lines from such a file are then imported having invalid time stamps\&. The time information can be added using the
Add
button or by manual entry\&. It is also possible to import lyrics via copy\-paste using
From Clipboard\&. Synchronized lyrics can be written to LRC files using
Export\&. Note that only entries with valid time stamps will be exported and that the entries will be sorted by time\&. Entries with invalid time won\*(Aqt be stored in the SYLT frame either, so make sure to include all timing information before leaving the dialog\&.
.PP
The
\m[blue]\fBID3 specification\fR\m[]\&\s-2\u[6]\d\s+2
suggests a time stamp for each syllable\&. However most players only support the granularity of a line or sentence\&. To support both use cases,
Kid3
follows the same conventions as
\m[blue]\fBSYLT Editor\fR\m[]\&\s-2\u[7]\d\s+2\&. Text which is entered into the table is assumed to start a new line unless it starts with a space or a hyphen\&. Exceptions to this rule are possible by starting a line with an underscore (\*(Aq_\*(Aq) to force continuation or a hash mark (\*(Aq#\*(Aq) to force a new line\&. These escape characters are not stored inside the SYLT frame\&. Inside the SYLT frame, new lines start with a line feed character (hex 0A) whereas continuations do not\&. When reading SYLT frames,
Kid3
checks if the first entry starts with a line feed\&. If this is not the case, it is assumed that all entries are new lines and that no syllable continuations are used\&.
.PP
While the track is played, the row associated with the current playing position is highlighted, so that the correctness of the synchronization information can be verified\&. If an offset has to be added to one or more time stamps, this can be accomplished with the
Add offset
context menu\&. Negative values can be used to reduce the time\&. Using
Seek to position
in the context menu, it is possible to set the playing position to the time of the selected row\&.
.PP
\fIRecommended procedure to add new synchronized lyrics\fR
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Get the unsynchronized lyrics, e\&.g\&. using
Lyrics → Embed Lyrics
from the file list context menu\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Copy the unsynchronized lyrics to the clipboard, just go to the
Lyrics
row in the frame table and press
Ctrl+C\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Add a synchronized lyrics frame (Add\&.\&.\&.,
Synchronized Lyrics,
OK), click
From Clipboard\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Now all lines from the unsynchronized lyrics are in the table, all time stamps are invalid (0:0:0\&.00)\&. You can delete empty entries beforehand\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Start playing the song by clicking the play button
►
in the play toolbar at the bottom of the main window\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
When the next lyrics line with invalid timestamp comes, click
Add
or press
Alt+A, the timestamp will be updated\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Continue like this until all timestamps are set\&. If you missed something, stop playback and clear the timestamps using the
Delete
key or by selecting them and using
Clear
from the context menu\&. To restart playback from a given timestamp, use
Seek to position
from the context menu\&.
.RE
.sp
.RE
.SS "The File Menu"
.PP
.PP
File → Open\&.\&.\&. (Ctrl+O)
.RS 4
Opens a directory\&.
All files matching the selected file name filter will be displayed in the file listbox and the chosen file is selected\&.
.RE
.PP
File → Open Recent
.RS 4
Opens a recently opened directory\&.
.RE
.PP
File → Open Directory\&.\&.\&. (Ctrl+D)
.RS 4
Opens a directory\&.
All files matching the selected file name filter will be displayed in the file listbox\&.
.RE
.PP
File → Reload (F5)
.RS 4
Reload directory\&.
Modified files have to be saved before\&. Expanded subfolders will be collapsed\&.
.RE
.PP
File → Save (Ctrl+S)
.RS 4
Saves all changed files in the directory\&.
The changed files are marked with a disk symbol in the file listbox\&. If any file names have been changed, those files will be renamed\&.
.RE
.PP
File → Revert
.RS 4
Reverts the changes of one or multiple files\&.
If no files are selected in the file listbox, the changes of all files will be reverted, else only the changes of the selected files are reverted\&.
.RE
.PP
File → Import\&.\&.\&.
.RS 4
The
Import dialog
can be used to import data directly from a freedb\&.org server, from a MusicBrainz server, from Discogs, Amazon or other sources of album track lists in textual format\&.
.sp
Import from a freedb\&.org server is possible using a dialog which appears when
From Server:
gnudb\&.org
or
TrackType\&.org
is selected\&. The artist and album name to search for can be entered in the two topmost fields, the albums which match the query will be displayed when
Find
is clicked and the results from
\m[blue]\fBwww\&.gnudb\&.org\fR\m[]\&\s-2\u[8]\d\s+2
are received\&. Importing the track data for an album is done by double\-clicking the album in the list\&. The freedb\&.org server to import from can be selected as well as the CGI path\&. The imported data is displayed in the preview table of the import dialog\&. When satisfied with the displayed tracks, they can be imported by terminating the import dialog with
OK\&.
.sp
A search on the Discogs server can be performed using
Discogs\&. As in the
gnudb\&.org
dialog, you can enter artist and album and then choose from a list of releases\&. If
Standard Tags
is marked, the standard information is imported, e\&.g\&. artist, album, and title\&. If
Additional Tags
is marked, more information is imported if available, e\&.g\&. performers, arrangers, or the publisher\&. If
Cover Art
is marked, cover art will be downloaded if available\&.
.sp
A search on Amazon can be performed using
Amazon\&. As in the
gnudb\&.org
dialog, you can enter artist and album and then choose from a list of releases\&. If
Additional Tags
is marked, more information is imported if available, e\&.g\&. performers, arrangers, or the publisher\&. If
Cover Art
is marked, cover art will be downloaded if available\&.
.sp
You can search in the same way in the release database of MusicBrainz using
From MusicBrainz Release\&. The workflow is the same as described for
From gnudb\&.org\&.
.sp
Import from a MusicBrainz server is possible using the dialog which appears when
From MusicBrainz Fingerprint
is selected\&. The Server can be selected as in the freedb import dialog\&. Below is a table displaying the imported track data\&. The right column shows the state of the MusicBrainz query, which starts with "Pending" when the dialog is opened\&. Then the fingerprint is looked up and if it does not yield a result, another lookup using the tags in the file is tried\&. Thus it can be helpful for a successful MusicBrainz query to store known information (e\&.g\&. artist and album) in the tags before the import\&. If a result was found, the search ends in the state "Recognized", otherwise nothing was found or multiple ambiguous results and one of them has to be selected by the user\&.
OK
and
Apply
use the imported data,
Cancel
closes the dialog\&. The closing can take a while since the whole MusicBrainz machinery has to be shut down\&.
.sp
For the import of textual data,
From File/Clipboard
opens a subdialog, where several preconfigured import formats are available\&. The first two, "CSV unquoted" and "CSV quoted" can be used to import data which was exported by the Export dialog\&. The CSV data can be edited with a spreadsheet, and shall be written using tabs as delimiters\&. Import should then be possible using "CSV quoted", which is more flexible than "CSV unquoted"\&. However, its fields cannot contain any double quotes\&. If you only export from
Kid3
and import later, "CSV unquoted" can be used as a simple format for this purpose\&. Note that there are also "Export CSV" and "Import CSV" commands in the context menu of the file list, which use scripts to export and import CSV data in a more complete, powerful and flexible way\&.
.sp
The next format, "freedb HTML text", can be used to copy information from an HTML page of
\m[blue]\fBfreedb\&.org\fR\m[]\&\s-2\u[9]\d\s+2\&. Search an album in freedb and if the desired information is displayed in the web browser, copy the contents to the clipboard\&. Then click the
From Clipboard
button and the imported tracks will be displayed in the preview table at the top of the dialog\&. If you are satisfied with the imported data, terminate the dialog with
OK, which will insert the data into the tags of the current directory\&. The destination (Tag 1,
Tag 2
or
Tag 1 and Tag 2) can be selected with a combo box\&. The files in the current directory should be in the correct track order to get their tags assigned\&. This is the case if they are numbered\&.
.sp
The next preconfigured import format, "freedb HTML source", can be used, if the data is available as an HTML document\&. Import is possible using the
From File
button, which opens a file selector, or copying its contents from an editor and then importing from clipboard\&. This format can be useful for offline import, although the HTML document could also be opened in a browser and then be imported in the first format via the clipboard\&.
.sp
More preconfigured formats, e\&.g\&. "Track Title Time", are available\&. An empty custom format can be created with
Add
to be set by the user\&. Two lines below the format name can be set with a regular expression to capture the fields from the import text\&. The first regular expression will be parsed once per document to gather per\-album data such as artist, album, year and genre\&. The second line is tried to match from the start of the document to the end to get track data, usually number and title\&. The regular expressions include all the features offered by Qt, which is most of the what Perl offers\&. Bracketing constructs "(\&.\&.)" create capture buffers for the fields to import and are preceded by
Kid3
specific codes to specify which field to capture\&. The codes are the same as used for the filename format, besides the codes listed below, any frame name is possible:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%s %{title} Title (Song)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%a %{artist} Artist
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%l %{album} Album
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%c %{comment} Comment
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%y %{year} Year
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%t %{track} Track
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%g %{genre} Genre
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%d %{duration} Duration
.RE
.sp
For example, a track regular expression (second line) to import from an \&.m3u playlist could be "%{track}(\ed+)\es+%{title}(\eS[^\er\en]*)\e\&.mp3[\er\en]"\&. All formats can be changed by editing the regular expressions and the name and then clicking
Save Settings\&. They will be stored in the
kid3rc
file in the configuration directory\&. This file can be directly edited to have more import formats or it can be deleted to revert to the default formats\&. Formats can be deleted using
Remove\&.
.sp
Accuracy
shows an estimation of how good the imported information matches the given tracks\&. It uses track durations or file names to calculate the level of similarity in percent\&.
Cover Art
shows the URL of the album cover image which will be downloaded\&.
.sp
To check whether the imported tracks match the current set of files, the duration of the imported tracks can be compared with the duration of the files\&. This option can be enabled with the checkbox
Check maximum allowable time difference
and the maximum tolerated difference in time can be set in seconds\&. If a mismatch in a length is detected, the length is displayed with a red background in the preview table\&.
.sp
If the files are ordered differently than the imported tracks, their assigned tracks have to be changed\&. This task can be facilitated using the
Match with
buttons
Length,
Track, and
Title, which will reorder the tracks according to the corresponding field\&. To correct the assignments manually, a track can be dragged with the left mouse button and the
Ctrl
key hold down, and then dropped at the new location\&.
.sp
When the import dialog is opened, it contains the actual contents of the tags\&. The tag type (Tag 1, Tag 2, Tag 1 and Tag 2) can be selected using the
Destination
combo box\&. The button on the right of this combo box can be used to revert the table to the current contents of the tags\&. The checkboxes in the first table column can be used to select the tracks which are imported\&. This can be useful if a folder contains the tracks of both CDs of a double CD and only the tracks of the second CD have to be imported\&.
.sp
To identify the tracks which are imported, it is possible to display the file names or the full paths to the files using the context menu of the table header\&. The values in the import table can be edited\&. The revert\-button to the right of the
Destination
combo box can be used to restore the contents of the tags, which can also be useful after changing the
Destination\&.
.sp
Almost all dialogs feature a
Save Settings
button, which can be used to store the dialog specific settings and the window size persistently\&.
.sp
From Tags
leads to a subdialog to set tag frames from the contents of other tag frames\&. This can be used to simply copy information between tags or extract a part from one frame and insert it in another\&.
.sp
As in the
import from file/clipboard
dialog, there are freely configurable formats to perform different operations\&. Already preconfigured are formats to copy the Album value to Album Artist, Composer or Conductor, and to extract the Track Number from Title fields which contain a number\&. There is also a format to extract a Subtitle from a Title field\&.
.sp
The following example explains how to add a custom format, which sets the information from the Subtitle field also in the Comment field\&. Create a new format using
Add
and set a new name, e\&.g\&. "Subtitle to Comment"\&. Then enter "%{subtitle}" in
Source
and "%{comment}(\&.*)" for
Extraction
and click
Save Settings\&.
.sp
The expression in
Source
can contain
format codes
for arbitrary tag frames, multiple codes can be used to combine the contents from different frames\&. For each track, a text is generated from its tags using the
Source
format, and the regular expression from
Extraction
is applied to this text to set new values for the tags\&. Format codes are used before the capturing parentheses to specify the tag frame where the captured text shall be stored\&. It works in the same way as for the
import from file/clipboard\&.
.RE
.PP
File → Import from gnudb\&.org\&.\&.\&.
.RS 4
Import from a freedb\&.org server using gnudb\&.org album search\&.
This menu item opens the same import dialog as
Import\&.\&.\&., but opens directly the
gnudb\&.org
dialog\&.
.RE
.PP
File → Import from TrackType\&.org\&.\&.\&.
.RS 4
Import from the TrackType\&.org server\&.
This menu item opens the same import dialog as
Import\&.\&.\&., but opens directly the
TrackType\&.org
dialog\&.
.RE
.PP
File → Import from Discogs\&.\&.\&.
.RS 4
Import from the Discogs server\&.
This menu item opens the same import dialog as
Import\&.\&.\&., but opens directly the
From Discogs
dialog\&.
.RE
.PP
File → Import from Amazon\&.\&.\&.
.RS 4
Import from Amazon\&.
This menu item opens the same import dialog as
Import\&.\&.\&., but opens directly the
From Amazon
dialog\&.
.RE
.PP
File → Import from MusicBrainz Release\&.\&.\&.
.RS 4
Import from the MusicBrainz release database\&.
This menu item opens the same import dialog as
Import\&.\&.\&., but opens directly the
From MusicBrainz Release
dialog\&.
.RE
.PP
File → Import from MusicBrainz Fingerprint\&.\&.\&.
.RS 4
Import from a MusicBrainz server\&.
This menu item opens the same import dialog as
Import\&.\&.\&., but opens directly the
From MusicBrainz Fingerprint
dialog\&.
.RE
.PP
File → Automatic Import\&.\&.\&.
.RS 4
Automatic Import
allows one to import information for multiple albums from various web services\&. If directories are selected in the file list, track data for the selected directories will be imported\&. If no directory is selected, all directories in the file list will be imported\&.
.sp
The tag type (Tag 1, Tag 2, Tag 1 and Tag 2) can be selected using the
Destination
combo box\&.
.sp
Profiles determine which servers will be contacted to fetch album information\&. Some profiles are predefined (All, MusicBrainz, Discogs, Cover Art), custom profiles can be added using the
Add
button at the right of the
Profile
combo box\&.
.sp
The table below shows the servers which will be used when importing album information using the selected profile\&. The import process for an album is finished if all required information has been found, so the order of the rows in the table is important\&. It can be changed using the
Move Up
and
Move Down
buttons\&.
Edit
can be used to change an existing entry\&. The
Server
selection offers the same servers as can be used in the import functions\&.
Standard Tags,
Additional Tags,
Cover Art
determine the information which shall be fetched from the server\&. Finally,
Accuracy
is the minimum accuracy which must be achieved to accept the imported data\&. If the accuracy is insufficient, the next server in the list will be tried\&. The same dialog containing the server properties appears when
Add
is clicked to add a new server entry\&. Existing entries can be deleted using
Remove\&.
.sp
To launch an automatic batch import with the selected profile, click
Start\&. Details about the running import are displayed at the top of the dialog\&. The process can be aborted with the
Abort
button\&.
.sp
.RE
.PP
File → Browse Cover Art\&.\&.\&.
.RS 4
The
Browse Cover Art
dialog helps to find album cover art\&.
Artist/Album
is filled from the tags if possible\&.
Source
offers a variety of websites with album cover art\&. The URL with artist and album as parameters can be found beneath the name\&. URL\-encoded values for artist and album can be inserted using
\fB%u{artist}\fR
and
\fB%u{album}\fR, other values from the tags are possible too, as described in
Configure Kid3,
User Actions\&. More sources can be entered after the entry "Custom Source" by replacing "Custom Source" with the source\*(Aqs name, pressing Enter, then inserting the URL and finally pressing
Save Settings\&. The resulting browser command is displayed at the top of the dialog and can be started by clicking
Browse\&. The browser, which can be configured in the settings, is started with the selected source\&. A cover image can then be dragged from the browser into the
Kid3
window and will be set in the picture frame of the selected files\&.
.sp
Because not all browsers support drag and drop of images and the pictures on websites often have a URL, in such cases
Kid3
will receive the URL and not the picture\&. If the URL points to a picture, it will be downloaded\&. However, if the URL refers to some other web resource, it has to be translated to the corresponding picture\&. Such mappings are defined in the table
URL extraction\&. The left column
Match
contains a regular expression which is compared with the URL\&. If it matches, the captured expressions in parentheses are inserted into the pattern of the right
Picture URL
column (at the positions marked with \e1 etc\&.)\&. The replaced regular expression contains the URL of the picture\&. By this means cover art can be imported from Amazon, Google Images, etc\&. using drag and drop\&. It is also possible to define your own mappings\&.
.RE
.PP
File → Export\&.\&.\&.
.RS 4
The
Export Dialog
is used to store data from the tags in a file or the clipboard\&. The editor at the top shows a preview of the data to export\&. If the export data contain tabulator characters, the export is displayed in a table\&. The data will be generated from the tags in the current directory according to the configured format\&.
.sp
The format settings are similar as in the Import dialog: The topmost field contains the title (e\&.g\&. "CSV unquoted"), followed by the header, which will be generated at the begin of the file\&. The track data follows; it is used for every track\&. Finally, the trailer can be used to generate some finishing text\&.
.sp
The format fields do not contain regular expressions as in the Import dialog, but only output format expressions with special %\-expressions, which will be replaced by values from the tags\&. The whole thing works like the file name format, and the same codes are used plus some additional codes\&. Not only the codes listed below but all tag frame names can be used\&.
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%s %{title} Title (Song)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%a %{artist} Artist
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%l %{album} Album
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%c %{comment} Comment
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%y %{year} Year
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%t %{track} Track (e\&.g\&. 01)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%t %{track\&.n} Track with field width n (e\&.g\&. 001 for %{track\&.3})
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%T %{tracknumber} Track (without leading zeros, e\&.g\&. 1)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%g %{genre} Genre
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%f %{file} File name
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%p %{filepath} Path
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%u %{url} URL
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%{dirname} Directory name
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%d %{duration} Duration in minutes:seconds
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%D %{seconds} Duration in seconds
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%n %{tracks} Number of tracks of the album
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%e %{extension} File extension
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%O %{tag1} The format of tag 1 (ID3v1\&.1 or empty if not existing)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%o %{tag2} The format of tag 2 (ID3v2\&.3\&.0, ID3v2\&.4\&.0, ID3v2\&.2\&.0, ID3v2\&.2\&.1, Vorbis, APE, MP4, ASF, or empty if not existing)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%b %{bitrate} Bit rate in kbit/s
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%v %{vbr} VBR or empty (only for ID3v2\&.3 with id3lib)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%r %{samplerate} Sample rate in Hz
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%m %{mode} Channel mode (Stereo or Joint Stereo)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%h %{channels} Number of channels (1 or 2)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%k %{codec} Codec (e\&.g\&. MPEG 1 Layer 3, MP4, Ogg Vorbis, FLAC, MPC, APE, ASF, AIFF, WAV)
.RE
.sp
A few formats are predefined\&. "CSV unquoted" separates the fields by tabs\&. Data in this format can be imported again into
Kid3
using the import format with the same name\&. "CSV quoted" additionally encloses the fields by double quotes, which eases the import into spreadsheet applications\&. However, the fields shall not contain any double quotes when this format is used\&. "Extended M3U" and "Extended PLS" generate playlists with extended attributes and absolute path names\&. "HTML" can be used to generate an HTML page with hyperlinks to the tracks\&. "Kover XML" creates a file which can be imported by the cover printing program Kover\&. "Technical Details" provides information about bit rate, sample rate, channels, etc\&. Finally, "Custom Format" is left empty for definition of a custom format\&. You can define more formats of your own by adding lines in the file
kid3rc
in the configuration directory\&. The other formats can be adapted to your needs\&.
.sp
The source of the tags to generate the export data (Tag 1
or
Tag 2) can be selected with a combo box\&. Pushing
To File
or
To Clipboard
stores the data in a file or on the clipboard\&.
OK
and
Cancel
close the dialog, whereas
OK
accepts the current dialog settings\&.
.RE
.PP
File → Create Playlist
.RS 4
Creates a playlist\&.
The format and contents of the playlist can be set by various options\&.
.sp
The name of the playlist can be the
Same as directory name
or use a
Format
with values from the tags, e\&.g\&. "%{artist} \- %{album}" to have the artist and album name in the playlist file name\&. The format codes are the same as for
Export\&.
Create new empty playlist
will make an empty playlist with the given name\&. The extension depends on the playlist format\&.
.sp
The location of the generated playlist is determined by the selection of the
Create in
combo box\&.
.PP
Current directory
.RS 4
The playlist is created in the current directory and contains only files of the current directory\&. The current directory is the directory where the current file is located\&. If multiple files are selected, the current file is probably the last selected file\&.
.RE
.PP
Every directory
.RS 4
A playlist is created in every directory which contains listed files, and each playlist contains the files of that directory\&.
.RE
.PP
Top\-level directory
.RS 4
Only one playlist is created in the top\-level directory (i\&.e\&. the directory of the file list) and it contains the listed files of the top\-level directory and all of its sub\-directories\&.
.RE
.sp
The
Format
of the playlist can be
M3U,
PLS
or
XSPF\&.
.sp
If
Include only the selected files
is checked, only the selected files will be included in the playlist\&. If a directory is selected, all of its files are selected\&. If this check box is not activated, all audio files are included in the playlist\&.
.sp
Sort by file name
selects the usual case where the files are ordered by file name\&. With
Sort by tag field, it is possible to sort by a format string with values from tag fields\&. For instance, "%{track\&.3}" can be used to sort by track number (the "\&.3" is used to get three digits with leading zeros because strings are used for sorting)\&. It is also possible to use multiple fields, e\&.g\&. "%{genre}%{year}" to sort using a string composed of genre and year\&.
.sp
The playlist entries will have relative or absolute file paths depending on whether
Use relative path for files in playlist
or
Use full path for files in playlist
is set\&.
.sp
When
Write only list of files
is set, the playlist will only contain the paths to the files\&. To generate an extended playlist with additional information, a format string can be set using the
Write info using
control\&.
.RE
.PP
File → Quit (Ctrl+Q)
.RS 4
Quits the application\&.
.RE
.SS "The Edit Menu"
.PP
.PP
Edit → Select All (Alt+A)
.RS 4
Selects all files\&.
.RE
.PP
Edit → Deselect (Ctrl+Shift+A)
.RS 4
Deselects all files\&.
.RE
.PP
Edit → Select All in Directory
.RS 4
Selects all files of the current directory\&.
.RE
.PP
Edit → Previous File (Alt+Up)
.RS 4
Selects the previous file\&.
.RE
.PP
Edit → Next File (Alt+Down)
.RS 4
Selects the next file\&.
.RE
.PP
Edit → Find\&.\&.\&. (Ctrl+F)
.RS 4
Find strings in the file names and the tags\&. The
Find
dialog is a subset of the
Replace
dialog, which is described below\&.
.RE
.PP
Edit → Replace\&.\&.\&. (Ctrl+R)
.RS 4
This function opens a dialog to find and replace strings in the file names and the tags\&. The set of frames where the search is performed can be restricted by deactivating the
Select all
checkbox and selecting the frames which shall be searched\&. There are also search options available to search backwards, case sensitively, and to use regular expressions\&.
.sp
Depending on the number of files, the search might take some time, therefore it can be aborted by closing the dialog\&.
.RE
.SS "The Tools Menu"
.PP
.PP
Tools → Apply Filename Format
.RS 4
When
Automatically apply format
is switched off for the filename format in the configuration dialog, this menu item can be used to
apply the configured format to the names of the selected files\&. This can also be used to check whether the file names conform with the configured format by applying the format to all saved files and then checking if any files were changed (and therefore marked with a disk symbol in the file listbox)\&.
.RE
.PP
Tools → Apply Tag Format
.RS 4
When
Automatically apply format
is switched off for the tag format in the configuration dialog, this menu item can be used to
apply the configured format to the tags of the selected files\&. This can also be used to check whether the tags conform with the configured format by applying the format to all saved files and then checking if any files were changed (and therefore marked with a disk symbol in the file listbox)\&.
.RE
.PP
Tools → Apply Text Encoding
.RS 4
Sets the
Text encoding
selected in
Settings/Configure Kid3\&.\&.\&./Tags/Tag 2
for all selected files\&. If UTF8 is selected, UTF16 will be used for ID3v2\&.3\&.0 tags because UTF8 is not supported for this format\&.
.RE
.PP
Tools → Rename Directory\&.\&.\&.
.RS 4
This dialog offers the possibility to automatically rename the currently open directory according to the tags in the files\&. Several formats are preconfigured to include information about artist, album and year in the directory name\&. It is also possible to set a custom format and
Edit
the list of available formats\&. The following special codes are used to insert tag values into the directory name:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%s %{title} Title (Song)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%a %{artist} Artist
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%l %{album} Album
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%c %{comment} Comment
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%y %{year} Year
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%t %{track} Track (e\&.g\&. 01)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%t %{track\&.n} Track with field width n (e\&.g\&. 001 for %{track\&.3})
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%T %{tracknumber} Track (without leading zeros, e\&.g\&. 1)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%g %{genre} Genre
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%{dirname} Directory name (e\&.g\&. %{year" "}%{dirname} will prepend the year to the current directory name)
.RE
.sp
If a directory separator "/" is found in the format, multiple directories are created\&. If you want to create a new directory instead of renaming the current directory, select
Create Directory
instead of
Rename Directory\&. The source of the tag information can be chosen between
From Tag 1 and Tag 2,
From Tag 1
and
From Tag 2\&. A preview for the rename operation performed on the first file can be seen in the
From
and
To
sections of the dialog\&.
.sp
Multiple directories can be renamed by selecting them\&.
.RE
.PP
Tools → Number Tracks\&.\&.\&.
.RS 4
If the track numbers in the tags are not set or have the wrong values, this function can
number the tracks automatically in ascending order\&. The start number can be set in the dialog\&. If only part of the tracks have to be numbered, they must be selected\&.
.sp
When
Total number of tracks
is checked, the number of tracks will also be set in the tags\&.
.sp
It is possible to number the tracks over multiple directories\&. The folders have to be expanded and selected\&.
.sp
If
Reset counter for each directory
is checked, track numbering is restarted with the given number for each directory when multiple folders are selected\&.
.sp
The number tracks dialog can also be used to format existing track numbers without changing the values when the check box left to
Start number
is deactivated\&. The total number of tracks will be added if the corresponding check box is active, which can be used to set the total for all selected tracks\&. If only formatting of the existing numbers is desired, this check box has to be deactivated too\&.
.RE
.PP
Tools → Filter\&.\&.\&.
.RS 4
The filter can be used to display only those files which match certain criteria\&. This is helpful if you want to organize a large collection and only edit those files which are not in the desired scheme\&. The expression defining which files to display uses the same format codes which are used in the file name format, import and export\&.
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%s %{title} Title (Song)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%a %{artist} Artist
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%l %{album} Album
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%c %{comment} Comment
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%y %{year} Year
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%t %{track} Track (e\&.g\&. 01)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%t %{track\&.n} Track with field width n (e\&.g\&. 001 for %{track\&.3})
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%T %{tracknumber} Track (without leading zeros, e\&.g\&. 1)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%g %{genre} Genre
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%f %{file} File name
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%p %{filepath} Absolute path to file
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%e %{extension} File extension
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%O %{tag1} The format of tag 1 (ID3v1\&.1 or empty if not existing)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%o %{tag2} The format of tag 2 (ID3v2\&.3\&.0, ID3v2\&.4\&.0, ID3v2\&.2\&.0, ID3v2\&.2\&.1, Vorbis, APE, MP4, ASF, or empty if not existing)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%b %{bitrate} Bit rate in kbit/s
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%v %{vbr} VBR or empty (only for ID3v2\&.3 with id3lib)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%r %{samplerate} Sample rate in Hz
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%m %{mode} Channel mode (Stereo or Joint Stereo)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%h %{channels} Number of channels (1 or 2)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%k %{codec} Codec (e\&.g\&. MPEG 1 Layer 3, MP4, Ogg Vorbis, FLAC, MPC, APE, ASF, AIFF, WAV)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%w %{marked} Marked, is 1 if the file is marked (e\&.g\&. because of truncation or standard violation), empty otherwise
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%1a %1{artist}, \&.\&.\&. Use the prefix 1 to get values of tag 1
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%2a %2{artist}, \&.\&.\&. Use the prefix 2 to get values of tag 2
.RE
.sp
These codes are replaced with the values for the file, and the resulting strings can be compared with the following operations:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
s1 equals s2: true if s1 and s2 are equal\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
s1 contains s2: true if s1 contains s2, i\&.e\&. s2 is a substring of s1\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
s matches re: true if s matches the regular expression re\&.
.RE
.sp
True expressions are replaced by 1, false by 0\&. True values are represented by 1, true, on and yes, false values by 0, false, off and no\&. Boolean operations are not, and, or (in this order of precedence) and can be grouped by parentheses\&.
.sp
Some filter rules are predefined and can serve as examples for your own expressions:
.PP
All
.RS 4
When the file list is filtered \- this is shown by "[filtered]" in the window title \- and all files shall be displayed again, the filtering can be reverted using this filter\&. It uses an empty expression, but a true value would have the same effect\&.
.RE
.PP
Filename Tag Mismatch
.RS 4
\fB not (%{filepath} contains "%{artist} \- %{album}/%{track} %{title}") \fR
.sp
Tests if the file path conforms with the file name format\&. This rule is automatically adapted if the file name format changes\&.
.RE
.PP
No Tag 1
.RS 4
\fB %{tag1} equals "" \fR
.sp
Displays only files which do not have a tag 1\&.
.RE
.PP
No Tag 2
.RS 4
\fB %{tag2} equals "" \fR
.sp
Displays only files which do not have a tag 2\&.
.RE
.PP
ID3v2\&.3\&.0 Tag
.RS 4
\fB %{tag2} equals "ID3v2\&.3\&.0" \fR
.sp
Displays only files which have an ID3v2\&.3\&.0 tag\&.
.RE
.PP
ID3v2\&.4\&.0 Tag
.RS 4
\fB %{tag2} equals "ID3v2\&.4\&.0" \fR
.sp
Displays only files which have an ID3v2\&.4\&.0 tag\&.
.RE
.PP
Tag 1 != Tag 2
.RS 4
\fB not (%1{title} equals %2{title} and %1{album} equals %2{album} and %1{artist} equals %2{artist} and %1{comment} equals %2{comment} and %1{year} equals %2{year} and %1{track} equals %2{track} and %1{genre} equals %2{genre}) \fR
.sp
Displays files with differences between tag 1 and tag2\&.
.RE
.PP
Tag 1 == Tag 2
.RS 4
\fB %1{title} equals %2{title} and %1{album} equals %2{album} and %1{artist} equals %2{artist} and %1{comment} equals %2{comment} and %1{year} equals %2{year} and %1{track} equals %2{track} and %1{genre} equals %2{genre} \fR
.sp
Displays files with identical tag 1 and tag 2\&.
.RE
.PP
Incomplete
.RS 4
\fB %{title} equals "" or %{artist} equals "" or %{album} equals "" or %{year} equals "" or %{tracknumber} equals "" or %{genre} equals "" \fR
.sp
Displays files with empty values in the standard tags (title, artist, album, date, track number, genre)\&.
.RE
.PP
No Picture
.RS 4
\fB %{picture} equals "" \fR
.sp
Displays only files which do not have a picture\&.
.RE
.PP
Marked
.RS 4
\fB not (%{marked} equals "") \fR
.sp
Displays only files which are marked because they violate the ID3 standard, are truncated or the picture is too large\&.
.RE
.PP
Custom Filter
.RS 4
To add your own filter, select this entry\&. For instance, if you want to have a filter for artists starting with "The", replace "Custom Filter" with the name "The Bands" and press Enter\&. Then insert the following expression into the line edit:
.sp
\fB %{artist} matches "The\&.*" \fR
.sp
Then click
Save Settings\&. Click
Apply
to filter the files\&. All files processed are displayed in the text view, with a "+" for those who match the filter and a "\-" for the others\&. When finished, only the files with an artist starting with "The" are displayed, and the window title is marked with "[filtered]"\&.
.RE
.RE
.PP
Tools → Convert ID3v2\&.3 to ID3v2\&.4
.RS 4
If there are any ID3v2\&.3 tags in the selected files, they will be
converted to ID3v2\&.4
tags\&. Frames which are not supported by TagLib will be discarded\&. Only files without unsaved changes will be converted\&.
.RE
.PP
Tools → Convert ID3v2\&.4 to ID3v2\&.3
.RS 4
If there are any ID3v2\&.4 tags in the selected files, they will be
converted to ID3v2\&.3
tags\&. Only files without unsaved changes will be converted\&.
.RE
.PP
Tools → Play
.RS 4
This opens a simple toolbar to play audio files\&. It contains buttons for the basic operations (Play/Pause,
Stop playback,
Previous Track,
Next Track,
Close), sliders for position and volume and a display of the current position\&. If multiple files are selected, the selected tracks are played, else all files will be played\&.
.RE
.SS "The Settings Menu"
.PP
.PP
Settings → Show Toolbar
.RS 4
Toggles displaying of the toolbar\&.
.RE
.PP
Settings → Show Statusbar
.RS 4
Toggles displaying of the statusbar, which displays longer actions such as opening or saving a directory\&.
.RE
.PP
Settings → Show Picture
.RS 4
Toggles displaying of the album cover art preview picture\&.
.RE
.PP
Settings → Auto Hide Tags
.RS 4
Empty tags are automatically hidden if this option is active\&. The
File,
Tag 1
and
Tag 2
sections can be manually collapsed and expanded by clicking on the corresponding
\-/+
buttons\&.
.RE
.PP
Settings → Configure Kid3\&.\&.\&.
.RS 4
Opens the
configuration dialog, which consists of pages for tags, files, user actions, and network settings\&.
.sp
Tag specific options can be found on the
Tags
page, which is itself separated into four tabs for
Tag 1,
Tag 2,
Tag 3, and
All Tags\&.
.sp
If
Mark truncated fields
is checked, truncated ID3v1\&.1 fields will be marked red\&. The text fields of ID3v1\&.1 tags can only have 30 characters, the comment only 28 characters\&. Also the genre and track numbers are restricted, so that fields can be truncated when imported or transferred from ID3v2\&. Truncated fields and the file will be marked red, and the mark will be removed after the field has been edited\&.
.sp
With
Text encoding
for
ID3v1
it is possible to set the character set used in ID3v1 tags\&. This encoding is supposed to be ISO\-8859\-1, so it is recommended to keep this default value\&. However, there are tags around with different encoding, so it can be set here and the ID3v1 tags can then be copied to ID3v2 which supports Unicode\&.
.sp
The check box
Use track/total number of tracks format
controls whether the track number field of ID3v2 tags contains simply the track number or additionally the total number of tracks in the directory\&.
.sp
When
Genre as text instead of numeric string
is checked, all ID3v2 genres will be stored as a text string even if there is a corresponding code for ID3v1 genres\&. If this option is not set, genres for which an ID3v1 code exists are stored as the number of the genre code (in parentheses for ID3v2\&.3)\&. Thus the genre Metal is stored as "Metal" or "(9)" depending on this option\&. Genres which are not in the list of ID3v1 genres are always stored as a text string\&. The purpose of this option is improved compatibility with devices which do not correctly interpret genre codes\&.
.sp
When
WAV files with lowercase id3 chunk
is checked, the RIFF chunk used to store ID3v2 tags in WAV files will be named "id3 " instead of "ID3 "\&. By default,
Kid3
and other applications using TagLib accept both the lowercase and the uppercase variant when reading WAV files, but they use "ID3 " when writing ID3v2 tags to WAV files\&. As there exist other applications which only accept "id3 " (e\&.g\&. JRiver Media Center and foobar2000), this option can be used to create tags which can be read by such applications\&.
.sp
When
Mark standard violations
is checked, ID3v2 fields which violate the standard will be marked red\&. Details about the violation are shown in a tooltip:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Must be unique
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
New line is forbidden
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Carriage return is forbidden
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Owner must be non\-empty
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Must be numeric
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Must be numeric or number/total
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Format is DDMM
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Format is HHMM
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Format is YYYY
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Must begin with a year and a space character
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Must be ISO 8601 date/time
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Must be musical key, 3 characters, A\-G, b, #, m, o
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Must have ISO 639\-2 language code, 3 lowercase characters
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Must be ISRC code, 12 characters
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Must be list of strings separated by \*(Aq|\*(Aq
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Has excess white space
.RE
.sp
The ID3 standard documents are available online:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\m[blue]\fBID3 tag version 2\&.3\&.0\fR\m[]\&\s-2\u[10]\d\s+2
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\m[blue]\fBID3 tag version 2\&.4\&.0 \- Main Structure\fR\m[]\&\s-2\u[11]\d\s+2
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
\m[blue]\fBID3 tag version 2\&.4\&.0 \- Native Frames\fR\m[]\&\s-2\u[6]\d\s+2
.RE
.sp
Text encoding
defines the default encoding used for ID3v2 frames and can be set to
ISO\-8859\-1,
UTF16, or
UTF8\&.
UTF8
is not valid for ID3v2\&.3\&.0 frames; if it is set,
UTF16
will be used instead\&. For ID3v2\&.4\&.0 frames, all three encodings are possible\&.
.sp
Version used for new tags
determines whether new ID3v2 tags are created as version 2\&.3\&.0 or 2\&.4\&.0\&.
.sp
Track number digits
is the number of digits in Track Number fields\&. Leading zeros are used to pad\&. For instance, with a value of 2 the track number 5 is set as "05"\&.
.sp
The combo box
Comment field name
is only relevant for Ogg/Vorbis and FLAC files and sets the name of the field used for comments\&. Different applications seem to use different names, "COMMENT" for instance is used by xmms, whereas amaroK uses "DESCRIPTION"\&.
.sp
The format of pictures in Ogg/Vorbis files is determined by
Picture field name, which can be
METADATA_BLOCK_PICTURE
or
COVERART\&. The first is the official standard and uses the same format as pictures in FLAC tags\&. COVERART is an earlier unofficial way to include pictures in Vorbis comments\&. It can be used for compatibility with legacy players\&.
.sp
If the
Mark if larger than
check box is activated, files containing embedded album cover art exceeding the given size in bytes are marked red\&. This can be used to find files containing oversized pictures which are not accepted by some applications and players\&. The default value is 131072 bytes (128 KB)\&.
.sp
Custom Genres
can be used to define genres which are not available in the standard genre list, e\&.g\&. "Gothic Metal"\&. Such custom genres will appear in the
Genre
combo box of
Tag 2\&. For ID3v1\&.1 tags, only the predefined genres can be used\&.
.sp
The list of custom genres can also be used to reduce the number of genres available in the
Genre
combo box to those typically used\&. If your collection mostly contains music in the genres Metal, Gothic Metal, Ancient and Hard Rock, you can enter those genres and mark
Show only custom genres\&. The
Tag 2
Genre
combo box will then only contain those four genres and you will not have to search through the complete genres list for them\&. In this example, only Metal and Hard Rock will be listed in the tag 1 genres list, because those two custom genres entries are standard genres\&. If
Show only custom genres
is not active, the custom genres can be found at the end of the genres list\&.
.sp
Quick Access Frames
defines which frame types are always shown in the
Tag 2
section\&. Such frames can then be added without first using the
Add
button\&. The order of these quick access frames can be changed by dragging and dropping items\&.
.sp
The combo box
Track number field name
is only relevant for RIFF INFO and sets the name of the field used for track numbers\&. Track numbers are not specified in the original RIFF standard, there are applications which use "ITRK", others use "IPRT"\&.
.sp
Tag Format
contains options for the format of the tags\&. When
Automatically apply format
is checked, the format configuration is automatically used while editing text in the line edits\&. The
Case conversion
can be set to
No changes,
All lowercase,
All uppercase,
First letter uppercase
or
All first letters uppercase\&. To use locale\-aware conversion between lowercase and uppercase characters, a locale can be selected in the combobox below\&. The string replacement list can be set to arbitrary string mappings\&. To add a new mapping, select the
From
cell of a row and insert the text to replace, then go to the
To
column and enter the replacement text\&. To remove a mapping set the
From
cell to an empty value (e\&.g\&. by first typing space and then backspace)\&. Inserting and deleting rows is also possible using a context menu which appears when the right mouse button is clicked\&. Replacement is only active, if the
String replacement
checkbox is checked\&.
.sp
The table in
Rating
contains the mapping of star ratings to the effective values stored in the tag\&. The frames with rating information are listed in the Rating row of the frame list\&. For these frames, the rating can be set by giving a number of stars out of five stars\&. Different tag formats and different applications use different values to map the star rating to the value stored in the tag\&. In order to display the correct number of stars,
Kid3
will look up a map in this table\&. The key to look up the mapping is the frame name, for example "RATING" as used for Vorbis comments or "IRTD" for RIFF INFO\&. For ID3v2 tags, a combined key is used consisting of the frame ID "POPM" of the Popularimeter frame and its "Email" field, separated by a dot\&. Therefore, different keys for ID3v2 exist, e\&.g\&. "POPM\&.Windows Media Player 9 Series" for the mapping used by Windows Media Player and Explorer, and simply "POPM" for POPM frames with an empty "Email" field\&. As multiple entries for "POPM" can exist, their order is important\&. When
Kid3
adds a new Popularimeter frame, it will use the first "POPM" entry to determine the value to be written into the "Email" field\&. This value will then specify the mapping to be used for star ratings\&. The first entry is also used if no key was found, it is therefore the default entry\&.
.sp
Besides the
Name
column containing the keys, the table has columns
1
to
5
for the values to be stored when the corresponding number of stars is given\&. The other way round, the values determine the number of stars which are displayed for the value stored in the frame\&. For instance, the row in the table below contains the values 1, 64, 128, 196, 255\&. The thresholds for the number of stars to be displayed lay between these values and are compatible with what the Windows Explorer uses\&.
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.B Table\ \&1.\ \&Entry in Rating Table
.TS
allbox tab(:);
lB lB lB lB lB lB.
T{
Name
T}:T{
1
T}:T{
2
T}:T{
3
T}:T{
4
T}:T{
5
T}
.T&
l l l l l l
l l l l l l.
T{
POPM
T}:T{
1
T}:T{
64
T}:T{
128
T}:T{
196
T}:T{
255
T}
T{
Range
T}:T{
1\-31
T}:T{
32\-95
T}:T{
96\-159
T}:T{
160\-223
T}:T{
224\-255
T}
.TE
.sp 1
On the page
Files
the check box
Load last\-opened files
can be marked so that
Kid3
will open and select the last selected file when it is started the next time\&.
Preserve file timestamp
can be checked to preserve the file modification time stamp\&.
Filename for cover
sets the name which is suggested when an embedded image is exported to a file\&. With
Text encoding (Export, Playlist)
the encoding used when writing files can be set\&. The default
System
can be changed for example if playlists have to be used on a different device\&.
.sp
If
Mark changes
is active, changed fields are marked with a light gray label background\&.
.sp
The section
File List
determines which files are displayed in the file list\&. A
Filter
can be used to restrict the items in this list to files with supported extensions\&. To explicitly specify which directories to display in the file list or exclude certain directories, the options
Include folders
and
Exclude folders
can be used\&. They can contain wildcard expressions, for instance
*/Music/*
to include only the
Music
folder, or
*/iTunes/*
to exclude the iTunes folder from the file list\&. If multiple such expressions have to be used, they can be separated by spaces or semicolons\&.
.sp
The buttons
Filename from tag
and
Tag from filename
in section
Format
open dialogs to edit the formats which are available in the
Format
combo boxes (with arrows up and down), which can be found in the
File
section of the main window\&.
.sp
Filename Format
contains options for the format of the filenames\&. The same options as in
Tag Format
are available\&.
.sp
The
User Actions
page contains a table with the commands which are available in the context menu of the file list\&. For critical operations such as deleting files, it is advisable to mark
Confirm
to pop up a confirmation dialog before executing the command\&.
Output
can be marked to see the output written by console commands (standard output and standard error)\&.
Name
is the name displayed in the context menu\&.
Command
is the command line to be executed\&. Arguments can be passed using the following codes:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%F %{files} File paths (a list if multiple files selected)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%f %{file} File path to single file
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%uF %{urls} URLs (a list if multiple files selected)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%uf %{url} URL to single file
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%d %{directory} Directory
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%s %{title} Title (Song)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%a %{artist} Artist
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%l %{album} Album
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%c %{comment} Comment
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%y %{year} Year
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%t %{track} Track (e\&.g\&. 01)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%t %{track\&.n} Track with field width n (e\&.g\&. 001 for %{track\&.3})
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%T %{tracknumber} Track (without leading zeros, e\&.g\&. 1)
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%g %{genre} Genre
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%b %{browser} Command to start the web browser
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
%q %{qmlpath} Base directory of provided QML files
.RE
.sp
The special code
\fB@separator\fR
can be set as a command to insert a separator into the user actions context menu\&. Menu items can be put into a submenu by enclosing them with
\fB@beginmenu\fR
and
\fB@endmenu\fR
commands\&. The name of the submenu is determined by the
Name
column of the
\fB@beginmenu\fR
command\&.
.sp
To execute QML scripts,
\fB@qml\fR
is used as a command name\&. The path to the QML script is passed as a parameter\&. The provided scripts can be found in the folder
%{qmlpath}/script/
(on Linux typically
/usr/share/kid3/qml/script/, on Windows
qml/script/
inside the installation directory, and on macOS in the app folder
kid3\&.app/Contents/Resources/qml/script/)\&. Custom scripts can be stored in any directory\&. If the QML code uses GUI components,
\fB@qmlview\fR
shall be used instead of
\fB@qml\fR\&. Additional parameters are passed to the QML script where they will be available via the
\fBgetArguments()\fR
function\&. An overview of some functions and properties which are available in QML can be found in the appendix
QML Interface\&.
.sp
The command which will be inserted with %{browser} can be defined in the
Web browser
line edit above\&. Commands starting with %{browser} can be used to fetch information about the audio files from the web, for instance
.sp
.if n \{\
.RS 4
.\}
.nf
\fB%{browser} http://lyricwiki\&.org/%u{artist}:%u{title}\fR
.fi
.if n \{\
.RE
.\}
.sp
will query the lyrics for the current song in
\m[blue]\fBLyricWiki\fR\m[]\&\s-2\u[12]\d\s+2\&. The "u" in %u{artist} and %u{title} is used to URL\-encode the artist %{artist} and song %{title} information\&. It is easy to define your own queries in the same way, e\&.g\&. an image search with
\m[blue]\fBGoogle\fR\m[]\&\s-2\u[13]\d\s+2:
.sp
.if n \{\
.RS 4
.\}
.nf
\fB%{browser} http://images\&.google\&.com/images?q=%u{artist}%20%u{album}\fR
.fi
.if n \{\
.RE
.\}
.sp
To add album cover art to tag 2, you can search for images with Google or Amazon using the commands described above\&. The picture can be added to the tag with drag and drop\&. You can also add an image with
Add, then select the Picture frame and import an image file or paste from the clipboard\&. Picture frames are supported for ID3v2, MP4, FLAC, Ogg and ASF tags\&.
.sp
To add and delete entries in the table, a context menu can be used\&.
.sp
The
Network
page contains only a field to insert the proxy address and optionally the port, separated by a colon\&. The proxy will be used when importing from an Internet server when the checkbox is checked\&.
.sp
In the
Plugins
page, available plugins can be enabled or disabled\&. The plugins are separated into two sections\&. The
Metadata Plugins & Priority
list contains plugins which support audio file formats\&. The order of the plugins is important because they are tried from top to bottom\&. Some formats are supported by multiple plugins, so files will be opened with the first plugin supporting them\&. The
TaglibMetadata
supports most formats, if it is at the top of the list, it will open most of the files\&. If you want to use a different plugin for a file format, make sure that it is listed before the
TaglibMetadata
plugin\&. Details about the metadata plugin and why you may want to use them instead of TagLib are listed below\&.
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Id3libMetadata: Uses
\m[blue]\fBid3lib\fR\m[]\&\s-2\u[14]\d\s+2
for ID3v1\&.1 and ID3v2\&.3 tags in MP3, MP2, AAC files\&. Supports a few more frame types than TagLib\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
OggFlacMetadata: Uses
\m[blue]\fBlibogg\fR\m[]\&\s-2\u[15]\d\s+2,
\m[blue]\fBlibvorbis, libvorbisfile\fR\m[]\&\s-2\u[16]\d\s+2
for Ogg files, and additionally
\m[blue]\fBlibFLAC++ and libFLAC\fR\m[]\&\s-2\u[17]\d\s+2
for FLAC files\&. These are the official libraries for these formats\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
TaglibMetadata: Uses
\m[blue]\fBTagLib\fR\m[]\&\s-2\u[18]\d\s+2
which supports a lot of audio file formats\&. It can be used for all audio files supported by
Kid3\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Mp4v2Metadata:
\m[blue]\fBmp4v2\fR\m[]\&\s-2\u[19]\d\s+2
was originally used by
Kid3
to support M4A files\&. Can be used in case of problems with the M4A support of TagLib\&.
.RE
.sp
The
Available Plugins
section lists the remaining plugins\&. Their order is not important, but they can be enabled or disabled using the check boxes\&.
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
AmazonImport: Used for the
Import from Amazon\&.\&.\&.
function\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
DiscogsImport: Used for the
Import from Discogs\&.\&.\&.
function\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
FreedbImport: Used for the
Import from gnudb\&.org\&.\&.\&.
and
Import from TrackType\&.org\&.\&.\&.
functions\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
MusicBrainzImport: Used for the
Import from MusicBrainz Release\&.\&.\&.
function\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
AcoustidImport: Used for the
Import from MusicBrainz Fingerprint\&.\&.\&.
function, which depends on the
\m[blue]\fBChromaprint\fR\m[]\&\s-2\u[20]\d\s+2
and
\m[blue]\fBlibav\fR\m[]\&\s-2\u[21]\d\s+2
libraries\&.
.RE
.sp
Plugins which are disabled will not be loaded\&. This can be used to optimize resource usage and startup time\&. The settings on this page take only effect after a restart of
Kid3\&.
.RE
.PP
Settings → Configure Shortcuts\&.\&.\&.
.RS 4
Opens a dialog to assign keyboard shortcuts for most of the program functions\&. There are even functions without corresponding menu or button available, e\&.g\&. next file, previous file, select all\&.
.sp
.RE
.SS "The Help Menu"
.PP
.PP
Help → Kid3 Handbook
.RS 4
Opens this handbook\&.
.RE
.PP
Help → About Kid3
.RS 4
Displays a short information about Kid3\&.
.RE
.SH "KID3\-CLI"
.SS "Commands"
.PP
\fBkid3\-cli\fR
offers a command\-line\-interface for
Kid3\&. If a directory path is used, the directory is opened\&. If one or more file paths are given, the common directory is opened and the files are selected\&. Subsequent commands will then work on these files\&. Commands are specified using
\fB\-c\fR
options\&. If multiple commands are passed, they are executed in the given order\&. If files are modified by the commands, they will be saved at the end\&. If no command options are passed,
\fBkid3\-cli\fR
starts in interactive mode\&. Commands can be entered and will operate on the current selection\&. The following sections list all available commands\&.
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBHelp\fR
.RS 4
.HP \w'\fBhelp\fR\ 'u
\fBhelp\fR [\fICOMMAND\-NAME\fR]
.PP
Displays help about the parameters of
\fICOMMAND\-NAME\fR
or about all commands if no command name is given\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBTimeout\fR
.RS 4
.HP \w'\fBtimeout\fR\ 'u
\fBtimeout\fR [default | off | \fITIME\fR]
.PP
Overwrite the default command timeout\&. The CLI commands abort after a command specific timeout is expired\&. This timeout is 10 seconds for
\fBls\fR
and
\fBalbumart\fR, 60 seconds for
\fBautoimport\fR
and
\fBfilter\fR, and 3 seconds for all other commands\&. If a huge number of files has to be processed, this timeouts may be too restrictive, thus the timeout for all commands can be set to
\fITIME\fR
ms, switched off altogether or be left at the default values\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBQuit application\fR
.RS 4
.HP \w'\fBexit\fR\ 'u
\fBexit\fR [force]
.PP
Exit application\&. If there are modified unsaved files, the
\fIforce\fR
parameter is required\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBChange directory\fR
.RS 4
.HP \w'\fBcd\fR\ 'u
\fBcd\fR [\fIDIRECTORY\fR]
.PP
If no
\fIDIRECTORY\fR
is given, change to the home directory\&. If a directory is given, change into the directory\&. If one or more file paths are given, change to their common directory and select the files\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBPrint the current working directory\fR
.RS 4
.HP \w'\fBpwd\fR\ 'u
\fBpwd\fR
.PP
Print the filename of the current working directory\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBDirectory list\fR
.RS 4
.HP \w'\fBls\fR\ 'u
\fBls\fR
.PP
List the contents of the current directory\&. This corresponds to the file list in the
Kid3
GUI\&. Five characters before the file names show the state of the file\&.
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
>
File is selected\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
*
File is modified\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
1
File has a tag 1, otherwise \*(Aq\-\*(Aq is displayed\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
2
File has a tag 2, otherwise \*(Aq\-\*(Aq is displayed\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
3
File has a tag 3, otherwise \*(Aq\-\*(Aq is displayed\&.
.RE
.sp
.if n \{\
.RS 4
.\}
.nf
kid3\-cli> \fBls\fR
  1\-\- 01 Intro\&.mp3
> 12\- 02 We Only Got This One\&.mp3
 *1\-\- 03 Outro\&.mp3
.fi
.if n \{\
.RE
.\}
.PP
In this example, all files have a tag 1, the second file also has a tag 2 and it is selected\&. The third file is modified\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBSave the changed files\fR
.RS 4
.HP \w'\fBsave\fR\ 'u
\fBsave\fR
.PP
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBSelect file\fR
.RS 4
.HP \w'\fBselect\fR\ 'u
\fBselect\fR [all | none | first | previous | next | \fIFILE\fR...]
.PP
To select all files, enter
\fBselect all\fR, to deselect all files, enter
\fBselect none\fR\&. To traverse the files in the current directory start with
\fBselect first\fR, then go forward using
\fBselect next\fR
or backward using
\fBselect previous\fR\&. Specific files can be added to the current selection by giving their file names\&. Wildcards are possible, so
\fBselect *\&.mp3\fR
will select all MP3 files in the current directory\&.
.sp
.if n \{\
.RS 4
.\}
.nf
kid3\-cli> \fBselect first\fR
kid3\-cli> \fBls\fR
> 1\-\- 01 Intro\&.mp3
  12\- 02 We Only Got This One\&.mp3
 *1\-\- 03 Outro\&.mp3
kid3\-cli> \fBselect next\fR
kid3\-cli> \fBls\fR
  1\-\- 01 Intro\&.mp3
> 12\- 02 We Only Got This One\&.mp3
 *1\-\- 03 Outro\&.mp3
kid3\-cli> \fBselect *\&.mp3\fR
kid3\-cli> \fBls\fR
> 1\-\- 01 Intro\&.mp3
> 12\- 02 We Only Got This One\&.mp3
>*1\-\- 03 Outro\&.mp3
.fi
.if n \{\
.RE
.\}
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBSelect tag\fR
.RS 4
.HP \w'\fBtag\fR\ 'u
\fBtag\fR [\fITAG\-NUMBERS\fR]
.PP
Many commands have an optional
\fITAG\-NUMBERS\fR
parameter, which specifies whether the command operates on tag 1, 2, or 3\&. If this parameter is omitted, the default tag numbers are used, which can be set by this command\&. At startup, it is set to
12
which means that information is read from tag 2 if available, else from tag 1; modifications are done on tag 2\&. The
\fB\fITAG\-NUMBERS\fR\fR
can be set to
\fB1\fR,
\fB2\fR, or
\fB3\fR
to operate only on the corresponding tag\&. If the parameter is omitted, the current setting is displayed\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBGet tag frame\fR
.RS 4
.HP \w'\fBget\fR\ 'u
\fBget\fR [all | \fIFRAME\-NAME\fR] [\fITAG\-NUMBERS\fR]
.PP
This command can be used to read the value of a specific tag frame or get information about all tag frames (if the argument is omitted or
\fBall\fR
is used)\&. Modified frames are marked with a \*(Aq*\*(Aq\&.
.sp
.if n \{\
.RS 4
.\}
.nf
kid3\-cli> \fBget\fR
File: MPEG 1 Layer 3 192 kbps 44100 Hz Joint Stereo
  Name: 01 Intro\&.mp3
Tag 1: ID3v1\&.1
  Title         Intro
  Artist        One Hit Wonder
  Album         Let\*(Aqs Tag
  Date          2013
  Track Number  1
  Genre         Pop
kid3\-cli> \fBget title\fR
Intro
.fi
.if n \{\
.RE
.\}
.PP
To save the contents of a picture frame to a file, use
.sp
.if n \{\
.RS 4
.\}
.nf
\fBget picture:\*(Aq/path/to/folder\&.jpg\*(Aq\fR
.fi
.if n \{\
.RE
.\}
.PP
To save synchronized lyrics to an LRC file, use
.sp
.if n \{\
.RS 4
.\}
.nf
\fBget SYLT:\*(Aq/path/to/lyrics\&.lrc\*(Aq\fR
.fi
.if n \{\
.RE
.\}
.PP
It is possible to get only a specific field from a frame, for example
\fBget POPM\&.Email\fR
for the Email field of a Popularimeter frame\&. If a file has multiple frames of the same kind, the different frames can be indexed with brackets, for example the first performer from a Vorbis comment can be retrieved using
\fBget performer[0]\fR, the second using
\fBget performer[1]\fR\&.
.PP
The pseudo field name "selected" can be used to check if a frame is selected, for example
\fBget artist\&.selected\fR
will return
1
if the artist frame is selected, else
0\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBSet tag frame\fR
.RS 4
.HP \w'\fBset\fR\ 'u
\fBset\fR {\fIFRAME\-NAME\fR} {\fIFRAME\-VALUE\fR} [\fITAG\-NUMBERS\fR]
.PP
This command sets the value of a specific tag frame\&. If
\fIFRAME\-VALUE\fR
is empty, the frame is deleted\&.
.sp
.if n \{\
.RS 4
.\}
.nf
kid3\-cli> \fBset remixer \*(AqO\&.H\&. Wonder\*(Aq\fR
.fi
.if n \{\
.RE
.\}
.PP
To set the contents of a picture frame from a file, use
.sp
.if n \{\
.RS 4
.\}
.nf
\fBset picture:\*(Aq/path/to/folder\&.jpg\*(Aq \*(AqPicture Description\*(Aq\fR
.fi
.if n \{\
.RE
.\}
.PP
To set synchronized lyrics from an LRC file, use
.sp
.if n \{\
.RS 4
.\}
.nf
\fBset SYLT:\*(Aq/path/to/lyrics\&.lrc\*(Aq \*(AqLyrics Description\*(Aq\fR
.fi
.if n \{\
.RE
.\}
.PP
To set a specific field of a frame, the field name can be given after a dot, e\&.g\&. to set the Counter field of a Popularimeter frame, use
.sp
.if n \{\
.RS 4
.\}
.nf
\fBset POPM\&.Counter 5\fR
.fi
.if n \{\
.RE
.\}
.PP
To set multiple frames of the same kind, an index can be given in brackets, e\&.g\&. to set multiple performers in a Vorbis comment, use
.sp
.if n \{\
.RS 4
.\}
.nf
kid3\-cli> \fBset performer[0] \*(AqLiza don Getti (soprano)\*(Aq\fR
kid3\-cli> \fBset performer[1] \*(AqJoe Barr (piano)\*(Aq\fR
.fi
.if n \{\
.RE
.\}
.PP
To select certain frames before a copy, paste or remove action, the pseudo field name "selected" can be used\&. Normally, all frames are selected, to deselect all, use
\fBset \*(Aq*\&.selected\*(Aq 0\fR, then for example
\fBset artist\&.selected 1\fR
to select the artist frame\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBRevert\fR
.RS 4
.HP \w'\fBrevert\fR\ 'u
\fBrevert\fR
.PP
Revert all modifications in the selected files (or all files if no files are selected)\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBImport from file or clipboard\fR
.RS 4
.HP \w'\fBimport\fR\ 'u
\fBimport\fR {\fIFILE\fR} {\fIFORMAT\-NAME\fR} [\fITAG\-NUMBERS\fR]
.PP
Tags are imported from the file
\fIFILE\fR
(or from the clipboard if
\fBclipboard\fR
is used for
\fIFILE\fR) in the format with the name
\fIFORMAT\-NAME\fR
(e\&.g\&.
\fB"CSV unquoted"\fR, see
Import)\&.
.PP
If
\fBtags\fR
is given for
\fIFILE\fR, tags are imported from other tags\&. Instead of
\fIFORMAT\-NAME\fR
parameters
\fISOURCE\fR
and
\fIEXTRACTION\fR
are required, see
Import from Tags\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBAutomatic import\fR
.RS 4
.HP \w'\fBautoimport\fR\ 'u
\fBautoimport\fR [\fIPROFILE\-NAME\fR] [\fITAG\-NUMBERS\fR]
.PP
Batch import using profile
\fIPROFILE\-NAME\fR
(see
Automatic Import,
\fB"All"\fR
is used if omitted)\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBDownload album cover artwork\fR
.RS 4
.HP \w'\fBalbumart\fR\ 'u
\fBalbumart\fR {\fIURL\fR} [all]
.PP
Set the album artwork by downloading a picture from
\fIURL\fR\&. The rules defined in the
Browse Cover Art
dialog are used to transform general URLs (e\&.g\&. from Amazon) to a picture URL\&. To set the album cover from a local picture file, use the
set
command\&.
.sp
.if n \{\
.RS 4
.\}
.nf
kid3\-cli> \fBalbumart
http://www\&.amazon\&.com/Versus\-World\-Amon\-Amarth/dp/B000078DOC\fR
.fi
.if n \{\
.RE
.\}
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBExport to file or clipboard\fR
.RS 4
.HP \w'\fBexport\fR\ 'u
\fBexport\fR {\fIFILE\fR} {\fIFORMAT\-NAME\fR} [\fITAG\-NUMBERS\fR]
.PP
Tags are exported to file
\fIFILE\fR
(or to the clipboard if
\fBclipboard\fR
is used for
\fIFILE\fR) in the format with the name
\fIFORMAT\-NAME\fR
(e\&.g\&.
\fB"CSV unquoted"\fR, see
Export)\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBCreate playlist\fR
.RS 4
.HP \w'\fBplaylist\fR\ 'u
\fBplaylist\fR
.PP
Create playlist in the format set in the configuration, see
Create Playlist\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBApply filename format\fR
.RS 4
.HP \w'\fBfilenameformat\fR\ 'u
\fBfilenameformat\fR
.PP
Apply file name format set in the configuration, see
Apply Filename Format\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBApply tag format\fR
.RS 4
.HP \w'\fBtagformat\fR\ 'u
\fBtagformat\fR
.PP
Apply tag name format set in the configuration, see
Apply Tag Format\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBApply text encoding\fR
.RS 4
.HP \w'\fBtextencoding\fR\ 'u
\fBtextencoding\fR
.PP
Apply text encoding set in the configuration, see
Apply Text Encoding\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBRename directory\fR
.RS 4
.HP \w'\fBrenamedir\fR\ 'u
\fBrenamedir\fR [\fIFORMAT\fR] [create | rename | dryrun] [\fITAG\-NUMBERS\fR]
.PP
Rename or create directories from the values in the tags according to a given
\fIFORMAT\fR
(e\&.g\&.
\fB%{artist} \- %{album}\fR, see
Rename Directory), if no format is given, the format defined in the
Rename directory
dialog is used\&. The default mode is
\fBrename\fR; to create directories,
\fBcreate\fR
must be given explicitly\&. The rename actions will be performed immediately, to just see what would be done, use the
\fBdryrun\fR
option\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBNumber tracks\fR
.RS 4
.HP \w'\fBnumbertracks\fR\ 'u
\fBnumbertracks\fR [\fITRACK\-NUMBER\fR] [\fITAG\-NUMBERS\fR]
.PP
Number the selected tracks starting with
\fITRACK\-NUMBER\fR
(1
if omitted)\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBFilter\fR
.RS 4
.HP \w'\fBfilter\fR\ 'u
\fBfilter\fR [\fIFILTER\-NAME\fR | \fIFILTER\-FORMAT\fR]
.PP
Filter the files so that only the files matching the
\fIFILTER\-FORMAT\fR
are visible\&. The name of a predefined filter expression (e\&.g\&.
\fB"Filename Tag Mismatch"\fR) can be used instead of a filter expression, see
Filter\&.
.sp
.if n \{\
.RS 4
.\}
.nf
kid3\-cli> \fBfilter \*(Aq%{title} contains "tro"\*(Aq\fR
Started
  /home/urs/One Hit Wonder \- Let\*(Aqs Tag
+ 01 Intro\&.mp3
\- 02 We Only Got This One\&.mp3
+ 03 Outro\&.mp3
Finished
kid3\-cli> \fBls\fR
  1\-\- 01 Intro\&.mp3
  1\-\- 03 Outro\&.mp3
kid3\-cli> \fBfilter All\fR
Started
  /home/urs/One Hit Wonder \- Let\*(Aqs Tag
+ 01 Intro\&.mp3
+ 02 We Only Got This One\&.mp3
+ 03 Outro\&.mp3
Finished
kid3\-cli> \fBls\fR
  1\-\- 01 Intro\&.mp3
  12\- 02 We Only Got This One\&.mp3
  1\-\- 03 Outro\&.mp3
.fi
.if n \{\
.RE
.\}
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBConvert ID3v2.3 to ID3v2.4\fR
.RS 4
.HP \w'\fBto24\fR\ 'u
\fBto24\fR
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBConvert ID3v2.4 to ID3v2.3\fR
.RS 4
.HP \w'\fBto23\fR\ 'u
\fBto23\fR
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBFilename from tag\fR
.RS 4
.HP \w'\fBfromtag\fR\ 'u
\fBfromtag\fR [\fIFORMAT\fR] [\fITAG\-NUMBERS\fR]
.PP
Set the file names of the selected files from values in the tags, for example
\fBfromtag \*(Aq%{track} \- %{title}\*(Aq 1\fR\&. If no format is specified, the format set in the GUI is used\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBTag from filename\fR
.RS 4
.HP \w'\fBtotag\fR\ 'u
\fBtotag\fR [\fIFORMAT\fR] [\fITAG\-NUMBERS\fR]
.PP
Set the tag frames from the file names, for example
\fBtotag \*(Aq%{albumartist} \- %{album}/%{track} %{title}\*(Aq 2\fR\&. If no format is specified, the format set in the GUI is used\&. If the format of the filename does not match this pattern, a few other commonly used formats are tried\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBTag to other tag\fR
.RS 4
.HP \w'\fBsyncto\fR\ 'u
\fBsyncto\fR {\fITAG\-NUMBER\fR}
.PP
Copy the tag frames from one tag to the other tag, e\&.g\&. to set the ID3v2 tag from the ID3v1 tag, use
\fBsyncto 2\fR\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBCopy\fR
.RS 4
.HP \w'\fBcopy\fR\ 'u
\fBcopy\fR [\fITAG\-NUMBER\fR]
.PP
Copy the tag frames of the selected file to the internal copy buffer\&. They can then be set on another file using the
\fBpaste\fR
command\&.
.PP
To copy only a subset of the frames, use the "selected" pseudo field with the
\fBset\fR
command\&. For example, to copy only the disc number and copyright frames, use
.sp
.if n \{\
.RS 4
.\}
.nf
\fBset \*(Aq*\&.selected\*(Aq 0\fR
\fBset discnumber\&.selected 1\fR
\fBset copyright\&.selected 1\fR
\fBcopy\fR
.fi
.if n \{\
.RE
.\}
.sp
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBPaste\fR
.RS 4
.HP \w'\fBpaste\fR\ 'u
\fBpaste\fR [\fITAG\-NUMBER\fR]
.PP
Set tag frames from the contents of the
\fBcopy\fR
buffer in the selected files\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBRemove\fR
.RS 4
.HP \w'\fBremove\fR\ 'u
\fBremove\fR [\fITAG\-NUMBER\fR]
.PP
Remove a tag\&.
.PP
It is possible to remove only a subset of the frames by selecting them as described in the
\fBcopy\fR command\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBPlay\fR
.RS 4
.HP \w'\fBplay\fR\ 'u
\fBplay\fR [pause | stop | previous | next]
.PP
Start audio playback\&. Once it has been started, it can be controlled with the
\fBpause\fR
(to pause and resume),
\fBstop\fR,
\fBprevious\fR
and
\fBnext\fR
options\&.
.RE
.SS "Examples"
.PP
Set title containing an apostrophe\&. Commands passed to
\fBkid3\-cli\fR
with
\fI\-c\fR
have to be in quotes if they do not only consist of a single word\&. If such a command itself has an argument containing spaces, that argument has to be quoted too\&. In UNIX shells single or double quotes can be used, but on the Windows Command Prompt, it is important that the outer quoting is done using double quotes and inside these quotes, single quotes are used\&. If the text inside the single quotes contains a single quote, it has to be escaped using a backslash character, as shown in the following example:
.sp
.if n \{\
.RS 4
.\}
.nf
\fBkid3\-cli \-c "set title \*(AqI\e\*(Aqll be there for you\*(Aq" /path/to/dir\fR
.fi
.if n \{\
.RE
.\}
.PP
Set album cover in all files of a directory using the batch import function:
.sp
.if n \{\
.RS 4
.\}
.nf
\fBkid3\-cli \-c "autoimport \*(AqCover Art\*(Aq" /path/to/dir\fR
.fi
.if n \{\
.RE
.\}
.PP
Remove comment frames and apply the tag format in both tags of all MP3 files of a directory:
.sp
.if n \{\
.RS 4
.\}
.nf
\fBkid3\-cli \-c "set comment \*(Aq\*(Aq 1" \-c "set comment \*(Aq\*(Aq 2" \e
\-c "tagformat 1" \-c "tagformat 2" /path/to/dir/*\&.mp3\fR
.fi
.if n \{\
.RE
.\}
.PP
Automatically import tag 2, synchronize to tag 1, set file names from tag 2 and finally create a playlist:
.sp
.if n \{\
.RS 4
.\}
.nf
\fBkid3\-cli \-c autoimport \-c "syncto 1" \-c fromtag \-c playlist \e
  /path/to/dir/*\&.mp3\fR
.fi
.if n \{\
.RE
.\}
.PP
For all files with an ID3v2\&.4\&.0 tag, convert to ID3v2\&.3\&.0 and remove the arranger frame:
.sp
.if n \{\
.RS 4
.\}
.nf
\fBkid3\-cli \-c "filter \*(AqID3v2\&.4\&.0 Tag\*(Aq" \-c "select all" \-c to23 \e
  \-c "set arranger \*(Aq\*(Aq" /path/to/dir\fR
.fi
.if n \{\
.RE
.\}
.PP
This Python script uses
\fBkid3\-cli\fR
to generate iTunes Sound Check iTunNORM frames from replay gain information\&.
.sp
.if n \{\
.RS 4
.\}
.nf

#!/usr/bin/env python3
# Generate iTunes Sound Check from ReplayGain\&.
import os, sys, subprocess

def rg2sc(dirpath):
  for root, dirs, files in os\&.walk(dirpath):
    for name in files:
      if name\&.endswith((\*(Aq\&.mp3\*(Aq, \*(Aq\&.m4a\*(Aq, \*(Aq\&.aiff\*(Aq, \*(Aq\&.aif\*(Aq)):
        fn = os\&.path\&.join(root, name)
        rg = subprocess\&.check_output([
          \*(Aqkid3\-cli\*(Aq, \*(Aq\-c\*(Aq, \*(Aqget "replaygain_track_gain"\*(Aq,
           fn])\&.strip()
        if rg\&.endswith(b\*(Aq dB\*(Aq):
          rg = rg[:\-3]
        try:
          rg = float(rg)
        except ValueError:
          print(\*(AqValue %s of %s in not a float\*(Aq % (rg, fn))
          continue
        sc = (\*(Aq \*(Aq + (\*(Aq%08X\*(Aq % int((10 ** (\-rg / 10)) * 1000) )) * 10
        subprocess\&.call([
          \*(Aqkid3\-cli\*(Aq, \*(Aq\-c\*(Aq, \*(Aqset iTunNORM "%s"\*(Aq % sc, fn])

if __name__ == \*(Aq__main__\*(Aq:
  rg2sc(sys\&.argv[1])

.fi
.if n \{\
.RE
.\}
.SH "CREDITS AND LICENSE"
.PP
Kid3
.PP
Program written by Urs Fleisch
<ufleisch at users\&.sourceforge\&.net>
.PP
\m[blue]\fBFDL\fR\m[]\&\s-2\u[22]\d\s+2
.PP
\m[blue]\fBGPL\fR\m[]\&\s-2\u[23]\d\s+2
.SH "INSTALLATION"
.SS "How to obtain Kid3"
.PP
Kid3
can be found at
\m[blue]\fBhttps://kid3\&.sourceforge\&.io\fR\m[]\&.
.SS "Requirements"
.PP
Kid3
needs
\m[blue]\fBQt\fR\m[]\&\s-2\u[24]\d\s+2\&.
\m[blue]\fBKDE\fR\m[]\&\s-2\u[25]\d\s+2
is recommended but not necessary, as
Kid3
can also be compiled as a Qt application\&.
Kid3
can be compiled for systems where these libraries are available, e\&.g\&. for GNU/Linux, Windows and macOS\&. To tag Ogg/Vorbis files,
\m[blue]\fBlibogg\fR\m[]\&\s-2\u[15]\d\s+2,
\m[blue]\fBlibvorbis and libvorbisfile\fR\m[]\&\s-2\u[16]\d\s+2
are required, for FLAC files
\m[blue]\fBlibFLAC++ and libFLAC\fR\m[]\&\s-2\u[17]\d\s+2\&.
\m[blue]\fBid3lib\fR\m[]\&\s-2\u[14]\d\s+2
is used for MP3 files\&. These four formats are also supported by
\m[blue]\fBTagLib\fR\m[]\&\s-2\u[18]\d\s+2, which can also handle Opus, MPC, APE, MP2, Speex, TrueAudio, WavPack, WMA, WAV, AIFF files and tracker modules\&. To import from acoustic fingerprints,
\m[blue]\fBChromaprint\fR\m[]\&\s-2\u[20]\d\s+2
and
\m[blue]\fBlibav\fR\m[]\&\s-2\u[21]\d\s+2
are used\&.
.PP
Kid3
is available for most Linux distributions, Windows and macOS\&. Links can be found on
\m[blue]\fBhttps://kid3\&.sourceforge\&.io\fR\m[]\&.
.SS "Compilation and Installation"
.PP
You can compile
Kid3
with or without KDE\&. Without KDE,
Kid3
is a simple Qt application and lacks some configuration and session features\&.
.PP
For a KDE version, go into the top directory and type
.sp
.if n \{\
.RS 4
.\}
.nf
% \fBcmake \&.\fR
% \fBmake\fR
% \fBmake install\fR
.fi
.if n \{\
.RE
.\}
.PP
To compile for different versions of Qt or KDE, set the corresponding
\fBcmake\fR
options\&.
.PP
If not all libraries are present,
Kid3
is built with reduced functionality\&. So you should take care to have all desired development packages installed\&. On the other side,
\fBcmake\fR\-options control which libraries are compiled in\&. The default is
\fB\-DWITH_TAGLIB:BOOL=ON \-DWITH_MP4V2:BOOL=OFF \-DWITH_ID3LIB:BOOL=ON \-DWITH_CHROMAPRINT:BOOL=ON \-DWITH_VORBIS:BOOL=ON \-DWITH_FLAC:BOOL=ON \fR\&. These options can be disabled using
\fBOFF\fR\&.
.PP
To build
Kid3
as a Qt application without KDE, use the
\fBcmake\fR
option
\fB\-DWITH_APPS=Qt\fR\&. To build both a KDE and a Qt application, set
\fB\-DWITH_APPS="Qt;KDE"\fR\&.
.PP
To use a specific Qt installation, set
\fB\-DQT_QMAKE_EXECUTABLE=/path/to/qmake\fR\&.
.PP
Generation of RPM\-Packages is supported by the file
kid3\&.spec, for Debian\-Packages, the script
build\-deb\&.sh
is available\&.
.PP
The Qt application can also be compiled for Windows and macOS\&. The script
buildlibs\&.sh
can be used to download and build all required libraries and create a
Kid3
package\&.
.SS "Configuration"
.PP
With KDE, the settings are stored in
\&.config/kid3rc\&. As a Qt application, this file is in
\&.config/Kid3/Kid3\&.conf\&. On Windows, the configuration is stored in the registry\&. on macOS in a plist file\&.
.PP
The environment variable
\fIKID3_CONFIG_FILE\fR
can be used to set the path of the configuration file\&.
.SH "D\-BUS INTERFACE"
.SS "D\-Bus Examples"
.PP
On Linux a D\-Bus\-interface can be used to control
Kid3
by scripts\&. Scripts can be written in any language with D\-Bus\-bindings (e\&.g\&. in Python) and can be added to the
User Actions
to extend the functionality of
Kid3\&.
.PP
The artist in tag 2 of the current file can be set to the value "One Hit Wonder" with the following code:
.PP
Shell
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
dbus\-send \-\-dest=net\&.sourceforge\&.kid3 \-\-print\-reply=literal \e
/Kid3 net\&.sourceforge\&.Kid3\&.setFrame int32:2 string:\*(AqArtist\*(Aq \e
string:\*(AqOne Hit Wonder\*(Aq
.fi
.if n \{\
.RE
.\}
.sp
or easier with Qt\*(Aqs
\fBqdbus\fR
(\fBqdbusviewer\fR
can be used to explore the interface in a GUI):
.sp
.if n \{\
.RS 4
.\}
.nf
qdbus net\&.sourceforge\&.kid3 /Kid3 setFrame 2 Artist \e
\*(AqOne Hit Wonder\*(Aq
.fi
.if n \{\
.RE
.\}
.RE
.PP
Python
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
import dbus
kid3 = dbus\&.SessionBus()\&.get_object(
  \*(Aqnet\&.sourceforge\&.kid3\*(Aq, \*(Aq/Kid3\*(Aq)
kid3\&.setFrame(2, \*(AqArtist\*(Aq, \*(AqOne Hit Wonder\*(Aq)
.fi
.if n \{\
.RE
.\}
.RE
.PP
Perl
.RS 4
.sp
.if n \{\
.RS 4
.\}
.nf
use Net::DBus;
$kid3 = Net::DBus\->session\->get_service(
  "net\&.sourceforge\&.kid3")\->get_object(
  "/Kid3", "net\&.sourceforge\&.Kid3");
$kid3\->setFrame(2, "Artist", "One Hit Wonder");
.fi
.if n \{\
.RE
.\}
.RE
.SS "D\-Bus API"
.PP
The D\-Bus API is specified in
net\&.sourceforge\&.Kid3\&.xml\&. The Kid3 interface has the following methods:
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBOpen file or directory\fR
.RS 4
.HP \w'boolean\ openDirectory('u
.BI "boolean openDirectory(string\ " "path" ");"
.PP
\fIpath\fR
.RS 4
path to file or directory
.RE
.PP
Returns true if OK\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBUnload the tags of all files which are not modified or selected\fR
.RS 4
.HP \w'unloadAllTags('u
.BI "unloadAllTags(void);"
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBSave all modified files\fR
.RS 4
.HP \w'boolean\ save('u
.BI "boolean save(void);"
.PP
Returns true if OK\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBGet a detailed error message provided by some methods\fR
.RS 4
.HP \w'string\ getErrorMessage('u
.BI "string getErrorMessage(void);"
.PP
Returns detailed error message\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBRevert changes in the selected files\fR
.RS 4
.HP \w'revert('u
.BI "revert(void);"
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBStart an automatic batch import\fR
.RS 4
.HP \w'boolean\ batchImport('u
.BI "boolean batchImport(int32\ " "tagMask" ", string\ " "profileName" ");"
.PP
\fItagMask\fR
.RS 4
tag mask (bit 0 for tag 1, bit 1 for tag 2)
.RE
.PP
\fIprofileName\fR
.RS 4
name of batch import profile to use
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBImport tags from a file\fR
.RS 4
.HP \w'boolean\ importFromFile('u
.BI "boolean importFromFile(int32\ " "tagMask" ", string\ " "path" ", int32\ " "fmtIdx" ");"
.PP
\fItagMask\fR
.RS 4
tag bit (1 for tag 1, 2 for tag 2)
.RE
.PP
\fIpath\fR
.RS 4
path of file
.RE
.PP
\fIfmtIdx\fR
.RS 4
index of format
.RE
.PP
Returns true if OK\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBImport tags from other tags\fR
.RS 4
.HP \w'importFromTags('u
.BI "importFromTags(int32\ " "tagMask" ", string\ " "source" ", string\ " "extraction" ");"
.PP
\fItagMask\fR
.RS 4
tag bit (1 for tag 1, 2 for tag 2)
.RE
.PP
\fIsource\fR
.RS 4
format to get source text from tags
.RE
.PP
\fIextraction\fR
.RS 4
regular expression with frame names and captures to extract from source text
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBDownload album cover art\fR
.RS 4
.HP \w'downloadAlbumArt('u
.BI "downloadAlbumArt(string\ " "url" ", boolean\ " "allFilesInDir" ");"
.PP
\fIurl\fR
.RS 4
URL of picture file or album art resource
.RE
.PP
\fIallFilesInDir\fR
.RS 4
true to add the image to all files in the directory
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBExport tags to a file\fR
.RS 4
.HP \w'boolean\ exportToFile('u
.BI "boolean exportToFile(int32\ " "tagMask" ", string\ " "path" ", int32\ " "fmtIdx" ");"
.PP
\fItagMask\fR
.RS 4
tag bit (1 for tag 1, 2 for tag 2)
.RE
.PP
\fIpath\fR
.RS 4
path of file
.RE
.PP
\fIfmtIdx\fR
.RS 4
index of format
.RE
.PP
Returns true if OK\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBCreate a playlist\fR
.RS 4
.HP \w'boolean\ createPlaylist('u
.BI "boolean createPlaylist(void);"
.PP
Returns true if OK\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBGet items of a playlist\fR
.RS 4
.HP \w'boolean\ getPlaylistItems('u
.BI "boolean getPlaylistItems(string\ " "path" ");"
.PP
\fIpath\fR
.RS 4
path to playlist file
.RE
.PP
Returns list of absolute paths to playlist items\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBSet items of a playlist\fR
.RS 4
.HP \w'boolean\ setPlaylistItems('u
.BI "boolean setPlaylistItems(string\ " "path" ", array\ " "items" ");"
.PP
\fIpath\fR
.RS 4
path to playlist file
.RE
.PP
\fIitems\fR
.RS 4
list of absolute paths to playlist items
.RE
.PP
Returns true if OK, false if not all items were found and added or saving failed\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBQuit the application\fR
.RS 4
.HP \w'quit('u
.BI "quit(void);"
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBSelect all files\fR
.RS 4
.HP \w'selectAll('u
.BI "selectAll(void);"
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBDeselect all files\fR
.RS 4
.HP \w'deselectAll('u
.BI "deselectAll(void);"
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBSet the first file as the current file\fR
.RS 4
.HP \w'boolean\ firstFile('u
.BI "boolean firstFile(void);"
.PP
Returns true if there is a first file\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBSet the previous file as the current file\fR
.RS 4
.HP \w'boolean\ previousFile('u
.BI "boolean previousFile(void);"
.PP
Returns true if there is a previous file\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBSet the next file as the current file\fR
.RS 4
.HP \w'boolean\ nextFile('u
.BI "boolean nextFile(void);"
.PP
Returns true if there is a next file\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBSelect the first file\fR
.RS 4
.HP \w'boolean\ selectFirstFile('u
.BI "boolean selectFirstFile(void);"
.PP
Returns true if there is a first file\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBSelect the previous file\fR
.RS 4
.HP \w'boolean\ selectPreviousFile('u
.BI "boolean selectPreviousFile(void);"
.PP
Returns true if there is a previous file\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBSelect the next file\fR
.RS 4
.HP \w'boolean\ selectNextFile('u
.BI "boolean selectNextFile(void);"
.PP
Returns true if there is a next file\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBSelect the current file\fR
.RS 4
.HP \w'boolean\ selectCurrentFile('u
.BI "boolean selectCurrentFile(void);"
.PP
Returns true if there is a current file\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBExpand or collapse the current file item if it is a directory\fR
.RS 4
.HP \w'boolean\ expandDirectory('u
.BI "boolean expandDirectory(void);"
.PP
A file list item is a directory if getFileName() returns a name with \*(Aq/\*(Aq as the last character\&.
.PP
Returns true if current file item is a directory\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBApply the file name format\fR
.RS 4
.HP \w'applyFilenameFormat('u
.BI "applyFilenameFormat(void);"
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBApply the tag format\fR
.RS 4
.HP \w'applyTagFormat('u
.BI "applyTagFormat(void);"
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBApply text encoding\fR
.RS 4
.HP \w'applyTextEncoding('u
.BI "applyTextEncoding(void);"
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBSet the directory name from the tags\fR
.RS 4
.HP \w'boolean\ setDirNameFromTag('u
.BI "boolean setDirNameFromTag(int32\ " "tagMask" ", string\ " "format" ", boolean\ " "create" ");"
.PP
\fItagMask\fR
.RS 4
tag mask (bit 0 for tag 1, bit 1 for tag 2)
.RE
.PP
\fIformat\fR
.RS 4
directory name format
.RE
.PP
\fIcreate\fR
.RS 4
true to create, false to rename
.RE
.PP
Returns true if OK, else the error message is available using getErrorMessage()\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBSet subsequent track numbers in the selected files\fR
.RS 4
.HP \w'numberTracks('u
.BI "numberTracks(int32\ " "tagMask" ", int32\ " "firstTrackNr" ");"
.PP
\fItagMask\fR
.RS 4
tag mask (bit 0 for tag 1, bit 1 for tag 2)
.RE
.PP
\fIfirstTrackNr\fR
.RS 4
number to use for first file
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBFilter the files\fR
.RS 4
.HP \w'filter('u
.BI "filter(string\ " "expression" ");"
.PP
\fIexpression\fR
.RS 4
filter expression
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBConvert ID3v2.3 tags to ID3v2.4\fR
.RS 4
.HP \w'convertToId3v24('u
.BI "convertToId3v24(void);"
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBConvert ID3v2.4 tags to ID3v2.3\fR
.RS 4
.HP \w'convertToId3v23('u
.BI "convertToId3v23(void);"
.PP
Returns true if OK\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBGet path of directory\fR
.RS 4
.HP \w'string\ getDirectoryName('u
.BI "string getDirectoryName(void);"
.PP
Returns absolute path of directory\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBGet name of current file\fR
.RS 4
.HP \w'string\ getFileName('u
.BI "string getFileName(void);"
.PP
Returns true absolute file name, ends with "/" if it is a directory\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBSet name of selected file\fR
.RS 4
.HP \w'setFileName('u
.BI "setFileName(string\ " "name" ");"
.PP
\fIname\fR
.RS 4
file name
.RE
.PP
The file will be renamed when the directory is saved\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBSet format to use when setting the filename from the tags\fR
.RS 4
.HP \w'setFileNameFormat('u
.BI "setFileNameFormat(string\ " "format" ");"
.PP
\fIformat\fR
.RS 4
file name format
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBSet the file names of the selected files from the tags\fR
.RS 4
.HP \w'setFileNameFromTag('u
.BI "setFileNameFromTag(int32\ " "tagMask" ");"
.PP
\fItagMask\fR
.RS 4
tag bit (1 for tag 1, 2 for tag 2)
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBGet value of frame\fR
.RS 4
.HP \w'string\ getFrame('u
.BI "string getFrame(int32\ " "tagMask" ", string\ " "name" ");"
.PP
\fItagMask\fR
.RS 4
tag bit (1 for tag 1, 2 for tag 2)
.RE
.PP
\fIname\fR
.RS 4
name of frame (e\&.g\&. "artist")
.RE
.PP
To get binary data like a picture, the name of a file to write can be added after the
\fIname\fR, e\&.g\&. "Picture:/path/to/file"\&. In the same way, synchronized lyrics can be exported, e\&.g\&. "SYLT:/path/to/file"\&.
.PP
Returns value of frame\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBSet value of frame\fR
.RS 4
.HP \w'boolean\ setFrame('u
.BI "boolean setFrame(int32\ " "tagMask" ", string\ " "name" ", string\ " "value" ");"
.PP
\fItagMask\fR
.RS 4
tag bit (1 for tag 1, 2 for tag 2)
.RE
.PP
\fIname\fR
.RS 4
name of frame (e\&.g\&. "artist")
.RE
.PP
\fIvalue\fR
.RS 4
value of frame
.RE
.PP
For tag 2 (\fItagMask\fR
2), if no frame with
\fIname\fR
exists, a new frame is added, if
\fIvalue\fR
is empty, the frame is deleted\&. To add binary data like a picture, a file can be added after the
\fIname\fR, e\&.g\&. "Picture:/path/to/file"\&. "SYLT:/path/to/file" can be used to import synchronized lyrics\&.
.PP
Returns true if OK\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBGet all frames of a tag\fR
.RS 4
.HP \w'array\ of\ string\ getTag('u
.BI "array of string getTag(int32\ " "tagMask" ");"
.PP
\fItagMask\fR
.RS 4
tag bit (1 for tag 1, 2 for tag 2)
.RE
.PP
Returns list with alternating frame names and values\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBGet technical information about file\fR
.RS 4
.HP \w'array\ of\ string\ getInformation('u
.BI "array of string getInformation(void);"
.PP
Properties are Format, Bitrate, Samplerate, Channels, Duration, Channel Mode, VBR, Tag 1, Tag 2\&. Properties which are not available are omitted\&.
.PP
Returns list with alternating property names and values\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBSet tag from file name\fR
.RS 4
.HP \w'setTagFromFileName('u
.BI "setTagFromFileName(int32\ " "tagMask" ");"
.PP
\fItagMask\fR
.RS 4
tag bit (1 for tag 1, 2 for tag 2)
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBSet tag from other tag\fR
.RS 4
.HP \w'setTagFromOtherTag('u
.BI "setTagFromOtherTag(int32\ " "tagMask" ");"
.PP
\fItagMask\fR
.RS 4
tag bit (1 for tag 1, 2 for tag 2)
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBCopy tag\fR
.RS 4
.HP \w'copyTag('u
.BI "copyTag(int32\ " "tagMask" ");"
.PP
\fItagMask\fR
.RS 4
tag bit (1 for tag 1, 2 for tag 2)
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBPaste tag\fR
.RS 4
.HP \w'pasteTag('u
.BI "pasteTag(int32\ " "tagMask" ");"
.PP
\fItagMask\fR
.RS 4
tag bit (1 for tag 1, 2 for tag 2)
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBRemove tag\fR
.RS 4
.HP \w'removeTag('u
.BI "removeTag(int32\ " "tagMask" ");"
.PP
\fItagMask\fR
.RS 4
tag bit (1 for tag 1, 2 for tag 2)
.RE
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBReparse the configuration\fR
.RS 4
.HP \w'reparseConfiguration('u
.BI "reparseConfiguration(void);"
.PP
Automated configuration changes are possible by modifying the configuration file and then reparsing the configuration\&.
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBPlays the selected files\fR
.RS 4
.HP \w'playAudio('u
.BI "playAudio(void);"
.RE
.SH "QML INTERFACE"
.SS "QML Examples"
.PP
QML scripts can be invoked via the context menu of the file list and can be set in the tab
User Actions
of the settings dialog\&. The scripts which are set there can be used as examples to program custom scripts\&. QML uses JavaScript, here is the obligatory "Hello World":
.sp
.if n \{\
.RS 4
.\}
.nf
import Kid3 1\&.0

Kid3Script {
  onRun: {
    console\&.log("Hello world, directory is", app\&.dirName)
    Qt\&.quit()
  }
}
.fi
.if n \{\
.RE
.\}
.PP
If this script is saved as
/path/to/Example\&.qml, the user command can be defined as
\fB@qml /path/to/Example\&.qml\fR
with name
\fBQML Test\fR
and
Output
checked\&. It can then be started using the
QML Test
item in the file list context menu, and the output will be visible in the window\&.
.PP
Alternatively, the script could also be started independent of Kid3 using the QML tools\&.
.sp
.if n \{\
.RS 4
.\}
.nf
qml \-apptype widget \-I /usr/lib/kid3/plugins/imports /path/to/Example\&.qml
.fi
.if n \{\
.RE
.\}
.sp
or
.sp
.if n \{\
.RS 4
.\}
.nf
qmlscene \-I /usr/lib/kid3/plugins/imports /path/to/Example\&.qml
.fi
.if n \{\
.RE
.\}
.sp
On Windows and macOS, the import path must be adapted to the
imports
folder inside the installation directory\&. Scripts started outside of
Kid3
will use the current directory, so it should be changed beforehand\&.
.PP
To list the titles in the tags 2 of all files in the current directory, the following script could be used:
.sp
.if n \{\
.RS 4
.\}
.nf
import Kid3 1\&.0

Kid3Script {
  onRun: {
    app\&.firstFile()
    do {
      if (app\&.selectionInfo\&.tag(Frame\&.Tag_2)\&.tagFormat) {
        console\&.log(app\&.getFrame(tagv2, "title"))
      }
    } while (app\&.nextFile())
  }
}
.fi
.if n \{\
.RE
.\}
.PP
If the directory contains many files, such a script might block the user interface for some time\&. For longer operations, it should therefore have a break from time to time\&. The alternative implementation below has the work for a single file moved out into a function\&. This function invokes itself with a timeout of 1 ms at the end, given that more files have to be processed\&. This will ensure that the GUI remains responsive while the script is running\&.
.sp
.if n \{\
.RS 4
.\}
.nf
import Kid3 1\&.0

Kid3Script {
  onRun: {
    function doWork() {
      if (app\&.selectionInfo\&.tag(Frame\&.Tag_2)\&.tagFormat) {
        console\&.log(app\&.getFrame(tagv2, "title"))
      }
      if (!app\&.nextFile()) {
        Qt\&.quit()
      } else {
        setTimeout(doWork, 1)
      }
    }

    app\&.firstFile()
    doWork()
  }
}
.fi
.if n \{\
.RE
.\}
.PP
When using
\fBapp\&.firstFile()\fR
with
\fBapp\&.nextFile()\fR, all files of the current directory will be processed\&. If only the selected files shall be affected, use
\fBfirstFile()\fR
and
\fBnextFile()\fR
instead, these are convenience functions of the
Kid3Script
component\&. The following example is a script which copies only the disc number and copyright frames of the selected file\&.
.sp
.if n \{\
.RS 4
.\}
.nf
import Kid3 1\&.1

Kid3Script {
  onRun: {
    function doWork() {
      if (app\&.selectionInfo\&.tag(Frame\&.Tag_2)\&.tagFormat) {
        app\&.setFrame(tagv2, "*\&.selected", false)
        app\&.setFrame(tagv2, "discnumber\&.selected", true)
        app\&.setFrame(tagv2, "copyright\&.selected", true)
        app\&.copyTags(tagv2)
      }
      if (!nextFile()) {
        Qt\&.quit()
      } else {
        setTimeout(doWork, 1)
      }
    }

    firstFile()
    doWork()
  }
}
.fi
.if n \{\
.RE
.\}
.PP
More example scripts come with
Kid3
and are already registered as user commands\&.
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
ReplayGain to SoundCheck
(ReplayGain2SoundCheck\&.qml): Create iTunNORM SoundCheck information from replay gain frames\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Resize Album Art
(ResizeAlbumArt\&.qml): Resize embedded cover art images which are larger than 500x500 pixels\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Extract Album Art
(ExtractAlbumArt\&.qml): Extract all embedded cover art pictures avoiding duplicates\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Embed Album Art
(EmbedAlbumArt\&.qml): Embed cover art found in image files into audio files in the same folder\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Embed Lyrics
(EmbedLyrics\&.qml): Fetch unsynchronized lyrics from web service\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Text Encoding ID3v1
(ShowTextEncodingV1\&.qml): Helps to find the encoding of ID3v1 tags by showing the tags of the current file in all available character encodings\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Export CSV
(ExportCsv\&.qml): Export recursively all tags of all files to a CSV file\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Export Playlist Folder
(ExportPlaylist\&.qml): Copy all files from a playlist into a directory and rename them according to their position\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
QML Console
(QmlConsole\&.qml): Simple console to play with
Kid3\*(Aqs QML API\&.
.RE
.sp
.SS "QML API"
.PP
The API can be easily explored using the QML Console, which is available as an example script with a user interface\&.
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBKid3Script\fR
.RS 4
.PP
Kid3Script
is a regular QML component located inside the plugin directory\&. You could use another QML component just as well\&. Using
Kid3Script
makes it easy to start the script function using the
\fBonRun\fR
signal handler\&. Moreover it offers some functions:
.sp
.if n \{\
.RS 4
.\}
.nf
onRun: Signal handler which is invoked when the script is started
tagv1, tagv2, tagv2v1: Constants for tag parameters
script: Access to scripting functions
configs: Access to configuration objects
getArguments(): List of script arguments
isStandalone(): true if the script was not started from within Kid3
setTimeout(callback, delay): Starts callback after delay ms
firstFile(): To first selected file
nextFile(): To next selected file
.fi
.if n \{\
.RE
.\}
.sp
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBScripting Functions\fR
.RS 4
.PP
As JavaScript and therefore QML too has only a limited set of functions for scripting, the
\fBscript\fR
object has some additional methods, for instance:
.sp
.if n \{\
.RS 4
.\}
.nf
script\&.properties(obj): String with Qt properties
script\&.writeFile(filePath, data): Write data to file, true if OK
script\&.readFile(filePath): Read data from file
script\&.removeFile(filePath): Delete file, true if OK
script\&.fileExists(filePath): true if file exists
script\&.renameFile(oldName, newName): Rename file, true if OK
script\&.copyFile(source, dest): Copy file, true if OK
script\&.makeDir(path): Create directory, true if OK
script\&.removeDir(path): Remove directory, true if OK
script\&.tempPath(): Path to temporary directory
script\&.listDir(path, [nameFilters], [classify]): List directory entries
script\&.system(program, [args], [msecs]): Synchronously start a system command,
  [exit code, standard output, standard error] if not timeout
script\&.systemAsync(program, [args], [callback]): Asynchronously start a system
command, callback will be called with [exit code, standard output, standard
error]
script\&.getEnv(varName): Get value of environment variable
script\&.setEnv(varName, value): Set value of environment variable
script\&.getQtVersion(): Qt version string, e\&.g\&. "5\&.4\&.1"
script\&.getDataMd5(data): Get hex string of the MD5 hash of data
script\&.getDataSize(data): Get size of byte array
script\&.dataToImage(data, [format]): Create an image from data bytes
script\&.dataFromImage(img, [format]): Get data bytes from image
script\&.loadImage(filePath): Load an image from a file
script\&.saveImage(img, filePath, [format]): Save an image to a file, true if OK
script\&.imageProperties(img): Get properties of an image, map containing
  "width", "height", "depth" and "colorCount", empty if invalid image
script\&.scaleImage(img, width, [height]): Scale an image, returns scaled image
.fi
.if n \{\
.RE
.\}
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBApplication Context\fR
.RS 4
.PP
Using QML, a large part of the
Kid3
functions are accessible\&. The API is similar to the one used for
D\-Bus\&. For details, refer to the respective notes\&.
.sp
.if n \{\
.RS 4
.\}
.nf
app\&.openDirectory(path): Open directory
app\&.unloadAllTags(): Unload all tags
app\&.saveDirectory(): Save directory
app\&.revertFileModifications(): Revert
app\&.importTags(tag, path, fmtIdx): Import file
app\&.importFromTags(tag, source, extraction): Import from tags
app\&.downloadImage(url, allFilesInDir): Download image
app\&.exportTags(tag, path, fmtIdx): Export file
app\&.writePlaylist(): Write playlist
app\&.getPlaylistItems(path): Get items of a playlist
app\&.setPlaylistItems(path, items): Set items of a playlist
app\&.selectAllFiles(): Select all
app\&.deselectAllFiles(): Deselect
app\&.firstFile([select], [onlyTaggedFiles]): To first file
app\&.nextFile([select], [onlyTaggedFiles]): To next file
app\&.previousFile([select], [onlyTaggedFiles]): To previous file
app\&.selectCurrentFile([select]): Select current file
app\&.selectFile(path, [select]): Select a specific file
app\&.getSelectedFilePaths([onlyTaggedFiles]): Get paths of selected files
app\&.requestExpandFileList(): Expand all
app\&.applyFilenameFormat(): Apply filename format
app\&.applyTagFormat(): Apply tag format
app\&.applyTextEncoding(): Apply text encoding
app\&.numberTracks(nr, total, tag, [options]): Number tracks
app\&.applyFilter(expr): Filter
app\&.convertToId3v23(): Convert ID3v2\&.4\&.0 to ID3v2\&.3\&.0
app\&.convertToId3v24(): Convert ID3v2\&.3\&.0 to ID3v2\&.4\&.0
app\&.getFilenameFromTags(tag): Filename from tags
app\&.getTagsFromFilename(tag): Filename to tags
app\&.getAllFrames(tag): Get object with all frames
app\&.getFrame(tag, name): Get frame
app\&.setFrame(tag, name, value): Set frame
app\&.getPictureData(): Get data from picture frame
app\&.setPictureData(data): Set data in picture frame
app\&.copyToOtherTag(tag): Tags to other tags
app\&.copyTags(tag): Copy
app\&.pasteTags(tag): Paste
app\&.removeTags(tag): Remove
app\&.playAudio(): Play
app\&.readConfig(): Read configuration
app\&.applyChangedConfiguration(): Apply configuration
app\&.dirName: Directory name
app\&.selectionInfo\&.fileName: File name
app\&.selectionInfo\&.filePath: Absolute file path
app\&.selectionInfo\&.detailInfo: Format details
app\&.selectionInfo\&.tag(Frame\&.Tag_1)\&.tagFormat: Tag 1 format
app\&.selectionInfo\&.tag(Frame\&.Tag_2)\&.tagFormat: Tag 2 format
app\&.selectionInfo\&.formatString(tag, format): Substitute codes in format string
app\&.selectFileName(caption, dir, filter, saveFile): Open file dialog to
select a file
app\&.selectDirName(caption, dir): Open file dialog to select a directory
.fi
.if n \{\
.RE
.\}
.PP
For asynchronous operations, callbacks can be connected to signals\&.
.sp
.if n \{\
.RS 4
.\}
.nf
function automaticImport(profile) {
  function onAutomaticImportFinished() {
    app\&.batchImporter\&.finished\&.disconnect(onAutomaticImportFinished)
  }
  app\&.batchImporter\&.finished\&.connect(onAutomaticImportFinished)
  app\&.batchImport(profile, tagv2)
}

function renameDirectory(format) {
  function onRenameActionsScheduled() {
    app\&.renameActionsScheduled\&.disconnect(onRenameActionsScheduled)
    app\&.performRenameActions()
  }
  app\&.renameActionsScheduled\&.connect(onRenameActionsScheduled)
  app\&.renameDirectory(tagv2v1, format, false)
}
.fi
.if n \{\
.RE
.\}
.RE
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
\fBConfiguration Objects\fR
.RS 4
.PP
The different configuration sections are accessible via methods of
\fBconfigs\fR\&. Their properties can be listed in the QML console\&.
.sp
.if n \{\
.RS 4
.\}
.nf
script\&.properties(configs\&.networkConfig())
.fi
.if n \{\
.RE
.\}
.sp
Properties can be set:
.sp
.if n \{\
.RS 4
.\}
.nf
configs\&.networkConfig()\&.useProxy = false
.fi
.if n \{\
.RE
.\}
.sp

.sp
.if n \{\
.RS 4
.\}
.nf
configs\&.batchImportConfig()
configs\&.exportConfig()
configs\&.fileConfig()
configs\&.filenameFormatConfig()
configs\&.filterConfig()
configs\&.findReplaceConfig()
configs\&.guiConfig()
configs\&.importConfig()
configs\&.mainWindowConfig()
configs\&.networkConfig()
configs\&.numberTracksConfig()
configs\&.playlistConfig()
configs\&.renDirConfig()
configs\&.tagConfig()
configs\&.tagFormatConfig()
configs\&.userActionsConfig()
.fi
.if n \{\
.RE
.\}
.RE
.SH "AUTHOR"
.PP
\fBUrs Fleisch\fR <\&ufleisch at users.sourceforge.net\&>
.RS 4
Software development
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2018 Urs Fleisch
.br
.PP
\m[blue]\fBFDL\fR\m[]
.sp
.SH "NOTES"
.IP " 1." 4
gnudb.org
.RS 4
\%http://gnudb.org
.RE
.IP " 2." 4
TrackType.org
.RS 4
\%http://tracktype.org
.RE
.IP " 3." 4
MusicBrainz
.RS 4
\%http://musicbrainz.org
.RE
.IP " 4." 4
Discogs
.RS 4
\%http://discogs.com
.RE
.IP " 5." 4
Amazon
.RS 4
\%http://www.amazon.com
.RE
.IP " 6." 4
ID3 specification
.RS 4
\%http://id3.org/id3v2.4.0-frames
.RE
.IP " 7." 4
SYLT Editor
.RS 4
\%http://www.compuphase.com/software_sylteditor.htm
.RE
.IP " 8." 4
www.gnudb.org
.RS 4
\%http://www.gnudb.org
.RE
.IP " 9." 4
freedb.org
.RS 4
\%http://freedb.org
.RE
.IP "10." 4
ID3 tag version 2.3.0
.RS 4
\%http://id3.org/id3v2.3.0
.RE
.IP "11." 4
ID3 tag version 2.4.0 - Main Structure
.RS 4
\%http://id3.org/id3v2.4.0-structure
.RE
.IP "12." 4
LyricWiki
.RS 4
\%http://www.lyricwiki.org
.RE
.IP "13." 4
Google
.RS 4
\%http://www.google.com
.RE
.IP "14." 4
id3lib
.RS 4
\%http://id3lib.sourceforge.net
.RE
.IP "15." 4
libogg
.RS 4
\%http://xiph.org/ogg/
.RE
.IP "16." 4
libvorbis, libvorbisfile
.RS 4
\%http://xiph.org/vorbis/
.RE
.IP "17." 4
libFLAC++ and libFLAC
.RS 4
\%http://flac.sourceforge.net
.RE
.IP "18." 4
TagLib
.RS 4
\%http://taglib.github.io/
.RE
.IP "19." 4
mp4v2
.RS 4
\%http://code.google.com/p/mp4v2
.RE
.IP "20." 4
Chromaprint
.RS 4
\%http://acoustid.org/chromaprint
.RE
.IP "21." 4
libav
.RS 4
\%http://libav.org/
.RE
.IP "22." 4
FDL
.RS 4
\%http://www.gnu.org/licenses/licenses.html#FDL
.RE
.IP "23." 4
GPL
.RS 4
\%http://www.gnu.org/licenses/licenses.html#GPL
.RE
.IP "24." 4
Qt
.RS 4
\%http://qt-project.org/
.RE
.IP "25." 4
KDE
.RS 4
\%http://www.kde.org
.RE