1EYED3(1) EYED3(1)
2
6 eyeD3 - displays and manipulates id3-tags on mp3 files
7
9 eyeD3 [options] file [file...]
10 eyeD3 [options] dir [dir...]
11
14 eyeD3 Manipulates ID3 tags in mp3 files and is able to read/write and
15 convert between ID3 v1.0, v1.1, v2.3 and v2.4 tags. High-level access
16 is provided to most frames, including APIC (i.e., images) frames.
17
20 -h, --help Shows a brief help string and exit.
21 --version
23 Show program's version number and exit.
24 --no-color
26 Disable color output.
27 -v, --verbose
29 Show all available tag information.
30 --debug
32 Trace program execution; for debugging.
33
36 -1, --v1
37 Only read/write ID3 v1 tags. By default, v1 tags are only read
38 if there is not a v2 tag.
39 -2, --v2
41 Only read/write ID3 v2.x tags.
42 --to-v1.1
44 Convert the file's tag to ID3 v1.1. (Or 1.0 if there is no track
45 number)
46 --to-v2.3
48 Convert the file's tag to ID3 v2.3.
49 --to-v2.4
51 Convert the file's tag to ID3 v2.4
52
55 Options for manipulating tag data have the side-effect of removing a
56 frame when the data specified is the empty string. For example,
57 --artist="" (or -a "") would cause the artist frame to be removed.
58 This is especially useful for removing comment frames.
59 -a STRING, --artist=STRING
62 Set artist the to STRING.
63 -A STRING, --album=STRING
65 Set album to STRING.
66 -t STRING, --title=STRING
68 Set track title to STRING.
69 -n NUM, --track=NUM
71 Set track number to NUM.
72 -N NUM, --track-total=NUM
74 Set total number of tracks to NUM.
75 -G STRING, --genre=STRING
77 Sets genre to STRING. (See --list-genres)
78 -Y YEAR, --year=YEAR
80 Set the four digit year.
81 -p STRING, --publisher=STRING
83 Set the publisher/label text.
84 --comment=[LANGUAGE]:DESCRIPTION:COMMENT
86 Add (or remove when COMMENT is "") a comment. Note that the
87 argument value MUST always contain exactly two ':' characters to
88 delimit the fields even when the default language is being used.
89 The DESCRIPTION string is the comment title. The optional LAN‐
90 GUAGE string MUST be a three-character ISO 639 language code.
91 The default is "eng" for English.
92 A tag may not have more than one comment frame with the same
94 DESCRIPTION and LANGUAGE values.
95 --remove-comments
97 Remove all comment frames from the tag.
98 --lyrics=[LANGUAGE]:DESCRIPTION:LYRICS
100 Add (or remove when LYRICS is "") a comment. Note that the
101 argument value MUST always contain exactly two ':' characters to
102 delimit the fields even when the default language is being used.
103 The DESCRIPTION string is the lyrics title. The optional LAN‐
104 GUAGE string MUST be a three-character ISO 639 language code.
105 The default is "eng" for English.
106 A tag may not have more than one lyrics frame with the same
108 DESCRIPTION and LANGUAGE values.
109 --remove-lyrics
111 Remove all lyrics frames from the tag.
112 --add-image=IMG_PATH:TYPE[:DESCRIPTION]
114 Add an image to the tag (APIC frame). The IMG_PATH is the image
115 file to add to the tag. If the path value is empty the image
116 frame with a value of TYPE is removed from the tag. The TYPE is
117 one of the types listed when 'eyeD3 --list-image-types' is run.
118 The DESCRIPTION is optional and will default to "".
119 A tag may not have more than one image frame with the same TYPE
121 values.
122 --remove-images
124 Remove all image (APIC) frames from the tag.
125 --add-object=OBJ_PATH[:DESCRIPTION[:MIME-TYPE[:FILENAME]]]
127 Add an encapsulated object to the tag (GEOB frame). The
128 description and filename are optional, but when used, the ':'
129 delimiters must be present. If the OBJ_PATH value is empty the
130 GEOB frame with DESCRIPTION is removed.
131 A tag may not have more than one object (GEOB) frame with the
133 same DESCRIPTION values.
134 -i DIR, --write-images=DIR
136 Causes all attached images (APIC frames) to be written to the
137 specified directory. They are named by their "image type". For
138 example, if the image is a png and the type is OTHER, a file
139 named OTHER.png is written to the desired directory. If the
140 file name already exist, a unique numeric value is appended to
141 the type string.
142 -o DIR, --write-objects=DIR
144 Causes all attached objects (GEOB frames) to be written to the
145 specified directory. The files are written with the name
146 "<filename>.<mime-subtype>" in the specified directory.
147 --set-text-frame=FID:TEXT
149 Set the value of a specific (i.e., FID) text frame. To remove
150 the frame, specify an empty value. e.g., --set-text-
151 frame="TDRC:"
152 --set-user-text-frame=DESC:TEXT
154 Set the value of a TXXX text frame with a unique description.
155 To remove the frame, specify an empty value. e.g., --set-user-
156 text-frame="Description:"
157 --set-url-frame=FID:URL
159 Set the value of a specific (i.e., FID) URL frame. To remove
160 the frame, specify an empty URL. e.g., --set-url-frame="WCOM:"
161 --set-user-url-frame=DESC:URL
163 Set the value of a WXXX frame with unique description string.
164 To remove the frame, specify an empty URL. e.g., --set-user-
165 url-frame="Description:"
166 --play-count=[+]N
168 Set the play count (PCNT). If the argument value begins with '+'
169 the value is incremented by N, otherwise it is set to exactly N.
170 --bpm=N
172 Set the beats per minute value. The value MUST be greater than
173 0.
174 --unique-file-id=OWNER_ID:ID
176 Add a UFID frame. If the ID arg is empty the UFID frame with
177 OWNER_ID is removed. An OWNER_ID MUST be specified.
178 --set-encoding=latin1|utf8|utf16-LE|utf16-BE
180 Set the encoding that is used for _all_ text frames in the tag.
181 The encoding is applied only when the tag is updated, therefore
182 a frame must be set or --force-update is present. Note that,
183 unfortunately, utf8 is not supported by ID3 v2.3 tags.
184 --remove-v1
186 Remove ID3 v1.x tag.
187 --remove-v2
189 Remove ID3 v2.x tag.
190 --remove-all
192 Remove all tags.
193
196 --rename=PATTERN
197 Rename the file based on PATTERN which may contain the following
198 substitution variables: %A (artist), %a (album), %t (title), %n
199 (track number), and %N (the total track count). The PATTERN
200 string MUST not contain the file name extenstion.
201 --fs-encoding=ENCODING
203 Use the specified character encoding for filenames when renaming
204 files. The default value is iso-8859-1.
205 -l, --list-genres
207 Display the table of "valid" ID3 genres and exit.
208 --list-image-types
210 List all possible image types for APIC frames.
211 --strict
213 Fail for tags that violate the ID3 specification.
214 --jep-118
216 Output the tag per the format described in JEP-0118. See
217 http://www.xmpp.org/extensions/xep-0118.html
218 --nfo Output NFO information for each album directory.
220 --lametag
222 Prints the LAME Tag.
223 --force-update
225 Update the tag regardless of whether any frames were set on the
226 command line.
227 --no-zero-padding
229 Don't pad track or disc numbers with 0's.
230 --no-tagging-time-frame
232 When saving tags do not add a TDTG (tagging time) frame.
233 -F DELIM
235 Specify a new delimiter for option values that contain multiple
236 fields (default delimiter is ':')
237
240 http://eyed3.nicfit.net/
241
244 eyeD3 was written by Travis Shirk <travis@pobox.com>. This manpage was
245 written by Alexander Wirt <formorer@debian.org> for the Debian Distri‐
246 bution and Travis Shirk.
247eyeD3 0.6.17 Aug. 06, 2011 EYED3(1)