~ubuntu-branches/ubuntu/oneiric/eyed3/oneiric

« back to all changes in this revision

Viewing changes to doc/eyeD3.1

  • Committer: Bazaar Package Importer
  • Author(s): Alexander Wirt
  • Date: 2006-11-18 01:47:38 UTC
  • mfrom: (1.2.1 upstream) (2.1.5 feisty)
  • Revision ID: james.westby@ubuntu.com-20061118014738-bcwcoe9gywrgorz2
New upstream version  

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.TH EYED3 "1" "Apr. 08, 2005" "eyeD3 0.6.4" ""
2
 
.SH "NAME"
3
 
.B eyeD3
4
 
\- displays and manipulates id3-tags on mp3 files
5
 
.SH "SYNOPSIS"
6
 
.B eyeD3
7
 
.RI [ options ]
8
 
.RI file
9
 
.RI [ file... ]
10
 
.br
11
 
.B eyeD3
12
 
.RI [ options ]
13
 
.RI dir
14
 
.RI [ dir... ]
15
 
.br
16
 
 
17
 
.SH "DESCRIPTION"
18
 
.B eyeD3
19
 
Manipulates ID3 tags in mp3 files and is able to read/write and convert between
20
 
ID3 v1.0, v1.1, v2.3 and v2.4 tags.  High-level access is provided to most
21
 
frames, including APIC (i.e., images) frames.
22
 
 
23
 
.SH "OPTIONS"
24
 
\fB\-h, \fB\-\-help\fR
25
 
Shows a brief help string and exit.
26
 
.TP
27
 
\fB\-\-version\fR
28
 
Show program's version number and exit.
29
 
.TP
30
 
\fB\-\-no\-color\fR
31
 
Disable color output.
32
 
.TP
33
 
\fB\-v\fR, \fB\-\-verbose\fR
34
 
Show all available tag information.
35
 
.TP
36
 
\fB\-\-debug\fR
37
 
Trace program execution; for debugging.
38
 
 
39
 
.SH "TAG VERSIONS"
40
 
.TP
41
 
\fB\-1, \fB\-\-v1\fR
42
 
Only read/write ID3 v1 tags. By default, v1 tags are only read if there is
43
 
not a v2 tag.
44
 
.TP
45
 
\fB\-2, \fB\-\-v2\fR
46
 
Only read/write ID3 v2.x tags.
47
 
.TP
48
 
\fB\-\-to\-v1.1\fR
49
 
Convert the file's tag to ID3 v1.1. (Or 1.0 if there is no track number)
50
 
.TP
51
 
\fB\-\-to\-v2.3\fR
52
 
Convert the file's tag to ID3 v2.3.
53
 
.TP
54
 
\fB\-\-to\-v2.4\fR
55
 
Convert the file's tag to ID3 v2.4
56
 
 
57
 
.SH "TAG DATA"
58
 
Options for manipulating tag data have the side-effect of removing a frame
59
 
when the data specified is the empty string.  For example, --artist="" 
60
 
(or -a "") would cause the artist frame to be removed.  This is especially
61
 
useful for removing comment frames.
62
 
 
63
 
.TP
64
 
\fB-a \fRSTRING, \fB\-\-artist=\fRSTRING\fR
65
 
Set artist the to STRING.
66
 
.TP
67
 
\fB-A \fRSTRING, \fB\-\-album=\fRSTRING\fR
68
 
Set album to STRING.
69
 
.TP
70
 
\fB-t \fRSTRING, \fB\-\-title=\fRSTRING\fR
71
 
Set track title to STRING.
72
 
\fB-n \fRNUM, \fB\-\-track=\fRNUM\fR
73
 
Set track number to NUM.
74
 
.TP
75
 
\fB-N \fRNUM, \fB\-\-track\-total=\fRNUM\fR
76
 
Set total number of tracks to NUM.
77
 
.TP
78
 
\fB-G \fRSTRING, \fB\-\-track\-genre=\fRSTRING\fR
79
 
Sets genre to STRING. (See --list-genres)
80
 
.TP
81
 
\fB-Y \fRYEAR, \fB\-\-year=\fRYEAR\fR
82
 
Set the four digit year.
83
 
.TP
84
 
\fB\-\-comment=\fR[LANGUAGE]:DESCRIPTION:COMMENT\fR
85
 
Add (or remove when COMMENT is "") a comment.  Note that the argument value
86
 
MUST always contain exactly two ':' characters to delimit the fields even
87
 
when the default language is being used.  The DESCRIPTION string is the
88
 
comment title.
89
 
The optional LANGUAGE string MUST be a three-character ISO 639
90
 
language code.  The default is "eng" for English.
91
 
 
92
 
A tag may not have more than one comment frame with the same DESCRIPTION and
93
 
LANGUAGE values. 
94
 
.TP
95
 
\fB\-\-remove-comments\fR
96
 
Remove all comment frames from the tag.
97
 
.TP
98
 
\fB\-\-add\-image=\fRIMG_PATH:TYPE[:DESCRIPTION]\fR
99
 
Add an image to the tag. 
100
 
The IMG_PATH is required and points to the image file to add to the tag.
101
 
The TYPE is one of the types listed when 'eyeD3 --list-image-types' is run.
102
 
It is used to classify what the image pertains to.
103
 
The DESCRIPTION is optional and will default to "".  
104
 
 
105
 
A tag may not have more than one image frame with the same DESCRIPTION and
106
 
TYPE values. 
107
 
.TP
108
 
\fB\-i, \-\-write-images\fR
109
 
Causes all attached images (APIC frames) to be written to the current directory.
110
 
They are named by their type.  For example, if the image is a png and the type
111
 
is OTHER, a file named OTHER.png is written to the current directory.
112
 
.TP
113
 
\fB\-\-set\-text\-frame=\fRFID:TEXT\fR
114
 
Set the value of a specific (i.e., FID) text frame.  To remove the frame,
115
 
specify an empty value.  e.g., --set-text-frame="TDRC:"
116
 
.TP
117
 
\fB\-\-play\-count=\fR[+]N\fR
118
 
Set the play count (PCNT). If the argument value begins with '+' the value is
119
 
incremented by N, otherwise it is set to exactly N.
120
 
.TP
121
 
\fB\-\-unique\-file-id=\fROWNER_ID:ID\fR
122
 
Add a UFID frame.  If the ID arg is empty the UFID frame with OWNER_ID is
123
 
removed.  An OWNER_ID MUST be specified.
124
 
.TP
125
 
\fB\-\-set\-encoding=\fRlatin1|utf8|utf16-LE|utf16-BE\fR
126
 
Set the encoding that is used for _all_ text frames in the tag. The encoding
127
 
is applied only when the tag is updated, therefore a frame must be set or
128
 
--force-update is present.  Note that, unfortunately, utf8 is not supported
129
 
by ID3 v2.3 tags.
130
 
.TP
131
 
\fB\-\-remove-v1\fR
132
 
Remove ID3 v1.x tag.
133
 
.TP
134
 
\fB\-\-remove-v2\fR
135
 
Remove ID3 v2.x tag.
136
 
.TP
137
 
\fB\-\-remove-all\fR
138
 
Remove all tags.
139
 
 
140
 
.SH "MISC. OPTIONS"
141
 
.TP
142
 
\fB\-\-rename=\fRPATTERN\fR
143
 
Rename the file based on PATTERN which may contain the following substitution
144
 
variables: %A (artist), %a (album), %t (title), %n (track number), and
145
 
%N (the total track count).  The PATTERN string MUST not contain the file
146
 
name extenstion.
147
 
.TP
148
 
\fB\-l\fR, \fB\-\-list\-genres\fR
149
 
Display the table of "valid" ID3 genres and exit.
150
 
.TP
151
 
\fB\-\-list\-image\-types\fR
152
 
List all possible image types for APIC frames.
153
 
.TP
154
 
\fB\-\-strict\fR
155
 
Fail for tags that violate the ID3 specification.
156
 
.TP
157
 
\fB\-\-jep\-118\fR
158
 
Output the tag per the format described in JEP-0118. See
159
 
http://www.jabber.org/jeps/jep-0118.html
160
 
.TP
161
 
\fB\-\-force\-update\fR
162
 
Update the tag regardless of whether any frames were set on the command line.
163
 
 
164
 
.SH SEE ALSO
165
 
http://eyed3.nicfit.net/
166
 
 
167
 
.SH AUTHOR
168
 
eyeD3 was written by Travis Shirk <travis@pobox.com>. This manpage was written
169
 
by Alexander Wirt <formorer@debian.org> for the Debian Distribution and Travis
170
 
Shirk.