]> CyberLeo.Net >> Repos - FreeBSD/releng/8.1.git/blob - usr.sbin/burncd/burncd.8
Copy stable/8 to releng/8.1 in preparation for 8.1-RC1.
[FreeBSD/releng/8.1.git] / usr.sbin / burncd / burncd.8
1 .\"
2 .\" Copyright (c) 2000,2001,2002 Søren Schmidt <sos@FreeBSD.org>
3 .\" All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\"    notice, this list of conditions and the following disclaimer,
10 .\"    without modification, immediately at the beginning of the file.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\" 3. The name of the author may not be used to endorse or promote products
15 .\"    derived from this software without specific prior written permission.
16 .\"
17 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 .\"
28 .\" $FreeBSD$
29 .\"
30 .Dd December 21, 2009
31 .Os
32 .Dt BURNCD 8
33 .Sh NAME
34 .Nm burncd
35 .Nd control the ATAPI CD-R/RW driver
36 .Sh SYNOPSIS
37 .Nm
38 .Op Fl deFlmnpqtv
39 .Op Fl f Ar device
40 .Op Fl s Ar speed
41 .Op Ar command
42 .Op Ar command Ar
43 .Sh DESCRIPTION
44 The
45 .Nm
46 utility is used to burn CD-R/RW media using the ATAPI cd driver.
47 .Pp
48 Available options and operands:
49 .Pp
50 .Bl -tag -width XXXXXXXXXXXX
51 .It Fl d
52 burn the CD-R/RW in DAO (disk at once) mode.
53 .It Fl e
54 eject the medium when done.
55 .It Fl f Ar device
56 set the device to use for the burning process.
57 .It Fl F
58 force operation regardless of warnings.
59 .It Fl l
60 read a list of image files from filename.
61 .It Fl m
62 close disk in multisession mode (otherwise disk is closed as singlesession).
63 .It Fl n
64 do not write gaps between data tracks in DAO mode.
65 .It Fl p
66 use preemphasis on audio tracks.
67 .It Fl q
68 quiet, do not print progress messages.
69 .It Fl s Ar speed
70 set the speed of the burner device.
71 Defaults to 4.
72 Specify
73 .Dq Li max
74 to use the drive's fastest speed.
75 .It Fl t
76 test write, do not actually write on the media.
77 .It Fl v
78 verbose, print extra progress messages.
79 .El
80 .Pp
81 .Ar command
82 may be one of:
83 .Pp
84 .Bl -tag -width XXXXXXXXXXXX
85 .It Cm msinfo
86 Show the first LBA of the last track on the media
87 and the next writeable address on the media for use with the
88 .Xr mkisofs 8 Ns 's Pq Pa ports/sysutils/cdrtools
89 .Fl C
90 switch when adding additional data to ISO file systems with extra sessions.
91 .It Cm blank
92 Blank a CD-RW medium.
93 This uses the fast blanking method, so data are not physically overwritten,
94 only those areas that make the media appear blank for further usage are erased.
95 .It Cm eject
96 Eject the medium when done.
97 This is equivalent to the
98 .Fl e
99 option.
100 .It Cm erase
101 Erase a CD-RW medium.
102 This erases the entire media.
103 Can take up to 1 hour to finish.
104 .It Cm format Brq Cm dvd+rw | dvd-rw
105 Formats a DVD+RW or DVD-RW media to the default max size and 2048 byte blocks.
106 This operation can take a long time to finish.
107 Progress reporting is done during the process.
108 .It Cm fixate
109 Fixate the medium so that the TOC is generated and the media can be used
110 in an ordinary CD drive.
111 The driver defaults to creating singlesession media (see
112 .Fl m
113 option).
114 Ignored in DAO mode (see
115 .Fl d
116 option).
117 .It Cm raw | audio
118 Set the write mode to produce audio (raw mode) tracks for the following
119 images on the command line.
120 .It Cm data | mode1
121 Set the write mode to produce data (mode1) tracks for the following
122 image files
123 on the command line.
124 .It Cm mode2
125 Set the write mode to produce data (mode2) tracks for the following
126 image files
127 on the command line.
128 .It Cm XAmode1
129 Set the write mode to produce data (XAmode1) tracks for the following image
130 files on the command line.
131 .It Cm XAmode2
132 Set the write mode to produce data (XAmode2) tracks for the following image
133 files on the command line.
134 .It Cm vcd
135 Set the write mode to produce VCD/SVCD tracks for the following image files
136 on the command line.
137 This automatically sets DAO
138 .Pq Fl d
139 and
140 .Dq "no gaps"
141 .Pq Fl n
142 modes.
143 .It Cm dvdrw
144 Set the write mode to write a DVD+RW from the following image.
145 DVDs only have one track.
146 .It Ar file
147 All other arguments are treated as filenames of images to write to the media,
148 or in case the
149 .Fl l
150 option is used as files containing lists of images.
151 .El
152 .Pp
153 Files whose length are not a multiple of the current media blocksize are
154 quietly zero padded to fit the blocksize requirement.
155 The conventional filename
156 .Fl
157 refers to stdin, and can only be used once.
158 .Sh ENVIRONMENT
159 The following environment variables affect the execution of
160 .Nm :
161 .Bl -tag -width ".Ev BURNCD_SPEED"
162 .It Ev BURNCD_SPEED
163 The write speed to use if one is not specified with the
164 .Fl s
165 flag.
166 .It Ev CDROM
167 The CD device to use if one is not specified with the
168 .Fl f
169 flag.
170 .El
171 .Sh FILES
172 .Bl -tag -width ".Pa /dev/acd0"
173 .It Pa /dev/acd0
174 The default device, if not overridden by the
175 .Ev CDROM
176 environment variable or the
177 .Fl f
178 option.
179 .El
180 .Sh EXAMPLES
181 The typical usage for burning a data CD-R:
182 .Pp
183 .Dl "burncd -f /dev/acd0 data file1 fixate"
184 .Pp
185 The typical usage for burning an audio CD-R:
186 .Pp
187 .Dl "burncd -f /dev/acd0 audio file1 file2 file3 fixate"
188 .Pp
189 The typical usage for burning an audio CD-R in DAO mode:
190 .Pp
191 .Dl "burncd -f /dev/acd0 -d audio file1 file2 file3"
192 .Pp
193 The typical usage for burning a mixed mode CD-R:
194 .Pp
195 .Dl "burncd -f /dev/acd0 data file1 audio file2 file3 fixate"
196 .Pp
197 The typical usage for burning from a compressed image file on stdin:
198 .Pp
199 .Dl "gunzip -c file.iso.gz | burncd -f /dev/acd0 data - fixate"
200 .Pp
201 In the examples above, the files burned to data CD-Rs are assumed to
202 be ISO9660 file systems.
203 .Xr mkisofs 8 ,
204 available in the
205 .Fx
206 Ports Collection,
207 as part of the
208 .Pa sysutils/cdrtools
209 port, is commonly used to create ISO9660 file system images
210 from a given directory tree.
211 .Sh HISTORY
212 The
213 .Nm
214 utility appeared in
215 .Fx 4.0 .
216 .Sh AUTHORS
217 The
218 .Nm
219 utility and this manpage was contributed by
220 .An S\(/oren Schmidt ,
221 Denmark
222 .Aq sos@FreeBSD.org .
223 .Sh BUGS
224 Probably, please report when found.