Imported Upstream version 1.1.11
[platform/upstream/cdrkit.git] / icedax / cdda2ogg.1
1 '\"
2 .TH "cdda2ogg" "1"
3 .SH "NAME"
4 cdda2ogg, cdda2mp3 \(em extract audio CD audio tracks and encode them
5 .SH "SYNOPSIS"
6 .PP
7 .B cdda2ogg
8 .PP
9 .B cdda2mp3
10 .SH "DESCRIPTION"
11 .PP
12 .B cdda2ogg is a simple script that uses the
13 .B icedax <fileprefix>
14 command to extract all audio tracks with the
15 .B icedax <fileprefix>
16 command and encode them using the
17 .B ogg123
18 respective
19 .I <censored>
20 MP3
21 encoder. The scripts are not intended to be full-featured music archiving
22 programs, but only for quick storing of few audio data.
23 It does not use databases like CDDB or have any extra features. You may look
24 at
25 .B icedax
26 if you need them.
27 .PP
28 .B ogg123
29 is provided by the
30 .B vorbis-tools
31 which needs to be installed separately.
32 See
33 .B www.ogg.org
34 for more information.
35
36 .SH "CONFIGURATION"
37 .PP
38 .B cdda2ogg
39 and
40 .B cdda2mp3
41 have predefined values for reading and labeling of the target files.
42 You can overwrite them with following environment variables:
43
44 .IP "CDDA_DEVICE" 10
45 Source device specification to get the data from.
46
47 .IP "LIST" 10
48 List of track numbers to be read, separated by spaces.
49
50 .IP "CDDA2WAV" 10
51 Defines the command to run the cdda2wav program
52
53 .IP "CDDA2WAV_OPTS" 10
54 Miscellaneous options passed to 
55 .IR $CDDA2WAV .
56
57 .IP "MP_CODER" 10
58 The encoder program.
59
60 .IP "MP_OPTIONS" 10
61 Additional options passed to
62 .IR $MP_CODER .
63  
64 .IP "FILEPREFIX" 10
65 The base part of the filename of resulting audio files. This can also be specified as the first argument to the script.
66
67 .PP
68 See cdda2ogg (cdda2mp3) script file to get the default values
69 .PP
70 System administrator can also set default values by creating of a shell
71 include file, defining the variables for the POSIX shell, and storing them as
72 /etc/default/cdda2ogg (resp. cdda2mp3).
73 .SH "EXAMPLES"
74 .PP
75 .B CDDA_DEVICE=/dev/cdrom1 cdda2ogg
76 .br
77 just stores every track in this device in audiotrackNUMBER.ogg
78 .PP
79 .PP
80 .B LIST="1 5 7" cdda2ogg PartsOfBestOfFoo
81 .br
82 stores the selected tracks from the default cdrom device as 01-PartsOfBestOfFoo.ogg, 05-PartsOfBestOfFoo.ogg, 07-PartsOfBestOfFoo.ogg.
83
84 .SH "SEE ALSO"
85 .BR icedax (1)
86 .SH "AUTHOR"
87 .PP
88 This manpage describes the program implementation of
89 .B
90 cdda2ogg
91 as shipped by the cdrkit distribution. See
92 .B
93 http://alioth.debian.org/projects/debburn/
94 for details. It is a spinoff from the original program distributed by the cdrtools project. However, the cdrtools developers are not involved in the development of this spinoff and therefore shall not be made responsible for any problem caused by it. Do not try to get support for this program by contacting the original authors.
95 .PP
96 If you have support questions, send them to
97 .PP
98 .B
99 debburn-devel@lists.alioth.debian.org
100 .br
101 .PP
102 If you have definitely found a bug, send a mail to this list or to
103 .PP
104 .B
105 submit@bugs.debian.org
106 .br
107 .PP
108 writing at least a short description into the Subject and "Package: cdrkit" into the first line of the mail body.
109 .PP
110 This manual page was written by Eduard Bloch
111 (blade@debian.org) for the
112 .B "Debian GNU/Linux system (but may be used by others). Permission is granted
113 to copy, distribute and/or modify this document under the terms of the GNU
114 General Public License, Version 2 as published by the Free Software Foundation.