File: mp3burn.1

package info (click to toggle)
mp3burn 0.4.2-2.3
  • links: PTS
  • area: main
  • in suites:
  • size: 156 kB
  • sloc: perl: 285; makefile: 38
file content (417 lines) | stat: -rw-r--r-- 15,123 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "MP3BURN 1"
.TH MP3BURN 1 "2010-10-25" "perl v5.10.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
mp3burn \- burn audio CDs from MP3, Ogg Vorbis, or FLAC files
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBmp3burn\fR [\s-1OPTION\s0] [mp3,ogg, and flac files]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBmp3burn\fR
is a simple command line tool for making audio CDs from
MP3s without filling up your disk with .wav files.  It uses
\&\fIPerl\fR\|(1), \fIogg123\fR\|(1), \fImpg321\fR\|(1) or \fImpg123\fR\|(1), \fIcdrecord\fR\|(1), 
\&\fIflac\fR\|(1), and the \fIMP3::Info\fR\|(3) Perl module.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-h, \-\-help\fR" 4
.IX Item "-h, --help"
Prints out a brief help
.IP "\fB\-m, \-\-swap\fR" 4
.IX Item "-m, --swap"
Manual \f(CW\*(C`cdrecord \-swab\*(C'\fR option mode.  
Use this to disable the automatic detection for swab mode in case it is
not working correctly on your system.  (Also, please send email to
<formorer@formorer.de> or file a bug against the mp3burn package if you
encounter this problem.)
.ie n .IP "\fB\-p, \-\-playlist\fR "".m3u playlist""" 4
.el .IP "\fB\-p, \-\-playlist\fR ``.m3u playlist''" 4
.IX Item "-p, --playlist .m3u playlist"
Use a playlist to specify audio files to burn.
Instead of (or in addition to) listing mp3/ogg/flac files, 
supply a .m3u playlist (e.g., from xmms) that contains the 
audio files for your \s-1CD\s0.
.Sp
Note:  If you specify both a playlist and audio files, the
files specified on the command-line will be appended to the list 
of audio files listed in the playlist.  If a file referenced
in a playlist cannot be read, it will be skipped.  Be wary of
playlist editors that use relative paths \- mp3burn cannot know
what path the playlist editor assumed.
.ie n .IP "\fB\-t, \-\-tmpdir\fR ""tmpdir""" 4
.el .IP "\fB\-t, \-\-tmpdir\fR ``tmpdir''" 4
.IX Item "-t, --tmpdir tmpdir"
Put temporary files in \fItmpdir\fR.
Default is to use the current directory.
.ie n .IP "\fB\-c, \-\-check\fR ""\s-1MMM:SS\s0"" | \s-1ATIP\s0" 4
.el .IP "\fB\-c, \-\-check\fR ``\s-1MMM:SS\s0'' | \s-1ATIP\s0" 4
.IX Item "-c, --check MMM:SS | ATIP"
Time check:  compute the total length of files to be burned
and warn if greater than \fI\s-1MMM:SS\s0\fR minutes and seconds.  If
the value \s-1ATIP\s0 is supplied, the total length is checked
against the length available on the CDR[W] as reported by
\&\s-1ATIP\s0.
.Sp
Note that FLAC-encoded files are assumed to be 1 second long
(until there is an easy way to get the file duration).  You
will need to calculate burn-length on your own with \s-1FLAC\s0 files.
.IP "\fB\-d, \-\-dummy\fR" 4
.IX Item "-d, --dummy"
Perform a \*(L"dummy\*(R" run: do everything except actually burn the \s-1CD\s0
(uses \fIcdrecord\fR\|(1) \f(CW\*(C`\-dummy\*(C'\fR option).
.ie n .IP "\fB\-o, \-\-cdrecord\fR  ""cdrecord_opts""" 4
.el .IP "\fB\-o, \-\-cdrecord\fR  ``cdrecord_opts''" 4
.IX Item "-o, --cdrecord  cdrecord_opts"
Specify the command line options for cdrecord. 
The quotes are required to prevent \fBmp3burn\fR from parsing \fIcdrecord\fR\|(1) options.
Overrides options specified in \fI~/.mp3burnrc\fR.
.Sp
Example: \fB\-o\fR \*(L"\-v dev=1,0 speed=4 \-swab\*(R"
.IP "\fBNote:\fR" 4
.IX Item "Note:"
The options \fI\-pad\fR and \fI\-audio\fR are added automatically, since they are
always necessary.  The script also tries to detect if \fI\-swab\fR  is needed (for
example on x86 and other little-Endian platforms).  cdrecord is supposed
to take care of any byte-ordering requirements specific to your burner. 
(If you end up with a \s-1CD\s0 that merely sounds like static, you most likely
need to toggle use of \fI\-swab\fR.)  You should also consider using \fI\-v\fR so
that you can watch the burn in progress. This goes for \fI~/.mp3burnrc\fR also.
.IP "\fB\-a, \-\-atip\fR" 4
.IX Item "-a, --atip"
Lookup the \s-1ATIP\s0 info for the device in the cdburner 
(using \fIcdrecord\fR\|(1) \f(CW\*(C`\-atip\*(C'\fR) and then exits.  This 
option can only be used (successfully) in conjuction with \fB\-o\fR.
.ie n .IP "\fB\-M, \-\-encoder\fR ""\s-1MP3\s0 decoder""" 4
.el .IP "\fB\-M, \-\-encoder\fR ``\s-1MP3\s0 decoder''" 4
.IX Item "-M, --encoder MP3 decoder"
Use an \s-1MP3\s0 decoder other than the default, which is mpg321.  This is
imperative when burning tracks that have sample rates other than 44.1kHz,
and the current version of mpg321 will not decode these files.  Specify
the name of the decoder to be used, e.g. \fImpg123\-oss\-3dnow\fR;  you can
also specify this in  your .mp3burnrc file with \fB\f(CB$mp3decoder\fB
=\fR \fImp3decoder\fR.  \fI(Note:  Currently, the \s-1MP3\s0 decoder must be
able to accept mpg123\-style command-line arguments.)\fR
.SH "RETURN VALUE"
.IX Header "RETURN VALUE"
\&\fBmp3burn\fR returns 0 on success.
.SH "DIAGNOSTICS"
.IX Header "DIAGNOSTICS"
.IP "Error in .mp3burnrc:" 4
.IX Item "Error in .mp3burnrc:"
\&\fIPerl\fR\|(1) cannot parse the \fI.mp3burnrc\fR file.
The following example occurs when a double quote is not terminated:
.Sp
.Vb 6
\&  bash\-2.05$ sudo mp3burn \-d ~/bell.ogg 
\&  String found where operator expected at (eval 10) line 7, at end of line
\&          (Missing operator before ?)
\&  Error in .mp3burnrc:
\&  Can\*(Aqt find string terminator \*(Aq"\*(Aq anywhere before EOF at (eval 10) line 7.
\&  bash\-2.05$
.Ve
.Sp
You will experience this error if you define both \f(CW$cdrecord_opts\fR and
\&\f(CW$mp3decoder\fR without terminating the variable assignments with the ';' 
character:
.Sp
.Vb 8
\&  $ mp3burn \-d \-t /tmp Theodor_Storm_Aquis_submersus_1.mp3 
\&  Scalar found where operator expected at (eval 10) line 2, near ""\-v speed=2 dev=0,3,0"
\&  $mp3decoder"
\&        (Missing operator before 
\&  $mp3decoder?)
\&  Error in .mp3burnrc:
\&  syntax error at (eval 10) line 2, near ""\-v speed=2 dev=0,3,0"
\&  $mp3decoder"
.Ve
.SH "EXAMPLES"
.IX Header "EXAMPLES"
Write an Ogg Vorbis file from a CD-R drive, \fI/dev/scd0\fR, 
mounted at \fI/mnt/scd0/\fR to a 
CD-RW drive, \fI/dev/scd1\fR, called \f(CW\*(C`0,1,0\*(C'\fR in \fIcdrecord\fR\|(1) \s-1SCSI\s0 notation.
Ensure that file is no longer than 50 minutes.
\&\fIsudo\fR\|(1) is used to get root permissions for \fIcdrecord\fR\|(1).
.PP
.Vb 1
\&  % sudo mp3burn \-c 050:00 \-o "\-v speed=2 dev=0,1,0" /mnt/scd0/bell.ogg
.Ve
.PP
Create a \fI~/.mp3burnrc\fR that prints a message before writing and uses
a different \s-1MP3\s0 decoder than the default of mpg321.
.PP
.Vb 3
\&  # This is an example.
\&  $cdrecord_opts="\-v speed=2 dev=0,1,0";
\&  $mp3decoder = "mpg123\-oss\-3dnow";
\&
\&  print "Nine seconds to slap a CD\-R in the drive!\en" ;
\&
\&  #
\&  # See mp3burn(3).
\&  #
.Ve
.PP
Specify an mp3decoder other than mpg321.
.PP
.Vb 1
\&  $ sudo mp3burn \-M mpg123\-esd ./rush/*mp3
.Ve
.SH "FILES"
.IX Header "FILES"
.IP "\fI~/.mp3burnrc\fR" 4
.IX Item "~/.mp3burnrc"
In this file, you may permanently specify the cdrecord options and
\&\s-1MP3\s0 decoder you want to use.  The format is:
.Sp
.Vb 2
\&  $cdrecord_opts = "cdrecord options";
\&  $mp3decoder = "some mp3 decoder";
.Ve
.Sp
You may place comments in this file by beginning a line with \f(CW\*(C`#\*(C'\fR.
.IP "\fBNote:\fR" 4
.IX Item "Note:"
The values of \f(CW$cdrecord_opts\fR and \f(CW$mp3decoder\fR in \fI~/.mp3burnrc\fR are ignored 
if the \f(CW\*(C`\-o\*(C'\fR or \f(CW\*(C`\-<\*(C'\fRcommand-line options are used, respectively.
.SH "CAVEATS"
.IX Header "CAVEATS"
Has not been tested extensively with Ogg Vorbis files.
Ogg Vorbis files must be in CD-DA format: 
i.e. 44100 samples/channel x 16 bits/sample x 2 channels.
.SH "BUGS"
.IX Header "BUGS"
If you execute \fBmp3burn\fR with root permissions, 
the \fI~/.mp3burnrc\fR will also be executed with root permissions.
.SH "NOTES"
.IX Header "NOTES"
There are a number of \s-1GUI\s0 frontends for \fBmp3burn\fR:
.IP "Xmp3Burn" 4
.IX Item "Xmp3Burn"
http://perso.wanadoo.es/ja_recio/xmp3burn/xmp3burn.html
.IP "Kmp3burn" 4
.IX Item "Kmp3burn"
http://computer.freepage.de/kmp3burn/index.htm
.IP "GtkMp3Burn" 4
.IX Item "GtkMp3Burn"
http://gtkmp3burn.sourceforge.net/
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIcdrecord\fR\|(1), \fImpg321\fR\|(1), \fIogg123\fR\|(1), \fIogginfo\fR\|(1), \fIflac\fR\|(1), \fIMP3::Info\fR\|(3)
The \fBmp3burn\fR web page is http://mp3burn.sourceforge.net/.
The Ogg Vorbis web page is http://www.xiph.org/ogg/vorbis/.
The \s-1FLAC\s0 web page is http://flac.sourceforge.net/.
.SH "AUTHOR"
.IX Header "AUTHOR"
Copyright (c) 2000 Ryan Richter. 
Copyright (c) 2003 Alexander Wirt
.PP
This script was written by Ryan Richter <bobort@bigfoot.com> with much code
contributed by Dan Lark <dlark@spinn.net>.
.PP
I would like to thank Dan Lark <dlark@spinn.net> for
contributing the ideas and code for most of the new features,
and Tony Mancill <tony@mancill.com> for making Debian packages
and helping with debugging.
.PP
Later in 2003 Alexander Wirt continued to write this program.
.PP
This program is licensed under the \s-1GNU\s0 General Public License.
You may fold, spindle, and mutilate this software under the terms of the \s-1GPL\s0.
.SH "HISTORY"
.IX Header "HISTORY"
.IP "20031014 <formorer@formorer.de>" 4
.IX Item "20031014 <formorer@formorer.de>"
Switches from standard getopt to GetOpts::Long
.Sp
Updated Manpage for the new option format
.IP "20031012 <formorer@formorer.de>" 4
.IX Item "20031012 <formorer@formorer.de>"
Updated mp3burn to use pod2usage
.Sp
Added \-h switch for getting help
.Sp
Fixed a bug with the output of file in conduction with \s-1FLAC\s0 files
.Sp
Added a gracefully exit if there are no valid files left
.Sp
Use String::Shellquote to avoid problems with the shell
.IP "20030203 <tmancill@debian.org>" 4
.IX Item "20030203 <tmancill@debian.org>"
hacked in support for \s-1FLAC\s0, as per suggested by <ldm@apartia.org>
.IP "20021110 <tmancill@debian.org>" 4
.IX Item "20021110 <tmancill@debian.org>"
updated to work with new ogginfo output format in vorbis-tools 1.0; 
modified slightly to not create FIFOs for invalid \s-1MP3/OGG\s0 files
.IP "20020728 <tmancill@debian.org>" 4
.IX Item "20020728 <tmancill@debian.org>"
added \fI\-M \f(CI$mp3decoder\fI\fR switch to support \s-1MP3\s0 decoders other than 
mpg321 and mpg123\-oss
.IP "20010917	<tmancill@debian.org>" 4
.IX Item "20010917	<tmancill@debian.org>"
added check to automatically add \-swab on ia32 platform
.Sp
\&\fIMP3::Info\fR\|(3) replaces MPEG::MP3Info
.IP "\fBmp3burn\fR 0.02 10/28/00" 4
.IX Item "mp3burn 0.02 10/28/00"
Changes since 0.01:
.Sp
Bugfixes:
.Sp
Spaces, quotes, and other shell metacharacters in filenames
should no longer problematic, since we use Shell:QuoteString 
to avoid problems with that (Feedback for that is wished).
.Sp
Mono MP3s and MP3s not sampled at 44.1kHz are no longer
problematic.
.Sp
New Features:
.Sp
Editing the executable is no longer necessary; cdrecord
options can be specified on the command line or in \fI~/.mp3burnrc\fR.
.Sp
Temp dir for FIFOs may be set to other than the current dir.
.Sp
Dummy runs now supported from the command line.
.Sp
A time check is now available: \fBmp3burn\fR can abort if total
time exceeds a threshold.  Requires MPEG::MP3Info.
.Sp
Playlist support.
.SH "POD ERRORS"
.IX Header "POD ERRORS"
Hey! \fBThe above document had some coding errors, which are explained below:\fR
.IP "Around line 583:" 4
.IX Item "Around line 583:"
You forgot a '=back' before '=head1'
.IP "Around line 589:" 4
.IX Item "Around line 589:"
\&'=item' outside of any '=over'