eyeD3 (1) Linux Manual Page
eyeD3 – displays and manipulates id3-tags on mp3 files
Synopsis
eyeD3 [options] file [file…]eyeD3 [options] dir [dir…]
Description
eyeD3 Manipulates ID3 tags in mp3 files and is able to read/write and convert between ID3 v1.0, v1.1, v2.3 and v2.4 tags. High-level access is provided to most frames, including APIC (i.e., images) frames.Options
-h, –help Shows a brief help string and exit.- –version
- Show program’s version number and exit.
- –no-color
- Disable color output.
- -v, –verbose
- Show all available tag information.
- –debug
- Trace program execution; for debugging.
Tag Versions
- -1, –v1
- Only read/write ID3 v1 tags. By default, v1 tags are only read if there is not a v2 tag.
- -2, –v2
- Only read/write ID3 v2.x tags.
- –to-v1.1
- Convert the file’s tag to ID3 v1.1. (Or 1.0 if there is no track number)
- –to-v2.3
- Convert the file’s tag to ID3 v2.3.
- –to-v2.4
- Convert the file’s tag to ID3 v2.4
Tag Data
Options for manipulating tag data have the side-effect of removing a frame when the data specified is the empty string. For example, –artist="" (or -a "") would cause the artist frame to be removed. This is especially useful for removing comment frames.- -a STRING, –artist=STRING
- Set artist the to STRING.
- -A STRING, –album=STRING
- Set album to STRING.
- -t STRING, –title=STRING
- Set track title to STRING.
- -n NUM, –track=NUM
- Set track number to NUM.
- -N NUM, –track-total=NUM
- Set total number of tracks to NUM.
- -G STRING, –genre=STRING
- Sets genre to STRING. (See –list-genres)
- -Y YEAR, –year=YEAR
- Set the four digit year.
- -p STRING, –publisher=STRING
- Set the publisher/label text.
- –comment=[LANGUAGE]:DESCRIPTION:COMMENT
- Add (or remove when COMMENT is "") a comment. Note that the argument value MUST always contain exactly two ‘:’ characters to delimit the fields even when the default language is being used. The DESCRIPTION string is the comment title. The optional LANGUAGE string MUST be a three-character ISO 639 language code. The default is "eng" for English.
A tag may not have more than one comment frame with the same DESCRIPTION and LANGUAGE values.
- –remove-comments
- Remove all comment frames from the tag.
- –lyrics=[LANGUAGE]:DESCRIPTION:LYRICS
- Add (or remove when LYRICS is "") a comment. Note that the argument value MUST always contain exactly two ‘:’ characters to delimit the fields even when the default language is being used. The DESCRIPTION string is the lyrics title. The optional LANGUAGE string MUST be a three-character ISO 639 language code. The default is "eng" for English.
A tag may not have more than one lyrics frame with the same DESCRIPTION and LANGUAGE values.
- –remove-lyrics
- Remove all lyrics frames from the tag.
- –add-image=IMG_PATH:TYPE[:DESCRIPTION]
- Add an image to the tag (APIC frame). The IMG_PATH is the image file to add to the tag. If the path value is empty the image frame with a value of TYPE is removed from the tag. The TYPE is one of the types listed when ‘eyeD3 –list-image-types’ is run. The DESCRIPTION is optional and will default to "".
A tag may not have more than one image frame with the same TYPE values.
- –remove-images
- Remove all image (APIC) frames from the tag.
- –add-object=OBJ_PATH[:DESCRIPTION[:MIME-TYPE[:FILENAME]]]
- Add an encapsulated object to the tag (GEOB frame). The description and filename are optional, but when used, the ‘:’ delimiters must be present. If the OBJ_PATH value is empty the GEOB frame with DESCRIPTION is removed.
A tag may not have more than one object (GEOB) frame with the same DESCRIPTION values.
- -i DIR, –write-images=DIR
- Causes all attached images (APIC frames) to be written to the specified directory. They are named by their "image type". For example, if the image is a png and the type is OTHER, a file named OTHER.png is written to the desired directory. If the file name already exist, a unique numeric value is appended to the type string.
- -o DIR, –write-objects=DIR
- Causes all attached objects (GEOB frames) to be written to the specified directory. The files are written with the name "<filename>.<mime-subtype>" in the specified directory.
- –set-text-frame=FID:TEXT
- Set the value of a specific (i.e., FID) text frame. To remove the frame, specify an empty value. e.g., –set-text-frame="TDRC:"
- –set-user-text-frame=DESC:TEXT
- Set the value of a TXXX text frame with a unique description. To remove the frame, specify an empty value. e.g., –set-user-text-frame="Description:"
- –set-url-frame=FID:URL
- Set the value of a specific (i.e., FID) URL frame. To remove the frame, specify an empty URL. e.g., –set-url-frame="WCOM:"
- –set-user-url-frame=DESC:URL
- Set the value of a WXXX frame with unique description string. To remove the frame, specify an empty URL. e.g., –set-user-url-frame="Description:"
- –play-count=[+]N
- Set the play count (PCNT). If the argument value begins with ‘+’ the value is incremented by N, otherwise it is set to exactly N.
- –bpm=N
- Set the beats per minute value. The value MUST be greater than 0.
- –unique-file-id=OWNER_ID:ID
- Add a UFID frame. If the ID arg is empty the UFID frame with OWNER_ID is removed. An OWNER_ID MUST be specified.
- –set-encoding=latin1|utf8|utf16-LE|utf16-BE
- Set the encoding that is used for _all_ text frames in the tag. The encoding is applied only when the tag is updated, therefore a frame must be set or –force-update is present. Note that, unfortunately, utf8 is not supported by ID3 v2.3 tags.
- –remove-v1
- Remove ID3 v1.x tag.
- –remove-v2
- Remove ID3 v2.x tag.
- –remove-all
- Remove all tags.
Misc. Options
- –rename=PATTERN
- Rename the file based on PATTERN which may contain the following substitution variables: %A (artist), %a (album), %t (title), %n (track number), and %N (the total track count). The PATTERN string MUST not contain the file name extenstion.
- –fs-encoding=ENCODING
- Use the specified character encoding for filenames when renaming files. The default value is iso-8859-1.
- -l, –list-genres
- Display the table of "valid" ID3 genres and exit.
- –list-image-types
- List all possible image types for APIC frames.
- –strict
- Fail for tags that violate the ID3 specification.
- –jep-118
- Output the tag per the format described in JEP-0118. See http://www.xmpp.org/extensions/xep-0118.html
- –nfo
- Output NFO information for each album directory.
- –lametag
- Prints the LAME Tag.
- –force-update
- Update the tag regardless of whether any frames were set on the command line.
- –no-zero-padding
- Don’t pad track or disc numbers with 0’s.
- –no-tagging-time-frame
- When saving tags do not add a TDTG (tagging time) frame.
- -F DELIM
- Specify a new delimiter for option values that contain multiple fields (default delimiter is ‘:’)