Merge from vendor branch READLINE:
[dragonfly.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: src/usr.sbin/burncd/burncd.8,v 1.6.2.8 2003/03/12 22:08:13 trhodes Exp $
29 .\" $DragonFly: src/usr.sbin/burncd/burncd.8,v 1.2 2003/06/17 04:29:52 dillon Exp $
30 .\"
31 .Dd December 4, 2001
32 .Os
33 .Dt BURNCD 8
34 .Sh NAME
35 .Nm burncd
36 .Nd control the ATAPI CD-R/RW driver
37 .Sh SYNOPSIS
38 .Nm
39 .Op Fl delmnpqtv
40 .Op Fl f Ar device
41 .Op Fl s Ar speed
42 .Op Ar command
43 .Op Ar command Ar
44 .Sh DESCRIPTION
45 The
46 .Nm
47 utility is used to burn CD-R/RW media using the ATAPI cd driver.
48 .Pp
49 Available options and operands:
50 .Pp
51 .Bl -tag -width XXXXXXXXXXXX
52 .It Fl d
53 burn the CD-R/RW in DAO (disk at once) mode.
54 .It Fl e
55 eject the media when done.
56 .It Fl f Ar device
57 set the device to use for the burning process.
58 .It Fl l
59 read a list of image files from filename.
60 .It Fl m
61 close disk in multisession mode (otherwise disk is closed as singlesession).
62 .It Fl n
63 do not write gaps between data tracks in DAO mode.
64 .It Fl p
65 use preemphasis on audio tracks.
66 .It Fl q
67 quiet, do not print progress messages.
68 .It Fl s Ar speed
69 set the speed of the burner device.
70 Defaults to 1.
71 Specify
72 .Dq Li max
73 to use the drive's fastest speed.
74 .It Fl t
75 test write, do not actually write on the media.
76 .It Fl v
77 verbose, print extra progress messages.
78 .El
79 .Pp
80 .Ar command
81 may be one of:
82 .Pp
83 .Bl -tag -width XXXXXXXXXXXX
84 .It Cm msinfo
85 Show the first LBA of the last track on the media
86 and the next writeable address on the media for use with the
87 .Xr mkisofs 8 Ns 's
88 .Fl C
89 switch when adding additional data to ISO file systems with extra sessions.
90 .It Cm blank
91 Blank a CD-RW medium.
92 This uses the fast blanking method, so data are not physically overwritten,
93 only those areas that make the media appear blank for further usage are erased.
94 .It Cm erase
95 Erase a CD-RW medium.
96 This erases the entire media.
97 Can take up to 1 hour to finish.
98 .It Cm fixate
99 Fixate the medium so that the TOC is generated and the media can be used
100 in an ordinary CD drive.
101 The driver defaults to creating singlesession media (see
102 .Fl m
103 option).
104 Should be the last command to
105 .Nm
106 as the program exits when this has been done.
107 Ignored in DAO mode (see
108 .Fl d
109 option).
110 .It Cm raw | audio
111 Set the write mode to produce audio (raw mode) tracks for the following
112 images on the command line.
113 .It Cm data | mode1
114 Set the write mode to produce data (mode1) tracks for the following
115 image files
116 on the command line.
117 .It Cm mode2
118 Set the write mode to produce data (mode2) tracks for the following
119 image files
120 on the command line.
121 .It Cm XAmode1
122 Set the write mode to produce data (XAmode1) tracks for the following image
123 files on the command line.
124 .It Cm XAmode2
125 Set the write mode to produce data (XAmode2) tracks for the following image
126 files on the command line.
127 .It Cm vcd
128 Set the write mode to produce VCD/SVCD tracks for the following image files
129 on the command line.
130 This automatically sets DAO
131 .Pq Fl d
132 and
133 .Dq "no gaps"
134 .Pq Fl n
135 modes.
136 .It Ar file
137 All other arguments are treated as filenames of images to write to the media,
138 or in case the
139 .Fl l
140 option is used as files containing lists of images.
141 .El
142 .Pp
143 Files whose length are not a multiple of the current media blocksize are
144 quietly zero padded to fit the blocksize requirement.
145 The conventional filename
146 .Fl
147 refers to stdin, and can only be used once.
148 .Sh EXAMPLES
149 The typical usage for burning a data CD-R:
150 .Pp
151 .Dl "burncd -f /dev/acd0c data file1 fixate"
152 .Pp
153 The typical usage for burning an audio CD-R:
154 .Pp
155 .Dl "burncd -f /dev/acd0c audio file1 file2 file3 fixate"
156 .Pp
157 The typical usage for burning an audio CD-R in DAO mode:
158 .Pp
159 .Dl "burncd -f /dev/acd0c -d audio file1 file2 file3"
160 .Pp
161 The typical usage for burning a mixed mode CD-R:
162 .Pp
163 .Dl "burncd -f /dev/acd0c data file1 audio file2 file3 fixate"
164 .Pp
165 The typical usage for burning from a compressed image file on stdin:
166 .Pp
167 .Dl "gunzip -c file.iso.gz | burncd -f /dev/acd0c data - fixate"
168 .Pp
169 In the examples above, the files burned to data CD-Rs are assumed to
170 be ISO9660 file systems.
171 .Xr mkisofs 8 ,
172 available in the
173 .Fx
174 Ports Collection, is commonly used to create ISO9660 file system images
175 from a given directory tree.
176 .Sh BUGS
177 Probably, please report when found.
178 .Sh HISTORY
179 The
180 .Nm
181 utility appeared in
182 .Fx 4.0 .
183 .Sh AUTHORS
184 The
185 .Nm
186 utility and this manpage was contributed by
187 .An S\(/oren Schmidt ,
188 Denmark
189 .Aq sos@FreeBSD.org .