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

« back to all changes in this revision

Viewing changes to doc/eyeD3.1.in

  • 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:
69
69
.TP
70
70
\fB-t \fRSTRING, \fB\-\-title=\fRSTRING\fR
71
71
Set track title to STRING.
 
72
.TP
72
73
\fB-n \fRNUM, \fB\-\-track=\fRNUM\fR
73
74
Set track number to NUM.
74
75
.TP
81
82
\fB-Y \fRYEAR, \fB\-\-year=\fRYEAR\fR
82
83
Set the four digit year.
83
84
.TP
 
85
\fB-p \fRSTRING, \fB\-\-publisher=\fRSTRING\fR
 
86
Set the publisher/label text.
 
87
.TP
84
88
\fB\-\-comment=\fR[LANGUAGE]:DESCRIPTION:COMMENT\fR
85
89
Add (or remove when COMMENT is "") a comment.  Note that the argument value
86
90
MUST always contain exactly two ':' characters to delimit the fields even
95
99
\fB\-\-remove-comments\fR
96
100
Remove all comment frames from the tag.
97
101
.TP
 
102
\fB\-\-lyrics=\fR[LANGUAGE]:DESCRIPTION:LYRICS\fR
 
103
Add (or remove when LYRICS is "") a comment.  Note that the argument value
 
104
MUST always contain exactly two ':' characters to delimit the fields even
 
105
when the default language is being used.  The DESCRIPTION string is the
 
106
lyrics title.
 
107
The optional LANGUAGE string MUST be a three-character ISO 639
 
108
language code.  The default is "eng" for English.
 
109
 
 
110
A tag may not have more than one lyrics frame with the same DESCRIPTION and
 
111
LANGUAGE values. 
 
112
.TP
 
113
\fB\-\-remove-lyrics\fR
 
114
Remove all lyrics frames from the tag.
 
115
.TP
98
116
\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.
 
117
Add an image to the tag (APIC frame). 
 
118
The IMG_PATH is the image file to add to the tag. If the path value is empty
 
119
the image frame with a value of TYPE is removed from the tag.
101
120
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
121
The DESCRIPTION is optional and will default to "".  
104
122
 
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.
 
123
A tag may not have more than one image frame with the same TYPE values. 
 
124
.TP
 
125
\fB\-\-add\-object=\fROBJ_PATH[:DESCRIPTION[:MIME-TYPE[:FILENAME]]]\fR
 
126
Add an encapsulated object to the tag (GEOB frame).  The description
 
127
and filename are optional, but when used, the ':'
 
128
delimiters must be present.  If the OBJ_PATH value is
 
129
empty the GEOB frame with DESCRIPTION is removed.
 
130
 
 
131
A tag may not have more than one object (GEOB) frame with the same DESCRIPTION
 
132
values. 
 
133
.TP
 
134
\fB\-i \fRDIR, \fB\-\-write\-images=\fRDIR\fR
 
135
Causes all attached images (APIC frames) to be written to the specified
 
136
directory.  They are named by their "image type".  For example, if the image
 
137
is a png and the type is OTHER, a file named OTHER.png is written to the
 
138
desired directory.  If the file name already exist, a unique numeric value is
 
139
appended to the type string.
 
140
.TP
 
141
\fB\-o \fRDIR, \fB\-\-write\-objects=\fRDIR\fR
 
142
Causes all attached objects (GEOB frames) to be written
 
143
to the specified directory.  The files are written with the name
 
144
"<filename>.<mime-subtype>" in the specified directory.
112
145
.TP
113
146
\fB\-\-set\-text\-frame=\fRFID:TEXT\fR
114
147
Set the value of a specific (i.e., FID) text frame.  To remove the frame,
118
151
Set the play count (PCNT). If the argument value begins with '+' the value is
119
152
incremented by N, otherwise it is set to exactly N.
120
153
.TP
 
154
\fB\-\-bpm=\fRN\fR
 
155
Set the beats per minute value.  The value MUST be greater than 0.
 
156
.TP
121
157
\fB\-\-unique\-file-id=\fROWNER_ID:ID\fR
122
158
Add a UFID frame.  If the ID arg is empty the UFID frame with OWNER_ID is
123
159
removed.  An OWNER_ID MUST be specified.
145
181
%N (the total track count).  The PATTERN string MUST not contain the file
146
182
name extenstion.
147
183
.TP
 
184
\fB\-\-fs\-encoding=\fRENCODING\fR
 
185
Use the specified character encoding for filenames when renaming files.  The
 
186
default value is iso-8859-1.
 
187
.TP
148
188
\fB\-l\fR, \fB\-\-list\-genres\fR
149
189
Display the table of "valid" ID3 genres and exit.
150
190
.TP