eyeD3(1)

1EYED3(1)                                                              EYED3(1)
2
3
4

NAME

6       eyeD3 - displays and manipulates id3-tags on mp3 files
7

SYNOPSIS

9       eyeD3 [options] file [file...]
10       eyeD3 [options] dir [dir...]
11
12

DESCRIPTION

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
18

OPTIONS

20       -h, --help Shows a brief help string and exit.
21
22       --version
23              Show program's version number and exit.
24
25       --no-color
26              Disable color output.
27
28       -v, --verbose
29              Show all available tag information.
30
31       --debug
32              Trace program execution; for debugging.
33
34

TAG VERSIONS

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
40       -2, --v2
41              Only read/write ID3 v2.x tags.
42
43       --to-v1.1
44              Convert the file's tag to ID3 v1.1. (Or 1.0 if there is no track
45              number)
46
47       --to-v2.3
48              Convert the file's tag to ID3 v2.3.
49
50       --to-v2.4
51              Convert the file's tag to ID3 v2.4
52
53

TAG DATA

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
60
61       -a STRING, --artist=STRING
62              Set artist the to STRING.
63
64       -A STRING, --album=STRING
65              Set album to STRING.
66
67       -t STRING, --title=STRING
68              Set track title to STRING.
69
70       -n NUM, --track=NUM
71              Set track number to NUM.
72
73       -N NUM, --track-total=NUM
74              Set total number of tracks to NUM.
75
76       -G STRING, --track-genre=STRING
77              Sets genre to STRING. (See --list-genres)
78
79       -Y YEAR, --year=YEAR
80              Set the four digit year.
81
82       -p STRING, --publisher=STRING
83              Set the publisher/label text.
84
85       --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
93              A  tag  may  not  have more than one comment frame with the same
94              DESCRIPTION and LANGUAGE values.
95
96       --remove-comments
97              Remove all comment frames from the tag.
98
99       --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
107              A  tag  may  not  have  more than one lyrics frame with the same
108              DESCRIPTION and LANGUAGE values.
109
110       --remove-lyrics
111              Remove all lyrics frames from the tag.
112
113       --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
120              A tag may not have more than one image frame with the same  TYPE
121              values.
122
123       --add-object=OBJ_PATH[:DESCRIPTION[:MIME-TYPE[:FILENAME]]]
124              Add  an  encapsulated  object  to  the  tag  (GEOB  frame).  The
125              description and filename are optional, but when  used,  the  ':'
126              delimiters  must be present.  If the OBJ_PATH value is empty the
127              GEOB frame with DESCRIPTION is removed.
128
129              A tag may not have more than one object (GEOB)  frame  with  the
130              same DESCRIPTION values.
131
132       -i DIR, --write-images=DIR
133              Causes  all  attached  images (APIC frames) to be written to the
134              specified directory.  They are named by their "image type".  For
135              example,  if  the  image  is a png and the type is OTHER, a file
136              named OTHER.png is written to the  desired  directory.   If  the
137              file  name  already exist, a unique numeric value is appended to
138              the type string.
139
140       -o DIR, --write-objects=DIR
141              Causes all attached objects (GEOB frames) to be written  to  the
142              specified  directory.   The  files  are  written  with  the name
143              "<filename>.<mime-subtype>" in the specified directory.
144
145       --set-text-frame=FID:TEXT
146              Set the value of a specific (i.e., FID) text frame.   To  remove
147              the   frame,   specify   an   empty  value.   e.g.,  --set-text-
148              frame="TDRC:"
149
150       --play-count=[+]N
151              Set the play count (PCNT). If the argument value begins with '+'
152              the value is incremented by N, otherwise it is set to exactly N.
153
154       --bpm=N
155              Set  the beats per minute value.  The value MUST be greater than
156              0.
157
158       --unique-file-id=OWNER_ID:ID
159              Add a UFID frame.  If the ID arg is empty the  UFID  frame  with
160              OWNER_ID is removed.  An OWNER_ID MUST be specified.
161
162       --set-encoding=latin1|utf8|utf16-LE|utf16-BE
163              Set  the encoding that is used for _all_ text frames in the tag.
164              The encoding is applied only when the tag is updated,  therefore
165              a  frame  must  be set or --force-update is present.  Note that,
166              unfortunately, utf8 is not supported by ID3 v2.3 tags.
167
168       --remove-v1
169              Remove ID3 v1.x tag.
170
171       --remove-v2
172              Remove ID3 v2.x tag.
173
174       --remove-all
175              Remove all tags.
176
177

MISC. OPTIONS

179       --rename=PATTERN
180              Rename the file based on PATTERN which may contain the following
181              substitution  variables: %A (artist), %a (album), %t (title), %n
182              (track number), and %N (the total  track  count).   The  PATTERN
183              string MUST not contain the file name extenstion.
184
185       --fs-encoding=ENCODING
186              Use the specified character encoding for filenames when renaming
187              files.  The default value is iso-8859-1.
188
189       -l, --list-genres
190              Display the table of "valid" ID3 genres and exit.
191
192       --list-image-types
193              List all possible image types for APIC frames.
194
195       --strict
196              Fail for tags that violate the ID3 specification.
197
198       --jep-118
199              Output the  tag  per  the  format  described  in  JEP-0118.  See
200              http://www.jabber.org/jeps/jep-0118.html
201
202       --force-update
203              Update  the tag regardless of whether any frames were set on the
204              command line.
205
206

AUTHOR

212       eyeD3 was written by Travis Shirk <travis@pobox.com>. This manpage  was
213       written  by Alexander Wirt <formorer@debian.org> for the Debian Distri‐
214       bution and Travis Shirk.
215
216
217
218eyeD3 0.6.12                     Feb. 24, 2007                        EYED3(1)